#include <usb_host.h>

Inheritance diagram for esphome::usb_host::USBClient:

Public Member Functions
	USBClient (uint16_t vid, uint16_t pid)

void	init_pool ()

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)

void	control_transfer_callback (const usb_transfer_t *xfer) const

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

void	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)

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

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="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

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

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
bool	register_ ()

TransferRequest *	get_trq_ ()

virtual void	disconnect ()

virtual void	on_connected ()

virtual void	on_disconnected ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

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

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

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

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

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

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
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::list< TransferRequest * >	trq_pool_ {}

TransferRequest	requests_ [MAX_REQUESTS] {}

Protected Attributes inherited from esphome::Component
uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

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

std::string	error_message_ {}

Detailed Description

Definition at line 62 of file usb_host.h.

Constructor & Destructor Documentation

◆ USBClient()

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

inline

Definition at line 66 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 283 of file usb_host_client.cpp.

◆ control_transfer_callback()

void esphome::usb_host::USBClient::control_transfer_callback ( const usb_transfer_t * xfer ) const

◆ disconnect()

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

protectedvirtual

Definition at line 272 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 383 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 76 of file usb_host.h.

◆ get_trq_()

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

protected

Definition at line 260 of file usb_host_client.cpp.

◆ init_pool()

void esphome::usb_host::USBClient::init_pool ( )

inline

Definition at line 68 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 179 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 91 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 92 of file usb_host.h.

◆ on_opened()

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

Definition at line 236 of file usb_host_client.cpp.

◆ on_removed()

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

Definition at line 242 of file usb_host_client.cpp.

◆ register_()

bool esphome::usb_host::USBClient::register_ ( )

protected

◆ release_trq()

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

Definition at line 390 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 161 of file usb_host_client.cpp.

◆ transfer_in()

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

Performs a transfer input operation.

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

◆ transfer_out()

void 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.

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

Field Documentation

◆ device_addr_

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

protected

Definition at line 96 of file usb_host.h.

◆ device_handle_

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

protected

Definition at line 95 of file usb_host.h.

◆ handle_

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

protected

Definition at line 94 of file usb_host.h.

◆ pid_

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

protected

Definition at line 99 of file usb_host.h.

◆ requests_

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

protected

Definition at line 101 of file usb_host.h.

◆ state_

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

protected

Definition at line 97 of file usb_host.h.

◆ trq_pool_

std::list<TransferRequest *> esphome::usb_host::USBClient::trq_pool_ {}

protected

Definition at line 100 of file usb_host.h.

◆ vid_

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

protected

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

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ USBClient()

Member Function Documentation

◆ control_transfer()

◆ control_transfer_callback()

◆ disconnect()

◆ dump_config()

◆ get_setup_priority()

◆ get_trq_()

◆ init_pool()

◆ loop()

◆ on_connected()

◆ on_disconnected()

◆ on_opened()

◆ on_removed()

◆ register_()

◆ release_trq()

◆ setup()

◆ transfer_in()

◆ transfer_out()

Field Documentation

◆ device_addr_

◆ device_handle_

◆ handle_

◆ pid_

◆ requests_

◆ state_

◆ trq_pool_

◆ vid_