#include <usb_host.h>

Inheritance diagram for esphome::usb_host::USBClient:

Public Member Functions
	USBClient (uint16_t vid, uint16_t pid)

void	setup () override

void	loop () override

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	dump_config () override

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={})

void	set_manufacturer_filter (const char16_t *manufacturer)

void	set_product_filter (const char16_t *product)

bool	is_connected () const
	Whether a device has been opened and its setup by the subclass has finished.

bool	get_device_info (UsbDeviceInfo &info) const
	Copy the connected device's identity out of the cached USB descriptors.

template<typename F >
void	add_on_connection_callback (F &&callback)
	Register a callback for the device this client claims being connected (true) or removed (false).

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)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

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< UsbEvent, USB_EVENT_QUEUE_SIZE >	event_queue

EventPool< UsbEvent, USB_EVENT_QUEUE_SIZE - 1 >	event_pool

Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Protected Member Functions
bool	process_usb_events_ ()

void	handle_open_state_ ()

TransferRequest *	get_trq_ ()

virtual void	disconnect ()

virtual void	on_connected ()

virtual bool	reports_connection_itself () const
	Whether the subclass reports the device as connected itself, once its own setup of the device has finished, rather than as soon as the device has been opened.

void	report_connected_ ()
	Report the claimed device to the connection callbacks.

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.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

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_ ()

Static Protected Member Functions
static void	usb_task_fn (void *arg)

Protected Attributes
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}

LazyCallbackManager< void(bool)>	connection_callback_

std::atomic< trq_bitmask_t >	trq_in_use_

const char16_t *	manufacturer_filter_ {nullptr}

const char16_t *	product_filter_ {nullptr}

uint16_t	vid_ {}

uint16_t	pid_ {}

bool	connection_reported_ {false}

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_

Detailed Description

Definition at line 150 of file usb_host.h.

Constructor & Destructor Documentation

◆ USBClient()

esphome::usb_host::USBClient::USBClient	(	uint16_t	vid,
		uint16_t	pid )

inline

Definition at line 154 of file usb_host.h.

Member Function Documentation

◆ add_on_connection_callback()

template<typename F >

void esphome::usb_host::USBClient::add_on_connection_callback ( F && callback )

inline

Register a callback for the device this client claims being connected (true) or removed (false).

Fires only for a device that was fully opened, so a device another client claims is never reported. Called from the main loop: connected once the device has been enumerated and the subclass has finished its setup of it (whether or not that setup succeeded), removed after on_disconnected() has run. This tracks the device's presence, not whether a given channel is usable.

Definition at line 184 of file usb_host.h.

◆ control_transfer()

bool esphome::usb_host::USBClient::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 = {} )

Definition at line 519 of file usb_host_client.cpp.

◆ disconnect()

void esphome::usb_host::USBClient::disconnect ( )

protectedvirtual

Definition at line 499 of file usb_host_client.cpp.

◆ dump_config()

void esphome::usb_host::USBClient::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::usb_uart::USBUartComponent, and esphome::usb_uart::USBUartTypeCH34X.

Definition at line 652 of file usb_host_client.cpp.

◆ get_device_info()

bool esphome::usb_host::USBClient::get_device_info ( UsbDeviceInfo & info ) const

Copy the connected device's identity out of the cached USB descriptors.

Returns false when no device is connected or the host stack refused the query.

Definition at line 204 of file usb_host_client.cpp.

◆ get_setup_priority()

float esphome::usb_host::USBClient::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 158 of file usb_host.h.

◆ get_trq_()

TransferRequest * esphome::usb_host::USBClient::get_trq_ ( )

protected

Definition at line 470 of file usb_host_client.cpp.

◆ get_trq_in_use()

trq_bitmask_t esphome::usb_host::USBClient::get_trq_in_use ( ) const

inline

Definition at line 165 of file usb_host.h.

◆ handle_open_state_()

void esphome::usb_host::USBClient::handle_open_state_ ( )

protected

Definition at line 356 of file usb_host_client.cpp.

◆ is_connected()

bool esphome::usb_host::USBClient::is_connected ( ) const

inline

Whether a device has been opened and its setup by the subclass has finished.

Definition at line 172 of file usb_host.h.

◆ loop()

void esphome::usb_host::USBClient::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::usb_uart::USBUartComponent.

Definition at line 350 of file usb_host_client.cpp.

◆ on_connected()

virtual void esphome::usb_host::USBClient::on_connected ( )

inlineprotectedvirtual

Reimplemented in esphome::usb_uart::USBUartTypeCdcAcm.

Definition at line 204 of file usb_host.h.

◆ on_disconnected()

virtual void esphome::usb_host::USBClient::on_disconnected ( )

inlineprotectedvirtual

Reimplemented in esphome::usb_uart::USBUartTypeCdcAcm.

Definition at line 212 of file usb_host.h.

◆ on_opened()

void esphome::usb_host::USBClient::on_opened ( uint8_t addr )

Definition at line 432 of file usb_host_client.cpp.

◆ on_removed()

void esphome::usb_host::USBClient::on_removed ( usb_device_handle_t handle )

Definition at line 438 of file usb_host_client.cpp.

◆ process_usb_events_()

bool esphome::usb_host::USBClient::process_usb_events_ ( )

protected

Definition at line 317 of file usb_host_client.cpp.

◆ release_trq()

void esphome::usb_host::USBClient::release_trq ( TransferRequest * trq )

Definition at line 672 of file usb_host_client.cpp.

◆ report_connected_()

void esphome::usb_host::USBClient::report_connected_ ( )

protected

Report the claimed device to the connection callbacks.

Idempotent; a subclass that reports itself calls this once the device is ready to use.

Definition at line 424 of file usb_host_client.cpp.

◆ reports_connection_itself()

virtual bool esphome::usb_host::USBClient::reports_connection_itself ( ) const

inlineprotectedvirtual

Whether the subclass reports the device as connected itself, once its own setup of the device has finished, rather than as soon as the device has been opened.

Reimplemented in esphome::usb_uart::USBUartComponent.

Definition at line 208 of file usb_host.h.

◆ set_manufacturer_filter()

void esphome::usb_host::USBClient::set_manufacturer_filter ( const char16_t * manufacturer )

inline

Definition at line 168 of file usb_host.h.

◆ set_product_filter()

void esphome::usb_host::USBClient::set_product_filter ( const char16_t * product )

inline

Definition at line 169 of file usb_host.h.

◆ setup()

void esphome::usb_host::USBClient::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::usb_uart::USBUartComponent.

Definition at line 276 of file usb_host_client.cpp.

◆ transfer_in()

bool esphome::usb_host::USBClient::transfer_in	(	uint8_t	ep_address,
		const transfer_cb_t &	callback,
		uint16_t	length )

Performs a transfer input operation.

THREAD CONTEXT: Called from both USB task and main loop threads!

USB task: USB UART input callbacks call start_input() which calls this
Main loop: Initial setup and other components

Parameters

ep_address	The endpoint address.
callback	The callback function to be called when the transfer is complete.
length	The length of the data to be transferred.

Exceptions

None.

Definition at line 587 of file usb_host_client.cpp.

◆ transfer_out()

bool esphome::usb_host::USBClient::transfer_out	(	uint8_t	ep_address,
		const transfer_cb_t &	callback,
		const uint8_t *	data,
		uint16_t	length )

Performs an output transfer operation.

THREAD CONTEXT: Called from both USB task and main loop threads.

USB task: output transfer callback restarts output directly (no defer)
Main loop: initial output trigger from write_array() and loop() Thread safety is ensured by:
get_trq_() uses atomic CAS (multi-consumer safe)
claimed trq slot is exclusively owned until submission
usb_host_transfer_submit() is safe to call from any task context

Parameters

ep_address	The endpoint address.
callback	The callback function to be called when the transfer is complete.
data	The data to be transferred.
length	The length of the data to be transferred.

Exceptions

None.

Definition at line 628 of file usb_host_client.cpp.

◆ usb_task_fn()

void esphome::usb_host::USBClient::usb_task_fn ( void * arg )

staticprotected

Definition at line 307 of file usb_host_client.cpp.

◆ usb_task_loop_()

void esphome::usb_host::USBClient::usb_task_loop_ ( ) const

protected

Definition at line 311 of file usb_host_client.cpp.

Field Documentation

◆ connection_callback_

LazyCallbackManager<void(bool)> esphome::usb_host::USBClient::connection_callback_

protected

Definition at line 228 of file usb_host.h.

◆ connection_reported_

bool esphome::usb_host::USBClient::connection_reported_ {false}

protected

Definition at line 239 of file usb_host.h.

◆ device_addr_

int esphome::usb_host::USBClient::device_addr_ {-1}

protected

Definition at line 226 of file usb_host.h.

◆ device_handle_

usb_device_handle_t esphome::usb_host::USBClient::device_handle_ {}

protected

Definition at line 225 of file usb_host.h.

◆ event_pool

EventPool<UsbEvent, USB_EVENT_QUEUE_SIZE - 1> esphome::usb_host::USBClient::event_pool

Definition at line 194 of file usb_host.h.

◆ event_queue

LockFreeQueue<UsbEvent, USB_EVENT_QUEUE_SIZE> esphome::usb_host::USBClient::event_queue

Definition at line 190 of file usb_host.h.

◆ handle_

usb_host_client_handle_t esphome::usb_host::USBClient::handle_ {}

protected

Definition at line 224 of file usb_host.h.

◆ manufacturer_filter_

const char16_t* esphome::usb_host::USBClient::manufacturer_filter_ {nullptr}

protected

Definition at line 233 of file usb_host.h.

◆ pid_

uint16_t esphome::usb_host::USBClient::pid_ {}

protected

Definition at line 236 of file usb_host.h.

◆ product_filter_

const char16_t* esphome::usb_host::USBClient::product_filter_ {nullptr}

protected

Definition at line 234 of file usb_host.h.

◆ requests_

TransferRequest esphome::usb_host::USBClient::requests_[MAX_REQUESTS] {}

protected

Definition at line 222 of file usb_host.h.

◆ state_

int esphome::usb_host::USBClient::state_ {USB_CLIENT_INIT}

protected

Definition at line 227 of file usb_host.h.

◆ trq_in_use_

std::atomic<trq_bitmask_t> esphome::usb_host::USBClient::trq_in_use_

protected

Definition at line 232 of file usb_host.h.

◆ usb_task_handle_

TaskHandle_t esphome::usb_host::USBClient::usb_task_handle_ {nullptr}

protected

Definition at line 223 of file usb_host.h.

◆ vid_

uint16_t esphome::usb_host::USBClient::vid_ {}

protected

Definition at line 235 of file usb_host.h.

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

esphome/components/usb_host/usb_host.h
esphome/components/usb_host/usb_host_client.cpp

Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ USBClient()

Member Function Documentation

◆ add_on_connection_callback()

◆ control_transfer()

◆ disconnect()

◆ dump_config()

◆ get_device_info()

◆ get_setup_priority()

◆ get_trq_()

◆ get_trq_in_use()

◆ handle_open_state_()

◆ is_connected()

◆ loop()

◆ on_connected()

◆ on_disconnected()

◆ on_opened()

◆ on_removed()

◆ process_usb_events_()

◆ release_trq()

◆ report_connected_()

◆ reports_connection_itself()

◆ set_manufacturer_filter()

◆ set_product_filter()

◆ setup()

◆ transfer_in()

◆ transfer_out()

◆ usb_task_fn()

◆ usb_task_loop_()

Field Documentation

◆ connection_callback_

◆ connection_reported_

◆ device_addr_

◆ device_handle_

◆ event_pool

◆ event_queue

◆ handle_

◆ manufacturer_filter_

◆ pid_

◆ product_filter_

◆ requests_

◆ state_

◆ trq_in_use_

◆ usb_task_handle_

◆ vid_