Step 12 of 56

The examples: all 96 of them

Most need no wiring, most tell you PASS or FAIL, and each one is the fastest way to find out whether a peripheral works on your board before you write a line against it.

How to use them

Every example builds and runs the same way, and the short name is enough:

./x list                       # names, profiles, directories
./x run gpio0_blink            # build + flash + monitor
./x run i2c_loopback -p /dev/ttyACM0

Run the self-test before writing code. When a driver page here says a peripheral works, that is a claim about the authors' board. The matching example is how you turn it into a claim about yours — and most need no external wiring at all, using internal loopback or a pad the chip samples itself.

They are also meant to be read. Each opens with a header saying what it demonstrates, what the console should print, and what hardware it needs; magic numbers are named and the reasoning is in the code. examples/STYLE.md records the bar, with esp32s3_gpio0_blink and esp32s3_gdma_copy as the models.

Mind the profile column. An example built for embedded will not build under light-tasking — the RAII driver handles need finalization (step 8). That is the first thing to check when a copied example fails to compile.

The catalogue

Generated from ./x list --json and the examples' own headers, so it cannot drift from what the repository actually contains. The last column links to the step that explains the thing being demonstrated.