Pre-release

This release is a pre-release and may not be stable for production use.

modbus-connection

A small, backend-neutral Modbus connection abstraction.

The top-level modbus_connection package provides the abstract ModbusConnection, the ModbusUnit Protocol, and a tiny exception hierarchy. Two interchangeable backends implement them (tmodbus and pymodbus); 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[tmodbus]"    # tmodbus backend
pip install "modbus-connection[pymodbus]"   # pymodbus backend

Example

Model a device once, then construct, 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 ModbusConnection


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 = ModbusConnection(ModbusTcpParams(host="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 SunSpec field types and model generator, 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 tmodbus
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-4.0.0a3.tar.gz (195.1 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-4.0.0a3-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

Details for the file modbus_connection-4.0.0a3.tar.gz.

File metadata

  • Download URL: modbus_connection-4.0.0a3.tar.gz
  • Upload date:
  • Size: 195.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for modbus_connection-4.0.0a3.tar.gz
Algorithm Hash digest
SHA256 7aafbe4cf8ad14a62ab22118b6c72ea7ba7ffc2ecf57de6f0ec1ac9d2ff060ad
MD5 ee57e0bc2d82b405942c93eb8af9721a
BLAKE2b-256 596da304bd1d5884bcb60a956eaab20554458183fd0ce9a53a511f3e9e4a6fd6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for modbus_connection-4.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed8af5938b6886a3a3ed98c878f1b27b08956aa3d35fc29981862f3819e7932c
MD5 437484060bcf7b93e9e51bc18cc94fe2
BLAKE2b-256 ef1c951735d6b8041d5095187fd29569bf17fb3dacc4df264209ff0192ff3919

See more details on using hashes here.

Provenance

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