Skip to content

Commit 520cd35

Browse files
authored
fix(uart_doc): Document RX and TX pin detachment behavior
Added note about driver behavior when RX and TX pins are detached.
1 parent 3663af9 commit 520cd35

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/en/api/serial.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ with additional features for advanced use cases.
2323
* **Event callbacks**: Receive and error event callbacks
2424
* **Configurable buffers**: Adjustable RX and TX buffer sizes
2525

26+
.. note::
27+
In case that both pins RX and TX are detached from UART, the driver will be stopped.
28+
Detaching may occur when, for instance, starting another peripheral using RX and TX pins, such as Wire.begin(RX0, TX0).
29+
2630
UART Availability
2731
-----------------
2832

0 commit comments

Comments
 (0)