# VectorHaptics Precompiled Libraries

Precompiled VectorHaptics libraries for ESP32 (environment: ESP32_PICO_MINI). Use these in your Arduino IDE or PlatformIO project.

## Installation

1. Copy all library folders (Vectorhaptics, VHAudioStreaming, VHChannelsI2s, VHBoardProfiles, VHDevTools, VHEffectReceiver) into your project's `lib/` folder.
2. Add the build flags below to your `platformio.ini`.

## platformio.ini Setup

Add these settings to your PlatformIO environment:

```ini
[env:ESP32_PICO_MINI]
platform = espressif32 @ 6.5.0
board = esp32dev
framework = arduino
monitor_speed = 115200
upload_speed = 512000
build_src_filter = +<*> -<.git/> -<.svn/> -<doc/>
board_build.partitions = no_ota.csv
build_flags =
    -Llib/Vectorhaptics/src/esp32
    -lVectorhaptics
    -Llib/VHAudioStreaming/src/esp32
    -lVHAudioStreaming
    -Llib/VHChannelsI2s/src/esp32
    -lVHChannelsI2s
    -Llib/VHBoardProfiles/src/esp32
    -lVHBoardProfiles
    -Llib/VHDevTools/src/esp32
    -lVHDevTools
    -Llib/VHEffectReceiver/src/esp32
    -lVHEffectReceiver
```

**Note:** Adjust `board` and `platform` if you use a different ESP32 variant. The `-L` and `-l` paths assume libraries are in `lib/` relative to your project root.

## Documentation

| Document | Description |
|----------|-------------|
| [docs/OVERVIEW.md](docs/OVERVIEW.md) | Library overview and architecture |
| [docs/guide/README.md](docs/guide/README.md) | Step-by-step guide (setup, primitives, channels, playback, etc.) |
| [docs/CODE_EXAMPLES.md](docs/CODE_EXAMPLES.md) | Quick reference code examples |
| [docs/API_REFERENCE.md](docs/API_REFERENCE.md) | Full API reference |

## Package Contents

- **Vectorhaptics**  Core haptics engine
- **VHAudioStreaming**  Audio streaming support
- **VHChannelsI2s**  I2S channel drivers
- **VHBoardProfiles**  Board profiles (e.g. ESP32 Pico Mini)
- **VHDevTools**  Developer tools & debugging
- **VHEffectReceiver**  Binary effect command receiver
