diff options
| author | Damien George <damien.p.george@gmail.com> | 2019-05-02 22:04:55 +1000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-05-07 13:56:42 +1000 |
| commit | 34942d0a72980173eca51b201f271f67bcae46b5 (patch) | |
| tree | 324e419a3ba4fb620e8a9d3e3c7c1cee74394562 /docs | |
| parent | 7e90e22ea52665e38138d1e704d5e527439b663c (diff) | |
stm32/machine_uart: Change default UART timeout to 0, for non blocking.
It's more common to need non-blocking behaviour when reading from a UART,
rather than having a large timeout like 1000ms (the original behaviour).
With a large timeout it's 1) likely that the function will read forever if
characters keep trickling it; or 2) the function will unnecessarily wait
when characters come sporadically, eg at a REPL prompt.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/pyb.UART.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst index 4359f1d9d..ab7ab2fb8 100644 --- a/docs/library/pyb.UART.rst +++ b/docs/library/pyb.UART.rst @@ -69,7 +69,7 @@ Constructors Methods ------- -.. method:: UART.init(baudrate, bits=8, parity=None, stop=1, \*, timeout=1000, flow=0, timeout_char=0, read_buf_len=64) +.. method:: UART.init(baudrate, bits=8, parity=None, stop=1, \*, timeout=0, flow=0, timeout_char=0, read_buf_len=64) Initialise the UART bus with the given parameters: |