HF Interface Wrapper 0.1.0-dev
Embedded C++ hardware abstraction layer
Loading...
Searching...
No Matches
hf_uart_flow_config_t Struct Reference

ESP32 UART flow control configuration. More...

#include <EspTypes_UART.h>

Public Member Functions

 hf_uart_flow_config_t () noexcept
 

Public Attributes

bool enable_hw_flow_control
 Enable hardware flow control (RTS/CTS)
 
bool enable_sw_flow_control
 Enable software flow control (XON/XOFF)
 
uint8_t xon_char
 XON character (default: 0x11)
 
uint8_t xoff_char
 XOFF character (default: 0x13)
 
uint16_t rx_flow_ctrl_thresh
 RX flow control threshold (bytes)
 
uint16_t tx_flow_ctrl_thresh
 TX flow control threshold (bytes)
 
bool auto_rts
 Automatic RTS control.
 
bool auto_cts
 Automatic CTS control.
 

Detailed Description

ESP32 UART flow control configuration.

Constructor & Destructor Documentation

◆ hf_uart_flow_config_t()

hf_uart_flow_config_t::hf_uart_flow_config_t ( )
inlinenoexcept

Member Data Documentation

◆ auto_cts

bool hf_uart_flow_config_t::auto_cts

Automatic CTS control.

◆ auto_rts

bool hf_uart_flow_config_t::auto_rts

Automatic RTS control.

◆ enable_hw_flow_control

bool hf_uart_flow_config_t::enable_hw_flow_control

Enable hardware flow control (RTS/CTS)

◆ enable_sw_flow_control

bool hf_uart_flow_config_t::enable_sw_flow_control

Enable software flow control (XON/XOFF)

◆ rx_flow_ctrl_thresh

uint16_t hf_uart_flow_config_t::rx_flow_ctrl_thresh

RX flow control threshold (bytes)

◆ tx_flow_ctrl_thresh

uint16_t hf_uart_flow_config_t::tx_flow_ctrl_thresh

TX flow control threshold (bytes)

◆ xoff_char

uint8_t hf_uart_flow_config_t::xoff_char

XOFF character (default: 0x13)

◆ xon_char

uint8_t hf_uart_flow_config_t::xon_char

XON character (default: 0x11)


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