micropython/docs/library
Damien George b16146d189 docs/machine: Change sleep to lightsleep and add timeout arguments.
The machine.sleep() function can be misleading because it clashes with
time.sleep() which has quite different semantics.  So change it to
machine.lightsleep() which shows that it is closer in behaviour to
machine.deepsleep().

Also, add an optional argument to these two sleep functions to specify a
maximum time to sleep for.  This is a common operation and underlying
hardware usually has a special way of performing this operation.

The existing machine.sleep() function will remain for backwards
compatibility purposes, and it can simply be an alias for
machine.lightsleep() without arguments.  The behaviour will be the same.
2019-01-27 11:12:16 +11:00
..
_thread.rst
array.rst
btree.rst
builtins.rst
cmath.rst
esp.rst docs: Add initial docs for esp32 port, including quick-ref and general. 2019-01-25 12:18:34 +11:00
esp32.rst docs/library: Add documentation for esp32 module. 2019-01-25 12:18:34 +11:00
framebuf.rst
gc.rst
index.rst docs/library: Add documentation for esp32 module. 2019-01-25 12:18:34 +11:00
lcd160cr.rst
machine.ADC.rst
machine.I2C.rst
machine.Pin.rst docs/machine.Pin: Document "hard" argument of Pin.irq method. 2018-10-15 00:17:54 +11:00
machine.RTC.rst
machine.SD.rst
machine.SPI.rst
machine.Signal.rst
machine.Timer.rst
machine.TimerWiPy.rst
machine.UART.rst
machine.WDT.rst
machine.rst docs/machine: Change sleep to lightsleep and add timeout arguments. 2019-01-27 11:12:16 +11:00
math.rst
micropython.rst lib/utils/pyexec: Forcefully unlock the heap if locked and REPL active. 2018-10-13 16:21:08 +11:00
network.CC3K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WIZNET5K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLAN.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLANWiPy.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.rst docs/library/network: Make AbstractNIC methods layout correctly. 2018-09-27 17:24:41 +10:00
pyb.ADC.rst
pyb.Accel.rst
pyb.CAN.rst
pyb.DAC.rst
pyb.ExtInt.rst
pyb.I2C.rst
pyb.LCD.rst
pyb.LED.rst
pyb.Pin.rst docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu. 2018-10-19 17:31:59 +11:00
pyb.RTC.rst
pyb.SPI.rst
pyb.Servo.rst
pyb.Switch.rst
pyb.Timer.rst
pyb.UART.rst
pyb.USB_HID.rst
pyb.USB_VCP.rst
pyb.rst
sys.rst
ubinascii.rst
ucollections.rst
ucryptolib.rst
uctypes.rst docs/library/uctypes: Add examples and make general updates. 2018-10-23 11:42:30 +11:00
uerrno.rst
uhashlib.rst
uheapq.rst
uio.rst docs/uio: Document StringIO/BytesIO(alloc_size) constructors. 2018-10-18 12:39:25 +11:00
ujson.rst
uos.rst
ure.rst docs/ure: Fully describe supported syntax subset, add example. 2018-12-13 01:16:30 +11:00
uselect.rst docs/uselect: Describe more aspects of poll.register/modify behavior. 2018-10-05 16:57:58 +10:00
usocket.rst
ussl.rst
ustruct.rst
utime.rst
uzlib.rst
wipy.rst