Skip to content

NSX

Examples

Examples¶

Eight ready-to-build example apps live in the examples/ directory of the neuralspotx repo. Each one is a self-contained NSX app — the same shape that nsx create-app produces — with its own nsx.yml manifest and nsx.lock receipt.

All examples target the Apollo510 EVB (apollo510_evb profile).

Quick Start¶

The recommended flow is to install nsx once and create your own app (see Getting Started). To try a maintained example without a git clone or a separate workspace, use the snippet below. (Note: this still downloads the full repository tarball; tar then extracts only the example folder you ask for.)

curl -fL https://github.com/AmbiqAI/neuralspotx/archive/refs/heads/main.tar.gz \
  | tar -xz -f - --strip-components=2 neuralspotx-main/examples/hello_world
cd hello_world

nsx configure --app-dir .
nsx build     --app-dir .
nsx flash     --app-dir .   # requires J-Link
nsx view      --app-dir .   # live SWO stream

Contributors who already have the repo cloned can simply cd neuralspotx/examples/hello_world and run the same commands.

Available Examples¶

hello_world ¶

Minimal SWO printf loop. Start here to verify your toolchain and board.

coremark ¶

EEMBC CoreMark with ITCM execution and NVM shutdown for clean power numbers.

power_benchmark ¶

Three-phase power measurement: CoreMark, idle, and deep sleep.

pmu_profiling ¶

Cortex-M55 PMU cycle counting, cache hits, and branch mispredicts.

kws_infer ¶

TFLite Micro keyword-spotting inference with CMSIS-NN kernels.

audio_capture ¶

PDM microphone capture with RMS/peak statistics over SWO.

usb_serial ¶

USB CDC virtual COM port echo app.

usb_rpc ¶

USB vendor-class RPC with nanopb protobuf serialization.