esp-idf/examples/peripherals/usb/host/cdc/cdc_acm_vcp/README.md
Tomas Rezucha 7fc0c14f4d usb_host: Add Virtual COM Port CDC example
This example implements usual UART/USB convertor driver.
Closes https://github.com/espressif/esp-idf/issues/8645
2022-04-22 09:50:46 +02:00

1.5 KiB

Supported Targets ESP32-S2 ESP32-S3

USB CDC-ACM Virtual Com Port example

(See the README.md file in the upper level 'examples' directory for more information about examples.)

This example shows how to extend CDC-ACM driver for Virtual Communication Port devices, such as CP210x or FTDI FT23x devices.

How to use example

  1. Pick your USB-to-UART device by executing idf.py menuconfig and navigating to Example Configuration -> USB-to-UART device type
  2. Change baudrate and other line coding parameters in cdc_acm_vcp.cpp to match your needs
  3. Now you can use the CDC-ACM to API to control the device and send data. Data are received in handle_rx callback
  4. Try disconnecting and then reconnecting of the USB device to experiment with USB hotplugging

Hardware Required

  • ESP board with USB-OTG supported
  • Silicon Labs CP210x or FTDI FT23x USB to UART converter

Connect USB_D+, USB_D-, GND and +5V signals of your ESP chip to matching signals on USB to UART converter.

Pin Assignment

See common pin assignments for USB Device examples from upper level.

Build and Flash

Build this project and flash it to the USB host board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(Replace PORT with the name of the serial port to use.)

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.