alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 12:35:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
465ff85d2bbfe5d1a65d3afadfc7555be7f50b51
esp-idf/examples/peripherals/usb/host/cdc/cdc_acm_vcp
History
Frantisek Hrbata 1c92945f59 change(examples): switch examples to use a minimal build 
Currently, several example dependencies rely on the fact that all
registered components are added to the build, along with components
specified in common requirements. This results in longer build times
because even unused components must be built. Switch all examples to use
idf_minimal_build to compile only the components actually required by
the example.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-11-20 20:14:40 +01:00
..
main
refactor(usb/examples): Depend on new esp_driver_gpio
2024-01-18 07:28:06 +01:00
CMakeLists.txt
change(examples): switch examples to use a minimal build
2024-11-20 20:14:40 +01:00
README.md
docs(usb_host): Update usb_host example READMEs for P4
2024-10-31 09:00:59 +01:00
sdkconfig.defaults
refactor(usb_host_examples): Enabled Hub support by default
2024-10-07 10:13:10 +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 ESP board, 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

  • Development board with USB-OTG support
  • A USB cable for Power supply and programming
  • Silicon Labs CP210x, FTDI FT23x or CP34x USB to UART converter

Pin Assignment

Follow instruction in examples/usb/README.md for specific hardware setup.

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.