Skip to content

Commit 6c80901

Browse files
committed
Update documentation
1 parent 1ad5e0b commit 6c80901

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This class allows the user to put the device into different low-power states and
2525
### `LowPower` <a id="class_low_power_1a096a38a40767b27b681330a514fd4e48" class="anchor"></a>
2626

2727
```cpp
28-
public LowPower()
28+
LowPower()
2929
```
3030

3131
Constructor for [LowPower](#class_low_power) class. Initializes the low power and sleep configurations.
@@ -34,7 +34,7 @@ Constructor for [LowPower](#class_low_power) class. Initializes the low power an
3434
### `sleep` <a id="class_low_power_1a351563f87f8d1f118e9d77201fd59a55" class="anchor"></a>
3535

3636
```cpp
37-
public void sleep()
37+
void sleep()
3838
```
3939

4040
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.
@@ -43,7 +43,7 @@ Puts the device into a standard sleep mode. This sleep mode consumes less power
4343
### `deepSleep` <a id="class_low_power_1ada3410c10d04970e0898eb5f7f36ce55" class="anchor"></a>
4444

4545
```cpp
46-
public void deepSleep()
46+
void deepSleep()
4747
```
4848

4949
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.
@@ -52,7 +52,7 @@ Puts the device into a deep sleep mode. The device consumes the least power in t
5252
### `enableWakeupFromPin` <a id="class_low_power_1a9ee83fbc2b670ac9490cd179b2e08138" class="anchor"></a>
5353

5454
```cpp
55-
public bool enableWakeupFromPin(uint8_t pin, PinStatus direction)
55+
bool enableWakeupFromPin(uint8_t pin, PinStatus direction)
5656
```
5757
5858
Enables wake-up of the device from a specified pin (A0, A1, A2, A3, A4, A5, D4, D7 )
@@ -65,7 +65,7 @@ Enables wake-up of the device from a specified pin (A0, A1, A2, A3, A4, A5, D4,
6565
### `enableWakeupFromRTC` <a id="class_low_power_1a91d86cab239a56506bf15e9d2139c097" class="anchor"></a>
6666
6767
```cpp
68-
public void enableWakeupFromRTC()
68+
void enableWakeupFromRTC()
6969
```
7070

7171
Enables wake-up of the device based on the Real-Time Clock (RTC).

0 commit comments

Comments
 (0)