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

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

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

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

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Data Fields
LockFreeQueue< UsbEvent, USB_EVENT_QUEUE_SIZE >	event_queue

EventPool< UsbEvent, USB_EVENT_QUEUE_SIZE >	event_pool

Protected Member Functions
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
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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 (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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 (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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 (uint32_t id)

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

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

uint16_t	vid_ {}

uint16_t	pid_ {}

std::atomic< trq_bitmask_t >	trq_in_use_

TransferRequest	requests_ [MAX_REQUESTS] {}

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

Definition at line 126 of file usb_host.h.

Constructor & Destructor Documentation

◆ USBClient()

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

inline

Definition at line 130 of file usb_host.h.

Member Function Documentation

◆ 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 398 of file usb_host_client.cpp.

◆ disconnect()

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

protectedvirtual

Definition at line 385 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.

Definition at line 517 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 134 of file usb_host.h.

◆ get_trq_()

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

protected

Definition at line 356 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 141 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 240 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 153 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 154 of file usb_host.h.

◆ on_opened()

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

Definition at line 318 of file usb_host_client.cpp.

◆ on_removed()

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

Definition at line 324 of file usb_host_client.cpp.

◆ release_trq()

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

Definition at line 530 of file usb_host_client.cpp.

◆ setup()

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

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::usb_uart::USBUartComponent.

Definition at line 199 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 466 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 main loop thread only

USB UART output uses defer() to ensure main loop context
Modbus and other components call from loop()

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 498 of file usb_host_client.cpp.

◆ usb_task_fn()

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

staticprotected

Definition at line 230 of file usb_host_client.cpp.

◆ usb_task_loop()

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

protected

Definition at line 234 of file usb_host_client.cpp.

Field Documentation

◆ device_addr_

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

protected

Definition at line 167 of file usb_host.h.

◆ device_handle_

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

protected

Definition at line 166 of file usb_host.h.

◆ event_pool

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

Definition at line 148 of file usb_host.h.

◆ event_queue

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

Definition at line 147 of file usb_host.h.

◆ handle_

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

protected

Definition at line 165 of file usb_host.h.

◆ pid_

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

protected

Definition at line 170 of file usb_host.h.

◆ requests_

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

protected

Definition at line 176 of file usb_host.h.

◆ state_

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

protected

Definition at line 168 of file usb_host.h.

◆ trq_in_use_

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

protected

Definition at line 175 of file usb_host.h.

◆ usb_task_handle_

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

protected

Definition at line 163 of file usb_host.h.

◆ vid_

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

protected

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

◆ control_transfer()

◆ disconnect()

◆ dump_config()

◆ get_setup_priority()

◆ get_trq_()

◆ get_trq_in_use()

◆ loop()

◆ on_connected()

◆ on_disconnected()

◆ on_opened()

◆ on_removed()

◆ release_trq()

◆ setup()

◆ transfer_in()

◆ transfer_out()

◆ usb_task_fn()

◆ usb_task_loop()

Field Documentation

◆ device_addr_

◆ device_handle_

◆ event_pool

◆ event_queue

◆ handle_

◆ pid_

◆ requests_

◆ state_

◆ trq_in_use_

◆ usb_task_handle_

◆ vid_