Skip to content

Conversation

@alrvid
Copy link
Contributor

@alrvid alrvid commented May 8, 2024

  1. Improve Standby Mode example by adding how to go into Standby Mode waiting for only a wakeup pin.

  2. Fix two incorrect comments.

  3. Add option to not turn off Ethernet. This option is added for libraries that turn off the rail that powers
    the Ethernet chip, and it prevents malfunction because of the combination of libraries.

  4. Improve template function Doxygen documentation. Adds one declaration for Doxygen and another for the compiler.
    Plus improves a bit on the documentation.

Alrik Vidstrom and others added 5 commits May 8, 2024 16:34
Adds one declaration for Doxygen and another for the compiler.
Plus improves a bit on the documentation.
This option is added for libraries that turn off the rail that powers
the Ethernet chip.
1. Typo where M7 should be M4.

2. Incorrect comment, because the flags are not just for standby
Adds how to go into Standby Mode waiting for only a wakeup pin.
@alrvid alrvid added type: imperfection Perceived defect in any part of project type: enhancement Proposed improvement labels May 8, 2024
@alrvid alrvid requested a review from sebromero May 8, 2024 15:16
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ alrvid
❌ actions-user
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link

github-actions bot commented May 8, 2024

Memory usage change @ c4cce7a

Board flash % RAM for global variables %
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A
Click for full report table
Board examples/AllowDeepSleep
flash
% examples/AllowDeepSleep
RAM for global variables
% examples/DeepSleepLockDebug
flash
% examples/DeepSleepLockDebug
RAM for global variables
% examples/Standby
flash
% examples/Standby
RAM for global variables
%
arduino:mbed_portenta:envie_m7 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
Click for full report CSV
Board,examples/AllowDeepSleep<br>flash,%,examples/AllowDeepSleep<br>RAM for global variables,%,examples/DeepSleepLockDebug<br>flash,%,examples/DeepSleepLockDebug<br>RAM for global variables,%,examples/Standby<br>flash,%,examples/Standby<br>RAM for global variables,%
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A

Copy link
Contributor

@sebromero sebromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use DOXYGEN_ONLY as the define so that it starts with DOXYGEN and is easier to spot.

Co-authored-by: Sebastian Romero <[email protected]>
@alrvid alrvid requested a review from sebromero May 8, 2024 15:56
Co-authored-by: Sebastian Romero <[email protected]>
Copy link
Contributor

@sebromero sebromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alrvid alrvid merged commit 38bdac1 into arduino-libraries:main May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: enhancement Proposed improvement type: imperfection Perceived defect in any part of project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants