Skip to content

Commit a8ece03

Browse files
committed
docs/machine.UART: Deconditionalize normal methods.
1 parent ac8843c commit a8ece03

1 file changed

Lines changed: 8 additions & 14 deletions

File tree

docs/library/machine.UART.rst

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,14 @@ Methods
6969
When no pins are given, then the default set of TX and RX pins is taken, and hardware
7070
flow control will be disabled. If pins=None, no pin assignment will be made.
7171

72-
.. only:: not port_esp8266
72+
.. method:: UART.deinit()
7373

74-
.. method:: UART.deinit()
74+
Turn off the UART bus.
7575

76-
Turn off the UART bus.
76+
.. method:: UART.any()
7777

78-
.. method:: UART.any()
79-
80-
Return the number of characters available for reading.
78+
Return true value if there're characters available for reading. On some
79+
boards, the number of available characters is returned.
8180

8281
.. method:: UART.read([nbytes])
8382

@@ -107,13 +106,10 @@ Methods
107106

108107
Return value: number of bytes written or ``None`` on timeout.
109108

110-
.. only:: not port_esp8266
111-
112-
.. method:: UART.sendbreak()
109+
.. method:: UART.sendbreak()
113110

114-
Send a break condition on the bus. This drives the bus low for a duration
115-
of 13 bits.
116-
Return value: ``None``.
111+
Send a break condition on the bus. This drives the bus low for a duration
112+
longer than required for a normal transmission of a character.
117113

118114
.. only:: port_wipy
119115

@@ -140,8 +136,6 @@ Methods
140136

141137
Returns an irq object.
142138

143-
.. only:: not port_esp8266
144-
145139
Constants
146140
---------
147141

0 commit comments

Comments
 (0)