diff options
Diffstat (limited to 'docs/library/machine.UART.rst')
| -rw-r--r-- | docs/library/machine.UART.rst | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst index 98e24f37dd..7399b9b6e9 100644 --- a/docs/library/machine.UART.rst +++ b/docs/library/machine.UART.rst @@ -86,13 +86,15 @@ Methods When no pins are given, then the default set of TX and RX pins is taken, and hardware flow control will be disabled. If pins=None, no pin assignment will be made. -.. method:: uart.deinit() +.. only:: not port_esp8266 - Turn off the UART bus. + .. method:: uart.deinit() -.. method:: uart.any() + Turn off the UART bus. - Return the number of characters available for reading. + .. method:: uart.any() + + Return the number of characters available for reading. .. method:: uart.read([nbytes]) @@ -127,11 +129,13 @@ Methods Return value: number of bytes written or ``None`` on timeout. -.. method:: uart.sendbreak() +.. only:: not port_esp8266 + + .. method:: uart.sendbreak() - Send a break condition on the bus. This drives the bus low for a duration - of 13 bits. - Return value: ``None``. + Send a break condition on the bus. This drives the bus low for a duration + of 13 bits. + Return value: ``None``. .. only:: port_wipy @@ -158,14 +162,16 @@ Methods Returns an irq object. -Constants ---------- +.. only:: not port_esp8266 + + Constants + --------- -.. data:: UART.EVEN -.. data:: UART.ODD + .. data:: UART.EVEN + .. data:: UART.ODD - parity types (anlong with ``None``) + parity types (anlong with ``None``) -.. data:: UART.RX_ANY + .. data:: UART.RX_ANY - IRQ trigger sources + IRQ trigger sources |