设备发现

更新时间：2021-07-16 07:39:28下载pdf

本文介绍设备发现的 API。

接口描述

查询用户所有设备信息的接口。

接口地址

GET: /v1.0/iot-01/voice/users/{uid}/devices

请求参数

参数名	类型	参数位置	是否必填	说明
uid	String	uri	true	用户 ID

返回参数

参数名	类型	说明
result	Object	返回结果
success	Boolean	判断请求是否成功。 true：成功， false：失败
t	Long	返回时间 13 位时间戳
code	Integer	响应码，成功时不显示
msg	String	请求失败的信息，成功时不显示

result 说明

参数名	类型	说明
devices	List	多个设备对象集合
version	String	接口版本号
message_id	String	请求标识符

devices 说明

参数名	类型	说明
capabilities	List	标准能力集合
category	String	标准品类
device_id	String	设备主键
device_name	String	设备名称

capabilities 说明

参数名	类型	说明
attributes	List	标准属性集合
commands	List	标准能力集合
interface_name	String	接口类型
support_query	Boolean	是否支持查询
support_report	Boolean	是否支持上报

attributes 说明

参数名	类型	说明
code	String	标准属性
rang_type	String	值类型
range_value	Object	值范围

请求示例

GET: /v1.0/iot-01/voice/users/ay1618816013155*****/devices

{}

返回示例

{
    "result": {
        "devices": [
            {
                "capabilities": [
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.PowerstateController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "powerstate",
                                "rang_type": "onOff"
                            }
                        ],
                        "commands": [
                            "TurnOn",
                            "TurnOff"
                        ]
                    }
                ],
                "device_id": "vdevo16196866******",
                "device_name": "plug",
                "category": "smartplug"
            },
            {
                "capabilities": [
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.BrightnessController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "brightness",
                                "rang_type": "percent"
                            }
                        ],
                        "commands": [
                            "SetBrightness",
                            "DecrementBrightness",
                            "IncrementBrightness"
                        ]
                    },
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.PowerstateController",
                        "support_query": true,
                        "attributes": [
                            {
                                "code": "powerstate",
                                "rang_type": "onOff"
                            }
                        ],
                        "commands": [
                            "TurnOn",
                            "TurnOff"
                        ]
                    },
                    {
                        "support_report": false,
                        "interface_name": "Tuya.SmartHome.ColorTemperatureController",
                        "support_query": false,
                        "attributes": [
                            {
                                "code": "colorTemperature",
                                "rang_type": "percent"
                            }
                        ],
                        "commands": [
                            "SetColorTemperature",
                            "IncrementColorTemperature",
                            "DecrementColorTemperature"
                        ]
                    }
                ],
                "device_id": "vdevo162078*****",
                "device_name": "Rxpower-Wifi-vdevo",
                "category": "light"
            }
        ],
        "message_id": "1dff3264-bb21-4f1c-b32b-d9106082fe23",
        "version": "V1.0"
    },
    "t": 1620981986459,
    "success": true
}

错误码

参考错误码。