Overview
Sends all currently stored state objects for a device to any active subscribe connections. This is useful for testing, debugging, or forcing an immediate state refresh on the thermostat without waiting for the normal subscribe cycle.Endpoint
Request
| Field | Type | Required | Description |
|---|---|---|---|
serial | string | Yes | Device serial number |
Response
Success (200 OK)
| Field | Type | Description |
|---|---|---|
success | boolean | Always true on success |
subscribers_notified | number | Number of active subscribe connections that received the push |
subscribers_notified of 0 means the device has no active subscribe connections at this moment (it may be sleeping or disconnected).
Error (400 Bad Request)
Error (404 Not Found)
When to Use
- Debugging: Force an immediate state push to see if the device picks up server-side changes
- Testing: Trigger a state delivery without modifying any values
- Recovery: If a device seems stuck, this may help it re-sync
Normal thermostat control (via
/command) automatically notifies subscribers. You only need to call this endpoint for explicit manual pushes.Example
Related
POST /command
Send a command (automatically notifies)
GET /api/events
Subscribe to state change events