djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/machine.UART: Deconditionalize normal methods.

Browse Source
This commit is contained in:
Paul Sokolovsky 2017-04-16 09:54:55 +03:00
parent ac8843ceec
commit a8ece0358f
1 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/library/machine.UART.rst
View File

@ -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
---------