跳到主要内容

Http 协议

提供一种简单设备接和数据上报功能的协议。 http 请求响应同步完成。

认证 http 设备协议采用一机一密,通过在 header 中添加 secret=设备密钥 进行认证。

事件上报

由设备上报事件到云端

请求

URL: /sys/{productKey}/{deviceName}/event/事件名

类型: POST

请求体:

参数类型说明
idString消息 ID
paramsJSON事件上报参数,格式:{"参数 1":值 1} 具体见产品物模型中事件的定义

响应

参数类型说明
codeint响应码,0:成功,x:其它错误

示例

curl 'http://localhost:8080/sys/xxpk/xxdn/event/lowpower' \
-H "Content-Type:application/json" \
-H 'secret:xx 密钥' \
-X POST \
-d '{"id":"123","power":1}'

{"code":0}

属性获取

设备根据需要向云端获取设备当前未生效属性更新到设备中。

请求

URL: /sys/{productKey}/{deviceName}/properties 类型: GET 请求参数: 参数 |类型 |说明 -|-|- params| String| 要获取的属性列表,以逗号分隔,为空获取所有。如:a,b,c

响应

参数类型说明
codeint响应码,0:成功,x:其它错误
dataJSON属性参数,格式:{"参数 1":值 1} 具体见产品物模型中属性的定义

示例

curl 'http://localhost:8080/sys/xxpk/xxdn/properties' \
-H 'secret:xx 密钥' \
-X GET \
-d 'params=a,b,c'

属性上报

将设备当前属性值上报给云端。

请求

URL: /sys/{productKey}/{deviceName}/properties 类型: POST 请求体: 参数 |类型 |说明 -|-|- params| JSON| 属性参数,格式:{"参数 1":值 1} 具体见产品物模型中属性的定义

响应

参数类型说明
codeint响应码,0:成功,x:其它错误

示例

curl 'http://localhost:8080/sys/xxpk/xxdn/properties' \
-H "Content-Type:application/json" \
-H 'secret:xx 密钥' \
-X POST \
-d '{"power":1}'

{"code":0}