Examples
Each example is a small firmware project with its own main/, CMakeLists.txt, and environment wrappers. Build one example at a time while learning so the logs stay short and the hardware path is obvious.
Use this pattern for ESP32-S3 examples:
sh
cd examples/esp32s3/udp
. ./env.sh
idf.py build
idf.py -p /dev/ttyACM0 flash monitorUse the matching source ./env.fish form if your shell is fish. Run ./tools/arc-projects.py --buildable --format report from the repository root when you want the discovered project list grouped with target, experiment status, and build command.
ESP32-S3 Examples
| Example | What it teaches |
|---|---|
examples/esp32s3/bench | Real ESP32-S3 benchmark firmware with Arc, raw ESP-IDF, and optional Arduino-ESP32 surfaces in one run. |
examples/esp32s3/bridge | Complementary MCPWM outputs, dead-time, and a small app::boot() surface. |
examples/esp32s3/can | TWAI/CAN self-test loopback without an external CAN transceiver. |
examples/esp32s3/copy | DMA memcpy, coherent cache handoff, and exact completion tickets. |
examples/esp32s3/count | RMT pulse output feeding PCNT pulse counting through a jumper. |
examples/esp32s3/dsp | SIMD-capable buffers, DSP kernels, Core 1 compute, and snapshot reporting. |
examples/esp32s3/dvp | LCD_CAM DVP camera-capture skeleton. |
examples/esp32s3/espnow | ESP-NOW raw radio transport with the same Core 0/Core 1 shape as UDP. |
examples/esp32s3/i2c | I2C master bus/device ownership. |
examples/esp32s3/i2s | Duplex I2S DMA movement and arc::Result<std::size_t> read/write paths. |
examples/esp32s3/i80 | LCD_CAM Intel 8080 DMA display/peripheral output. |
examples/esp32s3/net_client | TCP/TLS/HTTP-style client-side network building blocks. |
examples/esp32s3/ota | OTA slot inspection, image state, and flash capacity reporting. |
examples/esp32s3/probe | Cycle-counter measurement, min/avg/max stats, and Core 1 reporting. |
examples/esp32s3/pulse | MCPWM waveform generation plus MCPWM capture timing. |
examples/esp32s3/pwm | LEDC hardware PWM without a pinned task or busy loop. |
examples/esp32s3/scope | ADC continuous DMA capture and parsed sample frames. |
examples/esp32s3/sigma | Sigma-Delta pulse-density output. |
examples/esp32s3/sleep | RTC-retained boot counter, wake causes, and deep sleep. |
examples/esp32s3/space | Runtime flash, partition, image, and heap capacity reports. |
examples/esp32s3/spi | SPI DMA loopback with coherent queue and finish. |
examples/esp32s3/store | Typed NVS config, fixed text storage, and capacity reporting. |
examples/esp32s3/temp | Internal die-temperature telemetry. |
examples/esp32s3/timer | GPTimer alarm ISR and free-running counter logging. |
examples/esp32s3/trace | RMT transmit/capture loopback for symbol timing. |
examples/esp32s3/uart | UART ownership and byte movement. |
examples/esp32s3/udp | The first full transport example: Core 1 work plus Core 0 Wi-Fi/UDP. |
Portable Example
| Example | What it teaches |
|---|---|
examples/portable/pack | Fixed binary arc::pack records outside a full ESP32-S3 firmware build. |
Experimental ESP32-S31 Scaffolds
These projects are present so the intended API shape is visible, but they stay gated behind ARC_TARGET=esp32s31 and ARC_EXPERIMENTAL_ESP32S31=ON until a usable ESP32-S31 ESP-IDF target exists in the pinned SDK.
They share examples/esp32s31/sdkconfig.defaults for the Korvo-class 16 MB flash layout and PSRAM auto-detect path.
Run ./tools/s31-readiness.py --format report to separate Arc scaffold drift from missing local ESP-IDF esp32s31 target metadata. Use --require-sdk only when the preview SDK target should already be present.
| Example | Intended surface |
|---|---|
examples/esp32s31/amp | ESP32-S31-Korvo-1 Core0/Core1 migration policy scaffolding; true bare-core AMP remains off until an S31 policy exists. |
examples/esp32s31/audio | ESP32-S31-Korvo-1 audio codec, PA enable pin, and DMA buffer scaffolding. |
examples/esp32s31/cam | Camera/data-path scaffolding with ESP32-S31-Korvo-1 board topology facts. |
examples/esp32s31/console | ESP32-S31-Korvo-1 UART0 console topology and guarded UART contract. |
examples/esp32s31/control | ESP32-S31-Korvo-1 control-loop scaffolding on the S31 core map. |
examples/esp32s31/io | ESP32-S31-Korvo-1 ADC button and WS2812 status LED RMT ownership facts. |
examples/esp32s31/lcd | ESP32-S31-Korvo-1 RGB LCD topology, strap-overlapped control pins, and DMA frame ownership. |
examples/esp32s31/ml | ESP32-S31-Korvo-1 fixed-shape ML scaffolding. |
examples/esp32s31/ptp | Precision-time scaffolding; Korvo needs an external Ethernet PHY path for hardware timestamping. |
examples/esp32s31/radio | ESP32-S31-Korvo-1 Wi-Fi 6, Bluetooth 5.4, Bluetooth Classic, BLE, IEEE 802.15.4, Zigbee 3.0, Thread 1.4, and guarded Arc ESP-NOW/BLE Mesh/Thread contracts. |
examples/esp32s31/sd | ESP32-S31-Korvo-1 onboard microSD pin topology, strap-overlapped control GPIO, and guarded SDMMC mount contract. |
examples/esp32s31/security | ESP32-S31 secure boot, flash encryption, TEE, PUF, WorldGuard, and Arc SecureBoot/WorldGuard/PUF/Cloak contract scaffolding. |
examples/esp32s31/usb | ESP32-S31-Korvo-1 USB OTG PHY ownership and USB descriptor scaffolding. |
Reading Order
- Build
examples/esp32s3/udpif you want the complete Arc shape. - Build the smallest hardware example near your peripheral.
- Open Module Guide to find the matching header.
- Open API Reference for exact methods and failure behavior.