【物联网】Modbus 协议及Qinghub物联网平台应用

Modbus 协议简介

QingHub设计器在设计物联网数据采集时不可避免的需要针对Modbus协议的设备做相关数据采集，这里就我们的实际项目经验分享Modbus协议

你可以通过QingHub作业直接体验试用，也可以根据手册开发相应的代码块。 qinghub项目已经全面开源。

源码文件地址: https://gitee.com/qingplus/qingcloud-platform

QingHub设计器体验

简介

Modbus由MODICON公司于1979年开发，是一种工业现场总线协议标准。1996年施耐德公司推出基于以太网TCP/IP的Modbus协议：ModbusTCP。Modbus协议是一项应用层报文传输协议，包括ASCII、RTU、TCP三种报文类型。标准的Modbus协议物理层接口有RS232、RS422、RS485和以太网接口，采用master/slave方式通信。

功能码

重点介绍常用如下几个功能码:
1: 读线圈寄存器
2: 读离散输入寄存器
3: 读保持寄存器
4: 读输入寄存器
5: 写单个线圈寄存器
6: 写单个保持寄存器
15: 写多个线圈寄存器
16: 写多个保持寄存器

几种继承器介绍

线圈寄存器

实际上就可以类比为开关量，每个bit都对应一个信号的开关状态。所以一个byte就可以同时控制8路的信号。

离散输入寄存器

如果线圈寄存器理解了这个自然也明白了。离散输入寄存器就相当于线圈寄存器的只读模式，他也是每个bit表示一个开关量，而他的开关量只能读取输入的开关信号，是不能够写的。

保持寄存器

这个寄存器的单位不再是bit而是两个byte，也就是可以存放具体的数据量的，并且是可读写的。比如设置时间年月日，不但可以写也可以读出来现在的时间。写分为单个写和多个写。

输入寄存器

只剩下这最后一个了，这个和保持寄存器类似，但是也是只支持读而不能写。一个寄存器也是占据两个byte的空间。

通信协议 (重点看这里就可以了)

Modbus设备可分为主站(poll)和从站(slave)。主站只有一个，从站有多个，主站向各从站发送请求帧，从站给予响应。在使用TCP通信时，主站为client端，主动建立连接；从站为server端，等待连接(当然只要你愿意并足够熟悉，也可以反向操作)。

Mobus 的报文大致分为两类： MBAP+PDU。
MBAP= Modbus Application Protocol Header(Modbus应用协议) 头部
PDU = Protocol Data Unit （数据单元）

MBAP报文

MBAP为报文头，长度为7字节，组成如下：

事务处理标识	协议标识	长度	单元标识符
2字节	2字节	2字节	1字节

含义:
事务处理标识：可以理解为报文的序列号，一般每次通信之后就要加1以区别不同的通信数据报文。
协议标识符：00 00表示ModbusTCP协议。
长度：表示接下来的数据长度，单位为字节。
单元标识符：可以理解为设备地址。

PDU报文结构

PDU结构
PDU由功能码+数据组成。功能码为1字节，数据长度不定，由具体功能决定。
主站请求：功能码+数据
从站正常响应：请求功能码+响应数据
从站异常响应：异常功能码+异常码，其中异常功能码即将请求功能码的最高有效位置1，异常码指示差错类型

指令实例

查询（功能码0x03）

基本流程就是:
发送:地址 + 我要查 +（寄存器起始地址+个数）+校验
回复:地址 +（回）我要查 +（数据的字节数+数据） +校验

主机发送: 01 03 00 00 00 01 84 0A
含义:
01-地址
03-功能码,代表查询功能,其他功能后面再说
00 00-代表查询的起始寄存器地址.说明从0x0000开始查询.
00 01-代表查询了一个寄存器.结合前面的00 00,意思就是查询从0开始的1个寄存器值;
84 0A-CRC

从机回复: 01 03 02 12 34 B5 33
含义:
01-地址
03-功能码
02-代表后面数据的字节数,因为上面说到,一个寄存器有2个字节,所以后面的字节数肯定是2*查询的寄存器个数;
12 34-寄存器的值是12 34,结合发送的数据看出,01这个寄存器的值为12 34
B5 33-CRC校验码

修改单个寄存器（功能码0x06）

主机送: 01 06 00 00 00 01 48 0A
01-从机地址
06-功能码:修改单个寄存器功能,修改有些不同,有修改一个寄存器和修改多个寄存器;
00 00-修改的起始寄存器地址.说明从0x0000开始.
00 01-修改的值为00 01.结合前面的00 00,意思就是修改0号寄存器值为00 01;
48 0A-CRC

从机回复: 01 06 00 00 00 01 48 0A
01-从机地址
06-功能码:修改单个寄存器功能;
00 00-修改的起始寄存器地址.说明是0x0000.
00 01-修改的值为00 01.结合前面的00 00,意思就是修改0号寄存器值为00 01;
48 0A-CRC

修改多个寄存器（功能码0x10）

主机发送: 01 10 00 00 00 02 04 11 22 33 44 42 5A
01-从机地址
10-功能码,代表修改多个寄存器功能;
00 00-代表修改的起始寄存器地址.说明从0x0000开始.
00 02代表修改的寄存器数量
04 -表示修改的总字节数，由于只修改了1个寄存器，所以数据要有两个字节；
11 22 33 44-表示修改的值，结合上面，就是从第0000寄存器开始修改2寄存器值为11 22 33 44，就是把0000寄存器改为11 22，0001为33 44，
42 5A -循环冗余校验,是modbus的校验公式,从首个字节开始到22前面为止;

从机回复: 01 10 00 00 00 02 41 C8
01-从机地址
10-功能码
00 00-代表修改的起始寄存器地址.说明是0x0000.
00 02-代表修改的寄存器数量，只需要回复这么多久足够了，从机告诉主机修改了哪几个寄存器就足够了;
41 C8-循环冗余校验;

java 开发

maven 依赖

<!-- Modbus -->
<dependency>
    <groupId>com.infiniteautomation</groupId>
    <artifactId>modbus4j</artifactId>
    <version>3.1.0</version>
</dependency>
<dependency>
    <groupId>com.digitalpetri.modbus</groupId>
    <artifactId>modbus-master-tcp</artifactId>
    <version>1.2.0</version>
</dependency>

API 实例

第一：建立连接

/**
 * 获取 Modbus Master
 * @return ModbusMaster
 * @throws ModbusInitException ModbusInitException
 */
public ModbusMaster getMaster(ModbusConfig modbusConfig) throws ModbusInitException {
    log.debug("Modbus Tcp Connection Info {},{}", modbusConfig.getHostName(),modbusConfig.getPort());
    ModbusMaster modbusMaster = masterMap.get(modbusConfig.getEquipmentId());
    if (null == modbusMaster) {
        IpParameters params = new IpParameters();
        params.setHost(modbusConfig.getHostName());
        params.setPort(modbusConfig.getPort());
        **params.setEncapsulated(true);**
        modbusMaster = modbusFactory.createTcpMaster(params, true);
        modbusMaster.init();
        masterMap.put(modbusConfig.getEquipmentId(), modbusMaster);
    }
    return modbusMaster;
}

注意
这里有一个需要特别关注的地方，params.setEncapsulated(true)

如果encapsulated=true时：API 在构建消息是会自动加上CRC 校验码。

public byte[] getMessageData() {
    ByteQueue msgQueue = new ByteQueue();
    modbusMessage.write(msgQueue);
    ModbusUtils.pushShort(msgQueue, ModbusUtils.calculateCRC(modbusMessage));
    return msgQueue.popAll();
}

如果encapsulated=false时：消息会加上事务处理标识，协议标识6个字节:

public byte[] getMessageData() {
    ByteQueue msgQueue = new ByteQueue();
    modbusMessage.write(msgQueue);
    ByteQueue xaQueue = new ByteQueue();
    ModbusUtils.pushShort(xaQueue, transactionId);
    ModbusUtils.pushShort(xaQueue, ModbusUtils.IP_PROTOCOL_ID);
    ModbusUtils.pushShort(xaQueue, msgQueue.size());
    xaQueue.push(msgQueue);
    return xaQueue.popAll();
}

第二： API实例

/**
 * 读线圈寄存器
 * @param modbusMaster
 * @param slaveId
 * @param initOffset
 * @param count
 * @return
 * @throws ModbusTransportException
 */
private static String batchCoilStatus01(ModbusMaster modbusMaster,Integer slaveId,Integer initOffset,Integer count) throws ModbusTransportException {
    ReadCoilsRequest request= new ReadCoilsRequest(slaveId,initOffset,count);
    ReadCoilsResponse response = (ReadCoilsResponse) modbusMaster.send(request);
    byte[] data  = response.getData();
    String bytes = ByteUtils.toHexAscii(data);
    return bytes;
}

/**
 * 读离散输入寄存器
 * @param modbusMaster
 * @param slaveId
 * @param initOffset
 * @param count
 * @return
 * @throws ModbusTransportException
 */
private static String batchInputStatus02(ModbusMaster modbusMaster,Integer slaveId,Integer initOffset,Integer count) throws ModbusTransportException {
    ReadDiscreteInputsRequest request= new ReadDiscreteInputsRequest(slaveId,initOffset,count);
    ReadDiscreteInputsResponse response = (ReadDiscreteInputsResponse) modbusMaster.send(request);
    byte[] data  = response.getData();
    String bytes = ByteUtils.toHexAscii(data);
    return bytes;
}
/**
 *批量读取保持继承器
 * @param modbusMaster
 * @param slaveId
 * @param initOffset
 * @param count
 * @return
 * @throws ModbusTransportException
 */
private static String batchRead03(ModbusMaster modbusMaster,Integer slaveId,Integer initOffset,Integer count) throws  ModbusTransportException {
    ReadHoldingRegistersRequest request= new ReadHoldingRegistersRequest(slaveId,initOffset,count);
    ReadHoldingRegistersResponse response = (ReadHoldingRegistersResponse) modbusMaster.send(request);
    byte[] data  = response.getData();
    String bytes = ByteUtils.toHexAscii(data);
    return bytes;
}


/**
 * 批量读取输入继承器
 * @param modbusMaster
 * @param slaveId
 * @param initOffset
 * @param count
 * @return
 * @throws ModbusTransportException
 */
private static String batchRead04(ModbusMaster modbusMaster ,Integer slaveId,Integer initOffset, Integer count) throws  ModbusTransportException {
    ReadInputRegistersRequest request= new ReadInputRegistersRequest(slaveId,initOffset,count);
    ReadInputRegistersResponse response = (ReadInputRegistersResponse) modbusMaster.send(request);
    byte[] data  = response.getData();
    String bytes = ByteUtils.toHexAscii(data);
    return bytes;
}

轻云UC设计器实例

基础信息

组件名称： modbus-connector
组件版本： 1.0.0
组件类型：系统默认
状态：正式发布
组件描述：通过MODBUS 连接网关，采集或下发相关指令到设备端。

配置文件：

配置文件作为MODBUS配置界面元素的基础，MODBUS所有高级配置均可以通过重构该配置文件体现在前端界面上。配置参数分为三组：基础配置，连接配置，高级配置，一般情况可以随意扩展高级配置。

注：配置文件仅供修改升级组件式利用，一般情况下对用户透明。无需做任何更改，除非用户需要手动维护组件心跳或通信端口时，一般情况下禁止修改。

df:
  component:
    name: modbus-connector
    type: 2   #1:采集器;2:接收器;3:转换器;4:存储器;5:解析器;6:状态解析器:7:同步器;8:消息通知
    transportPort: 49096    #内部akka通信端口
    heartbeatCron: 0/30 * * ? * * *       #网关心跳数据上报时间
    #########本地环境用##########
    instance-id: 998
    topic: DEMO-TOPIC-998
    response-topic: DEMO-TOPIC-RESPONSE-198
    executor:
      akka-address: 192.168.3.195:49095
      rest-address: 192.168.3.195:49090
    #############结束##############

    parameter:
      connection[0]:                      #组件连接参数数组
        name: Host                        #参数名称，自定义
        key: hostName                     #参数key，自定义
        required: true                    #是否必传 true或false
        value-type: string                #参数值类型，支持 string, int, float
        default-value: 127.0.0.1          #参数默认值，自定义
        input-type: input                 #参数输入类型，支持 input-输入框，select-下拉框
        description: 数据采集端TCP 连接地址                 #参数值描述，自定义
      connection[1]:
        name: Port
        key: port
        required: true
        value-type: int
        input-type: input
        default-value: 502
        description: Modbus数据采集端TCP连接端口号
      connection[2]:
        name: 设备编号
        key: equipmentId
        required: true
        value-type: string
        input-type: input
        default-value: 80100012
        description: 设备编号(平台分配得设备编号)
      base[0]:
        name: 从站编号
        key: slaveId
        required: true
        value-type: int
        input-type: input
        description: 采集设备序号（slaveId即设备地址)
      base[1]:
        name: 功能码
        key: functionCode
        required: false
        value-type: int
        input-type: select
        select-option: 01|1,02|2,03|3,04|4,05|5,15|15,6|6,16|16
        description: 命名空间功能码 [1:读线圈状态、2:读离散输入状态、3:读保持寄存器、4:读输入寄存器,5:写单个线圈,15:写多个线圈,6:写单个保持寄存器,16:写多个保持寄存器]
      base[2]:
        name: 偏移量
        key: offset
        required: false
        value-type: int
        input-type: input
        description: 偏移量
      base[3]:
        name: 数量
        key: numberOfRegisters
        required: true
        value-type: int
        input-type: input
        default-value: 1
        description: 继承器数量(从偏移量开始读取多少个继承器）
      base[4]:
        name: Encapsulated
        key: encapsulated
        required: false
        value-type: int
        input-type: select
        select-option: true|1,false|2
        default-value: 1
        description: Master发送指令到slave时得消息格式为EncapMessage或者XaMessage
      advance[0]:
        name: CRON
        key: cron
        required: true
        value-type: string
        input-type: input
        default-value: 1/10 * * ? * * *
        description: 网关采集器定时任务

组件测试

配置网关

从组件列表中选择modbus-connector并拖动到作业设计器。

参数说明

修改右侧配置参数并保存，参数使用说明可以通过每个参数旁边的?查看。

参数含义可以对照Modbus Slave 软件中的相关信息。 Modbus Slave 下载

启动网关

注意观察执行日志，确保网关正常运行，状态status 字段为1时表示正常运行中

测试验证

1）前提准备：
下载并启动 Modbus Slave 调试工具

连接成功后记录相关信息：
IP： 192.168.3.45
Port : 502
Slave ID: 1
function code ： 3
偏移量： 0 （我们以0位作为测试数据）

2）进入到轻云UC通用设计中心，进入到设计器，并拖动modbus-connector组件到画板。
按规上面modbus slave 中的配置信息，设定好modbus-connector配置信息：

注意配置中的功能码，偏移量，从站编号，IP ，端口，需要与测试工具中的配置信息一致。
3）切换到UC设计器，重启modbus-connector网关，可以从执行日志板块看到数据。
这里的数据时定时获取的，通过配置参照中的表达式。如： 1/10 * * ? * * * 每10秒获取一次数据。