You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Espressif TinyUSB fork
1
+
# Espressif TinyUSB component
2
2
3
-
This is a fork of upstream [TinyUSB](https://github.com/hathach/tinyusb) with integration into ESP-IDF build system.
4
-
It is used mostly for rapid bugfixing and for releases independent from the upstream project.
5
-
We try to push all bugfixes and features to the upstream.
3
+
Upstream [TinyUSB](https://github.com/hathach/tinyusb) fork with integration into ESP-IDF build system.
6
4
7
5
## How to use
8
6
9
-
There are two options of using TinyUSB with Espressif's SoCs.
7
+
There are two options of using TinyUSB component with Espressif's SoCs:
10
8
11
-
### 1. Use this component together with [Espressif TinyUSB additions](https://github.com/espressif/idf-extra-components/tree/master/usb/esp_tinyusb/)
9
+
### 1. Use component via [Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb)
12
10
13
-
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::
11
+
[Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb) provides several preconfigured features to use benefits of TinyUSB stack faster.
12
+
13
+
To use [Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb), add ``idf_component.yml`` to your main component with the following content::
14
14
15
15
```yaml
16
16
## IDF Component Manager Manifest File
@@ -22,7 +22,10 @@ Or simply run:
22
22
```
23
23
idf.py add-dependency "esp_tinyusb^1.0.0"
24
24
```
25
-
### 2. Use TinyUSB only, without the [additions](https://github.com/espressif/idf-extra-components/tree/master/usb/esp_tinyusb/)
25
+
26
+
Then, the Espressif TinyUSB component will be added automatically during resolving dependencies by the component manager.
27
+
28
+
### 2. Use component directly
26
29
27
30
Use this option for custom TinyUSB applications.
28
31
In this case you will have to provide configuration header file ``tusb_config.h``. More information about TinyUSB configuration can be found [in official TinyUSB documentation](https://docs.tinyusb.org/en/latest/reference/getting_started.html).
0 commit comments