alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
6cb2080076
esp-idf/examples/peripherals/usb/host/cdc/cdc_acm_vcp
History
Daniel Paul 658b1de02c docs: Consistent naming convention for ESP Component Registry
2024-07-23 14:10:34 +08:00
..
main refactor(usb/examples): Depend on new esp_driver_gpio 2024-01-18 07:28:06 +01:00
CMakeLists.txt change(usb/examples): Trim the USB example builds 2023-10-10 10:28:47 +02:00
README.md docs: Consistent naming convention for ESP Component Registry 2024-07-23 14:10:34 +08:00
sdkconfig.defaults usb_host: Add Virtual COM Port CDC example 2022-04-22 09:50:46 +02:00

README.md

Supported Targets ESP32-P4 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 (VCP) devices, such as CP210x, FTDI FT23x or CH34x devices.

The drivers are fetched from ESP Component Registry together with VCP service that automatically loads correct driver for plugged-in device.

How to use example

  1. Connect your USB<->UART converter to ESP32-S2/S3, the device will be automatically enumerated and correct driver will be loaded
  2. Change baudrate and other line coding parameters in cdc_acm_vcp_example_main.cpp to match your needs
  3. Now you can use the usual CDC-ACM 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, FTDI FT23x or CP34x 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.