uart_flush() function

Alias of uart_flush_input. UART ring buffer flush. This will discard all data in the UART RX buffer.

Syntax

Show:

Summary

Declaration

Definition

from uart.h:575

esp_err_t uart_flush(uart_port_t uart_num);

Implemented in uart.c:1578

Arguments

Argument

Description

uart_num

UART port number, the max port number is (UART_NUM_MAX -1).

Return value

- ESP_OK Success - ESP_FAIL Parameter error

Notes

Instead of waiting the data sent out, this function will clear UART rx buffer. In order to send all the data in tx FIFO, we can use uart_wait_tx_done function.

Examples

uart_flush() is referenced by 1 libraries and example projects:

References

from examples

uart_flush() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle