Skip to content

Commit 485319f

Browse files
authored
Update README.md
1 parent c494863 commit 485319f

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# 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)
37

48
## API
59

@@ -26,20 +30,25 @@ Arduino library to support Low Power
2630
**param** serial: pointer to a UART
2731
**param** callback: pointer to a callback to call when the board is waked up.
2832

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-
3433
* **`void enableWakeupFrom(STM32RTC *rtc, voidFuncPtr callback)`**
3534
attach a callback to the RTC peripheral.
3635
**param** rtc: pointer to RTC
3736
**param** callback: pointer to a callback to call when the board is waked up.
3837

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+
3944
`Begin()` function must be called at least once before `idle()`, `sleep()`, `deepSleep()` or `shutdown()` functions.
4045

4146
`attachInterruptWakeup()` or `enableWakeupFrom()` functions should be called before `idle()`, `sleep()`, `deepSleep()` or `shutdown()` functions.
4247

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+
4352
The board will restart when exit the deepSleep or shutdown mode.
4453

4554
## Hardware state

0 commit comments

Comments
 (0)