Skip to content

Commit 2f6ec0c

Browse files
refined api documentation
1 parent e579646 commit 2f6ec0c

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

src/Arduino_Portenta_C33_LowPower.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,21 @@ class LowPower {
2020
*/
2121
LowPower();
2222

23-
void begin();
24-
2523
/**
2624
* Puts the device into a standard sleep mode.
27-
* The device can be woken up by predefined interrupts or conditions.
25+
* This sleep mode consumes less power than the active mode but more than the deep sleep mode.
26+
* The device will resume execution from the point where it entered the sleep mode.
2827
*/
2928
void sleep();
3029

3130
/**
3231
* Puts the device into a deep sleep mode.
33-
* The device consumes the least power in this mode but requires specific conditions to wake up.
32+
* The device consumes the least power in this mode but will reset when it wakes up effectively running the setup() function again.
3433
*/
3534
void deepSleep();
3635

3736
/**
38-
* Enables wake-up of the device from a specified pin.
37+
* Enables wake-up of the device from a specified pin (A0, A1, A2, A3, A4, A5, D4, D7 )
3938
* @param pin The pin number used for waking up the device.
4039
* @param direction The direction of the interrupt that will wake up the device. (RISING, FALLING, CHANGE)
4140
*/
@@ -62,7 +61,6 @@ class LowPower {
6261
*/
6362
int getDeepSleepWakeIRQChannelForPin(uint8_t pin);
6463

65-
int getDeepSleepWakeIRQEdgeForPin(uint8_t pin, PinStatus direction);
6664

6765
// Member variables
6866
uint16_t deepSleepWakeupSource = 0;

0 commit comments

Comments
 (0)