mirrors/micropython
1
0
Fork 0
mirror of https://github.com/licsber/micropython.git synced 2024-09-20 09:00:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.

Browse Source
This commit is contained in:
Radomir Dopieralski 2016-05-07 15:46:30 +02:00 committed by Paul Sokolovsky
parent 8db61e5b5a
commit 0c86a9471a
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -86,13 +86,15 @@ Methods
When no pins are given, then the default set of TX and RX pins is taken, and hardware 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. 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]) .. method:: uart.read([nbytes])
@ -127,11 +129,13 @@ Methods
Return value: number of bytes written or ``None`` on timeout. Return value: number of bytes written or ``None`` on timeout.
.. method:: uart.sendbreak() .. only:: not port_esp8266
Send a break condition on the bus. This drives the bus low for a duration .. method:: uart.sendbreak()
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 .. only:: port_wipy
@ -158,14 +162,16 @@ Methods
Returns an irq object. Returns an irq object.
Constants .. only:: not port_esp8266
---------
.. data:: UART.EVEN Constants
.. data:: UART.ODD ---------
parity types (anlong with ``None``) .. data:: UART.EVEN
.. data:: UART.ODD
.. data:: UART.RX_ANY parity types (anlong with ``None``)
IRQ trigger sources .. data:: UART.RX_ANY
IRQ trigger sources