Function esp_idf_sys::uart_set_rx_timeout

source ·

pub unsafe extern "C" fn uart_set_rx_timeout(
    uart_num: uart_port_t,
    tout_thresh: u8
) -> esp_err_t

Expand description

@brief UART set threshold timeout for TOUT feature

@param uart_num Uart number to configure, the max port number is (UART_NUM_MAX -1). @param 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 - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_INVALID_STATE Driver is not installed