modbus-connection

A small, backend-neutral Modbus connection abstraction.

The top-level modbus_connection package is a pure interface — the ModbusConnection / ModbusUnit Protocols and a tiny exception hierarchy — so consumers can type against it without committing to a backend. Two interchangeable backends implement it (pymodbus and tmodbus); the bare install pulls neither.

One physical Modbus link addresses many units (1–247). Sharing a single, internally-serialized connection across many consumers is strictly better than each opening a competing socket. This package is the connection abstraction that makes that sharing possible while keeping the backend swappable.

Install

pip install "modbus-connection[pymodbus]"   # pymodbus backend
pip install "modbus-connection[tmodbus]"    # tmodbus backend

Example

Model a device once, then connect, update, read, and write it. The optional modbus_connection.model framework maps a device's registers and coils to typed attributes and reads the whole device in as few Modbus calls as possible.

import asyncio

from modbus_connection import ModbusTcpParams
from modbus_connection.model import Component, gauge, uint32, coil
from modbus_connection.tmodbus import TmodbusConnection


class Meter(Component):
    voltage = gauge(0, 0.1, unit="V")  # scaled 16-bit register
    """Grid voltage."""

    current = gauge(1, 0.1, unit="A")
    """Grid current."""

    energy = uint32(2, unit="Wh")  # 32-bit over two registers
    """Lifetime energy."""

    relay = coil(0, writable=True)
    """Load relay."""


async def main() -> None:
    conn = TmodbusConnection(ModbusTcpParams(host="192.168.1.50", port=502))
    try:
        await conn.connect()
        meter = Meter(conn.for_unit(1))

        await meter.async_update()  # one pooled block read
        print(meter.voltage, meter.current, meter.energy, meter.relay)

        await meter.write("relay", True)  # write a writable field
    finally:
        await conn.close()


asyncio.run(main())

Documentation

Everything else — the other transports (UDP, serial, TLS), the full field-type and read-planning reference, repeated sub-units, the SunSpec field types and model generator, the query helper, the in-memory mock backend for tests, and the exception hierarchy — lives on the website:

https://home-assistant-libs.github.io/modbus-connection/

Develop

uv sync --extra pymodbus
uv run pytest

Formatting/linting is ruff and type-checking is mypy, both enforced in CI. Run them locally with:

uv run mypy

Install the commit hook with prek so code is formatted on commit:

uvx prek install          # set up the git hook
uvx prek run --all-files  # format + lint everything now

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (4.3.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for balloob from gravatar.com balloob

Credits

Author: home-assistant-libs

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache-2.0)

Requires

Python >=3.12

Provides Extra

pymodbus tmodbus

Tags

modbus pymodbus tmodbus

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modbus_connection-3.9.0.tar.gz (197.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

modbus_connection-3.9.0-py3-none-any.whl (80.5 kB view details)

Uploaded Python 3

File details

Details for the file modbus_connection-3.9.0.tar.gz.

File metadata

  • Download URL: modbus_connection-3.9.0.tar.gz
  • Upload date:
  • Size: 197.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for modbus_connection-3.9.0.tar.gz
Algorithm Hash digest
SHA256 dbdbb995c772763b9b56fc32ca89cfb254ce395462cf4498fe440e3d26e26fe4
MD5 02cc12bea1bfbf6207f8fa8a26e6b914
BLAKE2b-256 f97167deeb6ddf264ee00ffa4c47c267c0e3803bc354a379ced8652f270d1dd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for modbus_connection-3.9.0.tar.gz:

Publisher: publish.yml on home-assistant-libs/modbus-connection

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file modbus_connection-3.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for modbus_connection-3.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c38dad3497d6d0a04a6b26d8dfd4b9b1a07ce599b53758bb83d03718caa7f60
MD5 1fe5a3d6dc1dfeaf64b826a3323c8c62
BLAKE2b-256 c1d16a19e97118b1294e3ac11544daed74ea1dcb907191cfa11b40e3953eab34

See more details on using hashes here.

Provenance

The following attestation bundles were made for modbus_connection-3.9.0-py3-none-any.whl:

Publisher: publish.yml on home-assistant-libs/modbus-connection

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page