sofar-modbus 0.1.4__tar.gz

sofar_modbus-0.1.4/.github/workflows/ci.yml

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

sofar_modbus-0.1.4/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Existing release tag to build and publish (e.g. 4.0.1)
+        required: true
+        type: string
+
+env:
+  RELEASE_TAG: ${{ inputs.tag || github.event.release.tag_name }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ env.RELEASE_TAG }}
+      - uses: astral-sh/setup-uv@v7
+      - name: Set package version from release tag
+        run: sed -i "s/^version = \"0\\.0\\.0\"$/version = \"${RELEASE_TAG}\"/" pyproject.toml
+      - name: Verify the version was substituted
+        run: grep -qx "version = \"${RELEASE_TAG}\"" pyproject.toml
+      - run: uv build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

sofar_modbus-0.1.4/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage

sofar_modbus-0.1.4/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 2025 William Swann
+   Copyright 2026 darkrain-nl
+
+   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.

sofar_modbus-0.1.4/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.5
+Name: sofar-modbus
+Version: 0.1.4
+Summary: Read Sofar Solar inverters (HYD, KTL-X and the older PV/storage range) over Modbus.
+Project-URL: Homepage, https://github.com/darkrain-nl/sofar-modbus
+Author: sofar-modbus contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: home-assistant,inverter,modbus,sofar,sofar-solar,solar
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Requires-Dist: modbus-connection[tmodbus]>=4.6.1
+Description-Content-Type: text/markdown
+
+# sofar-modbus
+
+Read Sofar Solar inverters over Modbus, as typed Python objects rather than
+register numbers.
+
+The library maps Sofar's register set onto
+[modbus-connection](https://github.com/balloob/modbus-connection)'s device model:
+you hand it a `ModbusUnit`, call `async_update()`, and read sub-systems as
+attributes. It owns no connection and no I/O policy — the caller does.
+
+## Supported devices
+
+Sofar ships two quite different register maps, so there are two device objects.
+
+**`SofarInverter` — the current generation.** HYD hybrids and KTL-X / KTLM PV
+inverters, over the 0x0400 (state and identity), 0x0480 (grid), 0x0500
+(off-grid), 0x0580 (PV), 0x0600 (battery), 0x0680 (energy), 0x1000 (settings)
+and 0x9000 (BTS battery tower) blocks. Serial prefixes: `SP1`, `SP2`, `ZP1`,
+`ZP2`, `SM2E`, `ZM2E`, `SH3E`, `SS2E`, `ZS2E`, `SQ1ES1`, `SA1`, `SB1`, `SC1`,
+`SD1`, `SF4`, `SH1`, `SL1`, `SJ2`, `SS1`. Includes the Azzurro and ZCS
+rebadges. This is the only generation with writable registers.
+
+**`SofarLegacyInverter` — the older generation.** The earlier PV inverters
+(`SA1`, `SA3`, `SB1`, `ZA3`, `SC1`, `SD1`, `SF4`, `SH1`, `SJ2`, `SL1`, `SM1`)
+and the `SE1E` / `SM1E` / `ZE1E` / `ZM1E` storage inverters, over the 0x0000 and
+0x0200 blocks, with the serial number in the input-register space. Read-only.
+
+Within a generation, what an inverter serves depends on its model: single or
+three phase, PV-only or hybrid, how many MPPT trackers, whether off-grid (EPS)
+and parallel-system registers exist. The first update reads the serial number
+and settles this into an `InverterType` bitmask; each component declares the
+mask it applies to, and a poll reads only the matching ones. Nothing else is
+touched — an inverter without batteries never sees a battery register.
+
+## Usage
+
+```python
+import asyncio
+
+from modbus_connection import ModbusTcpParams
+from modbus_connection.tmodbus import ModbusConnection
+from sofar_modbus import SofarInverter
+
+
+async def main() -> None:
+    connection = ModbusConnection(
+        ModbusTcpParams(host="192.168.1.50", port=502, framer="rtu")
+    )
+    try:
+        inverter = SofarInverter(connection.for_unit(1), read_eps=True)
+        await inverter.async_update()
+
+        print("Model:", inverter.model, inverter.serial_number)
+        print("State:", inverter.state.system_state)
+        print("Grid power:", inverter.grid.active_power_output_total, "kW")
+        print("PV power:", inverter.pv_1_2.pv_power_total, "kW")
+        print("Battery SoC:", inverter.battery_totals.battery_capacity_total, "%")
+        print("Solar today:", inverter.energy.solar_generation_today, "kWh")
+    finally:
+        await connection.close()
+
+
+asyncio.run(main())
+```
+
+A poll reads each sub-system independently, the way the integration reads its
+blocks: one slow or refused block does not take the rest of the poll with it.
+`async_update()` returns an `UpdateReport` — a failed component keeps its
+previous values, does not notify its listeners, and is listed by attribute
+name with its error, while every other component refreshes and notifies once
+the whole poll is done. Only a dead link (`ModbusConnectionError`) raises:
+
+```python
+report = await inverter.async_update()
+for name, error in report.failed.items():
+    print(f"{name} kept its previous values: {error}")
+```
+
+Writing works the same way — a plain field write for the registers that take
+one, and a method for the registers the device insists on receiving as a block:
+
+```python
+from sofar_modbus.modern import ChargerUseMode, FeedinLimitationMode
+
+await inverter.charger.write("charger_use_mode", ChargerUseMode.PASSIVE_MODE)
+await inverter.feed_in.async_write_limit(FeedinLimitationMode.DISABLED, 3000)
+await inverter.passive.async_write_power(
+    grid_power=-2000, battery_min=0, battery_max=5000
+)
+await inverter.active_power_control.async_write_active_power_limit(True, 70)
+```
+
+`active_power_control` is a live throttle on the inverter's own output — distinct
+from `feed_in`, which caps power exported to the grid. It applies to PV-only
+inverters as well as hybrids, and takes effect within seconds.
+
+A BTS battery tower multiplexes every pack onto one register block, so packs are
+read one at a time rather than polled:
+
+```python
+if inverter.has_battery_tower:
+    pack = await inverter.async_read_pack(string_nr=0, pack_nr=0)
+    print(pack.pack_serial_number, pack.soc, pack.cell_1_voltage)
+```
+
+For an issue report, `async_read_raw()` dumps every register the inverter reads
+undecoded, keyed by address space and address — every block a poll covers, for
+the sub-systems this model serves. The pack block is not in it: a dump of it
+would be whichever pack happened to be selected, with nothing to say which.
+
+## ASCII over TCP is not supported
+
+Sofar inverters are reached over RTU or RTU-over-TCP. This library never accepts
+or forwards `framer="ascii"`, and it exposes no connect helper that could: the
+caller builds the `ModbusUnit` and hands it over. Build it from an RTU serial or
+RTU-over-TCP connection — an ASCII-framed TCP connection is unsupported and
+untested, and nothing here works around it.
+
+## Attribution
+
+The register maps are derived from
+[homeassistant-solax-modbus](https://github.com/wills106/homeassistant-solax-modbus)
+(Apache-2.0), specifically its `plugin_sofar.py` and `plugin_sofar_old.py`. This
+library keeps that project's field keys, scale factors, units and per-model
+filtering, and is released under the same licence.
+
+Where upstream declares two entities on one register, or the same key twice,
+this library keeps both rather than picking a winner — the docstring on each
+field carries upstream's name, and the tests spell out the cases.

sofar_modbus-0.1.4/README.md

@@ -0,0 +1,129 @@
+# sofar-modbus
+
+Read Sofar Solar inverters over Modbus, as typed Python objects rather than
+register numbers.
+
+The library maps Sofar's register set onto
+[modbus-connection](https://github.com/balloob/modbus-connection)'s device model:
+you hand it a `ModbusUnit`, call `async_update()`, and read sub-systems as
+attributes. It owns no connection and no I/O policy — the caller does.
+
+## Supported devices
+
+Sofar ships two quite different register maps, so there are two device objects.
+
+**`SofarInverter` — the current generation.** HYD hybrids and KTL-X / KTLM PV
+inverters, over the 0x0400 (state and identity), 0x0480 (grid), 0x0500
+(off-grid), 0x0580 (PV), 0x0600 (battery), 0x0680 (energy), 0x1000 (settings)
+and 0x9000 (BTS battery tower) blocks. Serial prefixes: `SP1`, `SP2`, `ZP1`,
+`ZP2`, `SM2E`, `ZM2E`, `SH3E`, `SS2E`, `ZS2E`, `SQ1ES1`, `SA1`, `SB1`, `SC1`,
+`SD1`, `SF4`, `SH1`, `SL1`, `SJ2`, `SS1`. Includes the Azzurro and ZCS
+rebadges. This is the only generation with writable registers.
+
+**`SofarLegacyInverter` — the older generation.** The earlier PV inverters
+(`SA1`, `SA3`, `SB1`, `ZA3`, `SC1`, `SD1`, `SF4`, `SH1`, `SJ2`, `SL1`, `SM1`)
+and the `SE1E` / `SM1E` / `ZE1E` / `ZM1E` storage inverters, over the 0x0000 and
+0x0200 blocks, with the serial number in the input-register space. Read-only.
+
+Within a generation, what an inverter serves depends on its model: single or
+three phase, PV-only or hybrid, how many MPPT trackers, whether off-grid (EPS)
+and parallel-system registers exist. The first update reads the serial number
+and settles this into an `InverterType` bitmask; each component declares the
+mask it applies to, and a poll reads only the matching ones. Nothing else is
+touched — an inverter without batteries never sees a battery register.
+
+## Usage
+
+```python
+import asyncio
+
+from modbus_connection import ModbusTcpParams
+from modbus_connection.tmodbus import ModbusConnection
+from sofar_modbus import SofarInverter
+
+
+async def main() -> None:
+    connection = ModbusConnection(
+        ModbusTcpParams(host="192.168.1.50", port=502, framer="rtu")
+    )
+    try:
+        inverter = SofarInverter(connection.for_unit(1), read_eps=True)
+        await inverter.async_update()
+
+        print("Model:", inverter.model, inverter.serial_number)
+        print("State:", inverter.state.system_state)
+        print("Grid power:", inverter.grid.active_power_output_total, "kW")
+        print("PV power:", inverter.pv_1_2.pv_power_total, "kW")
+        print("Battery SoC:", inverter.battery_totals.battery_capacity_total, "%")
+        print("Solar today:", inverter.energy.solar_generation_today, "kWh")
+    finally:
+        await connection.close()
+
+
+asyncio.run(main())
+```
+
+A poll reads each sub-system independently, the way the integration reads its
+blocks: one slow or refused block does not take the rest of the poll with it.
+`async_update()` returns an `UpdateReport` — a failed component keeps its
+previous values, does not notify its listeners, and is listed by attribute
+name with its error, while every other component refreshes and notifies once
+the whole poll is done. Only a dead link (`ModbusConnectionError`) raises:
+
+```python
+report = await inverter.async_update()
+for name, error in report.failed.items():
+    print(f"{name} kept its previous values: {error}")
+```
+
+Writing works the same way — a plain field write for the registers that take
+one, and a method for the registers the device insists on receiving as a block:
+
+```python
+from sofar_modbus.modern import ChargerUseMode, FeedinLimitationMode
+
+await inverter.charger.write("charger_use_mode", ChargerUseMode.PASSIVE_MODE)
+await inverter.feed_in.async_write_limit(FeedinLimitationMode.DISABLED, 3000)
+await inverter.passive.async_write_power(
+    grid_power=-2000, battery_min=0, battery_max=5000
+)
+await inverter.active_power_control.async_write_active_power_limit(True, 70)
+```
+
+`active_power_control` is a live throttle on the inverter's own output — distinct
+from `feed_in`, which caps power exported to the grid. It applies to PV-only
+inverters as well as hybrids, and takes effect within seconds.
+
+A BTS battery tower multiplexes every pack onto one register block, so packs are
+read one at a time rather than polled:
+
+```python
+if inverter.has_battery_tower:
+    pack = await inverter.async_read_pack(string_nr=0, pack_nr=0)
+    print(pack.pack_serial_number, pack.soc, pack.cell_1_voltage)
+```
+
+For an issue report, `async_read_raw()` dumps every register the inverter reads
+undecoded, keyed by address space and address — every block a poll covers, for
+the sub-systems this model serves. The pack block is not in it: a dump of it
+would be whichever pack happened to be selected, with nothing to say which.
+
+## ASCII over TCP is not supported
+
+Sofar inverters are reached over RTU or RTU-over-TCP. This library never accepts
+or forwards `framer="ascii"`, and it exposes no connect helper that could: the
+caller builds the `ModbusUnit` and hands it over. Build it from an RTU serial or
+RTU-over-TCP connection — an ASCII-framed TCP connection is unsupported and
+untested, and nothing here works around it.
+
+## Attribution
+
+The register maps are derived from
+[homeassistant-solax-modbus](https://github.com/wills106/homeassistant-solax-modbus)
+(Apache-2.0), specifically its `plugin_sofar.py` and `plugin_sofar_old.py`. This
+library keeps that project's field keys, scale factors, units and per-model
+filtering, and is released under the same licence.
+
+Where upstream declares two entities on one register, or the same key twice,
+this library keeps both rather than picking a winner — the docstring on each
+field carries upstream's name, and the tests spell out the cases.

sofar_modbus-0.1.4/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sofar-modbus"
+version = "0.1.4"
+description = "Read Sofar Solar inverters (HYD, KTL-X and the older PV/storage range) over Modbus."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+authors = [{ name = "sofar-modbus contributors" }]
+keywords = ["modbus", "sofar", "sofar-solar", "inverter", "solar", "home-assistant"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Topic :: Home Automation",
+]
+# The caller injects a ModbusUnit; tmodbus is the backend this is exercised against.
+dependencies = ["modbus-connection[tmodbus]>=4.6.1"]
+
+[project.urls]
+Homepage = "https://github.com/darkrain-nl/sofar-modbus"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.11",
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.6",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sofar_modbus"]
+
+[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", "D"]
+# D401 wants imperative docstrings; this codebase names things ("The inverter
+# type a serial implies"), matching modbus-connection's own style. D107 is
+# covered by the class docstring.
+ignore = ["D107", "D401"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.mypy]
+python_version = "3.12"
+files = ["src", "tests"]
+strict = true
+
+[tool.ruff.lint.per-file-ignores]
+# A test's name is its documentation; docstrings are for the ones that need a why.
+"tests/*" = ["D100", "D103", "D104"]

sofar_modbus-0.1.4/src/sofar_modbus/__init__.py

@@ -0,0 +1,44 @@
+"""sofar-modbus — read Sofar Solar inverters over Modbus.
+
+Two protocol generations live side by side, each with its own top-level device
+object built on ``modbus_connection.model``::
+
+    from modbus_connection import ModbusTcpParams
+    from modbus_connection.tmodbus import ModbusConnection
+    from sofar_modbus import SofarInverter
+
+    connection = ModbusConnection(ModbusTcpParams(host="10.0.0.5", framer="rtu"))
+    inverter = SofarInverter(connection.for_unit(1))
+    await inverter.async_update()
+    inverter.grid.active_power_output_total
+
+- :class:`SofarInverter` — the current HYD / KTL-X generation.
+- :class:`SofarLegacyInverter` — the older SA/SB/SC/SM1E generation.
+
+Which registers an inverter serves depends on its model, encoded as an
+:class:`InverterType` bitmask on every component. See :mod:`sofar_modbus.variants`.
+
+ASCII framing over TCP is not supported: build the ``ModbusUnit`` from an RTU or
+RTU-over-TCP connection.
+"""
+
+from .legacy import SofarLegacyInverter
+from .model import (
+    SofarComponent,
+    SofarComponentBase,
+    SofarLegacyComponent,
+    UpdateReport,
+)
+from .modern import SofarInverter
+from .variants import InverterType, matches
+
+__all__ = [
+    "InverterType",
+    "SofarComponent",
+    "SofarComponentBase",
+    "SofarInverter",
+    "SofarLegacyComponent",
+    "SofarLegacyInverter",
+    "UpdateReport",
+    "matches",
+]