modpoll2mqtt 2.0.0__tar.gz

modpoll2mqtt-2.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-2026 Ying Shaodong
+Copyright (c) 2026 yoch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

modpoll2mqtt-2.0.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.1
+Name: modpoll2mqtt
+Version: 2.0.0
+Summary: Modbus to MQTT gateway — fork of modpoll
+Home-page: https://github.com/yoch/modpoll2mqtt
+License: MIT
+Author: yoch
+Author-email: yoch.melka@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Topic :: System :: Networking
+Provides-Extra: serial
+Requires-Dist: paho-mqtt (>=2.1.0,<3.0.0)
+Requires-Dist: prettytable (>=3.9.0,<4.0.0)
+Requires-Dist: pymodbus (>=3.10,<4.0)
+Requires-Dist: pyserial (>=3.5,<4.0) ; extra == "serial"
+Requires-Dist: requests (>=2.32.5,<3.0.0)
+Project-URL: Documentation, https://yoch.github.io/modpoll2mqtt
+Project-URL: Repository, https://github.com/yoch/modpoll2mqtt
+Description-Content-Type: text/markdown
+
+# modpoll2mqtt — Modbus to MQTT Gateway
+
+[![Release](https://img.shields.io/github/v/release/yoch/modpoll2mqtt)](https://github.com/yoch/modpoll2mqtt/releases)
+[![Build status](https://img.shields.io/github/actions/workflow/status/yoch/modpoll2mqtt/main.yml?branch=main)](https://github.com/yoch/modpoll2mqtt/actions/workflows/main.yml?query=branch%3Amain)
+[![License](https://img.shields.io/github/license/yoch/modpoll2mqtt)](https://github.com/yoch/modpoll2mqtt/blob/main/LICENSE)
+[![Downloads](https://static.pepy.tech/badge/modpoll2mqtt/week)](https://pepy.tech/project/modpoll2mqtt)
+
+> Documentation: [yoch.github.io/modpoll2mqtt](https://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](https://github.com/gavinying/modpoll), with semantic MQTT writes by `ref` + `value` 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)
+- 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.
+
+```bash
+pip install modpoll2mqtt
+```
+
+Optional serial support (pyserial):
+
+```bash
+pip install 'modpoll2mqtt[serial]'
+```
+
+Upgrade:
+
+```bash
+pip install -U modpoll2mqtt
+```
+
+On Windows, [pipx](https://pypa.github.io/pipx/installation/) is recommended:
+
+```powershell
+pipx install modpoll2mqtt
+```
+
+## Quickstart
+
+Single poll of a Modbus TCP device (replace the IP address with yours):
+
+```bash
+modpoll --once \
+  --tcp 192.168.1.10 \
+  --config examples/modsim.csv
+```
+
+Publish to an MQTT broker:
+
+```bash
+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.
+
+### MQTT write by reference
+
+Once connected to the broker, `modpoll` subscribes to `modpoll/+/set`. Publish to `modpoll/<device>/set`:
+
+```json
+{
+  "ref": "PID_V3V_EC_Consigne_reprise",
+  "value": 21.5
+}
+```
+
+Example with [`examples/CTA/cta_conf_restaurant.csv`](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
+
+```bash
+# 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/`](examples/) and [`contrib/`](contrib/) for more device configurations.
+
+## Credits
+
+This project builds on:
+
+- [modpoll](https://github.com/gavinying/modpoll) — Ying Shaodong (MIT)
+- [modbus2mqtt](https://github.com/owagner/modbus2mqtt) — Oliver Wagner (MIT)
+- [spicierModbus2mqtt](https://github.com/mbs38/spicierModbus2mqtt) — Max Brueggemann (MIT)
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+

modpoll2mqtt-2.0.0/README.md

@@ -0,0 +1,126 @@
+# modpoll2mqtt — Modbus to MQTT Gateway
+
+[![Release](https://img.shields.io/github/v/release/yoch/modpoll2mqtt)](https://github.com/yoch/modpoll2mqtt/releases)
+[![Build status](https://img.shields.io/github/actions/workflow/status/yoch/modpoll2mqtt/main.yml?branch=main)](https://github.com/yoch/modpoll2mqtt/actions/workflows/main.yml?query=branch%3Amain)
+[![License](https://img.shields.io/github/license/yoch/modpoll2mqtt)](https://github.com/yoch/modpoll2mqtt/blob/main/LICENSE)
+[![Downloads](https://static.pepy.tech/badge/modpoll2mqtt/week)](https://pepy.tech/project/modpoll2mqtt)
+
+> Documentation: [yoch.github.io/modpoll2mqtt](https://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](https://github.com/gavinying/modpoll), with semantic MQTT writes by `ref` + `value` 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)
+- 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.
+
+```bash
+pip install modpoll2mqtt
+```
+
+Optional serial support (pyserial):
+
+```bash
+pip install 'modpoll2mqtt[serial]'
+```
+
+Upgrade:
+
+```bash
+pip install -U modpoll2mqtt
+```
+
+On Windows, [pipx](https://pypa.github.io/pipx/installation/) is recommended:
+
+```powershell
+pipx install modpoll2mqtt
+```
+
+## Quickstart
+
+Single poll of a Modbus TCP device (replace the IP address with yours):
+
+```bash
+modpoll --once \
+  --tcp 192.168.1.10 \
+  --config examples/modsim.csv
+```
+
+Publish to an MQTT broker:
+
+```bash
+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.
+
+### MQTT write by reference
+
+Once connected to the broker, `modpoll` subscribes to `modpoll/+/set`. Publish to `modpoll/<device>/set`:
+
+```json
+{
+  "ref": "PID_V3V_EC_Consigne_reprise",
+  "value": 21.5
+}
+```
+
+Example with [`examples/CTA/cta_conf_restaurant.csv`](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
+
+```bash
+# 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/`](examples/) and [`contrib/`](contrib/) for more device configurations.
+
+## Credits
+
+This project builds on:
+
+- [modpoll](https://github.com/gavinying/modpoll) — Ying Shaodong (MIT)
+- [modbus2mqtt](https://github.com/owagner/modbus2mqtt) — Oliver Wagner (MIT)
+- [spicierModbus2mqtt](https://github.com/mbs38/spicierModbus2mqtt) — Max Brueggemann (MIT)
+
+## License
+
+MIT — see [LICENSE](LICENSE).

modpoll2mqtt-2.0.0/modpoll/__init__.py

@@ -0,0 +1,6 @@
+import importlib.metadata as importlib_metadata
+
+try:
+    __version__ = importlib_metadata.version("modpoll2mqtt")
+except importlib_metadata.PackageNotFoundError:
+    __version__ = "0.0.0"

modpoll2mqtt-2.0.0/modpoll/__main__.py

@@ -0,0 +1,3 @@
+from .main import app
+
+app()

modpoll2mqtt-2.0.0/modpoll/arg_parser.py

@@ -0,0 +1,209 @@
+import argparse
+
+from . import __version__
+
+_CSV_DELIMITER_CHOICES = ("comma", "tab")
+
+
+def get_parser():
+    parser = argparse.ArgumentParser(
+        description=f"modpoll2mqtt v{__version__} - Modbus to MQTT gateway"
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"v{__version__}",
+    )
+    parser.add_argument(
+        "-f",
+        "--config",
+        required=True,
+        help="A local path or URL of Modbus configuration file. Required!",
+        nargs="+",
+    )
+    parser.add_argument(
+        "--csv-delimiter",
+        default="comma",
+        choices=_CSV_DELIMITER_CHOICES,
+        help=(
+            "Column delimiter code for Modbus config files "
+            f"({', '.join(_CSV_DELIMITER_CHOICES)}). Defaults to comma"
+        ),
+    )
+    parser.add_argument(
+        "-d",
+        "--daemon",
+        action="store_true",
+        help="Run in daemon mode without printing result",
+    )
+    parser.add_argument(
+        "-r",
+        "--rate",
+        type=float,
+        default=10.0,
+        help="The sampling rate (s) to poll modbus device, Defaults to 10.0",
+    )
+    parser.add_argument(
+        "-1", "--once", action="store_true", help="Only run polling at one time"
+    )
+    parser.add_argument(
+        "--interval",
+        type=float,
+        default=0.5,
+        help="The time interval in seconds between two polling, Defaults to 0.5",
+    )
+    parser.add_argument(
+        "--tcp", help="Act as a Modbus TCP master, connecting to host TCP"
+    )
+    parser.add_argument(
+        "--tcp-port", type=int, default=502, help="Port for MODBUS TCP. Defaults to 502"
+    )
+    parser.add_argument(
+        "--udp", help="Act as a Modbus UDP master, connecting to host UDP"
+    )
+    parser.add_argument(
+        "--udp-port", type=int, default=502, help="Port for MODBUS UDP. Defaults to 502"
+    )
+    parser.add_argument(
+        "--serial",
+        "--rtu",
+        dest="serial",
+        help="pyserial URL (or port name) for serial transport (alias: --rtu)",
+    )
+    parser.add_argument(
+        "--serial-baud",
+        "--rtu-baud",
+        dest="serial_baud",
+        type=int,
+        default=9600,
+        help="Baud rate for serial port. Defaults to 9600",
+    )
+    parser.add_argument(
+        "--serial-parity",
+        "--rtu-parity",
+        dest="serial_parity",
+        choices=["none", "odd", "even"],
+        default="none",
+        help="Parity for serial port. Defaults to none",
+    )
+    parser.add_argument(
+        "--timeout",
+        type=float,
+        default=3.0,
+        help="Response time-out seconds for MODBUS devices, Defaults to 3.0",
+    )
+    parser.add_argument(
+        "-o",
+        "--export",
+        default=None,
+        help="The file name to export references/registers",
+    )
+    parser.add_argument(
+        "--mqtt-version",
+        choices=["3.1.1", "5.0"],
+        default="3.1.1",
+        help="MQTT version. Defaults to MQTT v3.1.1",
+    )
+    parser.add_argument(
+        "--mqtt-host",
+        default=None,
+        help="MQTT server address. Skip MQTT setup if not specified",
+    )
+    parser.add_argument(
+        "--mqtt-port",
+        type=int,
+        default=1883,
+        help="1883 for non-TLS or 8883 for TLS, Defaults to 1883",
+    )
+    parser.add_argument(
+        "--mqtt-clientid",
+        default=None,
+        help="MQTT client name, If qos > 0, set unique name for multiple clients",
+    )
+    parser.add_argument(
+        "--mqtt-publish-topic-pattern",
+        default="modpoll/{{device_name}}/data",
+        help='Topic pattern for MQTT publish. Use {{device_name}} as placeholder for the device names in Modbus config. Defaults to "modpoll/{{device_name}}/data"',
+    )
+    parser.add_argument(
+        "--mqtt-subscribe-topic-pattern",
+        default="modpoll/+/set",
+        help='Topic pattern for MQTT write commands. Use + as placeholder for device name. Defaults to "modpoll/+/set"',
+    )
+    parser.add_argument(
+        "--mqtt-diagnostics-topic-pattern",
+        default="modpoll/{{device_name}}/diagnostics",
+        help="Topic pattern for MQTT diagnostics. Use {{device_name}} as placeholder for the device names in Modbus config. Defaults to modpoll/{{device_name}}/diagnostics",
+    )
+    parser.add_argument(
+        "--mqtt-qos",
+        choices=[0, 1, 2],
+        type=int,
+        default=0,
+        help="MQTT QoS value. Defaults to 0",
+    )
+    parser.add_argument(
+        "--mqtt-rx-queue-size",
+        type=int,
+        default=1000,
+        metavar="N",
+        help="Max MQTT subscribe messages buffered between polls (default: 1000)",
+    )
+    parser.add_argument(
+        "--mqtt-user", default=None, help="Username for authentication (optional)"
+    )
+    parser.add_argument(
+        "--mqtt-pass", default=None, help="Password for authentication (optional)"
+    )
+    parser.add_argument("--mqtt-use-tls", action="store_true", help="Use TLS")
+    parser.add_argument(
+        "--mqtt-insecure",
+        action="store_true",
+        help="Use TLS without providing certificates",
+    )
+    parser.add_argument("--mqtt-cacerts", default=None, help="Path to ca keychain")
+    parser.add_argument(
+        "--mqtt-tls-version",
+        choices=["tlsv1.2", "tlsv1.1", "tlsv1"],
+        default="tlsv1.2",
+        help="TLS protocol version, can be one of tlsv1.2 tlsv1.1 or tlsv1",
+    )
+    parser.add_argument(
+        "--mqtt-single",
+        action="store_true",
+        help="Publish each value in a single topic. If not specified, groups all values in one topic.",
+    )
+    parser.add_argument(
+        "--diagnostics-rate",
+        type=float,
+        default=0,
+        help="Time in seconds as publishing period for each device diagnostics",
+    )
+    parser.add_argument(
+        "--autoremove",
+        action="store_true",
+        help="Automatically remove poller if modbus communication has failed 3 times.",
+    )
+    parser.add_argument(
+        "--loglevel",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="INFO",
+        help="Set log level, Defaults to INFO",
+    )
+    parser.add_argument(
+        "--timestamp", action="store_true", help="Add timestamp to the result"
+    )
+    parser.add_argument(
+        "--delay",
+        type=int,
+        default=0,
+        help="Time to delay sending first request in seconds after connecting. Default to 0",
+    )
+    parser.add_argument(
+        "--framer",
+        default="default",
+        choices=["default", "ascii", "rtu", "socket"],
+        help="The type of framer for Modbus messages. Serial supports ascii/rtu; TCP/UDP use socket.",
+    )
+    return parser