Skip to content

Commit 8cfa032

Browse files
authored
Merge pull request #8 from arduino-libraries/documentation_updates
Formatting improvements in documentation
2 parents b962857 + afaca81 commit 8cfa032

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

Diff for: examples/Charger/Charger.ino

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
Cristian Dragomir ([email protected])
3131
Sebastian Romero ([email protected])
3232
*/
33+
3334
#include "Arduino_PowerManagement.h"
3435

3536
Charger charger;

Diff for: examples/Standby_WakeFromPin/Standby_WakeFromPin.ino

+17-14
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
/*
22
Standby Wake From Pin Demo
3+
34
This sketch demonstrates how you can use the Arduino_PowermManagement library to send a board to standby mode by using a GPIO pin and wake it up from another.
45
This sketch is universal and worksn on both Portenta C33 and H7.
6+
57
On the the Portenta C33 you can select any of the supported pins (A0, A1, A2, A3, A4, A5, D4, D7) to wake up the board from standby mode,
6-
but on the Portenta H7 only GPIO0 can be used to wake up the board from standby mode. GPIO0 is available through the High Density Connectors and you need a breakout board to access it.
8+
but on the Portenta H7 only GPIO0 can be used to wake up the board from standby mode. GPIO0 is available trough the High Density Connectors and you need a breakout board to access it.
79
810
Requirements:
9-
- Arduino Portenta C33, Arduino Portenta H7
10-
- Arduino IDE / Arduino CLI
11-
- PowerManagement library (installable from the Arduino Library Manager)
12-
Usage:
13-
- Connect a button to GOTO_SLEEP_PIN and with a pull-up resistor to 3.3V
14-
- Connect a button to pin PORTENTA_C33_WAKEUP_PIN if you are using the Portenta C33 or GPIO0 if you are using a Portenta H7 and with a pull-up resistor to 3.3V
15-
(If you need information about how to wire the buttons check this link: https://docs.arduino.cc/built-in-examples/digital/Button/)
16-
- Upload the provided sketch to the board
17-
- Press the button connected to GOTO_SLEEP_PIN to put the board into standby mode
18-
- Press the button connected to PORTENTA_C33_WAKEUP_PIN or GPIO0 to wake up the board from standby mode
19-
- The LED will blink every second to show that the board is awake when not in standby mode
20-
21-
Initial author: Cristian Dragomir ([email protected])
11+
- Arduino Portenta C33, Arduino Portenta H7
12+
- Arduino IDE / Arduino CLI
13+
- PowerManagement library (installable from the Arduino Library Manager)
14+
15+
Usage:
16+
- Connect a button to GOTO_SLEEP_PIN and with a pull-up resistor to 3.3V
17+
- Connect a button to pin PORTENTA_C33_WAKEUP_PIN if you are using the Portenta C33 or GPIO0 if you are using a Portenta H7 and with a pull-up resistor to 3.3V
18+
(If you need information about how to wire the buttons check this link: https://docs.arduino.cc/built-in-examples/digital/Button/)
19+
- Upload the provided sketch to the board
20+
- Press the button connected to GOTO_SLEEP_PIN to put the board into standby mode
21+
- Press the button connected to PORTENTA_C33_WAKEUP_PIN or GPIO0 to wake up the board from standby mode
22+
- The LED will blink every second to show that the board is awake when not in standby mode
23+
24+
Original author: C. Dragomir (http://arduino.cc)
2225
*/
2326

2427
#include "Arduino.h"

Diff for: examples/Standby_WakeFromRTC_C33/Standby_WakeFromRTC_C33.ino

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
/*
22
Standby Wake from RTC Demo for Portenta C33
3+
34
This example demonstrates how to wake up the Portenta C33 from standby mode using the included RTC (Real Time Clock).
45
The device will go to sleep for 1 second and then wake up. When the device is awake you will see the board's blue LED turned on.
5-
Effectively, you will get the same effect as with blink.
6+
Effectivelly, you will get the same effect as with blink.
67
78
On the Portenta C33 with the peripherals turned off you can expect around 60uA of current consumption in standby mode.
89
The example also turns off the peripherals before going to sleep and turns them back on after waking up.
10+
911
Usage:
1012
- Make sure you are running the latest version of the Renesas Core
1113
- Select the Portenta C33 board from the Tools menu
@@ -45,8 +47,8 @@ void setup() {
4547
}
4648
}
4749

50+
4851
board.setAllPeripheralsPower(true); // TODO: Check if this is necessary
49-
5052
digitalWrite(LEDB, LOW); // Turn on the blue LED to show that the board is still awake
5153

5254
RTC.begin();

Diff for: examples/Standby_WakeFromRTC_H7/Standby_WakeFromRTC_H7.ino

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ void setup() {
5858
delay(5000); // keep the board awake for 5 seconds, so we can se it working
5959
board.shutDownFuelGauge();
6060

61+
6162
// The LED should go off when the board goes to sleep
6263
board.setAllPeripheralsPower(false);
6364

0 commit comments

Comments
 (0)