Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
        • Red-blue alert light
        • Fill light
        • Indicator light
        • Infrared
        • Searchlight
        • White light
          • light.white.enabled (Read white light switch)
          • light.white.enabled (Set white light switch)
          • light.white.mode (Read white light mode)
          • light.white.mode (Set white light mode)
          • light.white.level (Read white light brightness)
          • light.white.level (Set white light brightness)
          • light.white.linkage (Read alarm-linked white light)
          • light.white.linkage (Set alarm-linked white light)
          • light.white.linkageEvents (Read white light linkage events)
          • light.white.linkageEvents (Set white light linkage events)
          • light.white.plan (Read white light arming schedule)
          • light.white.plan (Set white light arming schedule)
          • light.white.timer (Read white light timer)
          • light.white.timer (Set white light timer)
          • light.white.countdown (Read white light default countdown)
          • light.white.state (Read white light runtime state)
          • light.white.start (Start countdown white light)
          • light.white.stop (Stop countdown white light)
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

light.white.level (Read white light brightness)

light.white.level: Read white light brightness

light.white.level · Channel scope · Permission Config

What it does

Reads white light brightness on this channel per device.capability.list: IPCs often use struct { mode, brightness } (table below); some bulbs use integer brightness 1–100 (light-brightness scalar) with the same propertyId light.white.level—do not force struct or the device may return DV20xx.

Request URL

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

Minimum permission

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

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesArrayyes["light.white.level"]

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.level"
 ]
 }
}

Response data fields

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

NameDescriptionTypeRequiredValues
modeMode. 0 auto, 1 manual.enumyes0 auto; 1 manual
brightnessBrightness. Range 1–100, step 1.intyes1–100, step 1

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "light.white.level": {
 "mode": "0",
 "brightness": 1
 }
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set white light brightness · White light

light.white.mode (Set white light mode)
light.white.level (Set white light brightness)