diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-05-03 12:48:20 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-05-03 12:48:20 +0300 |
| commit | bb6458bf43c6e724643aa7854af7c17ea8beb787 (patch) | |
| tree | c8e250fb448e16b1276c1b86fdf9514ab1043aa0 /docs/library/machine.rst | |
| parent | db99ae00a2a37fbe3ec92f306e43c5c1e3fe18b0 (diff) | |
| download | micropython-bb6458bf43c6e724643aa7854af7c17ea8beb787.tar.gz micropython-bb6458bf43c6e724643aa7854af7c17ea8beb787.zip | |
docs/machine: More generic description of sleep's, WiPy details to its genref.
Diffstat (limited to 'docs/library/machine.rst')
| -rw-r--r-- | docs/library/machine.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst index f9dca29875..ce5edf4938 100644 --- a/docs/library/machine.rst +++ b/docs/library/machine.rst @@ -63,13 +63,15 @@ Power related functions .. function:: sleep() Stops the CPU and disables all peripherals except for WLAN. Execution is resumed from - the point where the sleep was requested. Wake sources are ``Pin``, ``RTC`` and ``WLAN``. + the point where the sleep was requested. For wake up to actually happen, wake sources + should be configured first. .. function:: deepsleep() - Stops the CPU and all peripherals including WLAN. Execution is resumed from main, just - as with a reset. The reset cause can be checked to know that we are coming from - ``machine.DEEPSLEEP``. Wake sources are ``Pin`` and ``RTC``. + Stops the CPU and all peripherals (including networking interfaces, if any). Execution + is resumed from the main script, just as with a reset. The reset cause can be checked + to know that we are coming from ``machine.DEEPSLEEP``. For wake up to actually happen, + wake sources should be configured first, like ``Pin`` change or ``RTC`` timeout. .. only:: port_wipy |