espressif_idf-extra-components/usb/esp_tinyusb/README.md

1.3 KiB

Espressif's additions to TinyUSB

Component Registry

This component adds features to TinyUSB that help users with integrating TinyUSB with their ESP-IDF application.

It contains:

  • Configuration of USB device and string descriptors
  • USB Serial Device (CDC-ACM) with optional Virtual File System support
  • Input and output streams through USB Serial Device
  • Other USB classes (MIDI, MSC, HID…) support directly via TinyUSB
  • VBUS monitoring for self-powered devices

Documentation and examples

You can find documentation in ESP-IDF Programming Guide.

You can find examples in ESP-IDF on GitHub.

How to use?

This component is distributed via IDF component manager. Just add idf_component.yml file to your main component with the following content:

## IDF Component Manager Manifest File
dependencies:
  esp_tinyusb: "~1.0.0"

Or simply run:

idf.py add-dependency esp_tinyusb~1.0.0