获取家庭支持的联动条件

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

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

接口描述

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

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
home_id	String	uri	true	家庭 ID

返回参数

参数名	类型	说明
result	List	返回参数说明

result 说明

参数名	类型	说明
device_id	String	设备 ID
functions	List	执行的操作
status	List	操作触发的条件

functions 说明

参数名	类型	说明
code	String	标准下发指令 Code
name	String	Code 名称
type	String	下发数据类型
values	Map	Code 对应的取值范围

status 说明

参数名	类型	说明
code	String	标准下发指令 Code
name	String	Code 名称
type	String	下发数据类型
values	Map	Code 对应的取值范围

values 说明

参数名	类型	说明
values	String

请求示例

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": "模式"
            }
        ]
    }
]

错误码

参考错误码。