modbus-connection 1.0.0__tar.gz

modbus_connection-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Ruff format
+        run: uvx ruff format --check .
+      - name: Ruff lint
+        run: uvx ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync --extra pymodbus --extra tmodbus
+      - name: Run tests
+        run: uv run pytest

modbus_connection-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Set package version from release tag
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: sed -i "s/^version = \"0\\.0\\.0\"$/version = \"${RELEASE_TAG}\"/" pyproject.toml
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

modbus_connection-1.0.0/.gitignore

@@ -0,0 +1,21 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Environments
+.venv/
+.env
+
+# Tooling
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# uv
+uv.lock

modbus_connection-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# Run with prek (https://github.com/j178/prek): `prek install` then commits are
+# auto-formatted; `prek run --all-files` to check everything.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.18
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [--fix]

modbus_connection-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

modbus_connection-1.0.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: modbus-connection
+Version: 1.0.0
+Summary: A small, backend-neutral Modbus connection abstraction (pymodbus / tmodbus).
+Project-URL: Homepage, https://github.com/home-assistant-libs/modbus-connection
+Author: home-assistant-libs
+License: Apache-2.0
+License-File: LICENSE
+Keywords: home-assistant,modbus,pymodbus,tmodbus
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.12
+Provides-Extra: pymodbus
+Requires-Dist: pymodbus[serial]<3.12,>=3.11; extra == 'pymodbus'
+Provides-Extra: tmodbus
+Requires-Dist: serialx>=0.1; extra == 'tmodbus'
+Requires-Dist: tmodbus>=0.3; extra == 'tmodbus'
+Description-Content-Type: text/markdown
+
+# modbus-connection
+
+A small, **backend-neutral** Modbus connection abstraction.
+
+The top-level `modbus_connection` package is a pure interface — the
+`ModbusConnection` / `ModbusUnit` [Protocols](https://typing.readthedocs.io/en/latest/spec/protocol.html),
+the shared `WordOrder` type, and a tiny exception hierarchy. It imports **no**
+Modbus library and **no** Home Assistant, so consumers can type against it
+without committing to a backend.
+
+Two interchangeable backends implement that interface:
+
+| Backend | Module | Extra |
+| --- | --- | --- |
+| [pymodbus](https://github.com/pymodbus-dev/pymodbus) | `modbus_connection.pymodbus` | `[pymodbus]` |
+| [tmodbus](https://github.com/wlcrs/tmodbus) | `modbus_connection.tmodbus` | `[tmodbus]` |
+
+The bare install pulls neither backend.
+
+## Why
+
+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: the
+`Protocol` never changes when the backend does.
+
+## Design
+
+- A connection is **transient** and **owner-held**. A backend *connect function*
+  returns a live, already-connected instance — there is no `connect()` on the
+  object.
+- Requests are serialized per connection — but by the backend library, not by
+  this wrapper: pymodbus's transaction manager and tmodbus's smart transport
+  each hold a lock for the full request/response cycle, so concurrent unit calls
+  on one connection can't interleave.
+- The connection does **not** self-reconnect. On a drop it fires
+  `on_connection_lost` (best-effort) and stops; recreating it is the owner's job.
+- Consumers receive a **`ModbusUnit`** (via `connection.for_unit(unit_id)`), a
+  stateless per-unit handle with no lifecycle methods. Every method **raises** on
+  failure — it never returns `None`.
+- The full 19-function-code Modbus surface is exposed, plus typed reads
+  (`read_uint16`, `read_float32`, …) that own datatype + word/byte ordering. A
+  backend that cannot implement a code raises `NotImplementedError`.
+
+## Install
+
+```bash
+pip install "modbus-connection[pymodbus]"   # pymodbus backend
+pip install "modbus-connection[tmodbus]"    # tmodbus backend
+```
+
+## Use
+
+```python
+import asyncio
+from modbus_connection.pymodbus import connect_tcp
+
+
+async def main() -> None:
+    conn = await connect_tcp("192.168.1.50", port=502)
+    try:
+        unit = conn.for_unit(1)
+        outside_temp = await unit.read_int16(9)        # raw register, signed
+        flow_setpoint = await unit.read_float32(40, word_order="big")
+        pump_on = (await unit.read_coils(56, 1))[0]
+        print(outside_temp, flow_setpoint, pump_on)
+    finally:
+        await conn.close()
+
+
+asyncio.run(main())
+```
+
+Swapping to tmodbus is a one-line import change:
+
+```python
+from modbus_connection.tmodbus import connect_tcp
+```
+
+## Exceptions
+
+Both backends raise the same neutral types:
+
+- `ModbusError` — base class.
+- `ModbusConnectionError` — link down / not connected / transport failure.
+- `ModbusTimeoutError` — request sent, no valid response in time.
+- `ModbusExceptionError` — device returned a Modbus exception response
+  (`.exception_code` carries the raw code).
+
+## Testing
+
+An in-memory mock backend ships as a `pytest` plugin (auto-registered via an
+entry point — no `conftest` wiring). It implements the same Protocols, so code
+typed against `ModbusUnit` runs against it unchanged.
+
+```python
+async def test_reads_setpoint(mock_modbus_unit):
+    mock_modbus_unit.holding[40] = 1234            # single value
+    mock_modbus_unit.holding[2] = [0x0001, 0x86A0]  # list -> consecutive registers
+    mock_modbus_unit.holding[9] = lambda: 7         # callable -> evaluated per read
+
+    assert await mock_modbus_unit.read_uint16(40) == 1234
+    assert await mock_modbus_unit.read_uint32(2) == 100000
+```
+
+Reads resolve against the per-space stores (`holding`, `input`, `coils`,
+`discrete_inputs`); writes mutate them and fire `on_write` callbacks, so a test
+can react to a write by mocking other registers:
+
+```python
+def test_command_sets_ready(mock_modbus_unit):
+    def respond(event):
+        if event.address == 0:          # a command was written
+            mock_modbus_unit.holding[100] = 1   # device flips its "ready" flag
+    mock_modbus_unit.on_write(respond)
+```
+
+Fixtures: `mock_modbus_connection` (a `MockModbusConnection`) and
+`mock_modbus_unit` (its unit 1). `MockModbusConnection` / `MockModbusUnit` are
+also importable from `modbus_connection.mock` for direct construction.
+
+## Develop
+
+```bash
+uv sync --extra pymodbus
+uv run pytest
+```
+
+Formatting/linting is [ruff](https://docs.astral.sh/ruff/), enforced in CI. Install
+the commit hook with [prek](https://github.com/j178/prek) so code is formatted on
+commit:
+
+```bash
+uvx prek install          # set up the git hook
+uvx prek run --all-files  # format + lint everything now
+```

modbus_connection-1.0.0/README.md

@@ -0,0 +1,137 @@
+# modbus-connection
+
+A small, **backend-neutral** Modbus connection abstraction.
+
+The top-level `modbus_connection` package is a pure interface — the
+`ModbusConnection` / `ModbusUnit` [Protocols](https://typing.readthedocs.io/en/latest/spec/protocol.html),
+the shared `WordOrder` type, and a tiny exception hierarchy. It imports **no**
+Modbus library and **no** Home Assistant, so consumers can type against it
+without committing to a backend.
+
+Two interchangeable backends implement that interface:
+
+| Backend | Module | Extra |
+| --- | --- | --- |
+| [pymodbus](https://github.com/pymodbus-dev/pymodbus) | `modbus_connection.pymodbus` | `[pymodbus]` |
+| [tmodbus](https://github.com/wlcrs/tmodbus) | `modbus_connection.tmodbus` | `[tmodbus]` |
+
+The bare install pulls neither backend.
+
+## Why
+
+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: the
+`Protocol` never changes when the backend does.
+
+## Design
+
+- A connection is **transient** and **owner-held**. A backend *connect function*
+  returns a live, already-connected instance — there is no `connect()` on the
+  object.
+- Requests are serialized per connection — but by the backend library, not by
+  this wrapper: pymodbus's transaction manager and tmodbus's smart transport
+  each hold a lock for the full request/response cycle, so concurrent unit calls
+  on one connection can't interleave.
+- The connection does **not** self-reconnect. On a drop it fires
+  `on_connection_lost` (best-effort) and stops; recreating it is the owner's job.
+- Consumers receive a **`ModbusUnit`** (via `connection.for_unit(unit_id)`), a
+  stateless per-unit handle with no lifecycle methods. Every method **raises** on
+  failure — it never returns `None`.
+- The full 19-function-code Modbus surface is exposed, plus typed reads
+  (`read_uint16`, `read_float32`, …) that own datatype + word/byte ordering. A
+  backend that cannot implement a code raises `NotImplementedError`.
+
+## Install
+
+```bash
+pip install "modbus-connection[pymodbus]"   # pymodbus backend
+pip install "modbus-connection[tmodbus]"    # tmodbus backend
+```
+
+## Use
+
+```python
+import asyncio
+from modbus_connection.pymodbus import connect_tcp
+
+
+async def main() -> None:
+    conn = await connect_tcp("192.168.1.50", port=502)
+    try:
+        unit = conn.for_unit(1)
+        outside_temp = await unit.read_int16(9)        # raw register, signed
+        flow_setpoint = await unit.read_float32(40, word_order="big")
+        pump_on = (await unit.read_coils(56, 1))[0]
+        print(outside_temp, flow_setpoint, pump_on)
+    finally:
+        await conn.close()
+
+
+asyncio.run(main())
+```
+
+Swapping to tmodbus is a one-line import change:
+
+```python
+from modbus_connection.tmodbus import connect_tcp
+```
+
+## Exceptions
+
+Both backends raise the same neutral types:
+
+- `ModbusError` — base class.
+- `ModbusConnectionError` — link down / not connected / transport failure.
+- `ModbusTimeoutError` — request sent, no valid response in time.
+- `ModbusExceptionError` — device returned a Modbus exception response
+  (`.exception_code` carries the raw code).
+
+## Testing
+
+An in-memory mock backend ships as a `pytest` plugin (auto-registered via an
+entry point — no `conftest` wiring). It implements the same Protocols, so code
+typed against `ModbusUnit` runs against it unchanged.
+
+```python
+async def test_reads_setpoint(mock_modbus_unit):
+    mock_modbus_unit.holding[40] = 1234            # single value
+    mock_modbus_unit.holding[2] = [0x0001, 0x86A0]  # list -> consecutive registers
+    mock_modbus_unit.holding[9] = lambda: 7         # callable -> evaluated per read
+
+    assert await mock_modbus_unit.read_uint16(40) == 1234
+    assert await mock_modbus_unit.read_uint32(2) == 100000
+```
+
+Reads resolve against the per-space stores (`holding`, `input`, `coils`,
+`discrete_inputs`); writes mutate them and fire `on_write` callbacks, so a test
+can react to a write by mocking other registers:
+
+```python
+def test_command_sets_ready(mock_modbus_unit):
+    def respond(event):
+        if event.address == 0:          # a command was written
+            mock_modbus_unit.holding[100] = 1   # device flips its "ready" flag
+    mock_modbus_unit.on_write(respond)
+```
+
+Fixtures: `mock_modbus_connection` (a `MockModbusConnection`) and
+`mock_modbus_unit` (its unit 1). `MockModbusConnection` / `MockModbusUnit` are
+also importable from `modbus_connection.mock` for direct construction.
+
+## Develop
+
+```bash
+uv sync --extra pymodbus
+uv run pytest
+```
+
+Formatting/linting is [ruff](https://docs.astral.sh/ruff/), enforced in CI. Install
+the commit hook with [prek](https://github.com/j178/prek) so code is formatted on
+commit:
+
+```bash
+uvx prek install          # set up the git hook
+uvx prek run --all-files  # format + lint everything now
+```

modbus_connection-1.0.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "modbus-connection"
+version = "1.0.0"
+description = "A small, backend-neutral Modbus connection abstraction (pymodbus / tmodbus)."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+authors = [{ name = "home-assistant-libs" }]
+keywords = ["modbus", "pymodbus", "tmodbus", "home-assistant"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: System :: Hardware",
+]
+dependencies = []
+
+[project.optional-dependencies]
+pymodbus = ["pymodbus[serial]>=3.11,<3.12"]
+tmodbus = ["tmodbus>=0.3", "serialx>=0.1"]
+
+[project.entry-points.pytest11]
+modbus_connection = "modbus_connection.pytest_plugin"
+
+[project.urls]
+Homepage = "https://github.com/home-assistant-libs/modbus-connection"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "pymodbus[serial]>=3.11,<3.12",
+    "tmodbus>=0.3",
+    "serialx>=0.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/modbus_connection"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py312"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B"]

modbus_connection-1.0.0/src/modbus_connection/__init__.py

@@ -0,0 +1,31 @@
+"""modbus_connection — a small, backend-neutral Modbus connection abstraction.
+
+The top-level package is the pure interface: the ``ModbusConnection`` /
+``ModbusUnit`` Protocols, the shared ``WordOrder`` type, and the exception
+hierarchy. It imports no Modbus backend and no Home Assistant.
+
+Pick a backend to actually talk to a device:
+
+- ``modbus_connection.pymodbus`` — ``connect_tcp`` / ``connect_serial`` over
+  pymodbus (install the ``[pymodbus]`` extra).
+- ``modbus_connection.tmodbus`` — the same over tmodbus (the ``[tmodbus]`` extra).
+"""
+
+from ._protocol import ModbusConnection, ModbusUnit
+from ._types import WordOrder
+from .exceptions import (
+    ModbusConnectionError,
+    ModbusError,
+    ModbusExceptionError,
+    ModbusTimeoutError,
+)
+
+__all__ = [
+    "ModbusConnection",
+    "ModbusConnectionError",
+    "ModbusError",
+    "ModbusExceptionError",
+    "ModbusTimeoutError",
+    "ModbusUnit",
+    "WordOrder",
+]