Devices & room

Use a room preset

POST/api/room/preset

Admin. Needs an unlock token (x-tempolight-token) while a PIN lock is set; without a lock, anyone can call it.

Lays out the room from a ready-made layout, built for your controllers.

Request body application/json

idstringrequired

A preset id from presets in the state.

Responses

200OKapplication/json

namestring

shapesobject[]

Show child attributes

typestringrequired

One of "line" "pole" "free" "circle" "rect" "hex" "tri" "matrix" "points"

namestring

devstringrequired

The device id it belongs to.

countintegerrequired

LEDs, 1 to 8192.

1 to 8192

frominteger | null

Its first LED on the device; null: after the previous shape.

revboolean

rotnumber

startnumber

zonestring | null

ptsnumber[][]

Points [x, y] for lines; for points, one LED at each.

cxnumber

cynumber

sizenumber

wnumber

hnumber

colsinteger

rowsinteger

zonesobject[]

Show child attributes

idstring

namestring

modestring

One of "follow" "effect" "ambient" "off"

effectstring | null

For mode effect.

brightnessnumber

0 to 1

400The body isn't valid JSON, or a value is wrong.application/json

errorstringrequired

What went wrong, in a sentence for people.

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X POST 'http://localhost:8080/api/room/preset' \
  -H 'content-type: application/json' \
  -d '{
  "id": "fourwalls"
}'

const res = await fetch("http://localhost:8080/api/room/preset", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "id": "fourwalls"
  }),
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    "http://localhost:8080/api/room/preset",
    json={
        "id": "fourwalls"
    },
)
print(res.json())

Response

{
  "name": "My room",
  "shapes": [
    {
      "type": "line",
      "name": "Desk strip",
      "count": 120,
      "dev": "d4k2x9",
      "rot": 0,
      "start": 0,
      "rev": false,
      "from": null,
      "zone": null,
      "pts": [
        [
          1.5,
          6
        ],
        [
          14.5,
          6
        ]
      ]
    }
  ],
  "zones": []
}

{
  "error": "Unknown preset \"x\""
}

{
  "error": "Settings are locked. Unlock with the PIN in Settings."
}