arduino/ArduinoLowPower
1
0
Fork 0
mirror of https://github.com/arduino-libraries/ArduinoLowPower.git synced 2025-04-19 11:42:14 +03:00
Code

Correct typos in comments and documentation

Browse Source
This commit is contained in:
per1234 2021-04-12 02:36:38 -07:00
parent 7b1e211b79
commit fbee85bfbc
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
examples/PrimoDeepSleep/PrimoDeepSleep.ino
View File

@ -4,16 +4,16 @@
Written by Chiara Ruggeri (chiara@arduino.org) Written by Chiara Ruggeri (chiara@arduino.org)
This example for the Arduino Primo board shows how to use This example for the Arduino Primo board shows how to use
low power library to enter in power off mode and save power. Arduino Low Power library to enter in power off mode and save power.
This mode ensure the deepest power saving mode. If you need This mode ensures the deepest power saving mode. If you need
a faster response from the board use standby function instead. a faster response from the board use standby function instead.
Please note that once exited from the deepest sleep mode the Please note that once exited from the deepest sleep mode the
board will reset (so setup will be run again). board will reset (so setup will be run again).
The functions enableWakeupFrom set the peripheral that will wake up The functions enableWakeupFrom set the peripheral that will wake up
the board. By calling it more than once you can choose more than the board. By calling it more than once you can choose multiple
a wakeup source. wakeup sources.
The board will be reset when it wakes up from power off. The board will be reset when it wakes up from power off.
You can use wakeUpCause() function to find out what signals woke up You can use wakeUpCause() function to find out what signals woke up
the board if you use more than one wakeUpBy.. function. the board if you use more than one wakeUpBy.. function.
@ -27,7 +27,7 @@
// Pin used to wakeup the board // Pin used to wakeup the board
const int digitalPin = 10; const int digitalPin = 10;
// Pin used in Compatarot module to wake up the board // Pin used in Comparator module to wake up the board
const int analogPin = A0; const int analogPin = A0;

6
examples/TianStandby/TianStandby.ino
View File

@ -1,12 +1,12 @@
/* /*
TianStandby TianStandby
This sketch demonstrates the usage of SAMD chip to furtherly reduce the power usage of Tian This sketch demonstrates the usage of SAMD chip to further reduce the power usage of the Tian
board. This method can be applied to any board with companion chips which expose a method board. This method can be applied to any board with companion chips which expose a method
(via direct pin interrupt or via a command) to enter and exit standby. (via direct pin interrupt or via a command) to enter and exit standby.
Sleep modes allow a significant drop in the power usage of a board while it does nothing waiting for an event to happen. Battery powered application can take advantage of these modes to enhance battery life significantly. Sleep modes allow a significant drop in the power usage of a board while it does nothing waiting for an event to happen. Battery powered applications can take advantage of these modes to enhance battery life significantly.
In this sketch, the internal RTC of SAMD chip will wake up the processor every 20 seconds. In this sketch, the internal RTC of the SAMD chip will wake up the processor every 20 seconds.
Before going to sleep, the SAMD chip tells the MIPS CPU to standby too. Before going to sleep, the SAMD chip tells the MIPS CPU to standby too.
Please note that, if the processor is sleeping, a new sketch can't be uploaded. To overcome this, manually reset the board (usually with a single or double tap to the RESET button) Please note that, if the processor is sleeping, a new sketch can't be uploaded. To overcome this, manually reset the board (usually with a single or double tap to the RESET button)

4
keywords.txt
View File

@ -1,5 +1,5 @@
####################################### #######################################
# Syntax Coloring Map For Energy Saving # Syntax Coloring Map For Arduino Low Power
####################################### #######################################
####################################### #######################################
@ -30,4 +30,4 @@ wakeupReason KEYWORD2
OTHER_WAKEUP LITERAL1 OTHER_WAKEUP LITERAL1
GPIO_WAKEUP LITERAL1 GPIO_WAKEUP LITERAL1
NFC_WAKEUP LITERAL1 NFC_WAKEUP LITERAL1
ANALOG_COMPARATOR_WAKEUP LITERAL1 ANALOG_COMPARATOR_WAKEUP LITERAL1

4
src/nrf52/ArduinoLowPower.cpp
View File

@ -64,7 +64,7 @@ void ArduinoLowPowerClass::deepSleep() {
//this is achieved by disabling all peripheral that use it //this is achieved by disabling all peripheral that use it
NRF_UARTE0->ENABLE = UARTE_ENABLE_ENABLE_Disabled; //disable UART NRF_UARTE0->ENABLE = UARTE_ENABLE_ENABLE_Disabled; //disable UART
NRF_SAADC ->ENABLE = (SAADC_ENABLE_ENABLE_Disabled << SAADC_ENABLE_ENABLE_Pos); //disable ADC NRF_SAADC ->ENABLE = (SAADC_ENABLE_ENABLE_Disabled << SAADC_ENABLE_ENABLE_Pos); //disable ADC
NRF_PWM0 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos); //disable all pwm instance NRF_PWM0 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos); //disable all PWM instances
NRF_PWM1 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos); NRF_PWM1 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos);
NRF_PWM2 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos); NRF_PWM2 ->ENABLE = (PWM_ENABLE_ENABLE_Disabled << PWM_ENABLE_ENABLE_Pos);
NRF_TWIM1 ->ENABLE = (TWIM_ENABLE_ENABLE_Disabled << TWIM_ENABLE_ENABLE_Pos); //disable TWI Master NRF_TWIM1 ->ENABLE = (TWIM_ENABLE_ENABLE_Disabled << TWIM_ENABLE_ENABLE_Pos); //disable TWI Master
@ -118,7 +118,7 @@ void ArduinoLowPowerClass::enableWakeupFrom(wakeup_reason peripheral, uint32_t p
nrf_lpcomp_config_t config={(nrf_lpcomp_ref_t)event, (nrf_lpcomp_detect_t)mode}; nrf_lpcomp_config_t config={(nrf_lpcomp_ref_t)event, (nrf_lpcomp_detect_t)mode};
nrf_lpcomp_configure(&config); nrf_lpcomp_configure(&config);
if(pin<14 && pin>19) if(pin<14 && pin>19)
return; //no analog pin is choosen return; //no analog pin was chosen
nrf_lpcomp_input_select(aPin[pin-14]); nrf_lpcomp_input_select(aPin[pin-14]);
nrf_lpcomp_enable(); nrf_lpcomp_enable();
nrf_lpcomp_task_trigger(NRF_LPCOMP_TASK_START); nrf_lpcomp_task_trigger(NRF_LPCOMP_TASK_START);