查询设备标准指令集

更新时间:2023-07-06 08:28:23下载pdf

本文介绍查询设备标准指令集的 API。

接口描述

查询设备标准指令集后,只返回自动化和一键执行支持的标准指令集。

接口地址

GET: /v2.0/iot-03/automations/devices/{device_id}/specifications

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue设备 ID

返回参数

参数名类型说明
resultLinkageDevicePropertiesRes返回结果

result 说明

参数名类型说明
device_idString设备 ID
functionsList执行动作的标准指令
statusList触发动作的标准状态

functions 说明

参数名类型说明
codeString标准下发指令 Code
nameStringCode名称
typeString下发数据类型,目前支持以下三种类型:
  • Boolean:布尔
  • Integer:整型
  • Enum:枚举
valuesJSONObjectCode 对应的取值范围

status 说明

参数名类型说明
codeString标准下发指令 Code
nameStringCode名称
typeString下发数据类型,目前支持以下三种类型:
  • Boolean:布尔
  • Integer:整型
  • Enum:枚举
valuesJSONObjectCode 对应的取值范围

请求示例

GET: /v2.0/iot-03/automations/devices/vdevo162755161767***/specifications

返回示例

{
    "result": {
        "device_id": "vdevo16275516176****",
        "functions": [
            {
                "code": "switch_1",
                "values": {
                },
                "type": "Boolean",
                "name": "开关1"
            },
            {
                "code": "countdown_1",
                "values": {
                    "max": 86400,
                    "scale": 0,
                    "unit": "s",
                    "min": 0,
                    "step": 1
                },
                "type": "Integer",
                "name": "开关1倒计时"
            },
            {
                "code": "relay_status",
                "values": {
                    "range": [
                        "power_off",
                        "power_on",
                        "last"
                    ]
                },
                "type": "Enum",
                "name": "设备重启状态设置"
            },
            {
                "code": "light_mode",
                "values": {
                    "range": [
                        "relay",
                        "pos",
                        "none"
                    ]
                },
                "type": "Enum",
                "name": "指示灯模式"
            },
            {
                "code": "child_lock",
                "values": {
                },
                "type": "Boolean",
                "name": "童锁"
            }
        ],
        "status": [
            {
                "code": "switch_1",
                "values": {
                },
                "type": "Boolean",
                "name": "开关1"
            },
            {
                "code": "countdown_1",
                "values": {
                    "max": 86400,
                    "scale": 0,
                    "unit": "s",
                    "min": 0,
                    "step": 1
                },
                "type": "Integer",
                "name": "开关1倒计时"
            },
            {
                "code": "relay_status",
                "values": {
                    "range": [
                        "power_off",
                        "power_on",
                        "last"
                    ]
                },
                "type": "Enum",
                "name": "设备重启状态设置"
            },
            {
                "code": "light_mode",
                "values": {
                    "range": [
                        "relay",
                        "pos",
                        "none"
                    ]
                },
                "type": "Enum",
                "name": "指示灯模式"
            },
            {
                "code": "child_lock",
                "values": {
                },
                "type": "Boolean",
                "name": "童锁"
            }
        ]
    },
    "t": 1635390721468,
    "success": true
}

错误码

参考 错误码