Skip to content

Formatting improvements in documentation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/Charger/Charger.ino
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
Cristian Dragomir ([email protected])
Sebastian Romero ([email protected])
*/

#include "Arduino_PowerManagement.h"

Charger charger;
Expand Down
31 changes: 17 additions & 14 deletions examples/Standby_WakeFromPin/Standby_WakeFromPin.ino
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
/*
Standby Wake From Pin Demo

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.
This sketch is universal and worksn on both Portenta C33 and H7.

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,
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.
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.

Check failure on line 8 in examples/Standby_WakeFromPin/Standby_WakeFromPin.ino

View workflow job for this annotation

GitHub Actions / spellcheck

trough ==> through

Check failure on line 8 in examples/Standby_WakeFromPin/Standby_WakeFromPin.ino

View workflow job for this annotation

GitHub Actions / spellcheck

trough ==> through

Requirements:
- Arduino Portenta C33, Arduino Portenta H7
- Arduino IDE / Arduino CLI
- PowerManagement library (installable from the Arduino Library Manager)
Usage:
- Connect a button to GOTO_SLEEP_PIN and with a pull-up resistor to 3.3V
- 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
(If you need information about how to wire the buttons check this link: https://docs.arduino.cc/built-in-examples/digital/Button/)
- Upload the provided sketch to the board
- Press the button connected to GOTO_SLEEP_PIN to put the board into standby mode
- Press the button connected to PORTENTA_C33_WAKEUP_PIN or GPIO0 to wake up the board from standby mode
- The LED will blink every second to show that the board is awake when not in standby mode

Initial author: Cristian Dragomir ([email protected])
- Arduino Portenta C33, Arduino Portenta H7
- Arduino IDE / Arduino CLI
- PowerManagement library (installable from the Arduino Library Manager)

Usage:
- Connect a button to GOTO_SLEEP_PIN and with a pull-up resistor to 3.3V
- 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
(If you need information about how to wire the buttons check this link: https://docs.arduino.cc/built-in-examples/digital/Button/)
- Upload the provided sketch to the board
- Press the button connected to GOTO_SLEEP_PIN to put the board into standby mode
- Press the button connected to PORTENTA_C33_WAKEUP_PIN or GPIO0 to wake up the board from standby mode
- The LED will blink every second to show that the board is awake when not in standby mode

Original author: C. Dragomir (http://arduino.cc)
*/

#include "Arduino.h"
Expand Down
6 changes: 4 additions & 2 deletions examples/Standby_WakeFromRTC_C33/Standby_WakeFromRTC_C33.ino
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
/*
Standby Wake from RTC Demo for Portenta C33

This example demonstrates how to wake up the Portenta C33 from standby mode using the included RTC (Real Time Clock).
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.
Effectively, you will get the same effect as with blink.
Effectivelly, you will get the same effect as with blink.

Check failure on line 6 in examples/Standby_WakeFromRTC_C33/Standby_WakeFromRTC_C33.ino

View workflow job for this annotation

GitHub Actions / spellcheck

Effectivelly ==> Effectively

Check failure on line 6 in examples/Standby_WakeFromRTC_C33/Standby_WakeFromRTC_C33.ino

View workflow job for this annotation

GitHub Actions / spellcheck

Effectivelly ==> Effectively

On the Portenta C33 with the peripherals turned off you can expect around 60uA of current consumption in standby mode.
The example also turns off the peripherals before going to sleep and turns them back on after waking up.

Usage:
- Make sure you are running the latest version of the Renesas Core
- Select the Portenta C33 board from the Tools menu
Expand Down Expand Up @@ -45,8 +47,8 @@
}
}


board.setAllPeripheralsPower(true); // TODO: Check if this is necessary

digitalWrite(LEDB, LOW); // Turn on the blue LED to show that the board is still awake

RTC.begin();
Expand Down
1 change: 1 addition & 0 deletions examples/Standby_WakeFromRTC_H7/Standby_WakeFromRTC_H7.ino
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ void setup() {
delay(5000); // keep the board awake for 5 seconds, so we can se it working
board.shutDownFuelGauge();


// The LED should go off when the board goes to sleep
board.setAllPeripheralsPower(false);

Expand Down
Loading