Espressif TinyUSB fork with DFU runtime
Go to file
Tomas Rezucha 120522d0f6 ci: Fix upload typo 2022-12-01 09:41:27 +01:00
.github ci: Fix upload typo 2022-12-01 09:41:27 +01:00
docs Fix typo 2021-12-22 22:56:53 +02:00
examples Merge pull request #1276 from kkitayam/fix_video_capture_frame_interval 2022-01-17 23:57:42 +07:00
hw Merge pull request #1283 from kasjer/kasjer/olimex-pic32-board-fixes 2022-01-19 09:55:18 +07:00
lib net_lwip_webserver: allow users to enable LWIP_IP6 if desired 2021-10-19 11:29:51 -05:00
src esp: Bump version to 0.12.1 2022-11-23 20:28:43 +01:00
test Add test CI. 2021-06-30 20:30:03 +02:00
tools Unify skip and only logic for build scripts 2022-01-05 15:44:23 -08:00
.gitattributes Add gitattributes 2020-01-15 14:46:12 -05:00
.gitignore Unify skip and only logic for build scripts 2022-01-05 15:44:23 -08:00
.gitmodules Merge branch 'master' into port-ft90x 2021-12-08 08:36:43 +00:00
.readthedocs.yaml rename to .readthedocs.yaml 2021-08-05 12:29:32 +07:00
CMakeLists.txt esp: ESP port commit 2022-11-23 20:28:36 +01:00
CODE_OF_CONDUCT.rst code_of_conduct: refactor file from markdown to restructuredtext 2021-07-30 12:46:30 +01:00
CONTRIBUTORS.rst remove ep descriptor wMaxPacketSize bitfield due to endian issue 2021-10-24 13:11:21 +07:00
LICENSE migrate license from BSD 3 clause to MIT 2019-03-20 16:11:42 +07:00
README.md esp: ESP port commit 2022-11-23 20:28:36 +01:00
README.rst correct link in rst 2022-01-17 12:15:54 +07:00
idf_component.yml esp: ESP port commit 2022-11-23 20:28:36 +01:00
pkg.yml Change mynewt package type to sdk 2020-05-07 10:11:58 +02:00
repository.yml increase version and update changelog 2021-08-30 12:44:38 +07:00
version.yml add repo & version yml 2018-09-02 16:44:27 +07:00

README.md

Espressif TinyUSB fork

This is a fork of upstream TinyUSB with integration into ESP-IDF build system. It is used mostly for rapid bugfixing and for releases independent from the upstream project. We try to push all bugfixes and features to the upstream.

How to use

There are two options of using TinyUSB with Espressif's SoCs.

1. Use this component together with Espressif TinyUSB additions

This is identical approach as in ESP-IDF 4.x releases. You can configure TinyUSB using Kconfig, as usual. Just add idf_component.yml to your main component with the following content::

## IDF Component Manager Manifest File
dependencies:
  esp_tinyusb: "^1.0.0" # Automatically update minor releases

Or simply run:

idf.py add-dependency esp_tinyusb^1.0.0

2. Use TinyUSB only, without the additions

Use this option for custom TinyUSB applications. In this case you will have to provide configuration header file tusb_config.h. More informatin about TinyUSB configuration can be found in official TinyUSB documentation.

You will also have to tell TinyUSB where to find the configuration file. This can be achieved by adding following CMake snippet to you main component's CMakeLists.txt:

idf_component_get_property(tusb_lib espressif__tinyusb COMPONENT_LIB)
target_include_directories(${tusb_lib} PRIVATE path_to_your_tusb_config)

Again, you can add this component to your project by adding idf_component.yml file:

## IDF Component Manager Manifest File
dependencies:
  tinyusb: "~0.12.1" # Automatically update bugfix releases. TinyUSB does not guarantee backward compatibility

Or simply run:

idf.py add-dependency tinyusb~0.12.1

README from the upstream TinyUSB can be found here.