summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.UART.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2018-07-18 15:47:44 +1000
committerDamien George <damien.p.george@gmail.com>2018-07-18 15:47:44 +1000
commit805fd0cfe6880153b990acc19f547e740b87f23d (patch)
treee0c567712a6a9cdf08acf5e180c1a35835b1d223 /docs/library/pyb.UART.rst
parent419eb8607415c3a0e47ebef231c7e57118924eee (diff)
downloadmicropython-805fd0cfe6880153b990acc19f547e740b87f23d.tar.gz
micropython-805fd0cfe6880153b990acc19f547e740b87f23d.zip
docs/library: Remove "only" directive from all pyb module docs.
By virtue of its name, the pyb module would only be available on a pyboard and so does not need to have conditional "only" directives throughout its documentation. These conditionals were added mostly in cfcf47c0644952358e1a260db159e807872a37e6 in the initial development of the cc3200 port, which had the pyb module before it switched to the machine module. And wipy only conditionals were removed from the pyb module documentation in 4542643025c77a7272bde348b89d5039aea28d23, so there's no need to retain any more conditionals.
Diffstat (limited to 'docs/library/pyb.UART.rst')
-rw-r--r--docs/library/pyb.UART.rst258
1 files changed, 119 insertions, 139 deletions
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst
index c299c838e7..4359f1d9d6 100644
--- a/docs/library/pyb.UART.rst
+++ b/docs/library/pyb.UART.rst
@@ -16,12 +16,10 @@ UART objects can be created and initialised using::
uart = UART(1, 9600) # init with given baudrate
uart.init(9600, bits=8, parity=None, stop=1) # init with given parameters
-.. only:: port_pyboard
+Bits can be 7, 8 or 9. Parity can be None, 0 (even) or 1 (odd). Stop can be 1 or 2.
- Bits can be 7, 8 or 9. Parity can be None, 0 (even) or 1 (odd). Stop can be 1 or 2.
-
- *Note:* with parity=None, only 8 and 9 bits are supported. With parity enabled,
- only 7 and 8 bits are supported.
+*Note:* with parity=None, only 8 and 9 bits are supported. With parity enabled,
+only 7 and 8 bits are supported.
A UART object acts like a `stream` object and reading and writing is done
using the standard stream methods::
@@ -32,84 +30,76 @@ using the standard stream methods::
uart.readinto(buf) # read and store into the given buffer
uart.write('abc') # write the 3 characters
-.. only:: port_pyboard
+Individual characters can be read/written using::
- Individual characters can be read/written using::
+ uart.readchar() # read 1 character and returns it as an integer
+ uart.writechar(42) # write 1 character
- uart.readchar() # read 1 character and returns it as an integer
- uart.writechar(42) # write 1 character
+To check if there is anything to be read, use::
- To check if there is anything to be read, use::
+ uart.any() # returns the number of characters waiting
- uart.any() # returns the number of characters waiting
-
- *Note:* The stream functions ``read``, ``write``, etc. are new in MicroPython v1.3.4.
- Earlier versions use ``uart.send`` and ``uart.recv``.
+*Note:* The stream functions ``read``, ``write``, etc. are new in MicroPython v1.3.4.
+Earlier versions use ``uart.send`` and ``uart.recv``.
Constructors
------------
-.. only:: port_pyboard
+.. class:: pyb.UART(bus, ...)
+
+ Construct a UART object on the given bus. ``bus`` can be 1-6, or 'XA', 'XB', 'YA', or 'YB'.
+ With no additional parameters, the UART object is created but not
+ initialised (it has the settings from the last initialisation of
+ the bus, if any). If extra arguments are given, the bus is initialised.
+ See ``init`` for parameters of initialisation.
- .. class:: pyb.UART(bus, ...)
-
- Construct a UART object on the given bus. ``bus`` can be 1-6, or 'XA', 'XB', 'YA', or 'YB'.
- With no additional parameters, the UART object is created but not
- initialised (it has the settings from the last initialisation of
- the bus, if any). If extra arguments are given, the bus is initialised.
- See ``init`` for parameters of initialisation.
+ The physical pins of the UART busses are:
- The physical pins of the UART busses are:
-
- - ``UART(4)`` is on ``XA``: ``(TX, RX) = (X1, X2) = (PA0, PA1)``
- - ``UART(1)`` is on ``XB``: ``(TX, RX) = (X9, X10) = (PB6, PB7)``
- - ``UART(6)`` is on ``YA``: ``(TX, RX) = (Y1, Y2) = (PC6, PC7)``
- - ``UART(3)`` is on ``YB``: ``(TX, RX) = (Y9, Y10) = (PB10, PB11)``
- - ``UART(2)`` is on: ``(TX, RX) = (X3, X4) = (PA2, PA3)``
+ - ``UART(4)`` is on ``XA``: ``(TX, RX) = (X1, X2) = (PA0, PA1)``
+ - ``UART(1)`` is on ``XB``: ``(TX, RX) = (X9, X10) = (PB6, PB7)``
+ - ``UART(6)`` is on ``YA``: ``(TX, RX) = (Y1, Y2) = (PC6, PC7)``
+ - ``UART(3)`` is on ``YB``: ``(TX, RX) = (Y9, Y10) = (PB10, PB11)``
+ - ``UART(2)`` is on: ``(TX, RX) = (X3, X4) = (PA2, PA3)``
- The Pyboard Lite supports UART(1), UART(2) and UART(6) only. Pins are as above except:
+ The Pyboard Lite supports UART(1), UART(2) and UART(6) only. Pins are as above except:
- - ``UART(2)`` is on: ``(TX, RX) = (X1, X2) = (PA2, PA3)``
+ - ``UART(2)`` is on: ``(TX, RX) = (X1, X2) = (PA2, PA3)``
Methods
-------
-.. only:: port_pyboard
-
- .. method:: UART.init(baudrate, bits=8, parity=None, stop=1, \*, timeout=1000, flow=0, timeout_char=0, read_buf_len=64)
-
- Initialise the UART bus with the given parameters:
-
- - ``baudrate`` is the clock rate.
- - ``bits`` is the number of bits per character, 7, 8 or 9.
- - ``parity`` is the parity, ``None``, 0 (even) or 1 (odd).
- - ``stop`` is the number of stop bits, 1 or 2.
- - ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS``
- or ``UART.RTS | UART.CTS``.
- - ``timeout`` is the timeout in milliseconds to wait for writing/reading the first character.
- - ``timeout_char`` is the timeout in milliseconds to wait between characters while writing or reading.
- - ``read_buf_len`` is the character length of the read buffer (0 to disable).
-
- This method will raise an exception if the baudrate could not be set within
- 5% of the desired value. The minimum baudrate is dictated by the frequency
- of the bus that the UART is on; UART(1) and UART(6) are APB2, the rest are on
- APB1. The default bus frequencies give a minimum baudrate of 1300 for
- UART(1) and UART(6) and 650 for the others. Use :func:`pyb.freq <pyb.freq>`
- to reduce the bus frequencies to get lower baudrates.
-
- *Note:* with parity=None, only 8 and 9 bits are supported. With parity enabled,
- only 7 and 8 bits are supported.
+.. method:: UART.init(baudrate, bits=8, parity=None, stop=1, \*, timeout=1000, flow=0, timeout_char=0, read_buf_len=64)
+
+ Initialise the UART bus with the given parameters:
+
+ - ``baudrate`` is the clock rate.
+ - ``bits`` is the number of bits per character, 7, 8 or 9.
+ - ``parity`` is the parity, ``None``, 0 (even) or 1 (odd).
+ - ``stop`` is the number of stop bits, 1 or 2.
+ - ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS``
+ or ``UART.RTS | UART.CTS``.
+ - ``timeout`` is the timeout in milliseconds to wait for writing/reading the first character.
+ - ``timeout_char`` is the timeout in milliseconds to wait between characters while writing or reading.
+ - ``read_buf_len`` is the character length of the read buffer (0 to disable).
+
+ This method will raise an exception if the baudrate could not be set within
+ 5% of the desired value. The minimum baudrate is dictated by the frequency
+ of the bus that the UART is on; UART(1) and UART(6) are APB2, the rest are on
+ APB1. The default bus frequencies give a minimum baudrate of 1300 for
+ UART(1) and UART(6) and 650 for the others. Use :func:`pyb.freq <pyb.freq>`
+ to reduce the bus frequencies to get lower baudrates.
+
+ *Note:* with parity=None, only 8 and 9 bits are supported. With parity enabled,
+ only 7 and 8 bits are supported.
.. method:: UART.deinit()
Turn off the UART bus.
-.. only:: port_pyboard
-
- .. method:: UART.any()
+.. method:: UART.any()
- Returns the number of bytes waiting (may be 0).
+ Returns the number of bytes waiting (may be 0).
.. method:: UART.read([nbytes])
@@ -120,13 +110,11 @@ Methods
If ``nbytes`` is not given then the method reads as much data as possible. It
returns after the timeout has elapsed.
- .. only:: port_pyboard
+ *Note:* for 9 bit characters each character takes two bytes, ``nbytes`` must
+ be even, and the number of characters is ``nbytes/2``.
- *Note:* for 9 bit characters each character takes two bytes, ``nbytes`` must
- be even, and the number of characters is ``nbytes/2``.
-
- Return value: a bytes object containing the bytes read in. Returns ``None``
- on timeout.
+ Return value: a bytes object containing the bytes read in. Returns ``None``
+ on timeout.
.. method:: UART.readchar()
@@ -152,22 +140,18 @@ Methods
.. method:: UART.write(buf)
- .. only:: port_pyboard
-
- Write the buffer of bytes to the bus. If characters are 7 or 8 bits wide
- then each byte is one character. If characters are 9 bits wide then two
- bytes are used for each character (little endian), and ``buf`` must contain
- an even number of bytes.
-
- Return value: number of bytes written. If a timeout occurs and no bytes
- were written returns ``None``.
+ Write the buffer of bytes to the bus. If characters are 7 or 8 bits wide
+ then each byte is one character. If characters are 9 bits wide then two
+ bytes are used for each character (little endian), and ``buf`` must contain
+ an even number of bytes.
-.. only:: port_pyboard
+ Return value: number of bytes written. If a timeout occurs and no bytes
+ were written returns ``None``.
- .. method:: UART.writechar(char)
+.. method:: UART.writechar(char)
- Write a single character on the bus. ``char`` is an integer to write.
- Return value: ``None``. See note below if CTS flow control is used.
+ Write a single character on the bus. ``char`` is an integer to write.
+ Return value: ``None``. See note below if CTS flow control is used.
.. method:: UART.sendbreak()
@@ -178,68 +162,64 @@ Methods
Constants
---------
-.. only:: port_pyboard
+.. data:: UART.RTS
+ UART.CTS
- .. data:: UART.RTS
- .. data:: UART.CTS
-
- to select the flow control type.
+ to select the flow control type.
Flow Control
------------
-.. only:: port_pyboard
-
- On Pyboards V1 and V1.1 ``UART(2)`` and ``UART(3)`` support RTS/CTS hardware flow control
- using the following pins:
-
- - ``UART(2)`` is on: ``(TX, RX, nRTS, nCTS) = (X3, X4, X2, X1) = (PA2, PA3, PA1, PA0)``
- - ``UART(3)`` is on :``(TX, RX, nRTS, nCTS) = (Y9, Y10, Y7, Y6) = (PB10, PB11, PB14, PB13)``
-
- On the Pyboard Lite only ``UART(2)`` supports flow control on these pins:
-
- ``(TX, RX, nRTS, nCTS) = (X1, X2, X4, X3) = (PA2, PA3, PA1, PA0)``
-
- In the following paragraphs the term "target" refers to the device connected to
- the UART.
-
- When the UART's ``init()`` method is called with ``flow`` set to one or both of
- ``UART.RTS`` and ``UART.CTS`` the relevant flow control pins are configured.
- ``nRTS`` is an active low output, ``nCTS`` is an active low input with pullup
- enabled. To achieve flow control the Pyboard's ``nCTS`` signal should be connected
- to the target's ``nRTS`` and the Pyboard's ``nRTS`` to the target's ``nCTS``.
-
- CTS: target controls Pyboard transmitter
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- If CTS flow control is enabled the write behaviour is as follows:
-
- If the Pyboard's ``UART.write(buf)`` method is called, transmission will stall for
- any periods when ``nCTS`` is ``False``. This will result in a timeout if the entire
- buffer was not transmitted in the timeout period. The method returns the number of
- bytes written, enabling the user to write the remainder of the data if required. In
- the event of a timeout, a character will remain in the UART pending ``nCTS``. The
- number of bytes composing this character will be included in the return value.
-
- If ``UART.writechar()`` is called when ``nCTS`` is ``False`` the method will time
- out unless the target asserts ``nCTS`` in time. If it times out ``OSError 116``
- will be raised. The character will be transmitted as soon as the target asserts ``nCTS``.
-
- RTS: Pyboard controls target's transmitter
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- If RTS flow control is enabled, behaviour is as follows:
-
- If buffered input is used (``read_buf_len`` > 0), incoming characters are buffered.
- If the buffer becomes full, the next character to arrive will cause ``nRTS`` to go
- ``False``: the target should cease transmission. ``nRTS`` will go ``True`` when
- characters are read from the buffer.
-
- Note that the ``any()`` method returns the number of bytes in the buffer. Assume a
- buffer length of ``N`` bytes. If the buffer becomes full, and another character arrives,
- ``nRTS`` will be set False, and ``any()`` will return the count ``N``. When
- characters are read the additional character will be placed in the buffer and will
- be included in the result of a subsequent ``any()`` call.
-
- If buffered input is not used (``read_buf_len`` == 0) the arrival of a character will
- cause ``nRTS`` to go ``False`` until the character is read.
+On Pyboards V1 and V1.1 ``UART(2)`` and ``UART(3)`` support RTS/CTS hardware flow control
+using the following pins:
+
+ - ``UART(2)`` is on: ``(TX, RX, nRTS, nCTS) = (X3, X4, X2, X1) = (PA2, PA3, PA1, PA0)``
+ - ``UART(3)`` is on :``(TX, RX, nRTS, nCTS) = (Y9, Y10, Y7, Y6) = (PB10, PB11, PB14, PB13)``
+
+On the Pyboard Lite only ``UART(2)`` supports flow control on these pins:
+
+ ``(TX, RX, nRTS, nCTS) = (X1, X2, X4, X3) = (PA2, PA3, PA1, PA0)``
+
+In the following paragraphs the term "target" refers to the device connected to
+the UART.
+
+When the UART's ``init()`` method is called with ``flow`` set to one or both of
+``UART.RTS`` and ``UART.CTS`` the relevant flow control pins are configured.
+``nRTS`` is an active low output, ``nCTS`` is an active low input with pullup
+enabled. To achieve flow control the Pyboard's ``nCTS`` signal should be connected
+to the target's ``nRTS`` and the Pyboard's ``nRTS`` to the target's ``nCTS``.
+
+CTS: target controls Pyboard transmitter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If CTS flow control is enabled the write behaviour is as follows:
+
+If the Pyboard's ``UART.write(buf)`` method is called, transmission will stall for
+any periods when ``nCTS`` is ``False``. This will result in a timeout if the entire
+buffer was not transmitted in the timeout period. The method returns the number of
+bytes written, enabling the user to write the remainder of the data if required. In
+the event of a timeout, a character will remain in the UART pending ``nCTS``. The
+number of bytes composing this character will be included in the return value.
+
+If ``UART.writechar()`` is called when ``nCTS`` is ``False`` the method will time
+out unless the target asserts ``nCTS`` in time. If it times out ``OSError 116``
+will be raised. The character will be transmitted as soon as the target asserts ``nCTS``.
+
+RTS: Pyboard controls target's transmitter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If RTS flow control is enabled, behaviour is as follows:
+
+If buffered input is used (``read_buf_len`` > 0), incoming characters are buffered.
+If the buffer becomes full, the next character to arrive will cause ``nRTS`` to go
+``False``: the target should cease transmission. ``nRTS`` will go ``True`` when
+characters are read from the buffer.
+
+Note that the ``any()`` method returns the number of bytes in the buffer. Assume a
+buffer length of ``N`` bytes. If the buffer becomes full, and another character arrives,
+``nRTS`` will be set False, and ``any()`` will return the count ``N``. When
+characters are read the additional character will be placed in the buffer and will
+be included in the result of a subsequent ``any()`` call.
+
+If buffered input is not used (``read_buf_len`` == 0) the arrival of a character will
+cause ``nRTS`` to go ``False`` until the character is read.