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.tmodbus import connect_tcp
from modbus_connection.model import Component, gauge, uint32, coil


class Meter(Component):
    voltage = gauge(0, 0.1, unit="V")     # scaled 16-bit register
    current = gauge(1, 0.1, unit="A")
    energy = uint32(2, unit="Wh")         # 32-bit over two registers
    relay = coil(0, writable=True)


async def main() -> None:
    conn = await connect_tcp("192.168.1.50", port=502)
    try:
        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 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.5.0.tar.gz (166.0 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.5.0-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for modbus_connection-3.5.0.tar.gz
Algorithm Hash digest
SHA256 999e6f6e873f7ab848a836c0cd094e9e6b4bf087a1d2cf51ab1f2d663cc5739a
MD5 0ccf7b10e57d715c39c472902d13c291
BLAKE2b-256 3a6edd7e92b8cf9d236caaced1c9e25ee0a031fd4214f66fb3d4f6cf95ea8fd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for modbus_connection-3.5.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.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for modbus_connection-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf4bf8474da0d63607e1235d176ff471234d614000079d107e6aa980ff32947e
MD5 b05b592f90f2e026f9e992c02a103d05
BLAKE2b-256 1aa456f299942470fec77529daf96f65ee4627e82e01f8aeb238700ad0571019

See more details on using hashes here.

Provenance

The following attestation bundles were made for modbus_connection-3.5.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