espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-31 03:07:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'doc/uart_num_fix_v4.2' into 'release/v4.2'

Browse Source 
docs: fix uart number naming error (v4.2)

See merge request espressif/esp-idf!12068
This commit is contained in:
Krzysztof Budzynski
2021-02-02 16:08:33 +08:00
parent 2ea3519964 d8ba0f9b0e
commit f697f475e5
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/api-reference/peripherals/uart.rst
View File

@ -1,7 +1,7 @@
UART UART
==== ====
{IDF_TARGET_UART_NUM:default = "UART1", esp32 = "UART2", esp32s2 = "UART1"} {IDF_TARGET_UART_NUM:default = "UART_NUM_1", esp32 = "UART_NUM_2", esp32s2 = "UART_NUM_1"}
Overview Overview
-------- --------
@ -99,21 +99,19 @@ After setting communication parameters, configure the physical GPIO pins to whic
The same macro should be specified for pins that will not be used. The same macro should be specified for pins that will not be used.
.. code-block:: c
.. only:: esp32 .. only:: esp32
:: .. code-block:: c
// Set UART pins(TX: IO16 (UART2 default), RX: IO17 (UART2 default), RTS: IO18, CTS: IO19) // Set UART pins(TX: IO16 (UART2 default), RX: IO17 (UART2 default), RTS: IO18, CTS: IO19)
ESP_ERROR_CHECK(uart_set_pin(UART_NUM_2, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE, 18, 19)); ESP_ERROR_CHECK(uart_set_pin(UART_NUM_2, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE, 18, 19));
.. only:: esp32s2 .. only:: esp32s2
:: .. code-block:: c
// Set UART pins(TX: IO17 (UART1 default), RX: IO18 (UART1 default), RTS: IO19, CTS: IO20) // Set UART pins(TX: IO17 (UART1 default), RX: IO18 (UART1 default), RTS: IO19, CTS: IO20)
ESP_ERROR_CHECK(uart_set_pin(UART_NUM_1, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE, 19, 20)); ESP_ERROR_CHECK(uart_set_pin(UART_NUM_1, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE, 19, 20));
.. _uart-api-driver-installation: .. _uart-api-driver-installation:
@ -189,7 +187,7 @@ There is a 'companion' function :cpp:func:`uart_wait_tx_done` that monitors the
.. code-block:: c .. code-block:: c
// Wait for packet to be sent // Wait for packet to be sent
const int uart_num = UART_NUM_2; const int uart_num = {IDF_TARGET_UART_NUM};
ESP_ERROR_CHECK(uart_wait_tx_done(uart_num, 100)); // wait timeout is 100 RTOS ticks (TickType_t) ESP_ERROR_CHECK(uart_wait_tx_done(uart_num, 100)); // wait timeout is 100 RTOS ticks (TickType_t)
@ -353,7 +351,7 @@ Circuit C: Auto Switching Transmitter/Receiver
VCC1 <-------------------+-----------+ +-------------------+----> VCC2 VCC1 <-------------------+-----------+ +-------------------+----> VCC2
10K ____ | | | | 10K ____ | | | |
+---|____|--+ +---x-----------x---+ 10K ____ | +---|____|--+ +---x-----------x---+ 10K ____ |
| | | +---|____|--+ GND2 | | | +---|____|--+
RX <----------+-------------------| RXD | | RX <----------+-------------------| RXD | |
10K ____ | A|---+---------------<> A (+) 10K ____ | A|---+---------------<> A (+)
+-------|____|------| PV ADM2483 | | ____ 120 +-------|____|------| PV ADM2483 | | ____ 120
@ -363,7 +361,7 @@ Circuit C: Auto Switching Transmitter/Receiver
---+ +-->| /RE | | ____ ---+ +-->| /RE | | ____
10K | | | | +---|____|---+ 10K | | | | +---|____|---+
____ | /-C +---| TXD | 10K | ____ | /-C +---| TXD | 10K |
TX >---|____|--B___|/ NPN | | | | TX >---|____|--+_B_|/ NPN | | | |
|\ | +---x-----------x---+ | |\ | +---x-----------x---+ |
| \-E | | | | | \-E | | | |
| | | | | | | | | |