标准指令集

更新时间:2022-09-05 07:28:29下载pdf

标准指令集是设备可下发的控制功能的指令集合。以产品类别区分,具体产品支持的控制指令是该类产品 标准指令集 的子集。本系列文档提供了涂鸦 IoT 平台部分品类产品的指令集,更多产品持续适配中,如有需求可 提交工单 联系涂鸦。

名词解释

名词 说明
标准指令集 标准指令集是设备可下发的控制功能的指令集合。
标准产品类别 标准产品类别提供了可使用 标准指令集 进行控制,和可使用 标准状态集 进行状态查询的标准化的产品类别列表。
标准状态集 标准状态集是设备可上报的功能状态集合。以产品类别区分,具体产品支持的功能状态是该类产品 标准状态集 的子集。
产品功能 产品功能是涂鸦 IoT 开发平台为智能设备定义的云端控制对接模型,用于阐述设备每一个功能的数据交互方式。

注意事项

  • 本章节提供的指令集与 涂鸦 IoT 平台产品功能 的定义并不完全一致。涂鸦 IoT 平台适配了涂鸦 IoT 平台中相同品类下不同产品的指令。
  • 您只需要适配涂鸦相同品类的指令集即可控制涂鸦相同品类下不同的产品。
  • 若返回的标准产品是类别码为 qt 的早期产品,可能不再支持,如需接入请 提交工单 确认。

使用步骤

本步骤以 产品功能 中的电压力锅为例,介绍如何查询智能设备的云端功能属性和状态属性。

第一步:查询设备功能属性

您可以参考本步骤中的请求示例查询您的设备所支持的标准接入的功能属性(即指令集)和支持可上报的状态属性(即状态集)。相关 API,请参考 查询设备规格属性

  • 指令集将用作 下发指令 中的 code

  • 状态集将用于查询设备状态接口。

    如果查询到的结果为空,请提交工单进行确认。

请求示例

curl --request GET "https://openapi.tuyacn.com/v1.0/iot-03/devices/vdevo16**********035/specifications" --header "sign_method: HMAC-SHA256" --header "client_id: x37******************mmu0" --header "t: 1630599812793" --header "mode: cors" --header "Content-Type: application/json" --header "sign: 4979EC676FB3B7******************A0835B1CF46265B" --header "access_token: 5eb*********1371"

返回示例

{
"result": {
	"category": "dylg",
	"functions": [
	{
		"code": "switch",
		"type": "Boolean",
		"values": "{}"
	},
	{
		"code": "start",
		"type": "Boolean",
		"values": "{}"
	},
	{
		"code": "appointment_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":0,\"max\":1440,\"scale\":0,\"step\":1}"
	},
	{
		"code": "cook_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":0,\"max\":6000,\"scale\":0,\"step\":1}"
	},
	{
		"code": "warm_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":30,\"max\":1440,\"scale\":0,\"step\":1}"
	}
	],
	"status": [
	{
		"code": "switch",
		"type": "Boolean",
		"values": "{}"
	},
	{
		"code": "start",
		"type": "Boolean",
		"values": "{}"
	},
	{
		"code": "appointment_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":0,\"max\":1440,\"scale\":0,\"step\":1}"
	},
	{
		"code": "cook_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":0,\"max\":6000,\"scale\":0,\"step\":1}"
	},
	{
		"code": "work_state",
		"type": "Enum",
		"values": "{\"range\":[\"idle\",\"appointment\",\"cooking\",\"warm\",\"paused\"]}"
	},
	{
		"code": "warm_time",
		"type": "Integer",
		"values": "{\"unit\":\"min\",\"min\":30,\"max\":1440,\"scale\":0,\"step\":1}"
	}
	]
},
"success": true,
"t": 1630599813188
}

第二步:下发设备指令

您可以通过下发指令集中的指令,对设备功能进行调试。相关 API,请参考 下发指令

以下请求示例是根据上一步查询到的设备功能属性,以 switch 为示例进行命令下发。

请求示例

curl --request POST "https://openapi.tuyacn.com/v1.0/iot-03/devices/vdevo16********035/commands" --header "sign_method: HMAC-SHA256" --header "client_id: x37upht******bmmu0" --header "t: 1630599977335" --header "mode: cors" --header "Content-Type: application/json" --header "sign: DE7D1F28BB2C775*********0F4A45D09430A13D48C0E086" --header "access_token: 5eb******1371" --data "{"commands":"[{\"code\":\"switch\",\"value\":true}]"}"

返回示例

{
	"result": true,
	"success": true,
	"t": 1630599977705
}

第三步:查询设备最新状态

您可以通过以下命令查询设备当前的状态。相关 API,请参考 查询单个设备的状态

继第二步对 switch 进行命令下发后,可以查询设备最新状态。

请求示例

curl --request GET "https://openapi.tuyacn.com/v1.0/devices/vdevo16********035/status" --header "sign_method: HMAC-SHA256" --header "client_id: x37******mmu0" --header "t: 1630600155872" --header "mode: cors" --header "Content-Type: application/json" --header "sign: BD000A8CC7F8E35************0851F75C64A202" --header "access_token: 5eb*********1371"

返回示例

{
"result": [
	{
	"code": "switch",
	"value": true
	},
	{
	"code": "start",
	"value": false
	},
	{
	"code": "appointment_time",
	"value": 0
	},
	{
	"code": "cook_time",
	"value": 0
	},
	{
	"code": "work_state",
	"value": "idle"
	},
	{
	"code": "warm_time",
	"value": 30
	}
],
"success": true,
"t": 1630600156146
}

类目code列表

您查询到的类目的 code 字段表示具体的产品简称,下表罗列了大多数指令 code 对应的产品。

类目 code 说明
amy 按摩椅
bgl 壁挂炉
bh 智能电茶壶
bx 冰箱
bxx 保险箱
cjkg 场景开关
ckmkzq 车库门控制器
ckqdkg 插卡取电开关
cl 窗帘
clkg 窗帘开关
cn 冲奶器
co2bj CO2报警传感器
cobj CO报警传感器
cs 除湿器
cwtswsq 宠物投射喂食器
cwwqfsq 宠物网球发射器
cwwsq 宠物喂食器
cwysj 宠物饮水机
cz 插座
dbl 电壁炉
dc 灯串
dcl 电磁炉
dd 灯带
dgnbj 多功能传感器
dj 光源
dlq 断路器
dr 电热毯
ds 电视
fs 风扇
fsd 风扇灯
fwd 氛围灯
ggq 灌溉器
gyd 感应灯
gyms 公寓门锁
hotelms 酒店门锁
hps 人体存在传感器
js 净水器
jsq 加湿器
jtmsbh 家用门锁保活
jtmspro 家庭门锁Pro
jwbj 甲烷报警器
kfj 咖啡机
kg 开关
kj 空气净化器
kqzg 空气炸锅
kt 空调
ktkzq 空调控制器
ldcg 亮度传感器
liliao 理疗产品
lyj 晾衣架
mal 报警主机
mb 面包机
mc 门窗控制器
mcs 门磁
mg 米柜
mjj 毛巾架
mk 门控
ms 家用门锁
ms_category 门锁配件
msp 猫砂盆
mzj 慢煮机
nnq 暖奶器
ntq 暖通器
pc 排插
photolock 音视频锁
pir 人体运动传感器
pm2.5 PM2.5传感器
qn 取暖器
rqbj 燃气报警器
rs 热水器
sb 手表(手环)
sd 扫地机
sf 沙发
sgbj 声光报警器
sj 水浸传感器
sos 紧急按钮
sp 智能摄像机
sz 植物生长机
tgkg 调光开关
tgq 调光器
tnq 智能调奶器
tracker 定位器
ts 跳绳
tyndj 太阳能灯
tyy 投影仪
tzc1 体脂秤
videolock 视频锁
wk 温控
wsdcg 温湿度传感器
xdd 吸顶灯
xfj 新风机
xxj 香薰机
xy 洗衣机
yb 浴霸
yg 浴缸
ykq 遥控器
ylcg 压力传感器
ywbj 烟雾报警器
zd 震动传感器
zndb 智能电表
znfh 智能饭盒
znsb 智能水表
znyh 智能药盒