ONENET设备终端接入协议MQTT.docx

《ONENET设备终端接入协议MQTT.docx》由会员分享，可在线阅读，更多相关《ONENET设备终端接入协议MQTT.docx（25页珍藏版）》请在第一文库网上搜索。

1、MessageQueuingTe1emetryTransport(MQ)版本号修订日期修订内容阐明V1.1/9/8草稿V2.0/4/8重构1iuyuanV2.1/4/19丰富报文格式,业务流程1eihongV2.2/7/13增长设备间订阅,创立topIC功能1eihong目录1。说明。32 接入流程3。3 PaCket格式说明。错误!未定义书签。3 .1FiXedheadCr44 .2Variab1eHeader&Pay1oad错误!未定义书签。4 支持的PaCket5。4.1CONNECT54.1.1FixedHeader54.12VaMabIeHeader54.1.3PaV1Oad靖误!未

2、定义书签。4. 2Ce)NNACK错误!未定义书签。1. 2.1FiXedHeader62. 2.2Variab1cHcade6。43PUB1ISH(dientServer)7。4.3.1FiXedheader74. 3.2VariabIeHCader。错误!未定义书签。4.3.3PaV10ad84.4。PUBuSH(SerVerdient)8。4.4.1FiXedheader。84.4.2VariabIeHeader84.4.3Pay1Oad。84.5 PUBACK94.4.1FiXedheader。94.4.2Variab1eHeader94.6 SUBSCRIBEq94.6.1 FiXC

3、dheader94.6.2 Variab1eHeader94.6.3 PayIOad94.7 SUBACK1Qo4.6.1FiXedheader104.6 .2VariaHeHeader104.7 .3PaMOad104. 8。UNSUBSCRIBE131. 7.1Fix/dheader104. 7.2Variab1eHeade门1。4.73PayIOad114.9UNSUBACK。114. 9.1FiXedheadec遍误!未定义书签。4.9.2Variab1eHeader115。接入流程0125. 1。连接鉴权12。5.2消息发布13,5.25数据点上报135.2.2平台命令（下发&回复）

4、175.2 创建TOPiC195.3 订阅错误!未定义书签。5.4 取消订阅215.5推送设备TOPiC22。1阐明MQTT合同具体内容请参见MQTTversion3.1.1官方文档，本文档对此不做具体阐明，仅指明OneNet的规定、默认参数、以及目前实现与MQTT官方文档的差别。该版本支持的功能： 鉴权； 数据点上报（平台指定topic）; 创立topic; 获取项目的tOPiC列表； 订阅/取消平台的topic; 设备间t。PiC订阅； 平台命令下发； QosO(cS)zQos1(C-S);2接入流程2.1 访问平台注册顾客；2.2 顾客根据业务状况,在“连接祈求”章节中选择EDP登录方式

5、(目前公测阶段，页面尚未提供MQTT登录选项，登录方式与EDP兼容)；2.3 登录需填写设备有关属性，在项目下新增设备,获取项目ID、设备ID,以及uthifo等信息；2.4 设备发送TCP连接祈求到如下地址,发送封装的报文与平台交互。平台服务器地址，TCP端口60023PaCket格式阐明包格式涉及三部分：FixedHeader所有packet中都必须有Varab1eHeader部分包具有Pay1oad部分包具有3.1FixedheaderBit76543210byte1MQTTPacketType0000byte2-5Remaining1ength(该字段占用1-4个字节)该版本支持的所有

6、类型:名字值流向描述CONNECT1c-s客户端祈求与服务端建立连接CONNACK2s-c服务端确认连接建立PUB1ISH3CoS发布消息PUBACK4CgS收到发布消息确认SUBSCRIBE8c-s订阅祈求SUBACK9S-C订阅确认UNSUBSCRIBE10c-s取消订阅UNSUBACK11s-c取消订阅确认3.2VribIeHeader&Pay1oad消息类型Variab1eHeaderPayIoadCONNECT有有CONNACK有有PUB1ISH有有PUBACK有无SUBSCRIBE有有SUBACK有有UNSUBSCRIBE有有UNSUBACK有无4支持的packet4.1CONNE

7、CTFixedHeaderBit7654321Obyte1MQTTPacketTypeOOOObyte25Remaining1ength（该字段占用1-4个字节）VariabIeHeaderDescription7654321Obyte1-2ProtocoIName1engthOOOOOOOOOOOOO1OObyte3zM,O1OO11O1byte4Q01010001byte5,T01010100byte6j01010100Byte7Protoco11eveI00000001Byte8ConnectFIaSUserfagPasswordf1agWi11RetainF1agWi11QosFIag

8、Wi1IF1agCIeanSessionF1agReserveByte910KeepA1ive版本必须设立为4,平台只支持版本V3.1.1,不支持更老的版本。使用第三方客户端时需要注意选择对时时版本。（2） USerfIQg与PC1SSWOrdfIag平台不容许匿名登陆,因此这两个标志位在连接时必须设立为1,否则觉得合同错误,平台将会断开连接。（3） Wi11fIQg与Wi11retainfIag/WiIIqosf1ag平台暂不支持WiIIf1ag,WiIIRetainF1Qg与Wi11QoSFIQg必须设立为0。（4） C1eanSessionFIag若客户端将CIeaSeSSion标志位设

9、立为0,当其断开后,平台将会保存SeSSion,sessio需保持的内容涉及：客户端订阅的t。PiC列表.客户端保存sessio的内容涉及：已经发送到服务端时但还没有收到确认的Qos1消息列表.待发送的QoSo列表.（5） ReserVe保存位，置0。（6） KeePA1iVe保活时间每个客户端可自定义设立连接保持时间,最短12。秒，最长65535秒。Pay1OadDescription与否必须存在格式FieId1C1ientIdentifier是2字节字串长度+utf8字串Fie1d2UserName是2字节字串长度+utf8字串Fie1d3UserPassword是2字节字串长度+utf8

10、字串与鉴权有关的字段涉及C1ientid,username和PQSSWOrCI,支持鉴权方式。字段设立消息示例CIier1Jid设立为平台创立设备时的设备idusername设立为“项目ID”password设立为“鉴权信息（auth_info）”c1ient_id=123username=zz433223passWOrd=注册FrJ鉴权信息”各字段阐明如下:项目ID：在平台添加项目时平台生成的ID;鉴权信息（QUth_inf。）:在平台申请设备时填写设备的QUthJnfo属性（数字+字母的字符串），该属性需要产品内具有唯一性；4.2C0NNACK4.2.1FixedHeaderBit7654

11、321Obyte1MQTTPacketTypeOOOObyte25Remaining1ength（该字段占用1-4个字节）4.2.2VariabIeHeaderDescription7654321Obyte1Acknow1edgeF1agsOOOOOOOSpbyte2ReturnCodeXXXXXXXXSP:SessionPresentFIagzSession信息在服务器已保持，置1沫保存,置0。返回码阐明:返回码描述0成功1合同版本错误2非法的cIientid3服务不可用4顾客名或密码错误5非法链接(例如token非法)失败：*如果c0neCt包不符合合同内容约束,则直接断掉连接，而不需要发

12、送Conack包.*如果鉴权或授权失败，答复一种带非0错误码的connack包.成功：*必须断掉反复的C1ietid.* 执行CIeQnSeSSion相应的操作.* 必须答复一种ConnCIck,答复码为0.* 开始消息传递，并加入keepa1ive的监视PS:客户端需要等到服务端的connack报文,才干发送后续的数据包.4.3 PUB1ISH(C1ient-server)4.3.1 FixedhederBit76543210byte1MQTTPacketTypeDUPQoS1eveIRETAIfIagNbyte25Remaining1ength（该字段占用1-4个字节）DUP:QoS1:如

13、果为0,则表达是第一次发送该包，如果为1,则表达为反复发送的包。QosO:DUP必须为0QOS:指定了该pub1ish包的qoS等级如下RETAIN:暂不实现QOS值Bit2Bit1描述OOO最多发送一次1O1至少发送一次PS：该版本只实现QosO,Qos14.3.2 VaribIeHeaderDescr1ption格式与否必须Fie1d1TopicName2字节字串长度+utf8字串是Fie1d2Packet1dentifier2字节QOSO:否，QoS1:是4.3.3Pay1oad4.4 PUB1ISHfserver-c1ient）4.4.1 FixedheaderBit7654321Obyte1