espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-02 12:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'doc/uart_num_fix' into 'master'

Browse Source 
docs: fix uart number naming error

Closes DOC-946

See merge request espressif/esp-idf!12067
This commit is contained in:
Krzysztof Budzynski
2021-01-21 17:33:21 +08:00
parent 3532f52f60 7a8a026b1d
commit 18c441d798
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
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,18 +99,18 @@ 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));
@@ -189,7 +189,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)