Skip to content

Commit e5ea93d

Browse files
authored
Merge pull request #13 from arduino-libraries/docs
Update documentation
2 parents b706879 + 3ae8ab2 commit e5ea93d

File tree

2 files changed

+97
-68
lines changed

2 files changed

+97
-68
lines changed

Diff for: README.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ In addition to power rail management and battery handling, the library provides
2828
- **Sleep**
2929
This mode offers a significant reduction in power consumption while maintaining a state of minimal activity.
3030
It's ideal for applications requiring periodic wake-ups or brief intervals of inactivity. This sleep mode resumes the operation from the last operation.
31-
You can manually enable this sleep mode on the Portenta C33, on the H7 and Nicla Vision however, this is automatically handled by mbed.
31+
You can manually enable this sleep mode on the Portenta C33. On the H7 and Nicla Vision however, this is automatically handled by mbed. There is a separate (deep) sleep mode on Portenta H7 and Nicla Vision that can be enabled through their [low power libraries](https://github.com/arduino-libraries/Arduino_LowPowerPortentaH7).
3232

33-
- **Deep Sleep**
34-
For scenarios demanding drastic power conservation, the Deep Sleep Mode drastically reduces the board's power usage. It's suitable for long-duration, battery-dependent applications where occasional wake-ups are sufficient. This mode restarts the board on wakeup, effectively running the `setup()` function again.
33+
- **Standby**
34+
For scenarios demanding drastic power conservation, the Standby Mode drastically reduces the board's power usage. It's suitable for long-duration, battery-dependent applications where occasional wake-ups are sufficient. This mode restarts the board on wakeup, effectively running the `setup()` function again.
3535

3636
#### Low Power Measurements
3737
Here's a table with the current consumption you can expect from each board in Sleep and Standby modes. Clicking on any of the values in the table above will send you to an image of the measurements for that specific scenario.
@@ -41,8 +41,8 @@ Here's a table with the current consumption you can expect from each board in Sl
4141
| Without power optimisations | [41.37 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/normal_usage_blink.png) | [123.86 mA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/normal_usage.png) | [123.86 mA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/normal_usage.png) |
4242
| Standby consumption with peripherals off | [58.99 μA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/deep_sleep_no_peripherals.png) | [75.51 μA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/H7_lite_deep_sleep_peripherals_off.png) | [379 μA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/H7_deep_sleep_peripherals_off.png) |
4343
| Standby consumption with peripherals on | [11.53 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/deep_sleep_peripherals_on.png) | [4.89 mA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/H7_lite_deep_sleep_peripherals_on.png) | [7.98 mA](https://github.com/arduino-libraries/Arduino_PowerManagement/blob/main/docs/assets/H7_deep_sleep_peripherals_on.png) |
44-
| Sleep consumption with peripherals off | [7.02 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/sleep_no_peripherals.png) | N/a | N/a |
45-
| Sleep consumption with peripherals on | [18.26 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/sleep_peripherals_on.png) | N/a | N/a |
44+
| Sleep consumption with peripherals off | [7.02 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/sleep_no_peripherals.png) | N/A | N/A |
45+
| Sleep consumption with peripherals on | [18.26 mA](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/assets/sleep_peripherals_on.png) | N/A | N/A |
4646

4747
> [!NOTE]
4848
> Sleep measurements are not available on the H7 boards because the board goes to sleep automatically when idling.
@@ -54,10 +54,9 @@ Here's a table with the current consumption you can expect from each board in Sl
5454
## Examples
5555
- [Battery](./examples/Battery/Battery.ino) - Demonstrates battery metrics monitoring.
5656
- [Charger](./examples/Charger/Charger.ino) - Illustrates charger status monitoring and control.
57-
- [DeepSleep_WakeFromPin](./examples/DeepSleep_WakeFromPin/DeepSleep_WakeFromPin.ino) - Demonstrates how to wake up the board from deep sleep using a wakeup pin.
58-
- [DeepSleep_WakeFromRTC_C33](./examples/DeepSleep_WakeFromRTC/DeepSleep_WakeFromRTC_C33.ino) - Demonstrates how to use the RTC to wake the Portenta C33 from deep sleep.
59-
- [DeepSleep_WakeFromRTC_H7](./examples/DeepSleep_WakeFromRTC/DeepSleep_WakeFromRTC_H7.ino) - Demonstrates how to use the RTC to wake the Portenta H7 from deep sleep.
60-
- [Powershell](./examples/Powershell/Powershell.ino) - Provides an interactive shell on the serial port that allows you to interact with any aspect of this library.
57+
- [Standby_WakeFromPin](./examples/Standby_WakeFromPin/Standby_WakeFromPin.ino) - Demonstrates how to wake up the board from standby using a wakeup pin.
58+
- [Standby_WakeFromRTC_C33](./examples/Standby_WakeFromRTC_C33/Standby_WakeFromRTC_C33.ino) - Demonstrates how to use the RTC to wake the Portenta C33 from standby.
59+
- [Standby_WakeFromRTC_H7](./examples/Standby_WakeFromRTC_H7/Standby_WakeFromRTC_H7.ino) - Demonstrates how to use the RTC to wake the Portenta H7 from standby.
6160

6261
## 👀 Instructions
6362

@@ -67,10 +66,10 @@ Here's a table with the current consumption you can expect from each board in Sl
6766

6867

6968
## ✨ Features
70-
- Monitor current and average battery metrics (voltage, current, percentage, temperature)
71-
- Monitor battery health metrics (power cycles, temperature, reported capacity)
69+
- Monitor current and average battery metrics (voltage, current, percentage)
70+
- Monitor battery health metrics (temperature, reported capacity)
7271
- Monitor and control charging
73-
- Save significant amounts of power by sending the boards into Sleep and Deep Sleep modes (only available for Portenta C33 for now)
72+
- Save significant amounts of power by sending the boards into Sleep (only available for Portenta C33 for now) and Standby modes
7473
- Toggle and set voltages on different power rails of the board
7574
- On Nicla Vision
7675
- Enable and disable the external power rail

0 commit comments

Comments
 (0)