全部文档

协议规范

协议版本

平台支持标准 MQTT 3.1.1版本

协议支持

报文支持

  • 平台支持connect、subscribe、publish、ping、unsubscribe、disconnect等报文
  • 平台不支持pubrec、pubrel、pubcomp报文

特性支持

平台对协议特性支持如下:

特性 是否支持 说明
will 不支持 will、will retain 的flag必须为0,will qos必须为0
session 支持 cleansession为0会保留上次连接的信息
retain 不支持 相关标记必须为0
QoS0 支持 平台发布订阅均支持QoS0
QoS1 支持 平台发布订阅均支持QoS1
QoS2 不支持 /

Topic约定

  • 平台暂时不支持用户自定义topic,创建设备的时候系统已经为每个设备创建好对应的topic
  • 下列topic中pid后面是改设备的产品id,devkey后面是该设备的设备id

普通设备

基础通信Topic

功能 Topic类 操作权限 描述
时钟同步 /ext/ntp/{pid}/{did}/request 发布 ntp时钟同步请求
时钟同步 /ext/ntp/{pid}/{did}/response 订阅 ntp时钟同步响应
配置更新 $sys/{pid}/{did}/thing/config/push 订阅 云端主动下推配置信息

物模型通信Topic

功能 Topic类 操作权限 描述
属性上报 $sys/{pid}/{did}/thing/property/post/reply 订阅 设备属性上报结果回复
属性上报 $sys/{pid}/{did}/thing/property/post 发布 设备属性上报
属性设置 $sys/{pid}/{did}/thing/property/set 订阅 设备属性设置(平台→设备)
属性设置 $sys/{pid}/{did}/thing/property/set_reply 发布 设备属性设置应答(设备→平台)

数据上传payload格式

设备属性主动上报

发布Topic:$sys/{pid}/{did}/thing/property/post,格式如下:

{
  "id": "123",
  "version": "1.0",
  "params": {
    "Power": {
      "value": "on",
      "time": 1524448722123
    },
    "WF": {
      "value": 23.6,
      "time": 1524448722123
    }
  }
}

表:请求参数说明

参数 类型 说明
id String 消息id号,用户自定义,String类型的数字,长度限制13位。
version String 物模型版本号,可选字段,不填默认为1.0
params JsonObject 请求参数,用户自定义,标准json格式。如以上示例中,设备上报了的两个属性Power和WF。具体属性信息,包含属性上报时间(time)和上报的属性值(value)。
time Long 属性值生成时间。该参数为可选字段,到豪秒级。根据您的业务场景决定消息中是否带时间戳。如果消息频繁,需根据时间戳判断消息顺序,建议消息中带有时间戳。
value Object 上报的属性值

响应:$sys/{pid}/{did}/thing/property/post/reply,格式如下:

{
  "id": "123",
  "code":xxxx,
  “msg”:"xxxx"
}

表:响应参数说明表

参数 类型 说明
Id String 消息id号,用户自定义,String类型的数字,长度限制13位。
code Integer 结果状态码
msg String 错误信息

设备属性设置

订阅Topic:$sys/{pid}/{did}/thing/property/set,JSON数据格式如下:

{
  "id": "123",
  "version": "1.0",
  "params": {
    "temperature": "30.5"
    ...
  }
}

表:请求参数说明

参数 类型 说明
id String 消息id号,平台定义,String类型的数字,长度限制13
version String 物模型版本号,可选字段
params JsonObject 属性设置参数。如以上示例中,设置属性:{"temperature":"30.5" }。

回复Topic:$sys/{pid}/{did}/thing/property/set_reply,格式如下:

{
  "id": "123"
  “code”:xxxx,
  “msg”:”xxxx”
}

表:响应参数说明表

参数 类型 说明
Id String 消息id号,平台定义,String类型的数字,长度限制13位。
code Integer 结果状态码
msg String 错误信息

results matching ""

    No results matching ""