aboutsummaryrefslogtreecommitdiff
path: root/docs/library/pyb.UART.rst
AgeCommit message (Collapse)Author
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
2020-07-25docs/library: Update pyb.UART to correct pyboard UART availability.Howard Lovatt
On original pyboard UART 5 isn't available; added pyboard D availability.
2019-05-07stm32/machine_uart: Change default UART timeout to 0, for non blocking.Damien George
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.
2018-07-18docs/library: Remove "only" directive from all pyb module docs.Damien George
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.
2017-12-04docs/library: Add xrefs to "stream" dictionary entry for many modules.Paul Sokolovsky
2016-12-15docs/library/pyb.UART: Moved writechar doc to sit with other writes.Lorenz Schmid
2016-12-15docs/library/pyb.UART: Added clarification about timeouts.Lorenz Schmid
2016-11-14docs: Remove references to readall() and update stream read() docs.Damien George
2016-06-08docs/pyb.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/pyb.*: Add "currentmodule:: pyb" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-04-13stmhal: Properly handle RTS/CTS flow control for buf/unbuf transfers.Peter Hinch
Fixes issues #1912 and #1913. UART documentation is also updated.
2016-03-17docs: Update pyb.UART.any() to mention that it returns character count.Peter Hinch
2015-10-25docs: Explicitly specify behavior of UART stream protocol methods on timeout.Paul Sokolovsky
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora
2015-09-16cc3200: Add UART.ODD and UART.EVEN to select parity.Daniel Campora
2015-09-16docs: Update I2C and UART docs to match the new API.Daniel Campora
2015-09-10cc3200: New UART API plus related test.Daniel Campora
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2015-06-04docs: Change "Micro Python" to "MicroPython" in all places in docs.Damien George
2015-02-22pyb.UART.rst: Clean up note about stream protocol support.Paul Sokolovsky
2015-02-22stmhal: For UART, check that baudrate is within 5% of desired value.Damien George
Also includes documentation about minimum baudrate. Addresses issue #1090.
2015-02-13stmhal: Add uart.sendbreak() method, to send a break condition.Damien George
2014-11-04docs: Add links from quickref to pyb classes.Damien George
2014-10-31docs: Cleanup and update some docs.Damien George
2014-10-31stmhal: Fix UART so bits counts number of data bits, not incl parity.Damien George
Addresses issue #950.
2014-10-31docs: Import documentation from source-code inline comments.Damien George
The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.