diff options
| author | Damien George <damien.p.george@gmail.com> | 2015-04-21 22:35:17 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2015-04-21 22:35:17 +0100 |
| commit | dea853d3a334ce5def51e803112d66b5dc8ecc3f (patch) | |
| tree | 4055bd2d451b004d32944cc48a406dc41d6be1c1 /docs/library/pyb.RTC.rst | |
| parent | 4735c45c511bf29ecb422456ca2ab0437e3c4ef0 (diff) | |
docs: Document pyb.stop, pyb.standby and pyb.RTC.wakeup.
Diffstat (limited to 'docs/library/pyb.RTC.rst')
| -rw-r--r-- | docs/library/pyb.RTC.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst index 2f9114ac2..eeefa100c 100644 --- a/docs/library/pyb.RTC.rst +++ b/docs/library/pyb.RTC.rst @@ -38,6 +38,17 @@ Methods ``subseconds`` counts down from 255 to 0 +.. method:: rtc.wakeup(timeout, callback=None) + + Set the RTC wakeup timer to trigger repeatedly at every ``timeout`` + milliseconds. This trigger can wake the pyboard from both the sleep + states: :meth:`pyb.stop` and :meth:`pyb.standby`. + + If ``timeout`` is ``None`` then the wakeup timer is disabled. + + If ``callback`` is given then it is executed at every trigger of the + wakeup timer. ``callback`` must take exactly one argument. + .. method:: rtc.info() Get information about the startup time and reset source. |