Skip to main content

​
Prerequisites

ESP32_USB_STREAM requires arduino-esp32 >= v2.0.14. Make sure you have the correct version installed before proceeding.

​
Required Dependencies

DependencyVersion
arduino-esp32>= v2.0.14

​
Installation Methods

1

Open Library Manager

In Arduino IDE, navigate to Sketch → Include Library → Manage LibrariesOr press Ctrl+Shift+I (Windows/Linux) or Cmd+Shift+I (macOS)
2

Search for ESP32_USB_STREAM

In the Library Manager search box, type ESP32_USB_STREAM
Make sure you have the ESP32 board package installed first. Go to Tools → Board → Boards Manager and install esp32 by Espressif Systems if you haven’t already.
3

Install the Library

Click the Install button next to the ESP32_USB_STREAM library entryWait for the installation to complete. The status will change to “INSTALLED”
4

Verify Installation

Check that the library is installed by going to Sketch → Include LibraryYou should see ESP32_USB_STREAM in the list of available libraries

​
Arduino IDE Version Compatibility

​
Verify Installation

After installation, verify that everything is working correctly:
1

Create a Test Sketch

Create a new sketch in Arduino IDE and add:
#include "USB_STREAM.h"

void setup() {
  Serial.begin(115200);
  USB_STREAM *usb = new USB_STREAM();
  Serial.println("ESP32_USB_STREAM library loaded successfully!");
}

void loop() {
  delay(1000);
}
2

Select Your Board

Go to Tools → Board and select your ESP32 board:
  • ESP32S2 Dev Module
  • ESP32S3 Dev Module
Or any other ESP32-S2/S3 variant you’re using
3

Verify Compilation

Click the Verify button (checkmark icon) or press Ctrl+RThe sketch should compile without errors. You should see:
Sketch uses X bytes (Y%) of program storage space.
Global variables use Z bytes (W%) of dynamic memory.
4

Check Examples

Verify that example sketches are available:Go to File → Examples → ESP32_USB_STREAMYou should see:
  • GettingStartUVC
  • GettingStartUAC
If you encounter compilation errors, ensure you have the correct arduino-esp32 version (>= v2.0.14) installed.

​
Updating the Library

​
Via Library Manager

  1. Open Sketch → Include Library → Manage Libraries
  2. Search for ESP32_USB_STREAM
  3. If an update is available, click the Update button

​
Manual Update

  1. Delete the existing ESP32_USB_Stream folder from your Arduino libraries directory
  2. Follow the manual installation steps above with the latest version

​
Troubleshooting

Make sure you have the ESP32 board package installed. The library may only appear when ESP32 boards are available.Update your Library Manager index: File → Preferences → Additional Boards Manager URLs should include:
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
Ensure your arduino-esp32 version is >= v2.0.14:
  1. Go to Tools → Board → Boards Manager
  2. Search for esp32
  3. Check the installed version
  4. Update if necessary
Restart Arduino IDE completely. If the issue persists, try reinstalling the library.

​
Next Steps

Quick Start Guide

Now that you have the library installed, let’s create your first USB streaming application

Build docs developers (and LLMs) love

Get started for freeTalk to us