4.1 下发命令接口
接口地址:
https://api.yoyoiot.cn/{AppID}/device/control/?sign={sign}&ts={ts}
{AppID} 为您的应用ID(由平台生成)请按准备工作的引导进入控制台,在开发设置页面查看。
{sign} 和 {ts} 的算法,请查看上一节中的描述
{AppID} 为您的应用ID(由平台生成)请按准备工作的引导进入控制台,在开发设置页面查看。
{sign} 和 {ts} 的算法,请查看上一节中的描述
请求数据:
这段命令是让ID为 820720 的 智能热敏打印机[4G] 的 输出 : 新订单 的命令下发
更多配置参数请到下方4.2 产品支持命令查看
{
"device":820720,
"order":{"print":"{"id":3561,"type":5,"pwidth":58,"pcopy":1,"ptype":1,"vtype":0,"vmessage":"您有一笔新订单请及时处理","contents":[{"cont":"友友物联","type":"title","align":"center"},{"thead":{"品名":"50%","金额":"50%"},"tbody":[["音箱",999.44],["打印机",100]]},{"both_sides":["合计","1099.44"]},{"cont":"1","type":"cut"}]}"}
}
请求方式:POST;数据格式:JSON这段命令是让ID为 820720 的 智能热敏打印机[4G] 的 输出 : 新订单 的命令下发
更多配置参数请到下方4.2 产品支持命令查看
请求参数
参数较长时建议使用POST方式
| 名称 | 必填 | 类型 | 说明 |
|---|---|---|---|
| gateway | 否 | string | 当发给设备的命令需要其关联的网关转发时,需要指定
网关的设备ID,唯一ID(在网关壳体上、控制台均可以找到)
指定多个网关时请用间隔符(,或|)连接,最多可以同时指定5台网关 |
| device | 是 | string | 设备ID,设备唯一ID(在设备壳体上、控制台均可以找到)
指定多台设备时请用间隔符(,或|)连接
指定多个设备时,不要这些设备属于同一类产品,但必须有相同的指令 |
| order | 是 | string | 命令,可传JSON字符串(推荐)或直接传参
简单命令:可直接GET或POST:设备的属性名称=属性值
复杂或较长的命令:请POST {"order":{命令内容}}
-----------------------------------------------------------------------
在一些业务场景,需要在命令里携带一些特征信息:如订单号等
可在order中增加一个字段extra,如{"power":1,"extra":"T25030700001"}
在本条命令对应的异步消息推送中,会原样返回此特征信息。
extra只支持32位以内的大小写英文字母和数字(a-zA-Z0-9) |
返回结果
需要注意的是,200仅代表平台接收到了合规的设备ID与参数名称,并成功向设备下发命令。
而设备可能已离线,或命令内容 / 参数有误,在设备上并没有看到预期效果。
在一些必须要求反馈的场景,请接收云端的消息推送,通过异步消息来标记设备是否成功执行命令。
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 200 命令下发成功。
501 未指定设备ID,设备ID为一个整型数字,或由“|”或“,"连接的多个数字。设备列表接口中输出了此ID,在本控制台的设备列表中也可以查看。
502 设备不存在或没有可用设备,传入设备ID均不存在。请检查设备ID是否正确,设备是否删除。
503 指定了过多设备,一次最多指定100台设备ID
504 一次指定了多个设备ID,但其中有一些并不可用(不存在、无权限或已删除)
50xx 请见“全局错误代码” |
4.2 产品支持命令
4.2.1 产品命令
| 命令 | 名称 | 内容 | 说明 |
|---|---|---|---|
|
输出 |
新订单 | {"print":{"id":3561,"type":5,"pwidth":58,"pcopy":1,"ptype":1,"vtype":0,"vmessage":"您有一笔新订单请及时处理","contents":[{"cont":"友友物联","type":"title","align":"center"},{"thead":{"品名":"50%","金额":"50%"},"tbody":[["音箱",999.44],["打印机",100]]},{"both_sides":["合计","1099.44"]},{"cont":"1","type":"cut"}]}} | |
| 饿了么 | {"print":{"id":3563,"type":5,"pwidth":58,"pcopy":1,"ptype":1,"vtype":0,"vmessage":"您有饿了么新订单请及时处理","contents":[{"cont":"饿了么外卖","type":"title","align":"center"},{"thead":{"品名":"50%","金额":"50%"},"tbody":[["盖饭",28],["例汤",8]]},{"both_sides":["合计","36.00"]},{"cont":"1","type":"cut"}]}} | ||
| 美团 | {"print":{"id":3562,"type":5,"pwidth":58,"pcopy":1,"ptype":1,"vtype":0,"vmessage":"您有美团新订单请及时处理","contents":[{"cont":"美团外卖","type":"title","align":"center"},{"thead":{"品名":"50%","金额":"50%"},"tbody":[["套餐",39.9],["饮品",12]]},{"both_sides":["合计","51.90"]},{"cont":"1","type":"cut"}]}} |
4.2.2 系统命令
| 命令 | 名称 | 内容 | 说明 |
|---|---|---|---|
| system | 获取网络信息 | network | |
| 获取设备状态 | state | ||
| 连接WiFi | wifi_connect | ||
| 连接配置的WiFi | wifi_connect_multi | ||
| 断开WiFi连接 | wifi_disconnect | ||
| 进入私有化模式 (如配置) |
private | ||
| 重启 | restart |