djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/machine: More generic description of sleep's, WiPy details to its genref.

Browse Source
This commit is contained in:
Paul Sokolovsky 2016-05-03 12:48:20 +03:00
parent db99ae00a2
commit bb6458bf43
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/library/machine.rst
View File

@ -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

12
docs/wipy/general.rst
View File

@ -170,9 +170,11 @@ There are currently 2 kinds of errors that you might see:
2. If the heartbeat LED stays on, then there was a hard fault, you cannot
recover from this, the only way out is to press the reset switch.
Power consumption in various sleep modes
----------------------------------------
Details on sleep modes
----------------------
* ``machine.idle()`` - ~12mA (in WLAN STA mode)
* ``machine.sleep()`` - 950uA (in WLAN STA mode)
* ``machine.deepsleep()`` - ~5uA
* ``machine.idle()``: Power consumption: ~12mA (in WLAN STA mode). Wake sources:
any hardware interrupt, no special configuration required.
* ``machine.sleep()``: 950uA (in WLAN STA mode). Wake sources are ``Pin``, ``RTC``
and ``WLAN``
* ``machine.deepsleep()``: ~5uA. Wake sources are ``Pin`` and ``RTC``.