uart_pattern_queue_reset() function

Allocate a new memory with the given length to save record the detected pattern position in rx buffer.

Syntax

Show:

Summary

Declaration

Definition

from uart.h:697

esp_err_t uart_pattern_queue_reset(uart_port_t uart_num, int queue_length);

Implemented in uart.c:587

Arguments

Argument

Declared as

Description

uart_num

uart_port_t

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

queue_length

int

Max queue length for the detected pattern. If the queue length is not large enough, some pattern positions might be lost. Set this value to the maximum number of patterns that could be saved in data buffer at the same time.

Return value

- ESP_ERR_NO_MEM No enough memory - ESP_ERR_INVALID_STATE Driver not installed - ESP_FAIL Parameter error - ESP_OK Success

Examples

uart_pattern_queue_reset() is referenced by 2 libraries and example projects:

References

from examples

uart_pattern_queue_reset() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle