uart_set_rx_timeout() function

UART set threshold timeout for TOUT feature

Syntax

Show:

Summary

Declaration

Definition

from uart.h:754

esp_err_t uart_set_rx_timeout(uart_port_t uart_num, const uint8_t tout_thresh);

Implemented in uart.c:1916

Arguments

Argument

Description

uart_num

Uart number to configure, the max port number is (UART_NUM_MAX -1).

tout_thresh

This parameter defines timeout threshold in uart symbol periods. The maximum value of threshold is 126. tout_thresh = 1, defines TOUT interrupt timeout equal to transmission time of one symbol (~11 bit) on current baudrate. If the time is expired the UART_RXFIFO_TOUT_INT interrupt is triggered. If tout_thresh == 0, the TOUT feature is disabled.

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_INVALID_STATE Driver is not installed

Examples

uart_set_rx_timeout() is referenced by 5 libraries and example projects:

References

from examples

uart_set_rx_timeout() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle