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
          • light.fill.sensitivity (Read fill-light sensitivity)
          • light.fill.sensitivity (Set fill-light sensitivity)
          • light.fill.distance (Read night fill distance)
          • light.fill.distance (Set night fill distance)
        • Indicator light
        • Infrared
        • Searchlight
        • 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.fill.distance (Set night fill distance)

light.fill.distance: Set night fill distance

light.fill.distance · Device and channel · Permission Config

What it does

Sets night fill distance. Omit channelId for the whole device; pass channelId for that channel. 0 near, 1 medium, 2 far. Out-of-range values are rejected, not clamped.

Request URL

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

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. channelId is optional (whole device when omitted; that channel when passed). Mixing device-level and channel-level properties in one request returns DV2008. A write timeout does not mean the operation did not run.

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
channelIdStringnoChannel ID; "0" is common on IPCs. Omit for whole device; pass for that channel
propertiesObjectyeslight.fill.distance: int, 0 near / 1 medium / 2 far

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.fill.distance": "0"
 }
 }
}

Response data fields

On success, code is "0" and data is {}.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {}
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Read night fill distance · Fill light

light.fill.distance (Read night fill distance)
light.indicator.enabled (Read device indicator light)