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

Merge branch 'bugfix/uart_api_reference_examples' into 'master'

Browse Source 
docs: Update type of uart_num in UART API Reference examples

See merge request espressif/esp-idf!13385
This commit is contained in:
Krzysztof Budzynski
2021-04-30 06:08:46 +00:00
parent 73adacb7d4 7b9b489968
commit bd5b14fd81
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -50,7 +50,7 @@ Call the function :cpp:func:`uart_param_config` and pass to it a :cpp:type:`uart
.. code-block:: c .. code-block:: c
const int uart_num = {IDF_TARGET_UART_NUM}; const uart_port_t uart_num = {IDF_TARGET_UART_NUM};
uart_config_t uart_config = { uart_config_t uart_config = {
.baud_rate = 115200, .baud_rate = 115200,
.data_bits = UART_DATA_8_BITS, .data_bits = UART_DATA_8_BITS,
@@ -195,7 +195,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 = {IDF_TARGET_UART_NUM}; const uart_port_t 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)
@@ -207,7 +207,7 @@ Once the data is received by the UART and saved in the Rx FIFO buffer, it needs
.. code-block:: c .. code-block:: c
// Read data from UART. // Read data from UART.
const int uart_num = {IDF_TARGET_UART_NUM}; const uart_port_t uart_num = {IDF_TARGET_UART_NUM};
uint8_t data[128]; uint8_t data[128];
int length = 0; int length = 0;
ESP_ERROR_CHECK(uart_get_buffered_data_len(uart_num, (size_t*)&length)); ESP_ERROR_CHECK(uart_get_buffered_data_len(uart_num, (size_t*)&length));