Examples

The ESP-IDF test application in examples/esp32, how to build it, and where to look for working code.

The application targets an ESP32-C6. CI builds every app below on each pull request.

The apps

App	What it shows	Source	CI
ws2812_comprehensive_test	Hardware test: channel set-up, colours (green first on the wire), brightness, an animation and a second strip	WS2812ComprehensiveTest.cpp	yes

Build and flash one (from examples/esp32, ESP-IDF environment loaded):

./scripts/build_app.sh ws2812_comprehensive_test Release
./scripts/flash_app.sh flash_monitor ws2812_comprehensive_test Release

Source of this table: examples/esp32/app_config.yml.

Set up once

git submodule update --init examples/esp32/scripts   # the HardFOC ESP-IDF build scripts
cd examples/esp32
. $IDF_PATH/export.sh                                 # ESP-IDF v5.5
./scripts/build_app.sh list                           # every app and build type

The scripts read app_config.yml (the same file this page's table comes from) and build each app as its own firmware image.

What to read

The test application drives a WS2812B strip on GPIO8 (and briefly a second one on GPIO4) and checks every return code: Begin(), red, green, blue and white for a second each, a walking pixel, a brightness ramp, the rainbow animator, then a second strip next to the first. Pins, length and timing are in esp32_ws2812_test_config.hpp. Other references:

You want to	Read
Light a strip with the fewest lines	tests/docs/quickstart.cpp (Quickstart)
Set pixels, dim, resize, animate, run two strips	tests/docs/api_tasks.cpp (API guide)
See exactly which pulses Show() sends	tests/test_strip.cpp (Testing and CI)
See what each effect draws per Tick()	tests/test_effects.cpp
Copy the ESP-IDF component wrapper	examples/esp32/components/hf_ws2812_rmt/