Skip to content

SSE_COMMANDS.md

Latest commit

 

History

History
65 lines (49 loc) · 1.18 KB

SSE_COMMANDS.md

File metadata and controls

65 lines (49 loc) · 1.18 KB
Raw

SSE Long Polling for Commands

Battery-optimized command delivery for IoT devices.

Endpoints

1. Immediate Poll

GET /dev/{device_id}/cmd
Authorization: Bearer {api_key}

Returns pending commands immediately.

2. HTTP Long Poll

GET /dev/{device_id}/cmd/poll?wait=30
Authorization: Bearer {api_key}

Waits up to 30 seconds for commands. Returns immediately if command arrives.

3. SSE Stream

GET /dev/{device_id}/cmd/stream?wait=30
Authorization: Bearer {api_key}
Accept: text/event-stream

Server-Sent Events stream. Sends keepalives and commands.

Response Format

HTTP Poll:

{"commands": [{"command_id": "cmd_xxx", "action": "reboot", "params": {}}]}

SSE Stream:

event:keepalive
data:{"time":"2025-12-22T20:39:31Z"}

event:command
data:[{"command_id":"cmd_xxx","action":"reboot"}]

Battery-Optimized Flow

1. Device sends data → POST /dev/{id}/data
   Response: {"status":"ok", "commands_pending": 1}

2. If commands_pending > 0:
   → GET /dev/{id}/cmd/poll?wait=30
   
3. Execute command

4. Acknowledge:
   → POST /dev/{id}/cmd/{cmd_id}/ack
   
5. Sleep, repeat

Test

./tests/sse_test.sh