ESPHome 2025.6.0
Loading...
Searching...
No Matches
esphome::usb_uart::USBUartComponent Class Reference

#include <usb_uart.h>

Inheritance diagram for esphome::usb_uart::USBUartComponent:
esphome::usb_host::USBClient esphome::Component esphome::usb_uart::USBUartTypeCdcAcm esphome::usb_uart::USBUartTypeCH34X esphome::usb_uart::USBUartTypeCP210X

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)
 
void start_input (USBUartChannel *channel)
 
void start_output (USBUartChannel *channel)
 
- Public Member Functions inherited from esphome::usb_host::USBClient
 USBClient (uint16_t vid, uint16_t pid)
 
void init_pool ()
 
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 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 Attributes

std::vector< USBUartChannel * > channels_ {}
 
- Protected Attributes inherited from esphome::usb_host::USBClient
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_ {}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::usb_host::USBClient
bool register_ ()
 
TransferRequestget_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.
 

Detailed Description

Definition at line 104 of file usb_uart.h.

Constructor & Destructor Documentation

◆ USBUartComponent()

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

Definition at line 106 of file usb_uart.h.

Member Function Documentation

◆ add_channel()

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

Definition at line 112 of file usb_uart.h.

◆ dump_config()

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

Reimplemented from esphome::usb_host::USBClient.

Definition at line 178 of file usb_uart.cpp.

◆ get_channels()

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

Definition at line 110 of file usb_uart.h.

◆ loop()

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

Reimplemented from esphome::usb_host::USBClient.

Definition at line 177 of file usb_uart.cpp.

◆ setup()

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

Reimplemented from esphome::usb_host::USBClient.

Definition at line 176 of file usb_uart.cpp.

◆ start_input()

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

Definition at line 193 of file usb_uart.cpp.

◆ start_output()

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

Definition at line 224 of file usb_uart.cpp.

Field Documentation

◆ channels_

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

Definition at line 118 of file usb_uart.h.


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