djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/machine.UART: Update and improve uart.any() docs.

Browse Source
This commit is contained in:
Damien George 2017-05-17 17:24:59 +10:00
parent aca898eeb0
commit 436d97b3f9
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/library/machine.UART.rst
View File

@ -65,8 +65,16 @@ Methods
.. method:: UART.any()
Return true value if there're characters available for reading. On some
boards, the number of available characters is returned.
Returns an integer counting the number of characters that can be read without
blocking. It will return 0 if there are no characters available and a positive
number if there are characters. The method may return 1 even if there is more
than one character available for reading.
For more sophisticated querying of available characters use select.poll::
poll = select.poll()
poll.register(uart, select.POLLIN)
poll.poll(timeout)
.. method:: UART.read([nbytes])