Skip to content

Commit bf53e2b

Browse files
How to use USBHID classes with ESP32-S2 and ESP32-S3 (#7214)
These instructions are based on esp32-arduino-lib-builder's build process, including https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/update-components.sh which explains how to clone tinyusb.
1 parent 5737016 commit bf53e2b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: docs/source/esp-idf_component.rst

+15
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,21 @@ Installation
3939
4040
.. note:: If you use Arduino with ESP-IDF often, you can place the arduino folder into global components folder.
4141

42+
If you're targeting the ESP32-S2 or ESP32-S3 and you want to use USBHID classes such as ``USBHID``, ``USBHIDConsumerControl``, ``USBHIDGamepad``, ``USBHIDKeyboard``, ``USBHIDMouse``, ``USBHIDSystemControl``, or ``USBHIDVendor``:
43+
44+
1. Clone these nested repos somewhere:
45+
46+
.. code-block:: bash
47+
48+
git clone https://github.com/espressif/esp32-arduino-lib-builder.git esp32-arduino-lib-builder && \
49+
git clone https://github.com/hathach/tinyusb.git esp32-arduino-lib-builder/components/arduino_tinyusb/tinyusb
50+
51+
2. In the project folder, edit ``CMakeLists.txt`` and add the following before the ``project()`` line:
52+
53+
.. code-block:: bash
54+
55+
set(EXTRA_COMPONENT_DIRS <path to esp32-arduino-lib-builder/components/arduino_tinyusb>)
56+
4257
Configuration
4358
-------------
4459

0 commit comments

Comments
 (0)