Skip to content

Commit d7cd717

Browse files
committed
Update documentation
1 parent 2f6ec0c commit d7cd717

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

docs/api.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ This class allows the user to put the device into different low-power states and
1515
Members | Descriptions
1616
--------------------------------|---------------------------------------------
1717
| [`LowPower`](#class_low_power_1a096a38a40767b27b681330a514fd4e48) | Constructor for [LowPower](#class_low_power) class. Initializes the low power and sleep configurations. |
18-
| [`begin`](#class_low_power_1ab6612ee1251267af4a79ebd243d3ebac) | |
19-
| [`sleep`](#class_low_power_1a351563f87f8d1f118e9d77201fd59a55) | Puts the device into a standard sleep mode. The device can be woken up by predefined interrupts or conditions. |
20-
| [`deepSleep`](#class_low_power_1ada3410c10d04970e0898eb5f7f36ce55) | Puts the device into a deep sleep mode. The device consumes the least power in this mode but requires specific conditions to wake up. |
21-
| [`enableWakeupFromPin`](#class_low_power_1a9ee83fbc2b670ac9490cd179b2e08138) | Enables wake-up of the device from a specified pin. |
18+
| [`sleep`](#class_low_power_1a351563f87f8d1f118e9d77201fd59a55) | Puts the device into a standard sleep mode. This sleep mode consumes less power than the active mode but more than the deep sleep mode. The device will resume execution from the point where it entered the sleep mode. |
19+
| [`deepSleep`](#class_low_power_1ada3410c10d04970e0898eb5f7f36ce55) | Puts the device into a deep sleep mode. The device consumes the least power in this mode but will reset when it wakes up effectively running the setup() function again. |
20+
| [`enableWakeupFromPin`](#class_low_power_1a9ee83fbc2b670ac9490cd179b2e08138) | Enables wake-up of the device from a specified pin (A0, A1, A2, A3, A4, A5, D4, D7 ) |
2221
| [`enableWakeupFromRTC`](#class_low_power_1a91d86cab239a56506bf15e9d2139c097) | Enables wake-up of the device based on the Real-Time Clock (RTC). |
2322

2423
## Members
@@ -32,21 +31,13 @@ public LowPower()
3231
Constructor for [LowPower](#class_low_power) class. Initializes the low power and sleep configurations.
3332
<hr />
3433

35-
### `begin` <a id="class_low_power_1ab6612ee1251267af4a79ebd243d3ebac" class="anchor"></a>
36-
37-
```cpp
38-
public void begin()
39-
```
40-
41-
<hr />
42-
4334
### `sleep` <a id="class_low_power_1a351563f87f8d1f118e9d77201fd59a55" class="anchor"></a>
4435

4536
```cpp
4637
public void sleep()
4738
```
4839

49-
Puts the device into a standard sleep mode. The device can be woken up by predefined interrupts or conditions.
40+
Puts the device into a standard sleep mode. This sleep mode consumes less power than the active mode but more than the deep sleep mode. The device will resume execution from the point where it entered the sleep mode.
5041
<hr />
5142

5243
### `deepSleep` <a id="class_low_power_1ada3410c10d04970e0898eb5f7f36ce55" class="anchor"></a>
@@ -55,7 +46,7 @@ Puts the device into a standard sleep mode. The device can be woken up by predef
5546
public void deepSleep()
5647
```
5748

58-
Puts the device into a deep sleep mode. The device consumes the least power in this mode but requires specific conditions to wake up.
49+
Puts the device into a deep sleep mode. The device consumes the least power in this mode but will reset when it wakes up effectively running the setup() function again.
5950
<hr />
6051

6152
### `enableWakeupFromPin` <a id="class_low_power_1a9ee83fbc2b670ac9490cd179b2e08138" class="anchor"></a>
@@ -64,7 +55,7 @@ Puts the device into a deep sleep mode. The device consumes the least power in t
6455
public bool enableWakeupFromPin(uint8_t pin, PinStatus direction)
6556
```
6657
67-
Enables wake-up of the device from a specified pin.
58+
Enables wake-up of the device from a specified pin (A0, A1, A2, A3, A4, A5, D4, D7 )
6859
#### Parameters
6960
* `pin` The pin number used for waking up the device.
7061

0 commit comments

Comments
 (0)