#include <usb_uart.h>

Inheritance diagram for esphome::usb_uart::USBUartComponent:

Public Member Functions
	USBUartComponent (uint16_t vid, uint16_t pid)

void	setup () override

void	loop () override

void	dump_config () override

std::vector< USBUartChannel * >	get_channels ()

void	add_channel (USBUartChannel *channel)

virtual void	start_input (USBUartChannel *channel)

void	start_output (USBUartChannel *channel)

void	enable_channels ()

void	apply_channel_settings (USBUartChannel *channel)

virtual void	on_rx_overflow (USBUartChannel *channel)

Public Member Functions inherited from esphome::usb_host::USBClient
	USBClient (uint16_t vid, uint16_t pid)

float	get_setup_priority () const override

void	on_opened (uint8_t addr)

void	on_removed (usb_device_handle_t handle)

bool	transfer_in (uint8_t ep_address, const transfer_cb_t &callback, uint16_t length)
	Performs a transfer input operation.

bool	transfer_out (uint8_t ep_address, const transfer_cb_t &callback, const uint8_t *data, uint16_t length)
	Performs an output transfer operation.

void	release_trq (TransferRequest *trq)

trq_bitmask_t	get_trq_in_use () const

bool	control_transfer (uint8_t type, uint8_t request, uint16_t value, uint16_t index, const transfer_cb_t &callback, const std::vector< uint8_t > &data={})

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Data Fields
LockFreeQueue< UsbDataChunk, USB_DATA_QUEUE_SIZE >	usb_data_queue_

EventPool< UsbDataChunk, USB_DATA_QUEUE_SIZE - 1 >	chunk_pool_

Data Fields inherited from esphome::usb_host::USBClient
LockFreeQueue< UsbEvent, USB_EVENT_QUEUE_SIZE >	event_queue

EventPool< UsbEvent, USB_EVENT_QUEUE_SIZE - 1 >	event_pool

Static Public Attributes
static constexpr int	USB_DATA_QUEUE_SIZE = 32

Protected Member Functions
void	config_transfer_ (uint8_t type, uint8_t request, uint16_t value, uint16_t index, const std::vector< uint8_t > &data={})

void	start_config_ (bool reload)

bool	run_config_machine_ ()

virtual bool	config_step (USBUartChannel channel, uint8_t step, bool reload, bool ok, const uint8_t response)=0

virtual bool	config_device_step (uint8_t step, bool ok, const uint8_t *response)

Protected Member Functions inherited from esphome::usb_host::USBClient
bool	process_usb_events_ ()

void	handle_open_state_ ()

TransferRequest *	get_trq_ ()

virtual void	disconnect ()

virtual void	on_connected ()

virtual void	on_disconnected ()

void	usb_task_loop_ () const

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
std::vector< USBUartChannel * >	channels_ {}

USBUartChannel *	cfg_single_ {nullptr}

USBUartChannel *	cfg_pending_reload_ {nullptr}

std::atomic< bool >	cfg_done_ {false}

uint8_t	cfg_response_ [8] {}

uint8_t	cfg_channel_idx_ {0}

uint8_t	cfg_step_ {0}

bool	cfg_active_ {false}

bool	cfg_reload_ {false}

bool	cfg_device_phase_ {false}

bool	cfg_in_flight_ {false}

bool	cfg_ok_ {true}

Protected Attributes inherited from esphome::usb_host::USBClient
TransferRequest	requests_ [MAX_REQUESTS] {}

TaskHandle_t	usb_task_handle_ {nullptr}

usb_host_client_handle_t	handle_ {}

usb_device_handle_t	device_handle_ {}

int	device_addr_ {-1}

int	state_ {USB_CLIENT_INIT}

std::atomic< trq_bitmask_t >	trq_in_use_

uint16_t	vid_ {}

uint16_t	pid_ {}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Additional Inherited Members
Static Protected Member Functions inherited from esphome::usb_host::USBClient
static void	usb_task_fn (void *arg)

Detailed Description

Definition at line 188 of file usb_uart.h.

Constructor & Destructor Documentation

◆ USBUartComponent()

esphome::usb_uart::USBUartComponent::USBUartComponent	(	uint16_t	vid,
		uint16_t	pid )

inline

Definition at line 190 of file usb_uart.h.

Member Function Documentation

◆ add_channel()

void esphome::usb_uart::USBUartComponent::add_channel ( USBUartChannel * channel )

inline

Definition at line 196 of file usb_uart.h.

◆ apply_channel_settings()

void esphome::usb_uart::USBUartComponent::apply_channel_settings ( USBUartChannel * channel )

Definition at line 540 of file usb_uart.cpp.

◆ config_device_step()

virtual bool esphome::usb_uart::USBUartComponent::config_device_step	(	uint8_t	step,
		bool	ok,
		const uint8_t *	response )

inlineprotectedvirtual

Reimplemented in esphome::usb_uart::USBUartTypeCH34X.

Definition at line 237 of file usb_uart.h.

◆ config_step()

virtual bool esphome::usb_uart::USBUartComponent::config_step	(	USBUartChannel *	channel,
		uint8_t	step,
		bool	reload,
		bool	ok,
		const uint8_t *	response )

protectedpure virtual

Implemented in esphome::usb_uart::USBUartTypeCdcAcm, esphome::usb_uart::USBUartTypeCH34X, esphome::usb_uart::USBUartTypeCP210X, esphome::usb_uart::USBUartTypeFT23XX, and esphome::usb_uart::USBUartTypePL2303.

◆ config_transfer_()

void esphome::usb_uart::USBUartComponent::config_transfer_	(	uint8_t	type,
		uint8_t	request,
		uint16_t	value,
		uint16_t	index,
		const std::vector< uint8_t > &	data = {} )

protected

Definition at line 565 of file usb_uart.cpp.

◆ dump_config()

void esphome::usb_uart::USBUartComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::usb_host::USBClient.

Reimplemented in esphome::usb_uart::USBUartTypeCH34X.

Definition at line 263 of file usb_uart.cpp.

◆ enable_channels()

void esphome::usb_uart::USBUartComponent::enable_channels ( )

Definition at line 533 of file usb_uart.cpp.

◆ get_channels()

std::vector< USBUartChannel * > esphome::usb_uart::USBUartComponent::get_channels ( )

inline

Definition at line 194 of file usb_uart.h.

◆ loop()

void esphome::usb_uart::USBUartComponent::loop ( )

overridevirtual

Reimplemented from esphome::usb_host::USBClient.

Definition at line 215 of file usb_uart.cpp.

◆ on_rx_overflow()

virtual void esphome::usb_uart::USBUartComponent::on_rx_overflow ( USBUartChannel * channel )

inlinevirtual

Reimplemented in esphome::usb_uart::USBUartTypeFT23XX.

Definition at line 209 of file usb_uart.h.

◆ run_config_machine_()

bool esphome::usb_uart::USBUartComponent::run_config_machine_ ( )

protected

Definition at line 594 of file usb_uart.cpp.

◆ setup()

void esphome::usb_uart::USBUartComponent::setup ( )

overridevirtual

Reimplemented from esphome::usb_host::USBClient.

Definition at line 214 of file usb_uart.cpp.

◆ start_config_()

void esphome::usb_uart::USBUartComponent::start_config_ ( bool reload )

protected

Definition at line 554 of file usb_uart.cpp.

◆ start_input()

void esphome::usb_uart::USBUartComponent::start_input ( USBUartChannel * channel )

virtual

Reimplemented in esphome::usb_uart::USBUartTypeFT23XX.

Definition at line 280 of file usb_uart.cpp.

◆ start_output()

void esphome::usb_uart::USBUartComponent::start_output ( USBUartChannel * channel )

Definition at line 349 of file usb_uart.cpp.

Field Documentation

◆ cfg_active_

bool esphome::usb_uart::USBUartComponent::cfg_active_ {false}

protected

Definition at line 248 of file usb_uart.h.

◆ cfg_channel_idx_

uint8_t esphome::usb_uart::USBUartComponent::cfg_channel_idx_ {0}

protected

Definition at line 246 of file usb_uart.h.

◆ cfg_device_phase_

bool esphome::usb_uart::USBUartComponent::cfg_device_phase_ {false}

protected

Definition at line 250 of file usb_uart.h.

◆ cfg_done_

std::atomic<bool> esphome::usb_uart::USBUartComponent::cfg_done_ {false}

protected

Definition at line 244 of file usb_uart.h.

◆ cfg_in_flight_

bool esphome::usb_uart::USBUartComponent::cfg_in_flight_ {false}

protected

Definition at line 251 of file usb_uart.h.

◆ cfg_ok_

bool esphome::usb_uart::USBUartComponent::cfg_ok_ {true}

protected

Definition at line 252 of file usb_uart.h.

◆ cfg_pending_reload_

USBUartChannel* esphome::usb_uart::USBUartComponent::cfg_pending_reload_ {nullptr}

protected

Definition at line 243 of file usb_uart.h.

◆ cfg_reload_

bool esphome::usb_uart::USBUartComponent::cfg_reload_ {false}

protected

Definition at line 249 of file usb_uart.h.

◆ cfg_response_

uint8_t esphome::usb_uart::USBUartComponent::cfg_response_[8] {}

protected

Definition at line 245 of file usb_uart.h.

◆ cfg_single_

USBUartChannel* esphome::usb_uart::USBUartComponent::cfg_single_ {nullptr}

protected

Definition at line 242 of file usb_uart.h.

◆ cfg_step_

uint8_t esphome::usb_uart::USBUartComponent::cfg_step_ {0}

protected

Definition at line 247 of file usb_uart.h.

◆ channels_

std::vector<USBUartChannel *> esphome::usb_uart::USBUartComponent::channels_ {}

protected

Definition at line 239 of file usb_uart.h.

◆ chunk_pool_

EventPool<UsbDataChunk, USB_DATA_QUEUE_SIZE - 1> esphome::usb_uart::USBUartComponent::chunk_pool_

Definition at line 215 of file usb_uart.h.

◆ usb_data_queue_

LockFreeQueue<UsbDataChunk, USB_DATA_QUEUE_SIZE> esphome::usb_uart::USBUartComponent::usb_data_queue_

Definition at line 213 of file usb_uart.h.

◆ USB_DATA_QUEUE_SIZE

int esphome::usb_uart::USBUartComponent::USB_DATA_QUEUE_SIZE = 32

staticconstexpr

Definition at line 212 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

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USBUartComponent()

Member Function Documentation

◆ add_channel()

◆ apply_channel_settings()

◆ config_device_step()

◆ config_step()

◆ config_transfer_()

◆ dump_config()

◆ enable_channels()

◆ get_channels()

◆ loop()

◆ on_rx_overflow()

◆ run_config_machine_()

◆ setup()

◆ start_config_()

◆ start_input()

◆ start_output()

Field Documentation

◆ cfg_active_

◆ cfg_channel_idx_

◆ cfg_device_phase_

◆ cfg_done_

◆ cfg_in_flight_

◆ cfg_ok_

◆ cfg_pending_reload_

◆ cfg_reload_

◆ cfg_response_

◆ cfg_single_

◆ cfg_step_

◆ channels_

◆ chunk_pool_

◆ usb_data_queue_

◆ USB_DATA_QUEUE_SIZE