Tomasz 'CeDeROM' CEDRO
602f9db2f3
docs/library/machine.UART: Add notes about UART init and deinit.
* `init()` can be called multiple times to reconfigure UART.
* After `deinit()` it is impossible to call `init()` again.
Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2 years ago
Jan
5d9171b5cc
docs/library/machine.UART.rst: Add details for `invert` parameter.
3 years ago
Damien George
d9d67adef1
docs: Remove trailing spaces and convert tabs to spaces.
Signed-off-by: Damien George <damien@micropython.org>
3 years ago
Will Sowerbutts
a3675294ae
esp32/machine_uart: Add flow kw-arg to enable hardware flow control.
This enables optional support for the hardware UART to use the RTS and/or
CTS pins for flow control.
The new "flow" constructor keyword specifies a bitmask of RTS and/or CTS.
This matches the interface used by machine.UART on stm32 and rp2.
Previously on ESP32 it was possible to specify which pins to use for the
RTS and CTS signals, but hardware flow control was never functional: CTS
was not checked before transmitting bytes, and RTS was always driven high
(signalling no buffer space available). With this patch, CTS and RTS both
operate as expected.
This also includes an update to the machine.UART documentation.
Signed-off-by: Will Sowerbutts <will@sowerbutts.com>
4 years ago
Zenix27
e76c7466b6
docs: Change `\*` to `*` in argument lists.
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 .
4 years ago
Jason Neal
5ef3b6b2d9
docs/library/machine.UART.rst: Detail timeout behaviour of read methods.
Also document existence of "invert" argument to constructor.
5 years ago
Damien George
b18fa1e606
docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.
If a port would like to expose the configuration of transmit and/or receive
buffers then it can use these arguments.
6 years ago
Damien George
4cc65e22d4
docs/library/machine.UART: Remove conditional docs for wipy port.
The UART.init() method is now included unconditionally and its wording
adjusted to better describe ports other than the cc3200.
UART.irq() is also included unconditionally, but this is currently only
available on the WiPy target.
6 years ago
Paul Sokolovsky
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
7 years ago
Paul Sokolovsky
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
7 years ago
Ville Skyttä
ca16c38210
various: Spelling fixes
8 years ago
Damien George
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
8 years ago
Damien George
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
8 years ago
Damien George
fabaa61437
docs/library/machine.UART: Remove pyboard-specific section.
stmhal doesn't have a machine.UART class so this section is not needed.
8 years ago
Paul Sokolovsky
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
8 years ago
Paul Sokolovsky
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
8 years ago
Damien George
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
8 years ago
Mike Causer
ce166e6b68
docs: Spelling mistakes
8 years ago
Paul Sokolovsky
79b40d1127
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
9 years ago
Paul Sokolovsky
7d7243f44c
docs/machine.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class
name.
9 years ago
Paul Sokolovsky
93968bd6fb
docs/machine.UART: Cleanup pyboard section.
9 years ago
Paul Sokolovsky
c8b7628094
docs/machine.*: Add "currentmodule:: machine" directive.
Makes sure that classes described in these separate files are properly
designated as belonging to "machine" module in indexes.
9 years ago
Radomir Dopieralski
0c86a9471a
docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.
9 years ago
Paul Sokolovsky
cf6daa0966
docs: Explicitly specify behavior of UART stream protocol methods on timeout.
9 years ago
danicampora
ceb169008d
docs: Several corrections to the classes in the machine module.
9 years ago
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago
Daniel Campora
8332044f75
cc3200: Add UART.ODD and UART.EVEN to select parity.
9 years ago
Daniel Campora
f38d16483a
docs: Update I2C and UART docs to match the new API.
9 years ago
Daniel Campora
f91f212d9f
cc3200: New UART API plus related test.
9 years ago
Daniel Campora
cfcf47c064
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
10 years ago
Damien George
3eece29807
docs: Change "Micro Python" to "MicroPython" in all places in docs.
10 years ago
Paul Sokolovsky
3527085587
pyb.UART.rst: Clean up note about stream protocol support.
10 years ago
Damien George
77fc276c08
stmhal: For UART, check that baudrate is within 5% of desired value.
Also includes documentation about minimum baudrate.
Addresses issue #1090 .
10 years ago
Damien George
baafb290ad
stmhal: Add uart.sendbreak() method, to send a break condition.
10 years ago
Damien George
8e701604d5
docs: Add links from quickref to pyb classes.
10 years ago
Damien George
a58713a899
docs: Cleanup and update some docs.
10 years ago
Damien George
4029f51842
stmhal: Fix UART so bits counts number of data bits, not incl parity.
Addresses issue #950 .
10 years ago
Damien George
88d3054ac0
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
10 years ago