Espressif TinyUSB fork with DFU runtime
Go to file
Tomas Rezucha 7d72b63313 Update version to 0.14.1 2022-12-14 15:00:03 +01:00
.codespell add ignore-words to make it easier to 2022-12-04 21:28:30 +07:00
.github esp: ESP port commit 2022-12-14 14:59:41 +01:00
docs more typos 2022-12-04 19:44:01 +07:00
examples Merge pull request #1767 from pete-pjb/master 2022-12-05 12:45:48 +07:00
hw more typos 2022-12-04 19:44:01 +07:00
lib Fix typos 2022-12-04 19:43:23 +07:00
src Update version to 0.14.1 2022-12-14 15:00:03 +01:00
test move build Fuzzer into pre-commit 2022-12-08 11:31:39 +07:00
tools add get-dependencies.py 2022-07-01 17:23:14 +07:00
.codespellrc update .codespell 2022-12-08 10:05:52 +07: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 stm32u5: Fix submodules paths 2022-10-20 11:04:49 +02:00
.readthedocs.yaml rename to .readthedocs.yaml 2021-08-05 12:29:32 +07:00
CMakeLists.txt esp: ESP port commit 2022-12-14 14:59:41 +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 increase version, update doc for release 2022-02-23 11:55:57 +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-12-14 14:59:41 +01:00
README.rst more docs update 2022-08-19 17:14:53 +07:00
idf_component.yml esp: ESP port commit 2022-12-14 14:59:41 +01:00
pkg.yml Change mynewt package type to sdk 2020-05-07 10:11:58 +02:00
repository.yml update repository.yml 2022-08-23 12:00:20 +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.