ESP32 UART port configuration. More...

#include <EspTypes_UART.h>

Public Member Functions
	hf_uart_config_t () noexcept

Public Attributes
hf_port_num_t	port_number
	UART port number (0, 1, 2)

hf_baud_rate_t	baud_rate
	Baud rate in bits per second.

hf_uart_data_bits_t	data_bits
	Data bits (5-8)

hf_uart_parity_t	parity
	Parity configuration.

hf_uart_stop_bits_t	stop_bits
	Stop bits (1, 1.5, 2)

hf_uart_flow_ctrl_t	flow_control
	Hardware flow control.

hf_pin_num_t	tx_pin
	TX pin number.

hf_pin_num_t	rx_pin
	RX pin number.

hf_pin_num_t	rts_pin
	RTS pin number (optional)

hf_pin_num_t	cts_pin
	CTS pin number (optional)

uint16_t	tx_buffer_size
	TX buffer size in bytes.

uint16_t	rx_buffer_size
	RX buffer size in bytes.

uint8_t	event_queue_size
	Event queue size for interrupt mode.

hf_uart_operating_mode_t	operating_mode
	Operating mode (polling/interrupt/DMA)

hf_timeout_ms_t	timeout_ms
	Default timeout for operations.

bool	enable_pattern_detection
	Enable pattern detection.

bool	enable_wakeup
	Enable UART wakeup from sleep.

bool	enable_loopback
	Enable loopback mode for testing.

Detailed Description

ESP32 UART port configuration.

Constructor & Destructor Documentation

◆ hf_uart_config_t()

hf_uart_config_t::hf_uart_config_t ( )

inlinenoexcept

Member Data Documentation

◆ baud_rate

hf_baud_rate_t hf_uart_config_t::baud_rate

Baud rate in bits per second.

◆ cts_pin

hf_pin_num_t hf_uart_config_t::cts_pin

CTS pin number (optional)

◆ data_bits

hf_uart_data_bits_t hf_uart_config_t::data_bits

Data bits (5-8)

◆ enable_loopback

bool hf_uart_config_t::enable_loopback

Enable loopback mode for testing.

◆ enable_pattern_detection

bool hf_uart_config_t::enable_pattern_detection

Enable pattern detection.

◆ enable_wakeup

bool hf_uart_config_t::enable_wakeup

Enable UART wakeup from sleep.

◆ event_queue_size

uint8_t hf_uart_config_t::event_queue_size

Event queue size for interrupt mode.

◆ flow_control

hf_uart_flow_ctrl_t hf_uart_config_t::flow_control

Hardware flow control.

◆ operating_mode

hf_uart_operating_mode_t hf_uart_config_t::operating_mode

Operating mode (polling/interrupt/DMA)

◆ parity

hf_uart_parity_t hf_uart_config_t::parity

Parity configuration.

◆ port_number

hf_port_num_t hf_uart_config_t::port_number

UART port number (0, 1, 2)

◆ rts_pin

hf_pin_num_t hf_uart_config_t::rts_pin

RTS pin number (optional)

◆ rx_buffer_size

uint16_t hf_uart_config_t::rx_buffer_size

RX buffer size in bytes.

◆ rx_pin

hf_pin_num_t hf_uart_config_t::rx_pin

RX pin number.

◆ stop_bits

hf_uart_stop_bits_t hf_uart_config_t::stop_bits

Stop bits (1, 1.5, 2)

◆ timeout_ms

hf_timeout_ms_t hf_uart_config_t::timeout_ms

Default timeout for operations.

◆ tx_buffer_size

uint16_t hf_uart_config_t::tx_buffer_size

TX buffer size in bytes.

◆ tx_pin

hf_pin_num_t hf_uart_config_t::tx_pin

TX pin number.

The documentation for this struct was generated from the following file:

inc/mcu/esp32/utils/EspTypes_UART.h

Public Member Functions

Public Attributes