Skip to content

Commit c4f96ae

Browse files
added more information to README.md
1 parent d377ef1 commit c4f96ae

File tree

3 files changed

+30
-21
lines changed

3 files changed

+30
-21
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# Portenta C33 Low Power Library
1+
# 🔌 Portenta C33 Low Power Library
22

33
[![Check Arduino](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/check-arduino.yml) [![Compile Examples](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/compile-examples.yml) [![Spell Check](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/spell-check.yml) [![Sync Labels](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/actions/workflows/sync-labels.yml)
44

55

66
The Portenta C33 Low Power Library is a library designed to optimize power consumption for projects using the Portenta C33 boards, which are powered by the Renesas RA6M5 microcontroller. The library achieves this by providing access to various low power modes. These modes are essential for applications where power efficiency is crucial, such as in remote sensing, IoT devices, or battery-powered applications.
77

88

9-
## Sleep Modes
9+
## Examples
10+
* [WakeFromGPIO](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/examples/WakeFromGPIO/WakeFromGPIO.ino) - This example demonstrates how you can use [the GPIO pins](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/README.md#wakeup-pins) to wake your board from sleep.
11+
12+
* [WakeFromRTC](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/examples/WakeFromRTC/WakeFromRTC.ino) - This example demonstrates how you can use the RTC to wake the board from sleep.
13+
14+
* [TurnPeripheralsOff](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/examples/TurnPeripheralsOff/TurnPeripheralsOff.ino) - This example extends the [WakeFromGPIO](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/examples/WakeFromGPIO/WakeFromGPIO.ino) example by enabling the user to disable several power lanes to achieve the minimum power consumption of about ~60µA.
15+
16+
17+
## 😴 Sleep Modes
1018

1119
### Sleep
1220
* **Function**: Reduces the microcontroller's power usage to about half of its normal consumption.
@@ -19,7 +27,26 @@ The Portenta C33 Low Power Library is a library designed to optimize power consu
1927
* **Wake-Up Triggers**: The board can be configured to wake up either from an RTC alarm or an external interrupt pin.
2028

2129

30+
## 📐 Measurements
31+
Here's an overview of the reduction in power usage that you can expect from this library. The screenshots below are taken from the nRF Power Profiler application using a Nordic PPK2 while running the blink sketch on the same board.
32+
33+
#### Normal operating conditions
34+
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/normal_usage_blink.png)
35+
36+
#### Sleep Mode with peripherals off
37+
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/sleep_no_peripherals.png)
38+
39+
#### Deep Sleep Mode with peripherals off
40+
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/deep_sleep_no_peripherals.png)
41+
42+
#### Sleep Mode with peripherals on
43+
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/sleep_peripherals_on.png)
44+
45+
#### Deep Sleep Mode with peripherals on
46+
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/deep_sleep_peripherals_on.png)
47+
48+
2249
> [!NOTE]
23-
> Note, this library reduces the power usage of the microcontroller, not the entire board and it's peripherals (Wi-Fi module for example). If you would like to reach the maximum power reduction possible for a Portenta C33 board, please use the [Arduino PowerManagement library](ttps://github.com/arduino-libraries/Arduino_PowerManagement) which allows you to turn off peripherals as well.
50+
> Note, this library reduces the power usage of the microcontroller, not the entire board and it's peripherals (Wi-Fi module for example). If you would like to reach the maximum power reduction possible for a Portenta C33 board, please check out the [TurnPeripheralsOff Example](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/examples/TurnPeripheralsOff/TurnPeripheralsOff.ino) that makes use of the [Arduino_PF1550 Library](https://github.com/arduino-libraries/Arduino_PF1550)
2451
2552
For more information about this libraries check the [library documentation](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/README.md) or the [API Reference](https://github.com/arduino-libraries/Arduino_LowPowerPortentaC33/blob/main/docs/api.md)

docs/README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,4 @@
11

2-
## Measurements
3-
Here's an overview of the reduction in power usage that you can expect from this library. The screenshots below are taken from the nRF Power Profiler application using a Nordic PPK2 while running the blink sketch on the same board.
4-
5-
#### Normal operating conditions
6-
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/normal_usage_blink.png)
7-
8-
#### Sleep Mode with peripherals off
9-
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/sleep_no_peripherals.png)
10-
11-
#### Deep Sleep Mode with peripherals off
12-
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/deep_sleep_no_peripherals.png)
13-
14-
15-
#### Sleep Mode with peripherals on
16-
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/sleep_peripherals_on.png)
17-
18-
#### Deep Sleep Mode with peripherals on
19-
![](https://raw.githubusercontent.com/arduino-libraries/Arduino_LowPowerPortentaC33/main/extras/results/deep_sleep_peripherals_on.png)
202

213
## Usage
224
### Selecting a wakeup source
-207 KB
Loading

0 commit comments

Comments
 (0)