1
1
# STM32LowPower
2
- Arduino library to support Low Power
2
+ Arduino library to support STM32 Low Power.
3
+
4
+ ## Requirement
5
+ * [ Arduino_Core_STM32] ( https://github.com/stm32duino/Arduino_Core_STM32 ) version >= 1.3.0
6
+ * [ STM32RTC] ( https://github.com/stm32duino/STM32RTC )
3
7
4
8
## API
5
9
@@ -26,20 +30,25 @@ Arduino library to support Low Power
26
30
** param** serial: pointer to a UART
27
31
** param** callback: pointer to a callback to call when the board is waked up.
28
32
29
- * ** ` void enableWakeupFrom(TwoWire *wire, voidFuncPtrVoid callback) ` ** :
30
- enable an I2C peripheral in low power mode. See board documentation for low power mode compatibility.
31
- ** param** wire: pointer to I2C
32
- ** param** callback: pointer to a callback to call when the board is waked up.
33
-
34
33
* ** ` void enableWakeupFrom(STM32RTC *rtc, voidFuncPtr callback) ` **
35
34
attach a callback to the RTC peripheral.
36
35
** param** rtc: pointer to RTC
37
36
** param** callback: pointer to a callback to call when the board is waked up.
38
37
38
+ * ** ` void enableWakeupFrom(TwoWire *wire, voidFuncPtrVoid callback) ` ** :
39
+ enable an I2C peripheral in low power mode. See board documentation for low power mode compatibility. ** Currently not available.**
40
+ ** param** wire: pointer to I2C
41
+ ** param** callback: pointer to a callback to call when the board is waked up.
42
+
43
+
39
44
` Begin() ` function must be called at least once before ` idle() ` , ` sleep() ` , ` deepSleep() ` or ` shutdown() ` functions.
40
45
41
46
` attachInterruptWakeup() ` or ` enableWakeupFrom() ` functions should be called before ` idle() ` , ` sleep() ` , ` deepSleep() ` or ` shutdown() ` functions.
42
47
48
+ HardwareSerial used as Wakeup source will configure it to use HSI clock source even if another peripheral clock is configured.
49
+
50
+ RTC used as Wakeup source will configure it to use LSE clock source even if another RTC clock source is selected.
51
+
43
52
The board will restart when exit the deepSleep or shutdown mode.
44
53
45
54
## Hardware state
0 commit comments