coldcard/micropython
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
a3675294ae
micropython/docs/library
History
Will Sowerbutts a3675294ae esp32/machine_uart: Add flow kw-arg to enable hardware flow control. 
This enables optional support for the hardware UART to use the RTS and/or
CTS pins for flow control.

The new "flow" constructor keyword specifies a bitmask of RTS and/or CTS.
This matches the interface used by machine.UART on stm32 and rp2.

Previously on ESP32 it was possible to specify which pins to use for the
RTS and CTS signals, but hardware flow control was never functional: CTS
was not checked before transmitting bytes, and RTS was always driven high
(signalling no buffer space available).  With this patch, CTS and RTS both
operate as expected.

This also includes an update to the machine.UART documentation.

Signed-off-by: Will Sowerbutts <will@sowerbutts.com>
2021-08-04 13:52:15 +10:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
btree.rst docs/library/btree.rst: Correct method typo: __detitem__ to __delitem__. 2020-10-20 17:13:02 +11:00
builtins.rst py/objexcept: Support errno attribute on OSError exceptions. 2021-04-23 22:03:46 +10:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
esp32.rst docs/library: Document new esp32.RMT features and fix wait_done. 2021-07-01 14:44:41 +10:00
esp.rst docs/library: Clarify that the arg to esp.deepsleep is in microseconds. 2020-06-30 22:01:44 +10:00
framebuf.rst docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB. 2020-02-10 23:04:15 +11:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
index.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
lcd160cr.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
machine.ADC.rst docs/library: Specify new machine.ADC class. 2019-09-04 15:35:09 +10:00
machine.ADCWiPy.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
machine.I2C.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
machine.I2S.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
machine.Pin.rst docs/library/machine.Pin.rst: Make it clear which methods are not core. 2021-02-03 00:54:18 +11:00
machine.PWM.rst docs/library/machine: Specify initial machine.PWM class. 2021-04-30 16:42:51 +10:00
machine.rst esp32,stm32: Add new machine.I2S class for I2S protocol support. 2021-07-05 23:42:25 +10:00
machine.RTC.rst docs/library/machine.RTC.rst: Document datetime method and fix ex code. 2021-06-12 22:53:49 +10:00
machine.SD.rst docs/machine: Add initial docs for new machine.SDCard class. 2019-06-03 00:42:24 +10:00
machine.SDCard.rst esp32/machine_sdcard: Add "freq" keyword arg to SDCard constructor. 2020-05-28 12:19:04 +10:00
machine.Signal.rst docs/library/machine.Signal.rst: Correct typo: usecases to use cases. 2020-10-20 17:21:30 +11:00
machine.SPI.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
machine.Timer.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
machine.TimerWiPy.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
machine.UART.rst esp32/machine_uart: Add flow kw-arg to enable hardware flow control. 2021-08-04 13:52:15 +10:00
machine.WDT.rst docs/library: Fix docs for machine.WDT to specify millisecond timeout. 2020-05-02 22:55:48 +10:00
math.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
micropython.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
network.CC3K.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
network.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
network.WIZNET5K.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
network.WLAN.rst docs/esp32: Document WLAN "reconnects" config option. 2021-06-17 18:48:17 +10:00
network.WLANWiPy.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
pyb.DAC.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ExtInt.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Flash.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
pyb.I2C.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
pyb.LCD.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.LED.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Pin.rst docs/library/pyb.Pin.rst: Update the arguments for Pin.init(). 2021-05-20 23:08:43 +10:00
pyb.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
pyb.RTC.rst docs,stm32: Fix minor typos in RTC docs, and->an. 2021-01-30 14:13:30 +11:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.SPI.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
pyb.Switch.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
pyb.Timer.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
pyb.UART.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
pyb.USB_HID.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_VCP.rst stm32/usb: Make irq's default trigger enable all events. 2021-06-23 16:11:37 +10:00
rp2.Flash.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
rp2.PIO.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
rp2.rst docs/library/rp2.rst: Fix typo overriden->overridden. 2021-05-12 00:05:55 +10:00
rp2.StateMachine.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
uarray.rst docs/library: Rename "array" module to "uarray". 2019-10-22 16:40:58 +11:00
uasyncio.rst docs/library/uasyncio.rst: Document stream readexactly() method. 2021-07-22 22:39:04 +10:00
ubinascii.rst extmod/modubinascii: Update code, docs for hexlify now CPython has sep. 2020-12-14 14:35:29 +11:00
ubluetooth.rst docs/library/ubluetooth.rst: Add passkey docs. 2020-12-02 14:44:36 +11:00
ucollections.rst docs/library: Add documentation for ucollections.deque. 2018-06-26 14:29:22 +10:00
ucryptolib.rst extmod/moducryptolib: Add AES-CTR support. 2019-05-06 18:09:48 +10:00
uctypes.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
uerrno.rst py/objexcept: Support errno attribute on OSError exceptions. 2021-04-23 22:03:46 +10:00
uhashlib.rst docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
uheapq.rst docs/library: Clarify what type of algorithm is implemented in heapq. 2021-05-18 12:24:21 +10:00
uio.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
ujson.rst docs/library/ujson: Document dump() and load() functions. 2018-02-15 11:37:48 +11:00
uos.rst extmod/vfs_lfs: Add mtime support to littlefs files. 2020-08-25 17:35:19 +10:00
ure.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
uselect.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
usocket.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
ussl.rst docs/library: Add a blank line to fix formatting for ussl docs. 2021-05-18 12:27:57 +10:00
ustruct.rst docs/library: Warn that ustruct doesn't handle spaces in format strings. 2021-07-06 14:59:50 +10:00
usys.rst all: Rename "sys" module to "usys". 2020-09-04 00:10:24 +10:00
utime.rst docs/library/utime.rst: Clarify behaviour and precision of sleep ms/us. 2021-07-22 00:07:37 +10:00
uzlib.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00