Commit 0c86a947 authored by Radomir Dopieralski's avatar Radomir Dopieralski Committed by Paul Sokolovsky
Browse files

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

parent 8db61e5b
...@@ -86,13 +86,15 @@ Methods ...@@ -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 ...@@ -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
.. method:: uart.sendbreak()
Send a break condition on the bus. This drives the bus low for a duration Send a break condition on the bus. This drives the bus low for a duration
of 13 bits. of 13 bits.
Return value: ``None``. Return value: ``None``.
.. only:: port_wipy .. only:: port_wipy
...@@ -158,14 +162,16 @@ Methods ...@@ -158,14 +162,16 @@ Methods
Returns an irq object. Returns an irq object.
Constants .. only:: not port_esp8266
---------
Constants
---------
.. data:: UART.EVEN .. data:: UART.EVEN
.. data:: UART.ODD .. 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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment