Symbols ![]()
loading...
Files ![]()
loading...
esp_usb::VCP class
Virtual COM Port Service Class Virtual COM Port (VCP) service manages drivers to connected VCP devices - typically USB UART converters. In practice, you rarely care about specifics of the devices; you only want uniform interface for them all. VCP service does just that, after you register drivers for various VCP devices, you can just call VCP::open and the service will load proper driver for device that was just plugged into USB port. Example usage:
{.cpp}
VCP::register_driver();
VCP::register_driver();
VCP::register_driver();
auto vcp = VCP::open(&dev_config);
The example code assumes that you have USB Host Lib already installed.Syntax
class VCP
{
public:
template<class T> static void
register_driver(void)
{
static_assert(T::pids.begin() != nullptr, "Every VCP driver must contain array of supported PIDs in 'pids' array");
static_assert(T::vid != 0, "Every VCP driver must contain supported VID in'vid' integer");
std::vector<uint16_t> pids(T::pids.begin(), T::pids.end());
vcp_driver new_driver = vcp_driver([](uint16_t pid, const cdc_acm_host_device_config_t *dev_config, uint8_t interface_idx) {
return static_cast<CdcAcmDevice *> (new T(pid, dev_config, interface_idx));
}, T::vid, pids);
drivers.push_back(new_driver);
}
static CdcAcmDevice *
open(uint16_t _vid, uint16_t _pid, const cdc_acm_host_device_config_t *dev_config, uint8_t interface_idx = 0);
static CdcAcmDevice *
open(const cdc_acm_host_device_config_t *dev_config, uint8_t interface_idx = 0);
private:
VCP() = delete;
VCP(const VCP &) = delete;
VCP &operator=(VCP &) = delete;
bool operator== (const VCP ¶m) = delete;
bool operator!= (const VCP ¶m) = delete;
typedef struct vcp_driver {
CdcAcmDevice *(*open)(uint16_t pid, const cdc_acm_host_device_config_t *dev_config, uint8_t interface_idx);
uint16_t vid;
std::vector<uint16_t> pids;
vcp_driver(auto open_func, const uint16_t _vid, const std::vector<uint16_t> &_pids): open(open_func), vid(_vid), pids(_pids) {};
} vcp_driver;
static std::vector<vcp_driver> drivers;
};
Fields
Field
Description
List of registered VCP drivers.