iot-modbus物联网通讯协议
iot-modbus 是一个物联网通讯协议。
- 基础架构采用Spring Boot2.x + Netty4.X + Maven3.6.x
- 日志采用 logback。
- 使用 netty 通讯实现 java 控制智能设备。
- 支持COM(串口)和TCP协议,支持服务端和客户端两种模式。
- 同时支持设备组多台设备高并发通讯。
- 采用工厂设计模式,代码采用继承和重写的方式实现高度封装,可作为SDK提供封装的接口,让具体的业务开发人员无需关心通讯协议的底层实现,直接调用接口即可使用。
- 实现了心跳、背光灯、扫码、刷卡、指静脉、温湿度和门锁(支持多锁)、LCD显示屏等指令控制、、三色报警灯控制。
- 代码注释丰富,包括上传和下发指令调用例子,非常容易上手。
版本说明
- V1.0.0版本仅支持TCP服务端通讯模式;
- V2.0.0版本支持TCP服务端和客户端两种模式,客户端模式还增加了心跳重连机制。
- V3.0.0版本支持COM(串口)和TCP协议,增加logback日志按文件大小和时间切割输出。
- V3.1.0版本代码优化,抽取公共模块子工程。
- V3.2.0版本TCP通讯增加支持LCD显示屏控制指令,支持批量控制LCD显示屏。
- V3.2.1版本串口通讯增加支持LCD显示屏控制指令,支持批量控制LCD显示屏。
- V3.2.2版本串口通讯接收指令数据拆包处理代码优化,网口通讯增加支持三色报警灯控制指令。
- V3.2.3版本串口通讯增加支持三色报警灯控制指令,串口通讯接收指令数据拆包处理代码优化。
- V3.2.4版本使用netty集成Rxtx对串口数据进行数据拆包处理,并且对指静脉指令进行优化。
- V3.2.5版本客户端模式支持同时连接多个服务端下发和接收指令数据。
安装教程
1. 系统Windows7以上;
2. 安装Jdk1.8以上;
2. 安装Maven3.6以上;
3. 代码以Maven工程导入Eclipse或Idea。
使用说明
- 工程结构说明:
- iot-modbus //物联网通讯父工程
- ├── doc //文档管理
- ├── iot-modbus-client //netty通讯客户端
- ├── iot-modbus-common //公共模块子工程
- ├── iot-modbus-netty //netty通讯子工程
- ├── iot-modbus-serialport //串口通讯子工程
- ├── iot-modbus-server //netty通讯服务端
- ├── iot-modbus-test //使用样例子工程
- └── tools //通讯指令调试工具
- 配置文件查看iot-modbus-test子工程resources目录下的application.yml文件;
- 启动文件查看iot-modbus-test子工程App.java文件;
- 服务启动后,服务端端口默认为:8080,netty通讯端口默认为:4000;
- 通讯指令调试工具,查看tools目录下的NetAssist.exe;
- 通讯指令采用Hex编码(十六进制);
- 串口通讯依赖文件查看doc/serialport目录,Windows环境下rxtxParallel.dll和rxtxSerial.dll文件拷贝到JDK安装的bin目录下,Linux环境将librxtxParallel.so和librxtxSerial.so文件拷贝到JDK安装的bin目录下;
- postman指令下发样例请查看doc/postman/通讯指令下发.postman_collection.json文件,包括门锁(单锁/多锁)、扫码、背光灯、LCD显示屏灯、三色报警灯指令。
指令格式
1. 以心跳指令(7E 04 00 BE 01 00 00 74 77 7F)作为样例说明,下标从0开始;
2. 第0位为起始符,长度固定占1个字节,固定格式:7E;
3. 第1、2位为数据长度,计算方法是从命令符到数据位(即:从3位到指令长度-3位),长度固定占2个字节,例如:04 00,表示长度为4;
4. 第3位为指令符,长度固定占1个字节,例如:BE,表示心跳指令;
5. 第4位为设备号,长度固定占1个字节,例如:01,表示设备号为1;
6. 第5位为层地址,长度固定占1个字节,例如:00,表示设备所有的层不执行;
7. 第6位为槽地址,长度固定占1个字节,例如:00,表示设备所有的槽不执行;
8. 指令长度-3位到-2位为校验位,采用CRC16_MODBUS(长度,命令,地址,数据)校验,例如:74 77,详细查看:ModbusCrc16Utils.java工具类;
9. 末位为结束符,长度固定占1个字节,固定格式:7F。
通讯指令
1. 心跳上传指令
- iot-modbus作为服务端,通过心跳来维持通讯,启动服务端后,打开NetAssist.exe指令调试工具,先往服务端发送心跳指令;
- 硬件往服务端发送:7E 04 00 BE 01 00 00 74 77 7F ,为必要指令。
2. 背光灯上传指令
- 硬件往服务端发送:7E 05 00 88 01 00 00 00 AF E3 7F
3. 扫码指令下发
- 服务端往硬件下发:7E 05 00 08 01 00 00 01 6F FD 7F
- 第7位为数据位,长度固定占1个字节,例如:01,表示开开启扫码头。
4. 扫码指令上传
- 硬件往服务端发送:7E 24 00 8F 01 00 00 03 45 30 30 34 30 31 30 38 32 38 30 32 41 36 39 33 0D 02 00 00 01 02 13 73 02 00 00 01 02 13 73 9B 79 7F
- 数据为:03 45 30 30 34 30 31 30 38 32 38 30 32 41 36 39 33 0D 02 00 00 01 02 13 73 02 00 00 01 02 13 73为条码信息。
5. 刷卡指令上传
- 硬件往服务端发送:7E 08 00 84 01 00 00 86 14 AE 02 7C 53 7F
- 数据位:86 14 AE 02为卡号信息。
6. 单开锁下发指令
- 服务端往硬件下发:7E 05 00 03 01 00 00 01 CA 3C 7F
- 第7位为数据位,长度固定占1个字节,例如:01,表示开1号锁。
7. 多开锁下发指令
- 服务端往硬件下发:7E 08 00 03 FF FF FF 01 00 02 01 7F B0 7F
- FF FF FF为指令做兼容填补位,后面 01 00 02 01是数据位,其中:01表示1号锁,00表示上锁;02表示2号锁,01表示开锁。
8. 锁状态上传指令
- 硬件往服务端发送:7E 0D 00 83 01 00 00 FF FF FF 01 00 05 02 00 01 EE 99 7F
- FF FF FF为指令做兼容填补位,后面 01 00 05 02 00 01是数据位,其中:01表示1号锁,00表示上锁,05表示传感器状态码;02表示2号锁,00表示上锁,01表示传感器状态码。
- 指静脉和温湿度指令(不作说明,详细查看代码);
- LCD显示屏批量控制下发指令(不作说明,详细查看代码);
- 三色报警灯控制下发指令(不作说明,详细查看代码)。
开源项目
- gitee地址:https://gitee.com/takeoff/iot-modbus
- github地址:https://github.com/luorongxi/iot-modbus