Commit 0caac94b authored by Lorenz Schmid's avatar Lorenz Schmid Committed by Damien George
Browse files

docs/library/pyb.UART: Added clarification about timeouts.

parent c16e7eae
...@@ -87,8 +87,8 @@ Methods ...@@ -87,8 +87,8 @@ Methods
- ``stop`` is the number of stop bits, 1 or 2. - ``stop`` is the number of stop bits, 1 or 2.
- ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS`` - ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS``
or ``UART.RTS | UART.CTS``. or ``UART.RTS | UART.CTS``.
- ``timeout`` is the timeout in milliseconds to wait for the first character. - ``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. - ``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). - ``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 This method will raise an exception if the baudrate could not be set within
......
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