获取家庭支持的联动条件

更新时间:2023-12-07 03:33:51下载pdf

本文介绍获取家庭支持的联动条件的 API。

接口描述

根据家庭 ID 获取联动条件或执行动作的标准功能点。

接口地址

GET: /v1.0/homes/{home_id}/enable-linkage/codes

请求参数

参数名类型参数位置是否必填说明
home_idStringuritrue家庭 ID

返回参数

参数名类型说明
resultList返回参数说明

result 说明

参数名类型说明
device_idString设备 ID
functionsList执行的操作
statusList操作触发的条件

functions 说明

参数名类型说明
codeString标准下发指令 Code
nameStringCode 名称
typeString下发数据类型
valuesMapCode 对应的取值范围

status 说明

参数名类型说明
codeString标准下发指令 Code
nameStringCode 名称
typeString下发数据类型
valuesMapCode 对应的取值范围

values 说明

参数名类型说明
valuesString

请求示例

GET: /v1.0/homes/52323****/enable-linkage/codes

返回示例

[
    {
        "device_id": "0120090568c63a89****",
        "functions": [
            {
                "code": "bright_value",
                "values": {
                    "max": 255,
                    "scale": 0,
                    "type": "value",
                    "unit": "",
                    "min": 25,
                    "step": 1
                },
                "type": "Integer",
                "name": "亮度"
            }
        ],
        "status": [
            {
                "code": "work_mode",
                "values": {
                    "range": [
                        "white",
                        "colour",
                        "scene",
                        "scene_1",
                        "scene_2",
                        "scene_3",
                        "scene_4"
                    ],
                    "type": "Enum"
                },
                "type": "Enum",
                "name": "模式"
            }
        ]
    }
]

错误码

参考 错误码