设备接入协议-TCP.doc

新大陆物联网云平台TCP设备接入协议1.说明该文档上的协议基于TCP,协议全部以JSON格式定义2・接入流程2.1. 访问平台 注册帐号2.2. 平台以项目为单位，一个项目下可以有多个设备，每个设备可以包含多个传感器，所以依次添加项目、设备、传感器，其中在添加设备时在“通讯协议” 一栏中可以选择TC叭MQTT\HTTP等方式2.3. 操作以上功能时顺便记录下：设备标识(device).设备传输密钥(key)等信息2.4. 硬件设备发送TCP连接请求到以下地址，发送以下各项数据报文与平台进行交互2.5. 平台接入服务器地址 或 IP 120.77.58.34, TCP 端口 8600,8700,88003・请求类型类型值含义方向1CONN REQ：连接请求C(client)->S(server)2CONN RESP：连接响应s->c3PUSH DATA：上报数据c->s4PUSH ACK：上报数据确认s->c5CMD REQ：命令请求s->c6CMD RESP：命令响应c->s7PING REQ:心跳请求s->c8PING RESP:心跳响应c->s其他值保留4. 连接请求(client卜〉(server)在当设备建立TCP连接到指定端I I后，需要发送连接请求报文，请求报文格式如下:”device”： ,,P123456789I,/llkey,,:ll9861d43a0733415ab5424ee7d0flc685,,/"ver'Tvl.rJSON 键JSON 值说明消息示例t1固体数字1,代表连接请求device设备标识在平台上添加设备时的设备标识：1） 新大陆网关：进入网关设置易【参数设置】 ・》【系统参数】中的序列号2） 新大陆农业网关：浏览器登录农业网关设 置页面・》【设备状态】中的设备编号3） 新大陆家居网关：进入平板的家居网关主 界而，界而左上角的一行序列号4） 其它的MCU/SOC/网关/等设备：可自 行输入一个唯一的标识用于与平台连接PF12345678Key传输密钥在平台上添加设备时自动生成的一串字符串 （32位长度的字符串），该值在全局内具备唯 一性；9861d43a0733415ab5424ee7d0flc685ver客户端代码版本号可以是自己拟定的一组客户端代码版本号值VI.15. 连接响应(server)->(client)硬件设备客户端发送连接请求后，服务端会发送响应消息，响应报文格式如下:{”t"：2,'•status1': 0JSON 键JSON 值说明消息示例t2固体数字2,代表连接响应2status状态结果一个字节表示，根据验证情况，枚举值如下0：握手连接成功；1：握手连接失败•协议错误；2：握手连接失败•未添加设备；3：握手连接失败■设备鉴权失败；4：握手连接失败■未授权；5-255：保留值；0当status为非0失败时：服务端不主动断开设备的连接，将保留35秒后重新发起连接请求6. 数据上报（client卜〉（server）设备与服务器建立连接后，便可以进行传感数据的上报上传，上报报文格式如下:{” t”：3,"datatype11:!"datas*1：!见下表说明}或［见下表说明］,"msgid": 123JSON 键JSON 值说明报文示例t3固体数字3,代表数据上报3datatype数据上报格式类型具体为datas属性内的传感数据格式类型，如 下=1： JSON格式1字符串;=2： JSON格式2字符串；=3： JSON格式3字符串;1datas要上报的传感数据数 组该属性根据datatype类型的不同，可以上报多 个传感器数据，也可以上报同一传感器的多条 数据，其中apitagl为传感的标识名，value为 传感值，可以是数字、浮点、字符串、二进制 （最大48字节大小）数据类型为1 （JSON格式1字符串）:"datas":{"apitagl*1: "valuel","apitag2u: value2z• • •}示例："datas11:{"temperature": 23.5, "rgb-r": ,,#999,,/• • •}数据类型为2 （JSON格式2字符串）:apitagl与value数据格式同上，datetimel须是 yyyy-mm-dd hh:mm:ss 格式”datas”：{"apitagl":{"datetimel":"valuel,,}/"apitag2": {"datetime2":"value2"}/• • •}示例：” datas”:{"temperature":{"2015-03-2222:31:12,,:22.5}/• • •}数据类型为3 (JSON格式3字符串)示例:value数据格式同上，dt 须是 yyyy-mm-dd hh:mm:ss 格式HdatasH:[{"apitag":"temperature"z"datapoints":[{”dt”:”2018・01・22 22:22:22”， 〃可选 "value": 36.5 〃数字浮点字符串}]},{"apitag": "location","datapoints":[…]L{...}]msgid消息编号由客户端生成的一个用于表示该条报文的编 号，用于服务器下发“上报响应”时原样带回1237. 数据上报响应(server)->(client)设备进行的任何一次传感数据上报后，服务端会下发确认信息，报文格式如下:{'•msgid": 123,"status":OJSON 键JSON 值说明消息示例t4固体数字4,代表数据上报响应4msgid消息编号由服务端原样返回客户端上一次上报数据的消 息ID值123status状态结果一个字节表示0：上报成功；1：上报失败；0其它：保留值；8. 命令请求(server)->(client)设备成功连接云平台后，除了进行传感数据的上报，服务端也能下发命令，如控制某个传感器的开关，报文格式 如下：”t”：5,"cmdidH: 123,"apitag":"rgb_ope n”HdataM:｛见下表说明｝JSON 键JSON 值说明消息示例t5固体数字55cmdid命令编号由服务端生成一个报文的编号，客户端设备收 到命令处理后上发“命令响应”时原样带回服 务端123apitag传感标识名（可空）为在平台上添加传感器时的标识名rgb ope ndata命令值一个命令值，可以是数字、浮点、字符串、JSON例数字：1浮点：12.3字符串：”你好”JSON：「onofftl，”red":23.5}9. 命令响应(client卜〉(server)该报文由客户端发往服务器，以响应相应的命令，报文格式如下:”t”：6,"cmdid^,: 123,” status”:。

"data": ｛见下表说明｝｝JSON 键JSON 值说明消息示例t6固体数字66cmdid命令编号命令请求时的命令编号，原样还回123status状态结果一个字节表示 0：处理成功； 1:处理失败； 其它：保留值；0data命令响应值响应值，可以是数字、浮点、字符串、JSON同上10. 心跳请求(server)->(client)心跳请求是服务端在客户端闲置io分钟后主动发送心跳包，确认是否还，若在后送后10秒内未收到响应包 则主动关闭连接，固定字符串报文如下：“$#AT#\r”11. 心跳响应(client)<->(server)客户端在收到心跳请求后，响应以下消息回应服务器客户端还，固定字符串报文如下：“$0K##\r”。