easymodbus4j: easymodbus4j 是一个高性能和易用的 Modbus 协议的 Java 实现，基于 Netty 开发，可用于 Modbus 4 的客户端和服务器开发

easymodbus4j运行效果图截屏

[](#easymodbus4j-chs)easymodbus4j [chs]

easymodbus4j是一个高性能和易用的 Modbus 协议的 Java 实现，基于 Netty 开发，可用于 Modbus协议的Java客户端和服务器开发.

[](#easymodbus4j-en)easymodbus4j [en]

A high-performance and ease-of-use implementation of the Modbus protocol written in Java netty support for modbus 8 mode client/server and master/slave.

[](#easymodbus4j-features-%E7%89%B9%E7%82%B9)easymodbus4j features 特点:

  • 1、Netty NIO high performance高性能.
  • 2、Modbus Function sync/aync 同步/异步非阻塞。
  • 3、Modbus IoT Data Connector Supports工业物联网平台IoT支持。
  • 4、支持Modbus TCP\Modbus RTU protocol两种通信协议.
  • 5、灵活架构,支持8种生产部署模式,自由组合,满足不同生产要求.
  • 6、通用组件包,支持高度自定义接口.
  • 7、完全支持Modbus TCP 4种部署模式: TCP服务器master,TCP客户端slave,TCP服务器slave,TCP客户端master。
  • 8、完全支持Modbus RTU 4种部署模式: RTU服务器master,RTU客户端slave,RTU服务器slave,RTU客户端master。
  • 9、友好的调试以及日志支持bit\bitset\byte\short\int\float\double。

  • 10、Supports Function Codes:

    • Read Coils (FC1)
    • Read Discrete Inputs (FC2)
    • Read Holding Registers (FC3)
    • Read Input Registers (FC4)
    • Write Single Coil (FC5)
    • Write Single Register (FC6)
    • Write Multiple Coils (FC15)
    • Write Multiple Registers (FC16)
    • Read/Write Multiple Registers (FC23)

[](#repositories)repositories

artifactId/jar:
easymodbus4j-core.jar Modbus protocol协议
easymodbus4j-codec.jar Modbus 通用编码器解码器
easymodbus4j.jar Modbus General/Common公共通用包
easymodbus4j-client.jar Modbus client客户端
easymodbus4j-server.jar Modbus server服务器端
easymodbus4j-extension.jar Modbus extension扩展包 ModbusMasterResponseProcessor/ModbusSlaveRequestProcessor interface

[](#quick-start%E5%BF%AB%E9%80%9F%E5%BC%80%E5%8F%91)quick Start快速开发:

[](#%E7%AC%AC%E4%B8%80%E6%AD%A5step1-import-jar)第一步step1 ,import jar:

  • 1.1 maven:

    <dependency>
    <groupId>com.github.zengfr</groupId>
    <artifactId>easymodbus4j-client</artifactId>
    <version>0.0.5</version>
    </dependency>
    <dependency>
    <groupId>com.github.zengfr</groupId>
    <artifactId>easymodbus4j-server</artifactId>
    <version>0.0.5</version>
    </dependency>
    <dependency>
    <groupId>com.github.zengfr</groupId>
    <artifactId>easymodbus4j-extension</artifactId>
    <version>0.0.5</version>
    </dependency>

[](#%E7%AC%AC%E4%BA%8C%E6%AD%A5step2implement-handler)第二步step2,implement handler:

  • 2.1 if master

    • 实现implement ResponseHandler接口 see easymodbus4j-example:ModbusMasterResponseHandler.java
    • or 实现implement ModbusMasterResponseProcessor 接口 use new ModbusMasterResponseHandler(responseProcessor);

  • 2.2 if slave

    • 实现implement RequestHandler接口 see easymodbus4j-example:ModbusSlaveRequestHandler.java
    • or 实现implement ModbusSlaveRequestProcessor 接口 use new ModbusSlaveRequestHandler(reqProcessor);

[](#%E7%AC%AC%E4%B8%89%E6%AD%A5step3)第三步step3,

  • 3.1 select one master/slave and client/server mode:

    modbusServer = ModbusServerTcpFactory.getInstance().createServer4Master(port, responseHandler);
    modbusClient = ModbusClientTcpFactory.getInstance().createClient4Slave(host,port, requestHandler);
    modbusClient = ModbusClientTcpFactory.getInstance().createClient4Master(host, port, responseHandler);
    modbusServer = ModbusServerTcpFactory.getInstance().createServer4Slave(port, requestHandler);
    modbusServer = ModbusServerRtuFactory.getInstance().createServer4Master(port, responseHandler);
    modbusClient = ModbusClientRtuFactory.getInstance().createClient4Slave(host,port, requestHandler);
    modbusClient = ModbusClientRtuFactory.getInstance().createClient4Master(host, port, responseHandler);
    modbusServer = ModbusServerRtuFactory.getInstance().createServer4Slave(port, requestHandler);

[](#%E7%AC%AC%E5%9B%9B%E6%AD%A5step4-faqs-and-advanced-extensions)第四步step4 ,FAQs and advanced extensions:

  • 4.1 how to send a request ? to send data

    Thread.sleep(3*1000);// sleep 3s before,when client or server open connection is async;
    Channel channel = client.getChannel());
    Channel channel = server.getChannelsBy(...));
    ChannelSender sender = ChannelSenderFactory.getInstance().get(channel);
    ChannelSender sender2 = new ChannelSender(channel,unitId,protocolIdentifier);
    sender.readCoils(...)
    sender.readDiscreteInputs(...)
    sender.writeSingleRegister(...)

  • 4.2 how to process request/response? to receive data see code in processResponseFrame mothod in ModbusMasterResponseHandler.java or ModbusMasterResponseProcessor.java

    public void processResponseFrame(Channel channel, int unitId, AbstractFunction reqFunc, ModbusFunction respFunc) {
    if (respFunc instanceof ReadCoilsResponse) {
    ReadCoilsResponse resp = (ReadCoilsResponse) respFunc;
    ReadCoilsRequest req = (ReadCoilsRequest) reqFunc;
    //process business logic for req/resp
    }
    };

  • 4.3 how to get response to byteArray for custom decode by yourself? see code in processResponseFrame mothod in ModbusMasterResponseHandler.java or ModbusMasterResponseProcessor.java

    public void processResponseFrame(Channel channel, int unitId, AbstractFunction reqFunc, ModbusFunction respFunc) {
    if (respFunc instanceof ReadDiscreteInputsResponse) {
    ReadDiscreteInputsResponse resp = (ReadDiscreteInputsResponse) respFunc;
    byte[] resutArray = resp.getInputStatus().toByteArray();
    }
    };

  • 4.4 how to show log? see ModbusMasterResponseHandler.java in example project.

    ModbusFrameUtil.showFrameLog(logger, channel, frame);

  • 4.5 how to custom a client/server advance by yourself?

    ModbusChannelInitializer modbusChannelInitializer=...;
    ModbusServerTcpFactory.getInstance().createServer4Master(port,modbusChannelInitializer);

[](#example-project-code)Example Project Code

[](#example-run-startup)Example run startup:

  • 1、unzip file easymodbus4j-example-0.0.5-release.zip.
  • 2、for modbus master mode:open autosend.txt file in dir or autosend.txt rsourcefile in easymodbus4j-example-0.0.5.jar
  • 3、for modbus master mode:edit autosend.txt file
  • 4、start startup.bat.
  • 5、you also can edit *.bat for modbus master/salve mode: .

[](#example%E5%AE%9E%E4%BE%8B%E8%AF%B4%E6%98%8E)Example实例说明:

  • 1、解压缩zip文件到文件夹
  • 2、java程序 运行不了 则安装jdk8.
  • 3、解压后8个bat文件 对应TCP/RTU 服务器master,客户端slave,服务器slave,客户端master 8种模式.
  • 4、Master模式 可以设置autosend.txt文件，定时发送读写请求。
  • 5、记事本打开bat文件可以编辑相关参数，如定时延时发送时间以及详细日志开关。

[](#%E5%BC%80%E5%8F%91%E5%AE%9E%E4%BE%8B%E7%B3%BB%E5%88%97%E6%95%99%E7%A8%8Bdevelop-a-series-of-tutorial-examples)开发实例系列教程Develop a series of tutorial examples

easymodbus4j 开发实例系列教程之1----客户端master模式
easymodbus4j 开发实例系列教程之2----服务端master模式

[](#capture-demo-%E8%BF%90%E8%A1%8C%E6%95%88%E6%9E%9C%E5%9B%BE%E6%88%AA%E5%B1%8F)capture demo 运行效果图截屏:

easymodbus4j运行效果图截屏1 easymodbus4j运行效果图截屏2 easymodbus4j运行效果图截屏3 easymodbus4j运行效果图截屏4

[](#capture-demo-%E8%BF%90%E8%A1%8C%E6%95%88%E6%9E%9C%E5%9B%BE%E6%88%AA%E5%B1%8F2)capture demo 运行效果图截屏2:

easymodbus4j运行效果图截屏1 easymodbus4j运行效果图截屏2 easymodbus4j运行效果图截屏3 easymodbus4j运行效果图截屏4

原网址: 访问
创建于: 2023-09-04 14:50:21
目录: default
标签: 无

未标明原创文章均为采集，版权归作者所有，转载无需和我联系，请注明原出处，南摩阿彌陀佛，知识，不只知道，要得到

请先后发表评论
  • 最新评论
  • 总共0条评论