# VectorHaptics Developer Guide

> **Note:** Code examples in these guides use placeholders such as `YOUR_OUTPUT_PIN`, `PIN_A`, `PIN_B`, etc. You must define your own GPIO pins for your board before running the examples.

A step-by-step guide for using the VectorHaptics-Core library. Each section builds on the previous one. For quick reference code, see [CODE_EXAMPLES.md](../CODE_EXAMPLES.md). For full API details, see [API_REFERENCE.md](../API_REFERENCE.md).

---

## Part 1: Device and Firmware Setup

| Doc | Topic |
|-----|-------|
| [01-setup.md](01-setup.md) | Install, Include, Define Channels, Initialize, First Effect |

---

## Part 2: Basic Commands

| Doc | Topic |
|-----|-------|
| [02-primitives.md](02-primitives.md) | Primitives (PULSE, TICK, VIBRATE, PAUSE, ERM, SWEEP), Play, Sequences |
| [03-channels.md](03-channels.md) | Target by Channel ID, Tags, Restrict Primitives per Channel |
| [04-playback.md](04-playback.md) | Play, Queue, RenderQueue, Non-Blocking Playback |

---

## Part 3: Advanced Features

| Doc | Topic |
|-----|-------|
| [05-audio.md](05-audio.md) | PCM, Audio Streaming, Multi-Channel, Mixing |
| [06-dsp.md](06-dsp.md) | DSP Module |
| [07-effect-receiver.md](07-effect-receiver.md) | Receiving Binary Commands (EffectReceiver) |
| [08-devtools.md](08-devtools.md) | Developer Tools & Debugging |
| [09-primitive-manager.md](09-primitive-manager.md) | Defaults, Min/Max, Custom Primitives |
| [10-board-profiles.md](10-board-profiles.md) | Board Profiles and Board Abstraction |
| [11-playback-status-and-callbacks.md](11-playback-status-and-callbacks.md) | Playback Status Polling, Channel Idle/Wake Callbacks |
