Skip to content
driver-box

Modbus插件

插件介绍

modbus插件用于连接modbus设备，支持 rtu、tcp、udp、tcp+tls 等通讯方式。

modbus连接配置

配置项必填类型参数说明
address必填string连接地址：例如：127.0.0.1:502 、/dev/ttyUSB0
mode必填string通讯方式，支持类型：
  • tcp
  • rtu
  • rtuovertcp
  • rtuoverudp
  • tcp+tls
  • udp
baudRate选填int波特率，仅当 mode 为rtu时需要设置。
默认：19200
dataBits选填int数据位 ，仅当 mode 为rtu时需要设置。
默认：8
stopBits选填int停止位 ，仅当 mode 为rtu时需要设置。
有效范围：
  • 0
  • 1
  • 2
parity选填int奇偶性校验 ，仅当 mode 为rtu时需要设置 。
有效范围：
  • 0:None
  • 1:EVEN
  • 2:ODD
duration选填string当前连接采集任务的执行周期。
默认：1s。例如：1s、1m、1h、1d
batchReadLen选填int支持连续读的字节数。
batchWriteLen选填int支持连续写的字节数。
retry选填int执行写操作出现失败时的重试次数，默认：3
virtual选填bool是否启用虚拟模式，默认：false 。详见：虚拟设备

示例

config.json

{
    ...
    "connections": {
        "192.168.16.111:502": {
            "address": "192.168.16.111:502",
            "batchReadLen": 50,
            "batchWriteLen": 10,
            "enable": true,
            "minInterval": 500,
            "mode": "tcp",
            "timeout": 5000,
            "virtual": false
        }
    },
    "protocolName": "modbus"
}

扩展点表配置

配置项必填类型参数说明
primaryTable必填string寄存器类型，支持类型：
  • HOLDING_REGISTER
  • COIL
  • DISCRETE_INPUT
  • INPUT_REGISTER
startAddress必填string点位所在的寄存器地址，详见：startAddress配置说明
rawType必填string数据原始类型 ，详见：rawType配置说明
duration选填string当前点位值的采集频率。
默认：1s。例如：1s、1m、1h、1d
wordSwap选填int
byteSwap选填int
bit选填string点位值所处的比特位起始位置，默认：0
bitLen选填int比特位长度

startAddress配置说明

寄存器地址存在三种表达方式：

  1. 十六进制表示
    使用前缀”0x”来指示该地址是十六进制形式，例如：“0x0400” 表示第1024个寄存器地址。 解析时，会去掉”0x”并将其转换为十进制。
  2. 十进制表示
    使用后缀”d”来区分十进制地址，例如：“40001d” 表示第40001个寄存器地址。 在解析时，会移除”d”并直接转换为十进制的uint16值。
  3. 特定格式表示
    对于长度为5位的数字字符串，遵循特定的地址映射规则：
    • 地址范围在1-9999，实际地址 = 字符串值 - 1。
    • 地址范围在10000-19999，实际地址 = 字符串值 - 10001。
    • 地址范围在30000-39999，实际地址 = 字符串值 - 30001。
    • 地址范围在40000-49999，实际地址 = 字符串值 - 40001。
    • 其他值被视为无效。

请注意，确保提供的地址符合上述格式，否则函数可能会返回错误。在与Modbus兼容的设备通信时，正确地表示和转换寄存器地址是至关重要的。

rawType配置说明

rawType 表示从寄存器读取到的字节数值代表的真实数据类型。

当寄存器类型为 COIL、DISCRETE_INPUT 时，rawType 参数无效。

rawType 适用于寄存器类型为：INPUT_REGISTER、HOLDING_REGISTER 的场景，且不同数据类型对应的寄存器字节数对照关系如下：

1字节2字节4字节
int16✔
uint16✔
int32✔
uint32✔
float32✔
int64✔
uint64✔
float64✔

性能优化

todo

虚拟设备

启用 modbus 虚拟模式，一方面要将 virtual 配置项设置为 true。 另一方面，要在 config.json 的同级目录下创建用于提供虚拟设备能力的 lua 脚本：converter.lua，并按以下步骤进行操作：

第一步：初始化脚本内容

脚本内容可从res/library/template/modbus_virtual.lua中拷贝。

第二步：初始化寄存器值

modbus 虚拟设备的寄存器值皆为 0，需要在 converter.lua 脚本中为设备添加初始值。 脚本的添加内容处于 initSlave 方法的 Begin--End 注释之间（其余地方不作调整）。

-- 初始化指定从机
function initSlave(slaveId, holdingRegister, coil, discreteInput, inputRegister)
    slaves[slaveId] = {
        [HOLDING_REGISTER] = initRegisters(holdingRegister),
        [COIL] = initRegisters(coil),
        [DISCRETE_INPUT] = initRegisters(discreteInput),
        [INPUT_REGISTER] = initRegisters(inputRegister)
    }


    -- 调用 mockWrite 方法初始化模拟数据
    -- Begin：以下需要开发者根据实际情况作修改




    -- End：以上需要开发者根据实际情况作修改


    return slaves[slaveId]
end

第三步：编写控制逻辑（可选）

对于点位读写分离的场景，需要开发者编写控制逻辑，以实现对模拟数据的更新。例如：开关点位的读操作处于寄存器地址 40001，而写操作处于 40002。

脚本的添加内容处于 mockWrite 方法的 Begin—End 注释之间（其余地方不作调整）。

--模拟modbus读写
-- slaveId 从机id
-- primaryTable 寄存器类型：HOLDING_REGISTER,COIL,DISCRETE_INPUT,INPUT_REGISTER
-- address 寄存器地址
-- value 值，byte数组
function mockWrite(slaveId, primaryTable, address, value)
    if address < 1 or address > 65535 then
        error("Invalid register address")
    end
    -- 寻找从机
    slave = slaves[slaveId]
    if slaves[slaveId] == nil then
        -- 初始化设备太多会增加内存消耗
        slave = initSlave(slaveId, 65535, 65535, 65535, 65535);
    end


    tableData = slave[primaryTable]
    --从address开始填充数据value
    for i = 1, #value do
        tableData[address + i - 1] = value[i]
    end


    -- 对于读写点分离的情况，需要手动填写读点位数值
    -- Begin：以下需要开发者根据实际情况作修改


    -- End：以上需要开发者根据实际情况作修改
end