Documentation Index
Fetch the complete documentation index at: https://docs.nolongerevil.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Control API is the interface you use to control your thermostats, query device status, and manage registrations. It runs on port 8082 and has no authentication by default.Port 8082 is separate from port 8000 (the device protocol port). Thermostats connect to port 8000. You connect to port 8082.
Base URL
your-server with your server’s IP address or hostname.
Authentication
The Control API has no authentication by default. It is designed for use on a trusted local network. If you expose it to the public internet, put it behind a reverse proxy with authentication.Available Endpoints
Thermostat Control
| Method | Endpoint | Description |
|---|---|---|
POST | /command | Send a command to a thermostat |
POST | /notify-device | Force-push current state to device subscribers |
Status & Monitoring
| Method | Endpoint | Description |
|---|---|---|
GET | /status | Get full device state |
GET | /api/events | SSE stream of device state changes |
GET | /api/schedule | Get the current weekly schedule |
GET | /api/stats | Server statistics |
GET | /health | Server health check |
Device Management
| Method | Endpoint | Description |
|---|---|---|
GET | /api/devices | List all registered devices |
POST | /api/register | Claim entry key and register a device |
POST | /api/dismiss-pairing/{serial} | Dismiss pairing dialog on device |
Network Discovery
| Method | Endpoint | Description |
|---|---|---|
POST | /api/scan-network | Scan subnet for Nest devices |
POST | /api/configure-nest | Point a discovered Nest device at this server |
Configuration
| Method | Endpoint | Description |
|---|---|---|
GET | /api/config | Server configuration (for the dashboard) |
POST | /api/mqtt-config | Configure MQTT integration |
Request Format
All requests that have a body useContent-Type: application/json.
Response Format
Success responses always return200 OK with a JSON body. Error responses use appropriate 4xx/5xx status codes.
Port Configuration
The control API port is configured via theCONTROL_PORT environment variable (default: 8082). The bind address is configured via CONTROL_HOST (default: 0.0.0.0).
POST /command
Send thermostat commands
GET /status
Query device state