mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Peter Marcisovsky 1302fd70ba ci: Add esp32s3 runner for usb device example tests - CI USB device tests are run on esp32s3 - usb_host env_marker removed - not used anymore - failing usb_device_ncm test fixed		2024-02-29 15:10:18 +01:00
..
main	change(usb/examples): Trim the USB example builds	2023-10-10 10:28:47 +02:00
CMakeLists.txt	feat(esp32p4): Add USB-OTG support for ESP32-P4	2024-01-30 15:07:11 +01:00
pytest_usb_device_console.py	ci: Add esp32s3 runner for usb device example tests	2024-02-29 15:10:18 +01:00
README.md	feat(esp32p4): Add USB-OTG support for ESP32-P4	2024-01-30 15:07:11 +01:00
sdkconfig.defaults	tinyusb: Use TinyUSB from component registry	2022-11-02 08:24:43 +01:00

README.md

Supported Targets	ESP32-P4	ESP32-S2	ESP32-S3

TinyUSB Sample Descriptor

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

This example shows how to set up ESP chip to get log output via Serial Device connection.

As a USB stack, a TinyUSB component is used.

How to use example

Hardware Required

Any ESP boards that have USB-OTG supported.

Pin Assignment

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

Build and Flash

Build the project and flash it to the 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.

Serial Connection

After program's start and getting of the message of readiness (Serial device is ready to connect) you can connect to the board using any serial port terminal application (e.g. CoolTerm).

Note: if you want to send data to the target see how to implement it via tud_cdc_rx_cb at the tusb_serial_device example.

Example Output

After the flashing you should see the output at idf monitor:

I (288) example: USB initialization
I (288) tusb_desc:
┌─────────────────────────────────┐
│  USB Device Descriptor Summary  │
├───────────────────┬─────────────┤
│bDeviceClass       │ 239         │
├───────────────────┼─────────────┤
│bDeviceSubClass    │ 2           │
├───────────────────┼─────────────┤
│bDeviceProtocol    │ 1           │
├───────────────────┼─────────────┤
│bMaxPacketSize0    │ 64          │
├───────────────────┼─────────────┤
│idVendor           │ 0x303a      │
├───────────────────┼─────────────┤
│idProduct          │ 0x4001      │
├───────────────────┼─────────────┤
│bcdDevice          │ 0x100       │
├───────────────────┼─────────────┤
│iManufacturer      │ 0x1         │
├───────────────────┼─────────────┤
│iProduct           │ 0x2         │
├───────────────────┼─────────────┤
│iSerialNumber      │ 0x3         │
├───────────────────┼─────────────┤
│bNumConfigurations │ 0x1         │
└───────────────────┴─────────────┘
I (458) TinyUSB: TinyUSB Driver installed
I (468) example: USB initialization DONE
I (468) example: log -> UART
example: print -> stdout
example: print -> stderr
...

Other log will be printed to USB:

I (3478) example: log -> USB
example: print -> stdout
example: print -> stderr