oitc/modbus-server

Modbus TCP Server Docker镜像文档

镜像概述

维护者: Michael Oberdorf IT-Consulting
源代码: https://github.com/cybcon/modbus-server
容器镜像: https://hub.docker.com/r/oitc/modbus-server

Modbus TCP Server是一个用Python编写的简单Modbus TCP服务器，支持预定义寄存器值。该服务器最初设计用于充当Modbus从机模拟系统，用于增强Modbus主机的测试以及测试从不同寄存器收集值的过程。

Modbus规范文档: PDF

支持的标签及对应Dockerfile链接

• https://github.com/cybcon/modbus-server/blob/v1.4.0/Dockerfile
• https://github.com/cybcon/modbus-server/blob/v1.3.2/Dockerfile
• https://github.com/cybcon/modbus-server/blob/v1.3.1/Dockerfile
• https://github.com/cybcon/modbus-server/blob/v1.3.0/Dockerfile
• https://github.com/cybcon/modbus-server/blob/v1.2.0/Dockerfile

核心功能与特性

• 支持Modbus TCP/UDP协议
• 可预定义各类寄存器初始值
• 支持自定义日志格式和日志级别
• 可配置寄存器起始地址模式(1或0)
• 自动初始化未定义寄存器为0值
• 支持TLS加密通信(实验性)

使用场景

• Modbus主机系统的增强测试
• 测试从不同寄存器收集值的过程
• 开发环境中的Modbus从机模拟
• 教学和学习Modbus协议
• 集成测试中的Mock服务

快速开始

步骤1: 拉取镜像

bash
docker pull oitc/modbus-server

步骤2: 运行Modbus TCP服务器

bash
docker run --rm -p 5020:5020 oitc/modbus-server:latest

步骤3: 使用自定义配置文件

默认配置文件将所有寄存器初始化为0x0000。如需设置自定义寄存器值，需创建自己的配置文件：

bash
docker run --rm -p 5020:5020 -v ./server_config.json:/server_config.json oitc/modbus-server:latest -f /server_config.json

或挂载配置文件替换默认配置，可省略文件参数：

bash
docker run --rm -p 5020:5020 -v ./server_config.json:/app/modbus_server.json oitc/modbus-server:latest

Docker Compose部署

yaml
services:
  modbus-server:
    container_name: modbus-server
    image: oitc/modbus-server:latest
    restart: always
    command: -f /server_config.json
    ports:
      - 5020:5020
    volumes:
      - ./server.json:/server_config.json:ro

配置说明

环境变量

命令行参数

配置文件详解

默认配置文件内容

容器中的/app/modbus_server.json文件包含以下默认配置：

json
{
"server": {
  "listenerAddress": "0.0.0.0",
  "listenerPort": 5020,
  "protocol": "TCP",
  "tlsParams": {
    "description": "path to certificate and private key to enable tls",
    "privateKey": null,
    "certificate": null
    },
  "logging": {
    "format": "%(asctime)-15s %(threadName)-15s  %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s",
    "logLevel": "INFO"
    }
  },
"registers": {
  "description": "initial values for the register types",
  "zeroMode": false,
  "initializeUndefinedRegisters": true,
  "discreteInput": {},
  "coils": {},
  "holdingRegister": {},
  "inputRegister": {}
  }
}

配置字段说明

预定义寄存器配置

预定义寄存器以寄存器编号作为键，由于JSON格式要求键为字符串，寄存器编号需表示为字符串，服务器初始化时会将其转换为整数。

离散输入和线圈寄存器(单比特)：使用true或false作为值。

示例配置：

json
"discreteInput": {
  "0": true,
  "1": true,
  "42": true,
  "166": false
}

保持寄存器和输入寄存器(16位字)：使用十六进制表示(以0x开头)或整数(0-65535)。

示例配置：

json
"holdingRegister": {
  "9": "0xAA00",
  "23": "0xBB11",
  "142": "0x1FC3",
  "2346": 255  // 等同于0x00FF
}

配置文件示例

• https://github.com/cybcon/modbus-server/blob/main/src/app/modbus_server.json
• https://github.com/cybcon/modbus-server/blob/main/examples/abb_coretec_example.json
• https://github.com/cybcon/modbus-server/blob/main/examples/test.json
• https://github.com/cybcon/modbus-server/blob/main/examples/udp.json