Documentation

Canonical public docs for WakeLink — setup, protocols, and deployment.

🚀

Getting Started

Quick Start
Zero to first wake command in 15 minutes
Installation Guide
Detailed server, Docker, and client setup
First Agent Setup
Connect your first ESP32 agent
📚

Guides

Guides Overview
Browse every WakeLink guide in one place
ESP32 Firmware
Flash WakeLink firmware to your ESP32
Android App
Mobile app setup and usage
CLI Tools
Command-line workflows and automation
Self-Hosted Server
Run your own WakeLink instance
Device Provisioning
Token provisioning and agent enrollment
OTA Updates
Over-the-air firmware update flow
⚡

API Reference

API Overview
Authentication, versioning, and rate limits
REST API
HTTP endpoints and request/response schemas
WebSocket Protocol
Real-time connection and message format
EWSP Wire Format
Encrypted Wire Session protocol spec
OpenAPI Spec
Interactive API explorer
🧠

Concepts

Architecture
Services, agents, and protocol boundaries
Security & Encryption
XChaCha20-Poly1305 and zero-knowledge design
Token Rotation
API and agent token lifecycle management
🛠️

Reference

Troubleshooting
Common issues, logs, and fixes

Popular Articles

Quick Start Guide →
Zero to first wake command in 15 minutes
5 min
Agent Setup →
Firmware, hardware and pin configuration
10 min
API Authentication →
Generate tokens and authenticate REST requests
8 min
Self-Hosting Guide →
Run your own WakeLink server with full control
15 min