Name

Description

Capability&Permission Example

Attribute(Status)

Protocol(Status inquiry&Control command)

power

Power control

[ { “capability”: “power”, “permission”: “readWrite” }]

{ “powerState”: “on”, //The field powerState indicates the power on/off state, which is required. string type, ”on“ means on, ”off“ means off, ”toggle“ means reverse.}

Turn on：{ “powerState”: “on”}Turn off：{ “powerState”: “off”}

toggle

Toggle control

[ // Single toggle example { “capability”: “toggle”, “permission”: “readWrite”, “name”: “1” }, // Multiple toggle example[ { “capability”: “toggle”, “permission”: “readWrite”, “name”: “1” }, { “capability”: “toggle”, “permission”: “readWrite”, “name”: “2” }]

{ “toggleState”: “on”, // The field “toggleState” indicates the toggle state of the {name} attribute of {device_id}. Required. String type. “on” means open, “off” means close, “toggle” means reverse.}

toggle format is special{ [capability] :{ [toggle-name]：{ [toggleState]:[value] } }}toggle 1 on, toggle 2 off{ “toggle”: { “1”: { “toggleState”: “on” }, “2”: { “toggleState”: “off” } }}

brightness

Brightness Control

[ { “capability”: “brightness”, “permission”: “readWrite” }]

{ “brightness”: 100, // The field “brightness” indicates the percentage of brightness. Int type. An integer with a value range of 0~100.}

0 is the darkest and 100 is the brightest. Set the brightness to 80%. { “brightness”: { “brightness”: 80, }}

color-temperature

Color temperature control

[ { “capability”: “color-temperature”, “permission”: “readWrite” }]

{ “colorTemperature”: 100, // 字段 “colorTemperature” Indicates the percentage of color temperature. Int type. An integer with a value range of 0~100. 0 means warm light, 50 means neutral light, and 100 means cold light.}

Set the Color temperature to 80%. { “color-temperature”: { “colorTemperature”: 50 }}

color-rgb

Color control

[ { “capability”: “color-rgb”, “permission”: “readWrite” }]

{ “red”: 255, // The field “red” represents red in the RGB color space. Required. Int type. An integer with a value range of 0~255. “green”: 0, // The field “green” represents green in the RGB color space. Required. Int type. An integer with a value range of 0~255. “blue”: 255, // The field “blue” represents blue in the RGB color space. Required. Int type. An integer with a value range of 0~255.}

Set the color.{ “color-rgb”: { “red”: 255, “green”: 0, “blue”: 255, }}

percentage

Percentage control

[ { “capability”: “percentage”, “permission”: “readWrite” }]

{ “percentage”: 100, // The field “percentage” represents a percentage of a certain degree, and the field percentageDelta can be selected as one of the two. int type. An integer with a value range of 0~100.}

Set to 40%{ “percentage”: { “percentage”: 40 }}

motor-control

Motor control

[ { “capability”: “motor-control”, “permission”: “readWrite” }]

{ “motorControl”: “stop”, // The field “motor-control“ indicates the open or close state of the motor。 Required. String type. Optional values, “open” (open), “close” (close), “stop” (stop), “lock” (lock).}

Turn on the motor{ “motor-control”: { “motorControl”: “open” }}

motor-reverse

Motor reverse

[ { “capability”: “motor-reverse”, “permission”: “readWrite” }]

{ “motorReverse”: true, // The field “motor-reverse” indicates the forward and reverse setting of the motor. Required. boolean type. true means forward rotation, false means reverse rotation.}

Set the motor reverse{ “motor-reverse”: { “motorReverse”: false }}

startup

Power on state (Power Supply)

[ { “capability”: “startup”, “permission”: “readWrite” }]

{ “startup”: “on” // String type. Required. Optional values, “on” (power on) ，“stay“ (stay power on)，”off“ (power off)}

Set the power on state to always stay on when powered on{ “startup”: { “startup”: “on” }}

startup

Toggle power on state (can use with toggle)

[ { “capability”: “startup”, “permission”: “readWrite”, “components”: [ //Components that support power on retention. If the device with the toggle sub-channel needs to support power on retention, this field is mandatory. In particular, the toggle capability supports separate power-on retention settings. For details, see the update protocol of toggle. // toggle 1 power on state { “capability”: “toggle”, // String type. Required. Represents the name of the component capability that supports power-on retention. Only “power” and “toggle” are supported. “name”: “1”, // The field “name” indicates the attribute name that can be toggled. Required. String type. Only uppercase and lowercase letters and numbers are allowed. Taking the multi-channel switch as an example, it should be the channel number, that is, 1, 2, 3, 4 } ] }]

{ “startup”: “on” // String type. Required. Optional values, “on” (power on) ，“stay“ (stay power on)，”off“ (power off)}

When channel 1 power on, the power state is always on{ “toggle”: { “1”: { “startup”: “on” } }}

camera-stream

Camera stream

{ “capability”: “camera-stream”, // The field “capability” indicates the name of the specific function. Rrequired. String type. camera-stream indicates the video streaming capability of the camera. “permission”: “read”, // The field “permission” indicates the use of specific functions. Required. String type. Optional values: “read” (readable), “write” (writable), “readWrite” (readable and writable)。 “configuration”: { “streamUrl”: “rtsp://<username>:<password>@<hostname>:<port>/streaming/channel01″, //stream url. String type. Required. } }

/

{ “camera-stream”: { “configuration”: { “streamUrl”: “rtsp://<username>:<password>@<hostname>:<port>/streaming/channel01″, // stream url. String type. Required. } }}

motor-clb

Motor calibration detection

[ { “capability”: “motor-clb”, “permission”: “read” }]

{ “motorClb”: “calibration”, // The field “motor-clb” indicates that the motor has been calibrated Required. String type, normal means normal mode (calibrated), calibration means it is being calibrated.}

The motor is being calibrated.{ “motor-clb”: { “motorClb”: “calibration” }}

detect

State detection

[ { “capability”: “detect”, “permission”: “read” }]

{ “detected”: true, // The field “detected” indicates the current detection result. Required. Boolean type, true indicates that the condition is detected, false indicates that the condition is not detected.}

The current state is the result detected.{ “detect”: { “detected”: true }}

humidity

Humidity detection

[ { “capability”: “humidity”, “permission”: “read” }]

{ “humidity”: 50, // The field “humidity” indicates the current relative humidity (percentage). Required. Int type. An integer with a value range of 0~100.}

Current humidity is 20{ “humidity”: { “humidity”: 20 }}

temperature

Temperature detection

[ { “capability”: “temperature”, “permission”: “read” }]

{ “temperature”: 26.5, // The field “temperature” indicates the current temperature. Required. Number type. The unit is Celsius.}

Current temperature is 20 Celsius{“temperature”: {“temperature”: 20}}

battery

Remaining battery detection

[{ “capability”: “battery”, “permission”: “read” }]

{ “battery”: 95, // The field “battery” indicates the percentage of remaining battery power. Required. Int type. An integer with a value range of -1~100. -1 means that the battery level is unknown.}

Current remaining power is 40.{ “battery”: { “battery”: 40 }}

press

Press detection

[ { “capability”: “press”, “permission”: “read” }]

{ “press”: “singlePress”, // The field “press” indicates the method of pressing the button. Required. String type. ptional values: “singlePress” (single-click/single short press), “doublePress” (double-click/two consecutive short presses), “longPress” (long press).}

A single click was detected{ “press”: { “press”: “singlePress” }}

rssi

Wireless signal strength detection

[ { “capability”: “rssi”, “permission”: “read” }]

{ “rssi”: -65, // The field “rssi” indicates the wireless signal strength (received signal strength indication). Required. int type. The unit is dBm, and the optional value is a negative integer.}

{ “rssi”: {“rssi”: -65 }}