light.white.timer (Read white light timer)

light.white.timer: Read white light timer

light.white.timer · Channel scope · Permission Config

What it does

Reads scheduled lighting entries (timer); arming window: plan. Up to 5 entries.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.

Request parameters

Name	Type	Required	Description
`token`	String	yes	Administrator, sub-user, or sub-account accessToken
`deviceId`	String	yes	Device serial number
`productId`	String	no	Optional. If sent and it does not match the device model → `DV2009`
`channelId`	String	yes	Channel ID; `"0"` is common on IPCs
`properties`	Array	yes	`["light.white.timer"]`

Common request fields and the signature are in Development specification.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "properties": [
 "light.white.timer"
 ]
 }
}

Response data fields

The value is in result.data.properties["light.white.timer"].

Array limit 5.

Name	Description	Type	Required	Values
`item.data`	Time parameter. Range 0–255, step 1.	`int`	yes	`0`–`255`, step `1`
`item.time`	Time of day (24h), format HH:mm	`text`	yes	Format `HH:mm`
`item.switch`	Lamp switch. 0 off, 1 on.	`enum` (JSON number or string)	yes	`0` off; `1` on
`item.status`	Task state. 0 invalid, 1 valid.	`enum` (JSON number or string)	yes	`0` invalid; `1` valid

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "light.white.timer": [
 {
 "data": 0,
 "time": "08:00",
 "switch": "0",
 "status": "0"
 }
 ]
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set white light timer · White light