ONENET设备终端接入协议4-MQTT

编号：_______________本资料为word版本，可以直接编辑和打印，感谢您的下载ONENET设备终端接入协议4-MQTT甲方：___________________乙方：___________________日期：___________________说明：本 合同 劳动合同范本免费下载装修合同范本免费下载租赁合同免费下载房屋买卖合同下载劳务合同范本下载 资料适用于约定双方经过谈判、协商而共同承认、共同遵守的 责任 安全质量包保责任状安全管理目标责任状8安全事故责任追究制幼儿园安全责任状占有损害赔偿请求权 与义务，同时阐述确定的时间内达成约定的承诺结果。文档可直接下载或修改，使用时请详细阅读内容。(MQTT)MessageQueuingTelemetryTransport版本号修订日期修订内容说明2015/9/8草稿2016/4/8重构Liuyuan2016/4/19丰富报文 格式 pdf格式笔记格式下载页码格式下载公文格式下载简报格式下载 ，业务流程Leihong2016/7/13增加设备间订阅，创建topic功能Leihong目录说明错误！未定义 书 关于书的成语关于读书的排比句社区图书漂流公约怎么写关于读书的小报汉书pdf 签。接入流程错误!未定义书签。Packet格式说明错误！未定义书签。Fixedheader错误!未定义书签。VariableHeader&Payload错误！未定义书签。支持的packet错误!未定义书签。CONNECT!误!未定义书签。FixedHeader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。CONNACK错误!未定义书签。FixedHeader错误！未定义书签。VariableHeader错误!未定义书签。PUBLISH(client->server)错误！未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。PUBLISH(server->client)错误！未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。PUBACK错误！未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。SUBSCRIBE错误!未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。SUBACK错误！未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。UNSUBSCRIBE昔误!未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。Payload错误！未定义书签。UNSUBACK错误！未定义书签。Fixedheader错误！未定义书签。VariableHeader错误!未定义书签。接入流程错误!未定义书签。连接鉴权错误!未定义书签。消息发布错误!未定义书签。数据点上报错误！未定义书签。平台命令(下发&回复)错误！未定义书签。创建Topic错误！未定义书签。订阅错误!未定义书签。取消订阅错误！未定义书签。推送设备Topic错误!未定义:说明MQTT协议详细内容请参见MQTTversion官方文档，本文档对此不做详细说明，仅指明OneNet的要求、默认 参数 转速和进给参数表a氧化沟运行参数高温蒸汽处理医疗废物pid参数自整定算法口腔医院集中消毒供应 、以及当前实现与MQTT官方文档的差异。该版本支持的功能：鉴权；数据点上报(平台指定topic);创建topic;获取项目的topic列表；订阅/取消平台的topic;设备间topic订阅；平台命令下发；Qos0(cS),Qos1(C->S);接入流程访问平台注册用户；用户根据业务情况，在“连接请求”章节中选择EDP登录方式(目前公测阶段，页面还未提供MQTT登录选项，登录方式与EDP兼容)；登录需填写设备相关属性，在项目下新增设备，获取项目ID、设备ID,以及authinfo等信息；设备发送TCP连接请求到以下地址，发送封装的报文与平台交互。平台服务器地址，TCP端口6002Packet格式说明包格式包含三部分:FixedHeader所有packet中都必须有VarableHeader部分包含有Payload部分包含有FixedheaderBit76543210byte1MQTTPacketType0000byte2-5RemainingLength（该字段占用1-4个字节）该版本支持的所有类型:名字值流向描述CONNECT1C->S客户端请求与服务端建立连接CONNACK2S->C服务端确认连接建立PUBLISH3CS发布消息PUBACK4CS收到发布消息确认SUBSCRIBE8C->S订阅请求SUBACK9S->C订阅确认UNSUBSCRIBE10C->S取消订阅UNSUBACK11S->C取消订阅确认VariableHeader&Payload消息类型VariableHeaderPayloadCONNECT有有CONNACK有有PUBLISH有有PUBACK有无SUBSCRIBE有有SUBACK有有UNSUBSCRIBE有有UNSUBACK有无支持的packetCONNECTFixedHeaderBit76543210byte1MQTTPacketType0000byte2-5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1-2ProtocolNameLength0000000000000100byte3M，01001101byte4Q'01010001byte5T，01010100byte6T，01010100Byte7ProtocolLevel00000001Byte8ConnectFlagUserflagPasswordflagWillRetainFlagWillQosFlagWillFlagCleanSessionFlagReserveByte9-10KeepAlive版本必须设置为4,平台只支持版本v,不支持更老的版本。使用第三方客户端时需要注意选择正确的版本。userflag与passwordflag平台不允许匿名登陆，因此这两个标志位在连接时必须设置为1,否则认为协议错误，平台将会断开连接。willflag与Willretainflag/Willqosflag平台暂不支持willflag,WillRetainFlag与WillQosFlag必须设置为0。CleanSessionFlag若客户端将cleansession标志位设置为0,当其断开后，平台将会保存session,session需保持的内容包含:客户端订阅的topic列表.客户端保存session的内容包含：已经发送到服务端的但还没有收到确认的Qos1消息列表.待发送的Qos0列表.Reserve保留位，置0。KeepAlive保活时间每个客户端可自定义设置连接保持时间，最短120秒，最长65535秒。PayloadDescriptionr是否必须存在格式Field1ClientIdentifier是2字节字串长度+utf8字串Field2UserName是2字节字串长度+utf8字串Field3UserPassword是2字节字串长度+utf8字串与鉴权相关的字段包含clientid,username和password,支持鉴权方式。字段设置消息示例client_id设置为平台创建设备时的设备idusername设置为项目IDpassword设置为鉴权信息(auth_info)”client_id=”123”username="433223"password="注册的鉴权信息"各字段说明如下：项目ID:在平台添加项目时平台生成的ID;鉴权信息（auth_info）:在平台申请设备时填写设备的auth_info属性（数字+字母的字符串），该属性需要产品内具备唯一性；CONNACKFixedHeaderBit76543210byte1MQTTPacketType0000byte2-5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1AcknowledgeFlags0000000Spbyte2ReturnCodexxxxxxxxSp:SessionPresentFlagsession信息在服务器已保持，置1;未保存，置0。返回码说明：返回码描述0成功1协议版本错误2非法的clientid3服务不PJ用4用户名或密码错误5非法链接（比如token非法）失败：*如果connect包不符合协议内容约束，则直接断掉连接，而不需要发送connack包.*如果鉴权或授权失败，回复一个带非0错误码的connack包.成功：*必须断掉重复的clientid.*执行cleansession对应的操作.*必须回复一个connack，回复码为0.*开始消息传递，并加入keepalive的监视.PS:客户端需要等到服务端的connack报文，才能发送后续的数据包.PUBLISH（client->server）FixedheaderBit76543210byte1MQTTPacketTypeDUPflagQoSLevelRETAINbyte2-5RemainingLength（该字段占用1-4个字节）DUP:QoS1:如果为0,则表示是第一次发送该包，如果为1,则表示为重复发送的包。Qos0:DUP必须为0QOS:指定了该publish包的qos等级如下RETAIN:暂不实现Qos值Bit2Bit1描述000取多发送次101至少发送一次PS该版本只实现Qos0,Qos1VariableHeaderDescription格式是否必须Field1TopicName「2字节字串长度+utf8字串是Field2PacketIdentifier2字节QoS0:否，QoS1是Payload内容根据不同业务自定义PUBLISH(server->client)FixedheaderBit76543210byte1MQTTPacketTypeDUPflagQoSLevelRETAINbyte2-5RemainingLength（该字段占用1-4个字节）DUP:QoS1:如果为0,则表示是第一次发送该包，如果为1,则表示为重复发送的包。Qos0:DUP必须为0QOS:指定了该publish包的qos等级如下RETAIN:Qos值Bit2Bit1描述000取多发送次PS该版本只实现Qos0VariableHeaderDescription格式Field1TopicName：2字节字串长度+utf8字串Payload内容根据不同业务自定义PUBACKFixedheaderBit76543210byte1MQTTPacketType0000byte2~5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1~2PacketIdentifierPacketIdentifierSUBSCRIBEFixedheaderBit76543210byte1MQTTPacketType0000byte2~5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1~2PacketIdentifierPacketIdentifierPayloadDescription格式Byte1~nTopicName2字节字串长度+utf8字串Byten+1Reserved保留字七（兼谷说明可以包含一个或多个topic.topic必须是数字、英文、反斜杠（/）的组合，目前不支持通配符。每个客户端最多订阅100个topic;以下topic被系统保留使用，（客户端不能订阅）：类型说明$开头平台保留SUBACKFixedheaderBit76543210byte1MQTTPacketType0000byte2~5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1~2PacketIdentifierPacketIdentifierPayloadDescription76543210byte1retcode返回码说明:返回码描述0x00成功0x80失败UNSUBSCRIBEFixedheaderBit76543210byte1MQTTPacketType0000byte2~5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1~2PacketIdentifierPacketIdentifierPayloadDescription格式Byte1~nTopicName2字节字串长度+utf8字串可以包含一个或多个topic.UNSUBACKFixedheaderBit76543210byte1MQTTPacketType0000byte2~5RemainingLength（该字段占用1-4个字节）VariableHeaderDescription76543210byte1~2PacketIdentifierPacketIdentifier接入流程连接鉴权设备向平台发起connect请求.connect中携带鉴权信息，具体参见（报文格式参考平台拿到鉴权信息进行鉴权.鉴权通过后，如果cleansession=0,平台将会加载保存的设备的一些信息.如订阅列表中描述）.如果cleansession=1,设备没有保存信息在平台，则不加载设备相关信息^返回鉴权结果ConnAck（报文格式参考.消息发布数据点上报设备使用publish报文来上传数据点，报文格式如下:VariableHeader:Field名称|说明格式FieldlTopicName="$dp”$dp为系统上传数据点的指令2字节字串长度+utf8字串Payload:Payload包含真正的数据点内容，支持的格式如下:说明\bit76543210Byte1Bit0-5数据类型指示，目前支持：Type=1.BytenDeviceOneNetPublish$dp(Qos0)存储Qos1(Client->Server)DeviceOneNetPublish$dp(Qos1)存储PubAck设备发布Qos0消息（上报数据点）平台收到上报数据点后保存起来.平台给设备回复PubAck（报文格式参考平台命令（下发&回复）命令下发平台使用publish报文来下发平台指令，报文格式如下:FixHeader：参考VariableHeader：Field名称说明格式Field1TopicName="$creq/cmduuid”$creq为系统下发Cmd的指令，2字节字串长度+utf8字串cmduuid为该条指令的uuidPayload:Payload包含真正的指令内容Publish$creq(Qos0)命令下发：平台向设备发送topic为$creq的消息（该topic为平台命令）.设备收到topic为$creq的topic时，需将其作为平台下发的指令来处理命令回复设备使用publish报文来回复平台指令，报文格式如下:FixHeader：参考VariableHeader：Field名称说明格式Field1TopicName="$crsp/cmduuid”$crsp为系统处理设备回复cmd的指令，cmduuid为该条指令的uuid2字节字串长度+utf8字串Payload:Payload包含真正回复的指令内容Qos1(Client<->Server)DeviceOneNetPuback消息如果设备回复响应时以Qos1回复，则平台需要给设备回复一个创建TopicDevice报文格式参考HTTP请求HTTP响应设备通过发送HTTP请求进彳ftopic的创建操作平台收到请求后创建topic并返回结果.请求及响应定义如下：HIIP万法POSTURL头部api-key:xxxx-ffff-zzzzz,必须masterkeyURL参数Httpbody内容(“力2力namexxxxxxOneNet平台收到请求后更新topic列表.平台给设备回复SubAck.G艮文格式参考取消订阅UnSubackOneNet更新设备订阅列表设备发起取消订阅请求.（报文格式参考平台收到请求后更新topic列表.平台给设备回复UnSubAck.G艮文格式参考推送设备TopicPublish报文推送:设备发起推送topic请求.（报文格式参考平台收到请求后，将topic推送到相关订阅设备.（目前只支持在线推送）平台返回推送ack（取决于qos）.（报文格式参考设备使用publish报文来推送Topic.报文格式如下：FixHeader：VariableHeader：Field名称说明格式FieldlTopicName填写设备订阅的topic2字节字串长度+utf8字串参号Payload：Payload为设备自定义内容HTTP请求推送请求及响应定义如下:HIIP万法POSTURL头部api-key:xxxx-ffff-zzzzz,必须masterkeyURL参数topic=XXXXXX,必选，在发送mqtt协议的topic.必填Httpbody内容用户自定义Json或一进制数据（小于64K）成功返回("errno":0,"error":sUcc”}PS:欢迎访问设备云门户网站注册用户，获取最新文档。