esphome::usb_cdc_acm Namespace Reference

Data Structures
struct	CDCEvent
class	USBCDCACMComponent
	Main USB CDC ACM component that manages the USB device and all CDC interfaces. More...
class	USBCDCACMInstance
	Represents a single CDC ACM interface instance. More...

Typedefs
using	LineCodingCallback = std::function<void(uint32_t bit_rate, uint8_t stop_bits, uint8_t parity, uint8_t data_bits)>
using	LineStateCallback = std::function<void(bool dtr, bool rts)>

Enumerations
enum	CDCEventType : uint8_t { CDC_EVENT_LINE_STATE_CHANGED , CDC_EVENT_LINE_CODING_CHANGED }

Functions
	ESPHOME_LOG_TAG (TAG, "usb_cdc_acm")
esp_err_t	ringbuf_read_bytes (RingbufHandle_t ring_buf, uint8_t *out_buf, size_t out_buf_sz, size_t *rx_data_size, TickType_t x_ticks_to_wait)

Variables
USBCDCACMComponent *	global_usb_cdc_component = nullptr

Typedef Documentation

LineCodingCallback

using esphome::usb_cdc_acm::LineCodingCallback = std::function<void(uint32_t bit_rate, uint8_t stop_bits, uint8_t parity, uint8_t data_bits)>

Definition at line 52 of file usb_cdc_acm.h.

LineStateCallback

using esphome::usb_cdc_acm::LineStateCallback = std::function<void(bool dtr, bool rts)>

Definition at line 53 of file usb_cdc_acm.h.

Enumeration Type Documentation

CDCEventType

enum esphome::usb_cdc_acm::CDCEventType : uint8_t

Enumerator
CDC_EVENT_LINE_STATE_CHANGED
CDC_EVENT_LINE_CODING_CHANGED

Definition at line 56 of file usb_cdc_acm.h.

Function Documentation

ESPHOME_LOG_TAG()

esphome::usb_cdc_acm::ESPHOME_LOG_TAG	(	TAG	,
		"usb_cdc_acm"	)

ringbuf_read_bytes()

esp_err_t esphome::usb_cdc_acm::ringbuf_read_bytes ( RingbufHandle_t ring_buf, uint8_t * out_buf, size_t out_buf_sz, size_t * rx_data_size, TickType_t x_ticks_to_wait )

inline

Definition at line 25 of file usb_cdc_acm.h.

Variable Documentation

global_usb_cdc_component

USBCDCACMComponent * esphome::usb_cdc_acm::global_usb_cdc_component = nullptr

Definition at line 12 of file usb_cdc_acm.cpp.