Create, Update and Remove Device Timer
PUT {{baseUrl}}/v1/device/:deviceUid/timer-settings
When the device should be woken up and when to turn it off to standby.
This endpoint is used for adding the Timers and also for removing Timers.
Parameters
Field | Type | Required | Description |
---|---|---|---|
deviceUid | string | required | Unique Device Identification |
Body
content-type: application/json or application/x-www-form-urlencoded
Field | Type | Description |
---|---|---|
type | string - ‘TIMER1’, ‘TIMER2’, ‘TIMER3’, ‘TIMER4’, ‘TIMER5’, ‘TIMER6’, ‘TIMER_7’ | Which of seven timers you would like to set |
timeOn | time / NULL, HH:MM:SS / NULL | Wake up time for selected timer |
timeOff | time / NULL, HH:MM:SS / NULL | Turn off time for selected timer |
volume | number / 0-100 | Volume, if device has speakers |
weekdays (weekdays[0-6] - for x-www-form-urlencoded) | string[] / ex.: sun, mon, tue, wed, thu, fri, sat | For which days the timer should be applied |
level | string - ‘NATIVE’ / ‘PROPRIETARY’ | Should the device turn off completely or should it just turn off the display |
How to remove Timers
Set timeOn
and timeOff
for respective type (TIMER1, TIMER2,..) to NULL
.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-auth | string | Authorization key and token | |
Content-Type | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{}