Frambe Admin

GET /api/clients

List all known frames with their status, IP, name, and config.

curl -s -H "Authorization: Bearer YOUR_TOKEN" http://YOUR_HOST:3030/api/clientsCopy

POST /api/clients/:id/command

Send a command to a specific frame. Available actions:

start — Start slideshow stop — Stop slideshow next — Next photo prev — Previous photo

sleep — Put frame to sleep wake — Wake frame refresh — Reload photos from source

setSource — Change photo source (payload: {"source":"album","albumId":"UUID"} or {"source":"random"} or {"source":"favorites"} or {"source":"person","personId":"UUID"})

setConfig — Update settings (payload: {"slideshowInterval":30,"showClock":true,...})

curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" -d '{"action":"next"}' http://YOUR_HOST:3030/api/clients/CLIENT_ID/commandCopy

curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" -d '{"action":"setSource","payload":{"source":"album","albumId":"YOUR_ALBUM_UUID"}}' http://YOUR_HOST:3030/api/clients/CLIENT_ID/commandCopy

DELETE /api/clients/:id

Remove a frame from the registry (clears it from the client list).

curl -s -X DELETE -H "Authorization: Bearer YOUR_TOKEN" http://YOUR_HOST:3030/api/clients/CLIENT_IDCopy

Home Assistant — rest_command examples

rest_command:
  frambe_next_photo:
    url: "http://YOUR_HOST:3030/api/clients/CLIENT_ID/command"
    method: POST
    headers:
      Authorization: "Bearer YOUR_TOKEN"
      Content-Type: "application/json"
    payload: '{"action": "next"}'

  frambe_sleep:
    url: "http://YOUR_HOST:3030/api/clients/CLIENT_ID/command"
    method: POST
    headers:
      Authorization: "Bearer YOUR_TOKEN"
      Content-Type: "application/json"
    payload: '{"action": "sleep"}'

  frambe_wake:
    url: "http://YOUR_HOST:3030/api/clients/CLIENT_ID/command"
    method: POST
    headers:
      Authorization: "Bearer YOUR_TOKEN"
      Content-Type: "application/json"
    payload: '{"action": "wake"}'

  frambe_set_album:
    url: "http://YOUR_HOST:3030/api/clients/CLIENT_ID/command"
    method: POST
    headers:
      Authorization: "Bearer YOUR_TOKEN"
      Content-Type: "application/json"
    payload: '{"action": "setSource", "payload": {"source": "album", "albumId": "YOUR_ALBUM_UUID"}}'Copy