地磁接收器与上位机通信协议.doc

地磁接收器与上位机通信协议地磁接收器与上位机通信协议 版本号版本号 1.0.01.0.0 苏州博朗明科技有限公司苏州博朗明科技有限公司 2015 年年 8 月月 1 目录目录 目录1 一、一、 前言前言4 二、二、 范围范围4 三、三、 系统拓朴图系统拓朴图.4 四、四、术语和缩略语术语和缩略语.4 41术语术语.4 4.1.1.传输控制协议/互联网络协议 TCP/IP transmission control protocol/internet protocol.4 4.1.2.传输时间间隔 transfer interval.4 4.1.3.数据实体 entity.4 4.1.4.上传 uploading.4 4.1.5.下传 downloading5 42缩略语缩略语.5 4.2.1.地磁接收器.5 4.2.2.扩展板.5 4.2.3.上位机.5 4.2.4.下位机.5 五、五、5 六、六、通讯方式通讯方式5 七、七、 数据传输通信协议数据传输通信协议6 71通信链路的维持通信链路的维持.6 72特殊说明特殊说明.6 73协议格式协议格式.6 74命令命令ID类别类别6 75命令编号列表命令编号列表.7 76通信系统协议通信系统协议.8 7.6.1.下行数据格式下行数据格式.8 7.6.1.1 上位机命令应答(命令 ID:0001H) .8 7.6.1.2 时间同步指令（命令 ID：0002H）.8 7.6.1.3 设备时间获取指令（命令 ID：0003H）.8 7.6.1.4 设备重启指令（命令 ID：0004H）.9 7.6.1.5 查询地磁终端状态指令（命令 ID:0005H）9 7.6.1.6 设备开关设置指令（命令 ID:0006H）9 7.6.1.7 设置阀值指令（命令 ID：0007H）.9 7.6.1.8 设置灵敏度指令（命令 ID：0008H）.9 7.6.1.9 设置采样间隔指令(命令 ID：0009H) 10 7.6.1.10 获得接收器参数指令(命令 ID：000AH)10 7.6.1.11 读取车辆信息（命令 ID:000BH）10 7.6.1.12 添加地磁终端（命令 ID:000CH）10 7.6.1.13 删除地磁终端（命令 ID:000DH） .11 2 7.6.1.14 配置通讯参数指令（命令 ID：0010） .11 7.6.1.15 配置地磁参数指令（命令 ID：0011H）.11 7.6.2.上行数据格式上行数据格式.11 7.6.2.1.地磁接收器命令应答（命令 ID：0F01H）12 7.6.2.2.查询状态命令应答 （命令 ID:0F05）.12 7.6.2.3.地磁接收器登录（命令 ID：0F10H）12 7.6.2.4.故障指令（命令 ID：0F11H） .12 7.6.2.5.地磁终端参数上传指令（命令 ID：0F12H）13 7.6.2.6.地磁接收器历史数据上传（命令 ID：0F13H）13 苏州博朗明科技有限公司 3 通信协议版本改动说明通信协议版本改动说明 协议版本 号 改动说明时间修改人 1.0.0通信协议初稿2015/8/20帅珠龙 苏州博朗明科技有限公司 4 一、一、 前言前言 地磁接收器与上位机通信协议，用于地磁配置软件或地磁数据采集监测软件与地磁接 收器设备或带 LAN 接口扩展板之间数据通信标准协议。 二、二、 范围范围 PC 端软件与硬件终端之间的标准通信。 本协议由苏州博朗明科技有限公司研发部负责解释。 三、三、 系统拓朴图系统拓朴图 四、四、术语和缩略语术语和缩略语 术语术语 4.1.1.传输控制协议/互联网络协议 TCP/IP transmission control protocol/internet protocol 一种网络通信协议，规范了网络上的所有通信设备，尤其是一个主机与另一个主机之 间的数据往来格式以及传送方式。TCP/IP是INTERNET的基础协议，也是计算机数据打包和 寻址的标准办法。 4.1.2. 传输时间间隔 transfer interval 是指数据上传或下发的时间间隔。 4.1.3.数据实体 entity 是指各类数据传输对象。 4.1.4.上传 uploading 地磁接收器或扩展板定时向上位机发送采集参数。 4.1.5.下传 downloading 配置软件或数据采集监测软件发送的查询指令或控制命令。 苏州博朗明科技有限公司 5 42缩略语缩略语 4.2.1.地磁接收器 指地磁系统中用于接收终端数据的中心处理设备。 4.2.2.扩展板 指地磁系统中用于通信扩展和状态显示的附加设备。 4.2.3.上位机 安装有配置软件或数据采集监测软件的PC/服务器。 4.2.4.下位机 泛指通信系统网关或其它拥有控制，数据采集等功能的底层控制设备。 五、五、通讯方式通讯方式 通信双方采用 TCP/IP 长连接方式，通信双方以客户-服务器方式建立 TCP 连接，用于双 方信息的相互提交。 上位机作为服务器方，开监听端口，地磁接收器作为客户端连接成功后，上位机接收 各地磁接收器发送的设备编号信息（下属地磁终端信息） ，并对接收到的数据返回对应的回 复消息，上位机主动下发设置及查询指令，地磁接收器或扩展板对接收到的数据返回对应 的回复消息。 六、六、数据操作流程图数据操作流程图 七、七、 数据传输通信协议数据传输通信协议 通信链路的维持通信链路的维持 下位机与上位机通信链路的维持是通过互发心跳指令的方式。 上位机-服务器方地磁接收器-客户端方 主动上传 主动下发 应答回复 回复 应答回复 回复 苏州博朗明科技有限公司 6 心跳指令由下位机向上位机周期性的发送，上位机收到心跳指令后回复一条心跳应答 指令。下位机心跳上传周期为10秒。上位机间隔三个周期未收以心跳数据则认为该下位机 已经断开，下位机若三个周期未收到心跳应答指令则认为与上位机链路断开进行重连。心 跳指令有消息长度及下位机设备ID，其它信息都没有。 72特殊说明特殊说明 超过一个字节存储空间的整数，协议中采用高位在前，低位在后的大端模式存放； 在本规范中所有指令包含的时间均为GMT时间； 本协议中所使用的ASCII字符指：0AH、0DH及20H到7EH之间的ASCII字符； 本协议中汉字均采用GB2312编码； 设备ID编号由三个字节组成，首字节代表下位机地址；第二，三个字节代表该接 收器所属的地磁终端地址，如果为0x0000则表示对该网络系统中所有地磁广播。 ID第二,三字节含义 OX0000 该接收器所属的所有地磁终端(广播) 0X0001 ID为0001的地磁 OXFFFF 仅对地磁接收器操作，不涉及地磁终 端 73协议格式协议格式 协议格式表 起始字节字段长度（字节）说明 0 起始符 10A 1 消息长度 1 消息的总长度（字节数），从第一个 字节到最后一个字节。 2 设备ID号 3 设备ID编号，第一个字节代表接收器 ID，第二，三个字节代表所属地磁编 号。 5 命令ID 2 第一个字节表示命令ID类别，第二个 字节表示命令编号。 7 命令序号 1 从0开始循环累加 注：分包（按协议）发送的数据，命 令序号需累加 8 信息内容 - 不定长，详见7.6 N 结束符 3EOF 74命令命令 IDID 类别类别 目前定义的命令ID类别有3类，以后视需要可以扩展： 序号命令ID类别编号通信方向说明 100H 下行由上位机发送给下位机 2 通信系统协议 0FH 上行由下位机发送给上位机 苏州博朗明科技有限公司 7 75命令命令编号编号列表列表 命令号命令号 命令内容命令内容传输方向传输方向 0001 上位机应答下行 0002 时间同步下行 0003 读取设备时间下行 0004 设备重启下行 0005 查询地磁终端状态下行 0006 设备开关设置下行 0007 设置阀值下行 0008 设置灵敏度下行 0009 设置采样间隔下行 000A 读取接收器参数下行 000B 读取车辆信息下行 000C 添加地磁终端下行 000D 删除地磁终端下行 0010 配置接收器通信参数下行 0011 配置地磁参数下行 0F01 地磁接收器应答上行 0F05 查询状态命令应答上行 0F10 地磁接收器登录上行 0F11 故障上传上行 0F12 地磁终端参数上传上行 0F13 接收器历史数据上传上行 76通信通信系统协议系统协议 苏州博朗明科技有限公司 8 7.6.1.下行数据格式下行数据格式 上位机命令应答(命令 ID:0001H) 上位机必须对地磁接收器的某些指令应答（除地磁接收器应答指令和已指定不需上位 机应答的数据），否则地磁接收器超时后会重发，地磁接收器按照设定的重发次数（出厂 默认为2次）和重发间隔（出厂默认为8秒）重发。该指令默认无需地磁接收器应答。 信息内容如下： 起始字节字段长度（字节）说明 8 应答命令序号 1 需要应答的那条命令序号 9 命令ID 2 地磁接收器上发指令的ID 11 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 11 结束符 3EOF 7.6.1.2 时间同步指令（命令 ID：0002H） 该指令只对下位机进行时间同步，下位机收到该指令后返回应答指令。如广播指令无 需应答。 信息内容如下： 起始字节字段长度（字节）说明 8 时间 7 开始一个字节代表年(2012年为0x0C)， 第二个字节代表周，第三个字节代表 月，第四个字节代表日，第五个字节 代表小时，第六个字节代表分，第七 个字节代表秒 15 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 16 结束符 3EOF 7.6.1.3 设备时间获取指令（命令 ID：0003H） 该指令用于获取指定地磁接收器或指定地磁终端（如有时间功能）的系统时间，地磁 接收器/地磁终端收到该指令后返回该设备的系统时间。 起始字节字段长度（字节）说明 8 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 9 结束符 3EOF 7.6.1.4 设备重启指令（命令 ID：0004H） 苏州博朗明科技有限公司 9 该指令用于重启地磁接收器（地磁终端），地磁接收器（地磁终端）收到该指令后返 回应答指令，返回应答后地磁接收器（地磁终端）进行重启操作。 起始字节字段长度（字节）说明 8 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 9 结束符 3EOF 7.6.1.5 查询地磁终端状态指令（命令 ID:0005H） 该指令用于获取地磁终端当前参数。设备收到该指令后立即返回当前所有工作参数。 起始字节字段长度（字节）说明 8 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 9 结束符 3EOF 7.6.1.6 设备开关设置指令（命令 ID:0006H） 该指令用于打开或关闭地磁终端，需地磁接收器应答。 起始字节字段长度（字节）说明 8 数据内容 1 00关机01开机 9 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 10 结束符 3EOF 7.6.1.7 设置阀值指令（命令 ID：0007H） 该指令用于设置阀值，需地磁接收器应答 起始字节字段长度（字节）说明 8 设定阀值 1 9 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 10 结束符 3EOF 7.6.1.8 设置灵敏度指令（命令 ID：0008H） 该指令用于设置灵敏度，需地磁接收器应答。 起始字节字段长度（字节）说明 8 灵敏度 1 9 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 苏州博朗明科技有限公司 10 10 结束符 3EOF 7.6.1.9 设置采样间隔指令(命令 ID：0009H) 该指令用于设置采样间隔，需地磁接收器应答。 起始字节字段长度（字节）说明 8 采样间隔 1 9 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 10 结束符 3EOF 7.6.1.10 获得接收器参数指令(命令 ID：000AH) 该指令用于获得设备参数（如阀值，灵敏度，采样间隔等）。需地磁接收器应答。 起始字节字段长度（字节）说明 8 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 9 结束符 3EOF 7.6.1.11 读取车辆信息（命令 ID:000BH） 该指令用于读取地磁上车辆信息，需地磁接收器应答。 起始字节字段长度（字节）说明 8 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 9 结束符 3EOF 7.6.1.12 添加地磁终端（命令 ID:000CH） 该指令需要地磁接收器应答,地磁接收器收到该指令后才会上传已添加地磁终端数据 起始字节字段长度（字节）说明 8 地磁终端ID 2 10 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 11 结束符 3EOF 7.6.1.13 删除地磁终端（命令 ID:000DH） 该指令需要地磁接收器应答,地磁接收器收到该指令后不会上传该地磁终端数据 起始字节字段长度（字节）说明 8 地磁终端ID 2 苏州博朗明科技有限公司 11 10 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 11 结束符 3EOF 7.6.1.14 配置通讯参数指令（命令 ID：0010） 此处的通讯参数即为上位机IP地址和端口号，当地磁接收器收到该指令并修完成后返 回应答指令，重新启动网络控制器后该参数生效，网络控制器连接设置的IP地址及端口。 起始字节字段长度（字节）说明 8 服务器通讯IP 地址 4 例如：10.20.37.19表示为0x0A 0x14 0x25 0x13 12 服务器通讯端 口号 2 数值范围0-65535 14 地磁接收器IP 地址 4 同IP 16 地磁接收器端 口号 2 同端口号 20 网关IP地址 4 同IP 24 子网掩码 4 同IP 25 地磁接收器ID 10-255 26 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 27 结束符 3EOF 7.6.1.15 配置地磁参数指令（命令 ID：0011H） 用来配置所属地磁的基本参数，需下位机应答 起始字节字段长度（字节）说明 8 参数1-10 10 相关参数定义参照地磁通信协议 18 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 19 结束符 3EOF 7.6.2.上行数据格式上行数据格式 地磁接收器命令应答（命令 ID：0F01H） 地磁接收器必须对上位机的某些指令应答，否则上位机超时后会重发，上位机按照重 发次数据（默认2次）和重发间隔（默认8秒）重发。该指令无需上位机应答。 起始字节字段长度（字节）说明 苏州博朗明科技有限公司 12 8 命令ID 2 上位机下发指令的ID 10 应答命令序号 1 需要应答的那条命令序号 11 操作结果 1 00失败，01成功 12 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 13 结束符 3EOF 7.6.2.2.查询状态命令应答 （命令 ID:0F05） 地磁接收器对上位机查询状态指令（0F05）进行应答，该指令无需上位机应答。 起始字节字段长度（字节）说明 8 应答命令序号 2 需要应答的那条命令序号 9 设备状态00离线，01在线 10 信号量00-FF 11 电池电量00-FF 10 地磁终端 参数 4 12 预留 14 校验码 1 第一个字符至校验码前一个字符的算 术和，取低8位 15 结束符 3EOF 7.6.2.3.地磁接收器登录（命令 ID：0F10H） 地磁接收器开启或重启后第一次向上位机发送数据时，必须首先发送登录指令，登录 指令携带地磁终端编号列表，该指令默认需要上位机返回命令应答。 该指令提供地磁接收器判断当前登录的上位机是否有效。 起始字节字段长度（字节）说明 8 地磁终端1 2 地磁终端1 ID - - 地磁终端n 2 地磁终端n ID - 校验码 1 第一个字符至校验码