modpoll2mqtt

Contents:

  • Installation
  • Quickstart
  • Basic Usage
  • Configuration
  • Operation and migration from 2.2.1
  • Changelog
modpoll2mqtt
  • modpoll2mqtt documentation
  • Edit on GitHub

modpoll2mqtt documentation

modpoll2mqtt is a command-line Modbus-to-MQTT gateway. Install it with pip install modpoll2mqtt and run the modpoll command.

It polls Modbus devices (RTU, TCP, UDP) using CSV configuration files, publishes values to an MQTT broker, and supports semantic write commands by CSV reference name.

Package on PyPI, source code and issues on GitHub.

Contents:

  • Installation
    • Install with pip or pipx
    • Uninstall
  • Quickstart
    • Poll once
    • Publish to MQTT
    • Write by reference
    • Validate before running
  • Basic Usage
    • Named Arguments
    • Commandline Usage
    • Configuration sources
    • Export
    • Operational flags
    • Configuration File
    • Framers and transports
    • Persistent Modbus connection
    • MQTT retain
    • MQTT status
    • MQTT diagnostics
    • MQTT payload keys
    • MQTT single publish
    • MQTT publish on change
    • Publish behavior
    • MQTT write commands
    • MQTT on-demand read (get)
    • Consolidation and migration
  • Configuration
    • Modbus configure file
    • Example 1: Modsim device (Modbus TCP device)
    • Example 2: SCPM-S6 Power Meter (Modbus RTU device)
  • Operation and migration from 2.2.1
    • Configuration and codecs
    • Writes and acknowledgements
    • Versioned command protocol
    • Resources, scheduling, and recovery
    • MQTT deployment and lifecycle
    • Validation and remaining field work
  • Changelog
    • 2.4.1 (2026-10-20)
    • 2.4.0 (2026-10-20)
    • 2.3.1 (2026-10-11)
    • 2.3.0 (2026-10-11)
    • 2.2.0 (2026-06-16)
    • 2.1.2 (2026-06-15)
    • 2.1.1 (2026-06-11)
    • 2.1.0 (2026-06-10)
    • 2.0.0 (2026-06-10)

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2021-2026 Ying Shaodong; 2026 yoch.

Built with Sphinx using a theme provided by Read the Docs.