diff options
author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-04-16 09:54:55 +0300 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-04-16 09:54:55 +0300 |
commit | a8ece0358fd5821dd0e9f215f8d852a62de834c0 (patch) | |
tree | 1208564610abb08d2a4416064a43d2cac7201564 /docs/library | |
parent | ac8843ceecb645b11737ea42d0f4248d742383cd (diff) | |
download | micropython-a8ece0358fd5821dd0e9f215f8d852a62de834c0.tar.gz micropython-a8ece0358fd5821dd0e9f215f8d852a62de834c0.zip |
docs/machine.UART: Deconditionalize normal methods.
Diffstat (limited to 'docs/library')
-rw-r--r-- | docs/library/machine.UART.rst | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst index fe7597eb59..55a5f354d2 100644 --- a/docs/library/machine.UART.rst +++ b/docs/library/machine.UART.rst @@ -69,15 +69,14 @@ 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. -.. only:: not port_esp8266 +.. method:: UART.deinit() - .. method:: UART.deinit() + Turn off the UART bus. - Turn off the UART bus. +.. method:: UART.any() - .. method:: UART.any() - - Return the number of characters available for reading. + Return true value if there're characters available for reading. On some + boards, the number of available characters is returned. .. method:: UART.read([nbytes]) @@ -107,13 +106,10 @@ Methods Return value: number of bytes written or ``None`` on timeout. -.. only:: not port_esp8266 - - .. method:: UART.sendbreak() +.. 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 + longer than required for a normal transmission of a character. .. only:: port_wipy @@ -140,8 +136,6 @@ Methods Returns an irq object. -.. only:: not port_esp8266 - Constants --------- |