设备管理

根据用户ID获取设备列表

请求地址

action: device.getDeviceList

params请求参数

参数名	类型	说明	是否必填
uid	String	涂鸦用户ID	是

请求示例

{
	"action": "device.getDeviceList",
	"params": {
		"uid": "ay1578921339405Lr3au"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
id	String	设备编号
uid	String	用户ID
local_key	String	密钥
category	String	产品类别
product_id	String	产品ID
sub	Boolean	是否是子设备（true：是，false：不是）
uuid	String	设备唯一标识
owner_id	String	设备拥有者ID
online	Boolean	设备在线状态
name	String	设备名称
ip	String	ip地址
time_zone	String	时区
create_time	Long	设备初次配网时间
update_time	Long	设备状态更新时间
active_time	Long	设备上次配网时间
status	List	设备功能状态

status说明

参数名	类型	说明
code	String	功能点code
value	String	功能点的值

根据应用获取设备列表

请求地址

action: device.getListBySchema

params请求参数

参数名	类型	说明	是否必填
schema	String	应用标识	是
page_no	Integer	起始页。默认第一页	是
page_size	Integer	分页大小。默认每页20条记录	否

请求示例

{
	"action": "device.getListBySchema",
	"params": {
		"schema": "testApp"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
total	Long	总数
devices	List	设备列表

devices说明

参数名	类型	说明
id	String	设备编号
uid	String	用户ID
local_key	String	密钥
category	String	产品类别
product_id	String	产品ID
sub	Boolean	是否是子设备（true：是，false：不是）
uuid	String	设备唯一标识
owner_id	String	设备拥有者ID
online	Boolean	设备在线状态
name	String	设备名称
ip	String	ip地址
time_zone	String	时区
create_time	Long	设备初次配网时间
update_time	Long	设备状态更新时间
active_time	Long	设备上次配网时间
status	List	设备功能状态

响应示例

{
  "success": true,
  "result": {
  "id": "vdevo153490924188132",
  "uid": "ay1485177979114baBn2",
  "category": "pc",
  "sub": false,
  "uuid": "vdevo153490924188132",
  "online": true,
  "status": [
   {
   "code": "switch_1",
   "value": "false",
   "mode": "rw"
   },
   {
   "code": "countdown_led",
   "value": "0",
   "mode": "rw"
   }
  ],
  "local_key": "aeb4ddbcc34cf26a",
  "product_id": "5T63equBYIDPmGXH",
  "owner_id": "703028"
  }
}

根据产品ID获取设备列表

请求地址

action: device.getListByProduct

params请求参数

参数名	类型	说明	是否必填
product_id	String	产品ID	是
page_no	Integer	起始页。默认第一页	否
page_size	Integer	分页大小。默认每页20条记录	否

请求示例

{
	"action": "device.getListByProduct",
	"params": {
		"product_id": "xxxxx"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
total	Long	总数
devices	List	设备列表

devices说明

参数名	类型	说明
id	String	设备编号
uid	String	用户ID
local_key	String	密钥
category	String	产品类别
product_id	String	产品ID
sub	Boolean	是否是子设备（true：是，false：不是）
uuid	String	设备唯一标识
owner_id	String	设备拥有者ID
online	Boolean	设备在线状态
name	String	设备名称
ip	String	ip地址
time_zone	String	时区
create_time	Long	设备初次配网时间
update_time	Long	设备状态更新时间
active_time	Long	设备上次配网时间
status	List	设备功能状态

响应示例

{
  "success": true,
  "result": {
  "id": "vdevo153490924188132",
  "uid": "ay1485177979114baBn2",
  "category": "pc",
  "sub": false,
  "uuid": "vdevo153490924188132",
  "online": true,
  "status": [
   {
   "code": "switch_1",
   "value": "false",
   "mode": "rw"
   },
   {
   "code": "countdown_led",
   "value": "0",
   "mode": "rw"
   }
  ],
  "local_key": "aeb4ddbcc34cf26a",
  "product_id": "5T63equBYIDPmGXH",
  "owner_id": "703028"
  }
}

根据设备ID列表获取设备列表

请求地址

action: device.getListByIds

params请求参数

参数名	类型	说明	是否必填
device_ids	String	设备ID列表	是

请求示例

{
	"action": "device.getListByIds",
	"params": {
		"device_ids": "vdevo15xxxx88132,vdevo1xxx188132"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
total	Long	总数
devices	List	设备列表

devices说明

参数名	类型	说明
id	String	设备编号
uid	String	用户ID
local_key	String	密钥
category	String	产品类别
product_id	String	产品ID
sub	Boolean	是否是子设备（true：是，false：不是）
uuid	String	设备唯一标识
owner_id	String	设备拥有者ID
online	Boolean	设备在线状态
name	String	设备名称
ip	String	ip地址
time_zone	String	时区
create_time	Long	设备初次配网时间
update_time	Long	设备状态更新时间
active_time	Long	设备上次配网时间
status	List	设备功能状态

响应示例

{
  "success": true,
  "result": {
  "id": "vdevo153490924188132",
  "uid": "ay1485177979114baBn2",
  "category": "pc",
  "sub": false,
  "uuid": "vdevo153490924188132",
  "online": true,
  "status": [
   {
   "code": "switch_1",
   "value": "false",
   "mode": "rw"
   },
   {
   "code": "countdown_led",
   "value": "0",
   "mode": "rw"
   }
  ],
  "local_key": "aeb4ddbcc34cf26a",
  "product_id": "5T63equBYIDPmGXH",
  "owner_id": "703028"
  }
}

下发设备指令

请求地址

action:  device.control

params请求参数

参数名	类型	说明	是否必需
device_id	String	设备ID	是
commands	Object	命令集	是

请求示例

{
	"action": "device.control",
	"params": {
		"device_id": "vdevo158132564936223",
		"commands": [
		{
			"code": "switch_led",
			"value": true
		}
		]
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功

获取设备的最新状态

请求地址

action:  device.status

params请求参数

参数名	类型	说明	是否必需
device_id	String	设备ID	是

请求示例

{
	"action": "device.status",
	"params": {
		"device_id": "vdevo158346027181013"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功

响应示例

{
	"result": [{
		"code": "switch_led",
		"value": true
	}, {
		"code": "work_mode",
		"value": "white"
	}, {
		"code": "bright_value_v2",
		"value": 370
	}, {
		"code": "temp_value_v2",
		"value": 216
	}, {
		"code": "scene_data_v2",
		"value": ""
	}, {
		"code": "countdown_1",
		"value": 0
	}, {
		"code": "control_data",
		"value": "{\"bright\":370,\"change_mode\":\"gradient\",\"h\":0,\"s\":0,\"temperature\":216,\"v\":0}"
	}],
	"success": true,
	"t": 1583740617030
}

按品类获取指令集

请求地址

action:  device.functionsByCategory

params请求参数

参数名	类型	说明	是否必填
category	String	类别名，诸如：kg、cz、dj	是

请求示例

{
	"action": "device.functionsByCategory",
	"params": {
		"category": "dj"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
category	String	产品类别
functions	List	指令集

functions说明

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

响应示例

{
  "success": true,
  "t": 1571293457435,
  "result": {
  "category": "kg",
  "functions": [
   {
   "name": "开关",
   "desc": "总开关,true:打开所有;false:关闭所有",
   "code": "switch",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关1",
   "desc": "开关1",
   "code": "switch_1",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关2",
   "desc": "开关2",
   "code": "switch_2",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关3",
   "desc": "开关3",
   "code": "switch_3",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关4",
   "desc": "开关4",
   "code": "switch_4",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关5",
   "desc": "开关5",
   "code": "switch_5",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关6",
   "desc": "开关6",
   "code": "switch_6",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "开关1倒计时",
   "desc": "开关1倒计时",
   "code": "countdown_1",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "开关2倒计时",
   "desc": "开关2倒计时",
   "code": "countdown_2",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "开关3倒计时",
   "desc": "开关3倒计时",
   "code": "countdown_3",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "开关4倒计时",
   "desc": "开关4倒计时",
   "code": "countdown_4",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "开关5倒计时",
   "desc": "开关5倒计时",
   "code": "countdown_5",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "开关6倒计时",
   "desc": "开关6倒计时",
   "code": "countdown_6",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "USB1倒计时",
   "desc": "USB1倒计时",
   "code": "countdown_usb1",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "USB2倒计时",
   "desc": "USB2倒计时",
   "code": "countdown_usb2",
   "type": "Integer",
   "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}"
   },
   {
   "name": "USB1",
   "desc": "USB1",
   "code": "switch_usb1",
   "type": "Boolean",
   "values": "{}"
   },
   {
   "name": "USB2",
   "desc": "USB2",
   "code": "switch_usb2",
   "type": "Boolean",
   "values": "{}"
   }
  ]
  }
}

获取设备支持的指令集

请求地址

action:  device.functions

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备ID	是

请求示例

{
	"action": "device.functions",
	"params": {
		"device_id": "vdevo158132564936223"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
category	String	产品类别
functions	List	指令集

functions 说明

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

响应示例

{
    "success": true,
    "t": 1571293457435,
    "result": {
        "category": "kg",
        "functions": [
             {
                "name": "开关",
                "desc": "总开关,true:打开所有;false:关闭所有",
                "code": "switch",
                "type": "Boolean",
                "values": "{}"
             },
             {
                "name": "开关1",
                "desc": "开关1",
                "code": "switch_1",
                "type": "Boolean",
                "values": "{}"
             }
        ]
    }
}

获取设备支持的指令集和状态集

请求地址

action:  device.specifications

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备ID	是

请求示例

{
	"action": "device.specifications",
	"params": {
		"device_id": "vdevo158132564936223"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
category	String	产品类别
functions	List	指令集
status	List	状态集

functions 说明

参数名	类型	说明
code	String	指令码
type	String	类型
values	String	参数范围

status 说明

参数名	类型	说明
code	String	状态码
type	String	类型
values	String	参数范围

响应示例

{
  "success":true,
  "t":1571201730542,
  "result":{
  "category":"dj",
  "functions":[
   {
   "code":"switch_led",
   "type":"Boolean",
   "values":"{}"
   },
   {
   "code":"work_mode",
   "type":"Enum",
   "values":"{\"range\":[\"colour\"]}"
   },
   {
   "code":"bright_value",
   "type":"Integer",
   "values":"{\"min\":0,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1}"
   },
   {
   "code":"colour_data",
   "type":"Json",
   "values":"{\"h\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":360,\"step\":1},\"s\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1},\"v\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1}}"
   }
  ],
  "status":[
   {
   "code":"switch_led",
   "type":"Boolean",
   "values":"{}"
   },
   {
   "code":"work_mode",
   "type":"Enum",
   "values":"{\"range\":[\"colour\"]}"
   },
   {
   "code":"bright_value",
   "type":"Integer",
   "values":"{\"min\":0,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1}"
   },
   {
   "code":"colour_data",
   "type":"Json",
   "values":"{\"h\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":360,\"step\":1},\"s\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1},\"v\":{\"min\":1,\"scale\":0,\"unit\":\"\",\"max\":255,\"step\":1}}"
   }
  ]
  }
}

获取设备详情

接口描述

可查询设备的详情信息，包括设备属性、设备最新状态。

请求地址

action:  device.details

params请求参数

参数名	类型	说明	是否必需
device_id	String	设备ID	是

请求示例

{
	"action": "device.details",
	"params": {
		"device_id": "vdevo158132564936223"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result说明

参数名	类型	说明
id	String	设备编号
uid	String	用户ID
local_key	String	密钥
category	String	产品类别
product_id	String	产品ID
sub	Boolean	是否是子设备（true：是，false：不是）
uuid	String	设备唯一标识
owner_id	String	家庭id
online	Boolean	设备在线状态
status	Object	设备功能状态

status说明

参数名	类型	说明
code	String	功能点code
value	String	功能点的值
type	String	功能点的类型