tiagocoutinho/modbus-proxy-py

ModBus TCP代理

镜像概述和主要用途

ModBus TCP代理镜像作为客户端与ModBus设备之间的七层反向代理，解决了多数ModBus设备仅支持少量客户端连接的问题。它允许多个客户端同时与同一ModBus设备通信，并通过先到先服务（REQ/REP）机制序列化通信，避免交叉消息冲突。

核心功能和特性

• 多客户端支持：突破ModBus设备客户端连接数限制，允许多个客户端同时接入
• 通信序列化：采用先到先服务机制处理客户端请求，避免交叉消息干扰
• 灵活部署：支持无配置文件快速启动和配置文件自定义部署两种模式
• 日志可配置：集成Python logging模块，支持详细日志格式和级别自定义

使用场景和适用范围

适用于工业自动化、物联网等场景，当多个客户端（如SCADA系统、监控平台、数据采集软件等）需要同时访问同一ModBus设备（如PLC、传感器、仪表等）时，解决设备客户端连接数限制问题。

使用方法和配置说明

无配置文件快速启动

通过命令行参数直接指定代理绑定地址和后端ModBus设备地址：

bash
docker run -d -p 5020:502 tiagocoutinho/modbus-proxy-py -b tcp://0:502 --modbus tcp://plc1.acme.org:502

参数说明：

• -b tcp://0:502：代理在容器内的绑定地址（0表示所有网络接口）和端口（502）
• --modbus tcp://plc1.acme.org:502：后端ModBus设备的地址和端口
• -p 5020:502：将容器的502端口映射到主机的5020端口

启动后，客户端可通过 <主机IP/主机名>:5020 访问ModBus设备。

使用配置文件启动

1. 创建配置文件

创建YAML格式配置文件（如conf.yml），定义设备和监听配置：

yaml
devices:
- modbus:
    url: plc1.acme.org:502  # 后端ModBus设备地址和端口
  listen:
    bind: 0:502  # 代理在容器内的绑定地址和端口

2. 运行容器

挂载配置文件并启动容器：

bash
docker run -p 5020:502 -v $PWD/conf.yml:/config/modbus-proxy.yml tiagocoutinho/modbus-proxy-py

注意：容器默认执行命令为 modbus-proxy -c /config/modbus-proxy.yml，因此挂载配置文件后无需额外参数。配置文件中每个设备定义需对应主机端口映射（-p <主机端口>:<容器端口>）。

日志配置

在配置文件中添加logging关键字可自定义日志记录。日志配置遵循Python logging.config.dictConfig() 的配置字典 schema。

示例配置：

yaml
devices:
- modbus:
    url: plc1.acme.org:502
  listen:
    bind: 0:9000
logging:
  version: 1
  formatters:
    standard:
      format: "%(asctime)s %(levelname)8s %(name)s: %(message)s"
  handlers:
    console:
      class: logging.StreamHandler
      formatter: standard
  root:
    handlers: ['console']
    level: DEBUG  # 日志级别：DEBUG/INFO/WARNING/ERROR/CRITICAL