summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan <climblinne@users.noreply.github.com>2022-03-03 13:49:06 +0100
committerDamien George <damien@micropython.org>2022-03-07 14:12:50 +1100
commit5d9171b5ccf154a4c7c5f8e152ea4fd75a5f33a5 (patch)
tree78d5d4bb70cf64af0ee1e99ba8bd81988b61366c
parentd696d9141e29da524fc78a1044f90a6e9107892f (diff)
docs/library/machine.UART.rst: Add details for `invert` parameter.
-rw-r--r--docs/library/machine.UART.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst
index 8fb42cfe8..e23952573 100644
--- a/docs/library/machine.UART.rst
+++ b/docs/library/machine.UART.rst
@@ -63,6 +63,12 @@ Methods
- *timeout* specifies the time to wait for the first character (in ms).
- *timeout_char* specifies the time to wait between characters (in ms).
- *invert* specifies which lines to invert.
+
+ - ``0`` will not invert lines (idle state of both lines is logic high).
+ - ``UART.INV_TX`` will invert TX line (idle state of TX line now logic low).
+ - ``UART.INV_RX`` will invert RX line (idle state of RX line now logic low).
+ - ``UART.INV_TX | UART.INV_RX`` will invert both lines (idle state at logic low).
+
- *flow* specifies which hardware flow control signals to use. The value
is a bitmask.