#include <usb_uart.h>

Inheritance diagram for esphome::usb_uart::USBUartChannelBase:

Public Member Functions
void	write_array (const uint8_t *data, size_t len) override

bool	peek_byte (uint8_t *data) override

bool	read_array (uint8_t *data, size_t len) override

size_t	available () override

bool	is_connected () override

uart::UARTFlushResult	flush () override

void	load_settings (bool dump_config) override

void	set_debug (bool debug)

void	set_dummy_receiver (bool dummy_receiver)

void	set_debug_prefix (const char *prefix)

void	set_flush_timeout (uint32_t flush_timeout_ms) override

void	set_rx_callback (std::function< void()> cb)
	Register a callback invoked immediately after data is pushed to the input ring buffer.

uint8_t	get_interface_number () const
	USB interface number a host driver binds to for this channel: the communication interface of a CDC ACM function, otherwise the data interface.

uint8_t	get_interface_class () const
	bInterfaceClass of the interface `get_interface_number()` names

uint8_t	get_port_number () const
	Index of this port among the ports on its interface.

bool	set_modem_control (bool dtr, bool rts)
	Store DTR/RTS and send them to the device. False when not connected.

bool	get_dtr () const

bool	get_rts () const

Public Member Functions inherited from esphome::uart::UARTComponent
void	write_array (const std::vector< uint8_t > &data)

void	write_byte (uint8_t data)

void	write_str (const char *str)

void	write_array_progmem (const uint8_t *data, size_t len)

void	write_array_progmem (const uint8_t *data, size_t len)

bool	read_byte (uint8_t *data)

virtual size_t	available_for_write ()

size_t	paced_write_room (uint32_t last_write_ms)

void	set_tx_pin (InternalGPIOPin *tx_pin)

void	set_rx_pin (InternalGPIOPin *rx_pin)

void	set_flow_control_pin (InternalGPIOPin *flow_control_pin)

void	set_rx_buffer_size (size_t rx_buffer_size)

size_t	get_rx_buffer_size ()

virtual void	set_rx_full_threshold (size_t rx_full_threshold)

void	set_rx_full_threshold_ms (uint8_t time)

size_t	get_rx_full_threshold ()

virtual void	set_rx_timeout (size_t rx_timeout)

size_t	get_rx_timeout ()

void	set_stop_bits (uint8_t stop_bits)

uint8_t	get_stop_bits () const

void	set_data_bits (uint8_t data_bits)

uint8_t	get_data_bits () const

void	set_parity (UARTParityOptions parity)

UARTParityOptions	get_parity () const

void	set_baud_rate (uint32_t baud_rate)

uint32_t	get_baud_rate () const

void	load_settings ()
	Load the UART settings.

template<typename F >
void	add_debug_callback (F &&callback)

Public Member Functions inherited from esphome::Parented< USBUartComponent >
	Parented ()

	Parented (USBUartComponent *parent)

USBUartComponent *	get_parent () const
	Get the parent of this object.

void	set_parent (USBUartComponent *parent)
	Set the parent of this object.

Static Public Attributes
static constexpr uint8_t	USB_OUTPUT_CHUNK_COUNT = USB_UART_OUTPUT_CHUNK_COUNT

Static Public Attributes inherited from esphome::uart::UARTComponent
static constexpr size_t	RX_FULL_THRESHOLD_UNSET = 0

Protected Member Functions
	USBUartChannelBase (uint8_t index, uint16_t buffer_size)

void	check_logger_conflict () override

LineStopBits	line_stop_bits_ () const

LineParity	line_parity_ () const

Protected Member Functions inherited from esphome::uart::UARTComponent
bool	check_read_timeout_ (size_t len=1)

Protected Attributes
RingBuffer	input_buffer_

LockFreeQueue< UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT >	output_queue_

EventPool< UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT - 1 >	output_pool_

std::function< void()>	rx_callback_ {}

CdcEps	cdc_dev_ {}

StringRef	debug_prefix_ {}

uint32_t	flush_timeout_ms_ {100}

std::atomic< bool >	input_started_ {true}

std::atomic< bool >	output_started_ {true}

std::atomic< bool >	initialised_ {false}

const uint8_t	index_

bool	debug_ {}

bool	dummy_receiver_ {}

bool	dtr_ {true}

bool	rts_ {true}

bool	reload_pending_ {false}

bool	modem_pending_ {false}

Protected Attributes inherited from esphome::uart::UARTComponent
InternalGPIOPin *	tx_pin_ {}

InternalGPIOPin *	rx_pin_ {}

InternalGPIOPin *	flow_control_pin_ {}

size_t	rx_buffer_size_ {}

size_t	rx_full_threshold_ {RX_FULL_THRESHOLD_UNSET}

size_t	rx_timeout_ {0}

uint32_t	baud_rate_ {0}

uint8_t	stop_bits_ {0}

uint8_t	data_bits_ {0}

UARTParityOptions	parity_ {UART_CONFIG_PARITY_NONE}

CallbackManager< void(UARTDirection, uint8_t)>	debug_callback_ {}

Protected Attributes inherited from esphome::Parented< USBUartComponent >
USBUartComponent *	parent_

Detailed Description

Definition at line 160 of file usb_uart.h.

Constructor & Destructor Documentation

◆ USBUartChannelBase()

esphome::usb_uart::USBUartChannelBase::USBUartChannelBase	(	uint8_t	index,
		uint16_t	buffer_size )

inlineprotected

Definition at line 217 of file usb_uart.h.

Member Function Documentation

◆ available()

size_t esphome::usb_uart::USBUartChannelBase::available ( )

inlineoverridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 176 of file usb_uart.h.

◆ check_logger_conflict()

void esphome::usb_uart::USBUartChannelBase::check_logger_conflict ( )

inlineoverrideprotectedvirtual

Implements esphome::uart::UARTComponent.

Definition at line 218 of file usb_uart.h.

◆ flush()

uart::UARTFlushResult esphome::usb_uart::USBUartChannelBase::flush ( )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 174 of file usb_uart.cpp.

◆ get_dtr()

bool esphome::usb_uart::USBUartChannelBase::get_dtr ( ) const

inline

Definition at line 212 of file usb_uart.h.

◆ get_interface_class()

uint8_t esphome::usb_uart::USBUartChannelBase::get_interface_class ( ) const

inline

bInterfaceClass of the interface get_interface_number() names

Definition at line 201 of file usb_uart.h.

◆ get_interface_number()

uint8_t esphome::usb_uart::USBUartChannelBase::get_interface_number ( ) const

inline

USB interface number a host driver binds to for this channel: the communication interface of a CDC ACM function, otherwise the data interface.

Definition at line 195 of file usb_uart.h.

◆ get_port_number()

uint8_t esphome::usb_uart::USBUartChannelBase::get_port_number ( ) const

inline

Index of this port among the ports on its interface.

Every driver here exposes one port per interface; a multiplexed driver would index its channels.

Definition at line 208 of file usb_uart.h.

◆ get_rts()

bool esphome::usb_uart::USBUartChannelBase::get_rts ( ) const

inline

Definition at line 213 of file usb_uart.h.

◆ is_connected()

bool esphome::usb_uart::USBUartChannelBase::is_connected ( )

inlineoverridevirtual

Reimplemented from esphome::uart::UARTComponent.

Definition at line 177 of file usb_uart.h.

◆ line_parity_()

LineParity esphome::usb_uart::USBUartChannelBase::line_parity_ ( ) const

protected

Definition at line 740 of file usb_uart.cpp.

◆ line_stop_bits_()

LineStopBits esphome::usb_uart::USBUartChannelBase::line_stop_bits_ ( ) const

protected

Definition at line 729 of file usb_uart.cpp.

◆ load_settings()

void esphome::usb_uart::USBUartChannelBase::load_settings ( bool dump_config )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 755 of file usb_uart.cpp.

◆ peek_byte()

bool esphome::usb_uart::USBUartChannelBase::peek_byte ( uint8_t * data )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 190 of file usb_uart.cpp.

◆ read_array()

bool esphome::usb_uart::USBUartChannelBase::read_array	(	uint8_t *	data,
		size_t	len )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 197 of file usb_uart.cpp.

◆ set_debug()

void esphome::usb_uart::USBUartChannelBase::set_debug ( bool debug )

inline

Definition at line 182 of file usb_uart.h.

◆ set_debug_prefix()

void esphome::usb_uart::USBUartChannelBase::set_debug_prefix ( const char * prefix )

inline

Definition at line 184 of file usb_uart.h.

◆ set_dummy_receiver()

void esphome::usb_uart::USBUartChannelBase::set_dummy_receiver ( bool dummy_receiver )

inline

Definition at line 183 of file usb_uart.h.

◆ set_flush_timeout()

void esphome::usb_uart::USBUartChannelBase::set_flush_timeout ( uint32_t flush_timeout_ms )

inlineoverridevirtual

Reimplemented from esphome::uart::UARTComponent.

Definition at line 185 of file usb_uart.h.

◆ set_modem_control()

bool esphome::usb_uart::USBUartChannelBase::set_modem_control	(	bool	dtr,
		bool	rts )

Store DTR/RTS and send them to the device. False when not connected.

Definition at line 760 of file usb_uart.cpp.

◆ set_rx_callback()

void esphome::usb_uart::USBUartChannelBase::set_rx_callback ( std::function< void()> cb )

inline

Register a callback invoked immediately after data is pushed to the input ring buffer.

Called from USBUartComponent::loop() in the main loop context. Allows consumers (e.g. ZigbeeProxy) to process bytes in the same loop iteration they arrive, eliminating one full main-loop-wakeup cycle of latency.

Definition at line 191 of file usb_uart.h.

◆ write_array()

void esphome::usb_uart::USBUartChannelBase::write_array	(	const uint8_t *	data,
		size_t	len )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 140 of file usb_uart.cpp.

Field Documentation

◆ cdc_dev_

CdcEps esphome::usb_uart::USBUartChannelBase::cdc_dev_ {}

protected

Definition at line 229 of file usb_uart.h.

◆ debug_

bool esphome::usb_uart::USBUartChannelBase::debug_ {}

protected

Definition at line 238 of file usb_uart.h.

◆ debug_prefix_

StringRef esphome::usb_uart::USBUartChannelBase::debug_prefix_ {}

protected

Definition at line 230 of file usb_uart.h.

◆ dtr_

bool esphome::usb_uart::USBUartChannelBase::dtr_ {true}

protected

Definition at line 241 of file usb_uart.h.

◆ dummy_receiver_

bool esphome::usb_uart::USBUartChannelBase::dummy_receiver_ {}

protected

Definition at line 239 of file usb_uart.h.

◆ flush_timeout_ms_

uint32_t esphome::usb_uart::USBUartChannelBase::flush_timeout_ms_ {100}

protected

Definition at line 232 of file usb_uart.h.

◆ index_

const uint8_t esphome::usb_uart::USBUartChannelBase::index_

protected

Definition at line 237 of file usb_uart.h.

◆ initialised_

std::atomic<bool> esphome::usb_uart::USBUartChannelBase::initialised_ {false}

protected

Definition at line 236 of file usb_uart.h.

◆ input_buffer_

RingBuffer esphome::usb_uart::USBUartChannelBase::input_buffer_

protected

Definition at line 222 of file usb_uart.h.

◆ input_started_

std::atomic<bool> esphome::usb_uart::USBUartChannelBase::input_started_ {true}

protected

Definition at line 234 of file usb_uart.h.

◆ modem_pending_

bool esphome::usb_uart::USBUartChannelBase::modem_pending_ {false}

protected

Definition at line 245 of file usb_uart.h.

◆ output_pool_

EventPool<UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT - 1> esphome::usb_uart::USBUartChannelBase::output_pool_

protected

Definition at line 227 of file usb_uart.h.

◆ output_queue_

LockFreeQueue<UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT> esphome::usb_uart::USBUartChannelBase::output_queue_

protected

Definition at line 223 of file usb_uart.h.

◆ output_started_

std::atomic<bool> esphome::usb_uart::USBUartChannelBase::output_started_ {true}

protected

Definition at line 235 of file usb_uart.h.

◆ reload_pending_

bool esphome::usb_uart::USBUartChannelBase::reload_pending_ {false}

protected

Definition at line 244 of file usb_uart.h.

◆ rts_

bool esphome::usb_uart::USBUartChannelBase::rts_ {true}

protected

Definition at line 242 of file usb_uart.h.

◆ rx_callback_

std::function<void()> esphome::usb_uart::USBUartChannelBase::rx_callback_ {}

protected

Definition at line 228 of file usb_uart.h.

◆ USB_OUTPUT_CHUNK_COUNT

uint8_t esphome::usb_uart::USBUartChannelBase::USB_OUTPUT_CHUNK_COUNT = USB_UART_OUTPUT_CHUNK_COUNT

staticconstexpr

Definition at line 171 of file usb_uart.h.

The documentation for this class was generated from the following files:

esphome/components/usb_uart/usb_uart.h
esphome/components/usb_uart/usb_uart.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ USBUartChannelBase()

Member Function Documentation

◆ available()

◆ check_logger_conflict()

◆ flush()

◆ get_dtr()

◆ get_interface_class()

◆ get_interface_number()

◆ get_port_number()

◆ get_rts()

◆ is_connected()

◆ line_parity_()

◆ line_stop_bits_()

◆ load_settings()

◆ peek_byte()

◆ read_array()

◆ set_debug()

◆ set_debug_prefix()

◆ set_dummy_receiver()

◆ set_flush_timeout()

◆ set_modem_control()

◆ set_rx_callback()

◆ write_array()

Field Documentation

◆ cdc_dev_

◆ debug_

◆ debug_prefix_

◆ dtr_

◆ dummy_receiver_

◆ flush_timeout_ms_

◆ index_

◆ initialised_

◆ input_buffer_

◆ input_started_

◆ modem_pending_

◆ output_pool_

◆ output_queue_

◆ output_started_

◆ reload_pending_

◆ rts_

◆ rx_callback_

◆ USB_OUTPUT_CHUNK_COUNT