modpoll2mqtt 2.1.1

Modbus to MQTT gateway — fork of modpoll

modpoll2mqtt — Modbus to MQTT Gateway

Documentation: yoch.github.io/modpoll2mqtt

modpoll2mqtt is a command-line Modbus-to-MQTT gateway. It polls Modbus devices (RTU, TCP, UDP) using CSV configuration files, publishes values to an MQTT broker, and accepts write commands by CSV reference name.

Install the PyPI package as modpoll2mqtt; the executable command remains modpoll.

Fork of modpoll, with semantic MQTT writes by CSV reference name and CTA (air handling unit) examples.

Features

• Modbus RTU, TCP, and UDP (CSV configuration files)
• Local display of polled data (debug mode)
• MQTT publishing of references (configurable topics)
• Optional MQTT retain on data publishes (--mqtt-retain)
• MQTT writes by CSV reference name (modpoll/<device>/set)
• Local CSV export of polled data
• Bit-level access on registers and coils

Installation

Python 3.10+ required.

pip install modpoll2mqtt

Optional serial support (pyserial):

pip install 'modpoll2mqtt[serial]'

Upgrade:

pip install -U modpoll2mqtt

On Windows, pipx is recommended:

pipx install modpoll2mqtt

Quickstart

Single poll of a Modbus TCP device (replace the IP address with yours):

modpoll --once \
  --tcp 192.168.1.10 \
  --config examples/modsim.csv

Publish to an MQTT broker:

modpoll \
  --tcp 192.168.1.10 \
  --mqtt-host broker.emqx.io \
  --config examples/modsim.csv

Data is published to modpoll/<device_name>/data by default.

Add --mqtt-retain so the broker keeps the last data message per topic for new subscribers. Diagnostics topics are never retained. If a device goes offline, retained values may still appear live until the next successful publish.

MQTT write by reference

Once connected to the broker, modpoll subscribes to modpoll/+/set. Publish to modpoll/<device>/set:

{
  "PID_V3V_EC_Consigne_reprise": 21.5,
  "BP_MA_CTA": true
}

Unknown reference names in the payload are skipped with a warning.

Example with examples/CTA/cta_conf_restaurant.csv: an int16 reference with scale 0.1 accepts 21.5 as input; the raw register value 215 is written.

Migration from modpoll 1.6.x: the low-level format (object_type, address, value) is no longer supported.

Configuration pitfalls

• On coil or discrete_input pollers, use bool with the absolute Modbus coil address for a single boolean.
• bool8 / bool16: legacy grouped reads (group index, not a direct coil address).
• On holding_register or input_register, use bool with address:bit (0–15), e.g. 40019:15,bool.
• <endian> must be BE_BE, LE_BE, LE_LE, or BE_LE only.
• --autoremove disables a poller after 3 consecutive Modbus failures.

Examples

# Modbus TCP
modpoll --tcp 192.168.1.10 --config examples/modsim.csv

# Modbus serial
modpoll --serial /dev/ttyUSB0 --serial-baud 9600 --config contrib/eniwise/scpms6.csv

# MQTT + CSV export
modpoll --tcp 192.168.1.10 --mqtt-host localhost --export data.csv --config examples/modsim.csv

# Multiple config files
modpoll --tcp 192.168.1.10 --config examples/modsim.csv examples/modsim2.csv

# CTA (building automation example)
modpoll --tcp 192.168.1.20 --mqtt-host localhost --config examples/CTA/cta_conf_restaurant.csv

See examples/ and contrib/ for more device configurations.

Credits

This project builds on:

• modpoll — Ying Shaodong (MIT)
• modbus2mqtt — Oliver Wagner (MIT)
• spicierModbus2mqtt — Max Brueggemann (MIT)

License

MIT — see LICENSE.