mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 20:41:14 +00:00

Files

Frantisek Hrbata 1c92945f59 change(examples): switch examples to use a minimal build

Currently, several example dependencies rely on the fact that all
registered components are added to the build, along with components
specified in common requirements. This results in longer build times
because even unused components must be built. Switch all examples to use
idf_minimal_build to compile only the components actually required by
the example.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>

2024-11-20 20:14:40 +01:00

main

refactor(usb_host_examples): Enabled Hub support by default

2024-10-07 10:13:10 +02:00

CMakeLists.txt

change(examples): switch examples to use a minimal build

2024-11-20 20:14:40 +01:00

pytest_usb_host_msc.py

ci: Added esp32p4 usb tests to CI:

2024-02-29 10:35:09 +01:00

README.md

docs(usb_host): Update usb_host example READMEs for P4

2024-10-31 09:00:59 +01:00

sdkconfig.defaults

refactor(usb_host_examples): Enabled Hub support by default

2024-10-07 10:13:10 +02:00

README.md

Supported Targets	ESP32-P4	ESP32-S2	ESP32-S3

USB Mass Storage Class example

Overview

This example demonstrates usage of the MSC (Mass Storage Class) to access storage on a USB flash drive. Upon connection of the flash drive, it is mounted to the Virtual filesystem. The following example operations are then performed:

Print device info (capacity, sectors size, and count...)
List all folders and files in the root directory of the USB flash drive
Create ESP subdirectory (if not present already), as well as a text.txt file
Run read/write benchmarks by transferring 1 MB of data to a dummy file

Note: This example currently supports only FAT-formatted drives. Other file systems, such as exFAT or NTFS, are not compatible with this example. Please ensure that your USB drive is formatted as FAT to avoid compatibility issues.

USB Reconnections

The example is run in a loop so that it can demonstrate USB connection and reconnection handling. If you want to deinitialize the entire USB Host Stack, you can short GPIO0 to GND. GPIO0 is usually mapped to a BOOT button, thus pressing the button will deinitialize the stack.

Hardware Required

Development board with USB-OTG support
A USB cable for Power supply and programming
A USB flash drive

Common Pin Assignments

Follow instructions in examples/usb/README.md for specific hardware setup.

Additionally, GPIO0 can be shorted to ground in order to deinitialize USB stack.

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example Output

...
I (380) example: Waiting for USB flash drive to be connected
I (790) example: MSC device connected
...
Device info:
         Capacity: 29339 MB
         Sector size: 512
         Sector count: 60088319
         PID: 0x5595
         VID: 0x0781
         iProduct:  SanDisk 3.2Gen1
         iManufacturer:  USB
         iSerialNumber: 0401545df64623a907abf299bae54c9
I (990) example: ls command output:
SYSTEM~1
ESP
DUMMY
I (1000) example: Reading file
I (1010) example: Read from file '/usb/esp/test.txt': 'Hello World!'
I (1030) example: Writing to file /usb/esp/dummy
I (2160) example: Write speed 0.93 MiB/s
I (2160) example: Reading from file /usb/esp/dummy
I (3110) example: Read speed 1.10 MiB/s
I (3140) example: Example finished, you can disconnect the USB flash drive