批量获取指令集

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

本文介绍批量获取指令集的 API。

接口描述

批量获取设备支持的指令集，最多支持 20 个设备。

接口地址

GET: /v1.0/devices/functions

请求参数

参数名	类型	参数位置	是否必填	说明
device_ids	String	query	false	设备 ID 列表，多个 ID 逗号分隔，最多支持 20 个设备

返回参数

参数名	类型	说明
result	List	设备集合、指令集合和分类

result 说明

参数名	类型	说明
category	String	产品类别
functions	List	指令集
devices	List	设备 ID 列表

functions 说明

参数名	类型	说明
name	String	指令名称
desc	String	描述
code	String	指令
type	String	指令类型
values	String	指令入参范围

devices 说明

参数名	类型	说明
devices	String	设备 ID

请求示例

GET: /v1.0/devices/functions?device_ids=vdevo168****14179625,vdevo16****2860414179

返回示例

{
    "functions": [
        {
            "code": "switch_1",
            "values": "{}",
            "type": "Boolean",
            "name": "开关1",
            "desc": "开关1"
        },
        {
            "code": "countdown_1",
            "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}",
            "type": "Integer",
            "name": "开关1倒计时",
            "desc": "开关1倒计时"
        },
        {
            "code": "switch_led",
            "values": "{}",
            "type": "Boolean",
            "name": "开关",
            "desc": "开关"
        },
        {
            "code": "remote_id",
            "values": "{}",
            "type": "String",
            "name": "遥控器id",
            "desc": "遥控器id"
        },
        {
            "code": "mode",
            "values": "{\"range\":[\"cold\",\"warm\",\"auto\",\"air\",\"dehumid\"]}",
            "type": "Enum",
            "name": "模式",
            "desc": "模式"
        },
        {
            "code": "target_temp",
            "values": "{\"min\":0,\"max\":100,\"scale\":1,\"step\":1}",
            "type": "Integer",
            "name": "目标温度",
            "desc": "目标温度"
        },
        {
            "code": "fan_level",
            "values": "{\"range\":[\"auto\",\"low\",\"middle\",\"high\"]}",
            "type": "Enum",
            "name": "风速档位",
            "desc": "风速档位"
        },
        {
            "code": "control",
            "values": "{\"range\":[\"send_ir\",\"study\",\"study_exit\",\"study_key\"]}",
            "type": "Enum",
            "name": "设备控制",
            "desc": "设备控制"
        }
    ],
    "devices": [
        "vdevo16****414179",
        "vdevo168****4179625"
    ],
    "category": "zigbeekt"
}

错误码

参考错误码。