diff options
| author | Damien George <damien.p.george@gmail.com> | 2019-01-30 14:15:51 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-01-30 14:15:51 +1100 |
| commit | 4dfcc255d5ebe8625b87e5b923db9e22166bb9b4 (patch) | |
| tree | d9361faed0e34995567a9ef2571f908f7d145359 | |
| parent | d5d060ead9a7c7c97c9f2492be5450139b7e006c (diff) | |
docs: Convert all cases of machine.sleep to machine.lightsleep.
| -rw-r--r-- | docs/esp32/quickref.rst | 2 | ||||
| -rw-r--r-- | docs/wipy/general.rst | 2 | ||||
| -rw-r--r-- | docs/wipy/quickref.rst | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/esp32/quickref.rst b/docs/esp32/quickref.rst index 81b2a53b3..426d14e3e 100644 --- a/docs/esp32/quickref.rst +++ b/docs/esp32/quickref.rst @@ -421,7 +421,7 @@ Note that TouchPads can be used to wake an ESP32 from sleep:: t = TouchPad(Pin(14)) t.config(500) # configure the threshold at which the pin is considered touched esp32.wake_on_touch(True) - machine.sleep() # put the MCU to sleep until a touchpad is touched + machine.lightsleep() # put the MCU to sleep until a touchpad is touched For more details on touchpads refer to `Espressif Touch Sensor <https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/touch_pad.html>`_. diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index 4dfab9c05..b1109c495 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -178,7 +178,7 @@ Details on sleep modes * ``machine.idle()``: Power consumption: ~12mA (in WLAN STA mode). Wake sources: any hardware interrupt (including systick with period of 1ms), no special configuration required. -* ``machine.sleep()``: 950uA (in WLAN STA mode). Wake sources are ``Pin``, ``RTC`` +* ``machine.lightsleep()``: 950uA (in WLAN STA mode). Wake sources are ``Pin``, ``RTC`` and ``WLAN`` * ``machine.deepsleep()``: ~350uA. Wake sources are ``Pin`` and ``RTC``. diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst index 1f34bdaa9..7aa832fd2 100644 --- a/docs/wipy/quickref.rst +++ b/docs/wipy/quickref.rst @@ -28,7 +28,7 @@ See the :mod:`machine` module:: machine.unique_id() # return the 6-byte unique id of the board (the WiPy's MAC address) machine.idle() # average current decreases to (~12mA), any interrupts wake it up - machine.sleep() # everything except for WLAN is powered down (~950uA avg. current) + machine.lightsleep() # everything except for WLAN is powered down (~950uA avg. current) # wakes from Pin, RTC or WLAN machine.deepsleep() # deepest sleep mode, MCU starts from reset. Wakes from Pin and RTC. @@ -163,7 +163,7 @@ See :ref:`machine.RTC <machine.RTC>` :: rtc_i = rtc.irq(trigger=RTC.ALARM0, handler=alarm_handler, wake=machine.SLEEP) # go into suspended mode waiting for the RTC alarm to expire and wake us up - machine.sleep() + machine.lightsleep() SD card ------- @@ -199,7 +199,7 @@ See :ref:`network.WLAN <network.WLAN>` and :mod:`machine`. :: # enable wake on WLAN wlan.irq(trigger=WLAN.ANY_EVENT, wake=machine.SLEEP) # go to sleep - machine.sleep() + machine.lightsleep() # now, connect to the FTP or the Telnet server and the WiPy will wake-up Telnet and FTP server |