# Examples

Every example here is a real NSX app: an `nsx.yml`, a `CMakeLists.txt` and source, built by
the same commands as an app you generate. They are the fastest way to see how a capability
is wired before you wire it yourself.

From a source checkout you can build any of them by name, because the positional app
argument resolves under `./examples`:

```bash
nsx build hello_world --board apollo510_evb
```

Several declare more than one target, so `--board` picks which one you are building. See
[Boards and targets](https://ambiqai.github.io/neuralspotx/guides/apps/boards-and-targets/).

## What each one covers

| Example | Tier | Status | Capabilities | Boards tested |
| --- | --- | --- | --- | --- |
| [FreeRTOS Blinky](https://ambiqai.github.io/neuralspotx/guides/examples/freertos_blinky/) | Basics | `tested` | `freertos`, `rtos` | `apollo510_evb` |
| [Hello World](https://ambiqai.github.io/neuralspotx/guides/examples/hello_world/) | Basics | `tested` | `swo`, `printf` | `apollo510_evb` |
| [USB Serial](https://ambiqai.github.io/neuralspotx/guides/examples/usb_serial/) | Basics | `tested` | `usb`, `cdc-acm` | `apollo510_evb` |
| [Audio Capture](https://ambiqai.github.io/neuralspotx/guides/examples/audio_capture/) | Capabilities | `tested` | `audio`, `pdm` | `apollo510_evb` |
| [CoreMark](https://ambiqai.github.io/neuralspotx/guides/examples/coremark/) | Capabilities | `builds` | `benchmark`, `rtt`, `itcm` | none declared |
| [PMU Profiling](https://ambiqai.github.io/neuralspotx/guides/examples/pmu_profiling/) | Capabilities | `tested` | `pmu`, `profiling` | `apollo510_evb` |
| [Power Benchmark](https://ambiqai.github.io/neuralspotx/guides/examples/power_benchmark/) | Capabilities | `builds` | `power`, `gpio`, `timer` | none declared |
| [BLE Webble](https://ambiqai.github.io/neuralspotx/guides/examples/ble_webble/) | Integrations | `experimental` | `ble`, `cordio`, `freertos` | `apollo3p_evb`, `apollo4p_blue_kxr_evb`, `apollo510b_evb` |
| [KWS Inference](https://ambiqai.github.io/neuralspotx/guides/examples/kws_infer/) | Integrations | `tested` | `ml`, `tflite`, `cmsis-nn`, `helia-rt` | `apollo510_evb` |
| [USB RPC](https://ambiqai.github.io/neuralspotx/guides/examples/usb_rpc/) | Integrations | `tested` | `usb`, `rpc`, `nanopb` | `apollo510_evb` |

Every column in that table comes from the example's own front matter. **Tier** is the
reading order: `Basics` first, then `Capabilities` one at a time, then
`Integrations` that compose several. **Status** and **Boards tested** are the author's
declaration of what they ran and where, not a test record this site holds, so treat a
"none declared" boards column as "not stated" rather than as "does not work".

## Where to start

- New to NSX: [Hello World](https://ambiqai.github.io/neuralspotx/guides/examples/hello_world/), then
  [FreeRTOS Blinky](https://ambiqai.github.io/neuralspotx/guides/examples/freertos_blinky/).
- Measuring something: [PMU Profiling](https://ambiqai.github.io/neuralspotx/guides/examples/pmu_profiling/),
  [Power Benchmark](https://ambiqai.github.io/neuralspotx/guides/examples/power_benchmark/) and
  [CoreMark](https://ambiqai.github.io/neuralspotx/guides/examples/coremark/).
- Running a model: [KWS Inference](https://ambiqai.github.io/neuralspotx/guides/examples/kws_infer/).
- Talking to a host: [USB Serial](https://ambiqai.github.io/neuralspotx/guides/examples/usb_serial/),
  [USB RPC](https://ambiqai.github.io/neuralspotx/guides/examples/usb_rpc/) and
  [BLE Webble](https://ambiqai.github.io/neuralspotx/guides/examples/ble_webble/).
- Reading a sensor: [Audio Capture](https://ambiqai.github.io/neuralspotx/guides/examples/audio_capture/).

The sources are in
[`examples/`](https://github.com/AmbiqAI/neuralspotx/tree/main/examples) in the
repository, and each page below carries that example's README.