Devices & room

Write WLED segments

POST/api/devices/{id}/segments

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

Writes the room's LED ranges for this controller into WLED as segments.

idstringrequired

A WLED device id (d…).

200OKapplication/json

segmentsobject[]

Show child attributes

startinteger

endinteger

namestring

revboolean

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X POST 'http://localhost:8080/api/devices/id/segments'

const res = await fetch("http://localhost:8080/api/devices/id/segments", {
  method: "POST",
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    "http://localhost:8080/api/devices/id/segments",
)
print(res.json())

Response

{
  "segments": [
    {
      "start": 0,
      "end": 120,
      "name": "Desk strip",
      "rev": false
    }
  ]
}

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