1 Star 0 Fork 370

只会CRUD / iot-modbus

forked from takeoff / iot-modbus 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

iot-modbus

介绍

物联网通讯协议,基于netty框架,支持COM(串口)和TCP协议,支持服务端和客户端两种模式,实现Java控制智能设备,同时支持设备组多台设备高并发通讯。采用工厂设计模式,代码采用继承和重写的方式实现高度封装,可作为SDK提供封装的接口,让具体的业务开发人员无需关心通讯协议的底层实现,直接调用接口即可使用。实现了心跳、背光灯、扫码、刷卡、指静脉、温湿度和门锁(支持多锁)、LCD显示屏等指令控制。代码注释丰富,包括上传和下发指令调用例子,非常容易上手。

版本说明

  1. V1.0.0版本仅支持TCP服务端通讯模式;
  2. V2.0.0版本支持TCP服务端和客户端两种模式,客户端模式还增加了心跳重连机制。
  3. V3.0.0版本支持COM(串口)和TCP协议,增加logback日志按文件大小和时间切割输出。
  4. V3.1.0版本代码优化,抽取公共模块子工程。
  5. V3.2.0版本支持LCD显示屏控制指令,支持批量控制LCD显示屏。

软件架构

软件架构说明 基础架构采用Spring Boot2.x + Netty4.X + Maven3.6.x,日志采用logback。

安装教程

  1. 系统Windows7以上;
  2. 安装Jdk1.8以上;
  3. 安装Maven3.6以上;
  4. 代码以Maven工程导入Eclipse或Idea。

使用说明

  1. 工程结构说明:
  • 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 //通讯指令调试工具
  1. 配置文件查看iot-modbus-test子工程resources目录下的application.yml文件;
  2. 启动文件查看iot-modbus-test子工程App.java文件;
  3. 服务启动后,服务端端口默认为:8080,网口通讯端口默认为:4000,串口通讯默认串口为:COM1;
  4. 通讯指令调试工具,TCP通讯模式使用tools目录下的NetAssist.exe,串口通讯模式使用tools目录下的UartAssist.exe;
  5. 通讯指令采用Hex编码(十六进制);
  6. 串口通讯依赖文件查看doc/serialport目录,Windows环境下rxtxParallel.dll和rxtxSerial.dll文件拷贝到JDK安装的bin目录下,Linux环境将librxtxParallel.so和librxtxSerial.so文件拷贝到JDK安装的bin目录下;
  7. 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 ,为必要指令。
  1. 背光灯上传指令
  • 硬件往服务端发送:7E 05 00 88 01 00 00 00 AF E3 7F
  1. 扫码指令下发
  • 服务端往硬件下发:7E 05 00 08 01 00 00 01 6F FD 7F
  • 第7位为数据位,长度固定占1个字节,例如:01,表示开开启扫码头。
  1. 扫码指令上传
  • 硬件往服务端发送: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为条码信息。
  1. 刷卡指令上传
  • 硬件往服务端发送:7E 08 00 84 01 00 00 86 14 AE 02 7C 53 7F
  • 数据位:86 14 AE 02为卡号信息。
  1. 单开锁下发指令
  • 服务端往硬件下发:7E 05 00 03 01 00 00 01 CA 3C 7F
  • 第7位为数据位,长度固定占1个字节,例如:01,表示开1号锁。
  1. 多开锁下发指令
  • 服务端往硬件下发: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表示开锁。
  1. 锁状态上传指令
  • 硬件往服务端发送: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表示传感器状态码。
  1. 指静脉和温湿度指令(不作说明,详细查看代码)。
  2. LCD显示屏批量控制下发指令(不作说明,详细查看代码)。

调试说明

  1. 找到iot-modbus-test子工程App.java文件启动服务端,如下图所示:
  • 输入图片说明
  • 说明:项目启动成功后,控制台日志输出服务端的端口为:8080;项目服务名为:iot-modbus-test;服务端开启socket通讯端口为:4000。
  1. 将工程tools目录下通讯指令调试工具NetAssist拷贝到Windows桌面,双击打开,并配置参数,如下图所示:
  • 输入图片说明
  • 说明:协议类型选择TCP Client(调试工具作为模拟硬件通讯的客服端);远程主机地址输入本地电脑的IP地址;远程主机端口输入服务端端口4000;接收和发送的编码选择HEX;最后点击连接按钮进行连接,连接成功后服务端控制台日志输出如下图所示:
  • 输入图片说明
  1. 客户端往服务端上传心跳指令,如下图所示:
  • 输入图片说明
  • 说明:拷贝心跳指令到通讯指令调试工具NetAssist的数据发送窗口粘贴进来,然后点击发送按钮;此时服务端将接收到心跳指令,如下图所示:
  • 输入图片说明
  • 说明:客服端与服务端的通讯连接需要通过客户端定时往服务端发送心跳指令来维持,在生产环境中发送频率一般可设置为每5秒一次,如果通讯连接断开则客服端与服务端无法通讯。注意:在调试的过程中,如果通讯指令调试工具NetAssist与服务端通讯连接断开,则要手动点击NetAssist的连接按钮,重新往服务端发送一条心跳的指令。
  1. 使用Postman请求服务端往客户端下发控制单锁指令,如下图所示:
  1. 其他上传和下发的指令不作详细介绍,感兴趣的同学可以参考通讯指令和工程目录doc/postman目录下的请求样例。

创作不易,别忘了点亮Star,你们的支持,是我源源不断的动力。

欢迎加入交流群

  • QQ群
  • 输入图片说明
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

物联网通讯协议,基于netty框架,支持COM(串口)和TCP协议,同时支持设备组多台设备高并发通讯。设计上采用工厂设计模式,代码采用继承和重写的方式实现高度封装,可作为SDK提供封装的接口,让具体的业务开发人员无需关心通讯协议的底层实现,直接调用接口即可使用。实现了心跳、背光灯、扫码、刷卡、指静脉、温湿度和门锁(支持多锁)等指令控制。代码注释丰富,包括上传下发指令调用例子,非常容易上手。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/chenyp/iot-modbus.git
git@gitee.com:chenyp/iot-modbus.git
chenyp
iot-modbus
iot-modbus
master

搜索帮助