Reference¶
Hardware reference and changelog.
Device hardware¶
Reference for the physical buttons and LED states on a Raclip device.
Buttons¶
The device has three buttons:
| Button | Press | Hold (10 s) |
|---|---|---|
| On/Off | Toggle the device on or off | Hard reset |
| Start/Stop | Start a recording, or pause/resume an active one | Clear stored Wi-Fi networks and re-enter setup mode |
| Send | End the current recording and upload it | Retry a failed upload (when idle) |
LED states¶
A single multi-color LED communicates device state. Color and pattern together identify the state.
| LED | State | Meaning |
|---|---|---|
| Off | Off | Device powered down. |
| Solid blue | Ready | On, connected to Wi-Fi, ready to record. |
| Slow white pulse | Charging | Plugged in and charging. |
| Alternating white / blue | Provisioning | Setup mode — connect to RaClip-Setup Wi-Fi to configure your network. |
| Solid magenta | Recording | Actively capturing audio. |
| Slow blue blink | Paused | Recording is paused — press Start/Stop to resume. |
| Solid cyan | Sending | Uploading the recording. |
| Fast magenta flash | Error | Upload or registration failed. Press On/Off to retry. |
| Medium magenta flash | SD card missing | Recording requires an SD card; insert one and reboot. |
Typical recording flow¶
- Idle — solid blue.
- Press Start/Stop — solid magenta. Recording.
- (Optional) Press Start/Stop again — slow blue blink. Paused. Press Start/Stop once more to resume.
- Press Send — solid cyan. Uploading.
- Upload complete — back to solid blue.
Re-entering setup mode¶
If you need to reconfigure Wi-Fi (move offices, change networks, etc.):
- Hold Start/Stop for 10 seconds.
- The device clears its stored networks and reboots.
- The LED begins alternating white/blue — you're back in setup mode.
- Follow Connect to Wi-Fi again.
Changelog¶
docs.raclip.ai¶
v0.1 — 2026-04-29¶
- Initial public docs.
- Getting Started: claim, Wi-Fi, API key, first recording, webhooks.
- API reference: calls (list, latest, get, info, download, delete, statistics, usage summary), webhooks.
- Python SDK reference: Client, AsyncClient, devices/calls resources, models, exceptions.
- Node.js SDK reference: Client, devices/calls resources, TypeScript interfaces, exceptions.
- Device hardware reference.
Python SDK (raclip)¶
0.0.1 — 2026-04¶
- Initial release. Read-only surface for devices and calls.
- Sync (
Client) and async (AsyncClient) clients. - Pydantic v2 response models, typed exception hierarchy.
calls.downloadstreaming helper.
Node.js SDK (@raclip/sdk)¶
0.0.4 — 2026-04-30¶
- Renamed package to
@raclip/sdk. DeviceStatusSnapshot.is_onlineis now optional (boolean | undefined).- Improved error message extraction for FastAPI validation errors.
- CI/CD pipeline fixes.
0.0.1 — 2026-04-30¶
- Initial release. Read-only surface for devices and calls.
Clientwith API key resolution from options orRACLIP_API_KEYenv var.devices:list,stats,get,status.calls:list,latest,get,info,statistics,download.- Typed error hierarchy:
RaclipErrorand seven subtypes. - Dual ESM + CJS build, zero runtime dependencies, Node.js ≥ 18.
API¶
April 2026¶
- Public surface stabilized at
https://api.raclip.ai/api/raclip/calls/.... - Webhook event
recording.completedwith HMAC-SHA256 signature verification. - API-key auth via gateway, org derivation server-side.