indevolt-modbus 0.1.0__tar.gz

indevolt_modbus-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @eliaslecomte

indevolt_modbus-0.1.0/.github/renovate.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "description": "Renovate configuration for indevolt-modbus",
+  "dependencyDashboard": false,
+  "extends": [
+    "config:recommended",
+    ":separateMajorReleases",
+    ":combinePatchMinorReleases",
+    "helpers:pinGitHubActionDigests"
+  ],
+  "rebaseWhen": "conflicted",
+  "ignorePaths": [
+    "**/node_modules/**"
+  ],
+  "github-actions": {
+    "enabled": true
+  },
+  "lockFileMaintenance": {
+    "enabled": true,
+    "schedule": [
+      "before 5am on monday"
+    ]
+  },
+  "packageRules": [
+    {
+      "matchManagers": [
+        "github-actions"
+      ],
+      "groupName": "GitHub Actions",
+      "minimumReleaseAge": "3 days"
+    },
+    {
+      "matchDepTypes": [
+        "dev",
+        "test"
+      ],
+      "groupName": "Dev & Test Dependencies",
+      "minimumReleaseAge": "3 days"
+    },
+    {
+      "matchPackageNames": [
+        "modbus-connection"
+      ],
+      "groupName": "Core Protocol Dependencies"
+    }
+  ]
+}

indevolt_modbus-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - name: Install dependencies
+        run: uv sync --locked
+      - 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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - name: Install dependencies
+        run: uv sync --locked
+      - name: Run tests
+        run: uv run pytest
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - run: uv build
+      - run: uvx twine check --strict dist/*

indevolt_modbus-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+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
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+        with:
+          ref: ${{ env.RELEASE_TAG }}
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - name: Set package version from validated release tag
+        run: uv run --no-project script/set_version.py "$RELEASE_TAG"
+      - run: uv build
+      - name: Validate distribution metadata and README
+        run: uvx twine check --strict dist/*
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # release/v1

indevolt_modbus-0.1.0/.gitignore

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

indevolt_modbus-0.1.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 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.

indevolt_modbus-0.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.5
+Name: indevolt-modbus
+Version: 0.1.0
+Summary: Read and control Indevolt energy storage devices over Modbus.
+Project-URL: Homepage, https://github.com/eliaslecomte/indevolt-modbus
+Project-URL: Repository, https://github.com/eliaslecomte/indevolt-modbus
+Project-URL: Issues, https://github.com/eliaslecomte/indevolt-modbus/issues
+Author: indevolt-modbus contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: indevolt,inverter,modbus,solar
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Requires-Dist: modbus-connection[tmodbus]>=4.12.4
+Description-Content-Type: text/markdown
+
+# indevolt-modbus
+
+A standalone, typed Python library for reading and controlling Indevolt energy
+storage devices over Modbus. The caller supplies a `modbus_connection.ModbusUnit`
+and owns the connection. Functional subsystems use `Component` fields, and
+`IndevoltDevice` combines them with partial-failure reporting.
+
+Repository: [eliaslecomte/indevolt-modbus](https://github.com/eliaslecomte/indevolt-modbus).
+
+## Install
+
+Requires Python 3.12 or newer. From this checkout:
+
+```sh
+pip install .
+```
+
+The package is not yet published. The release workflow builds a versioned wheel
+and source archive and publishes them through PyPI Trusted Publishing.
+
+## Read a device
+
+Enable Modbus server mode in the Indevolt app. The documented TCP defaults are
+port **8899** and unit **1**. The vendor currently describes physical RTU support
+as forthcoming; the library accepts a serial unit but hardware support must be
+confirmed for the installed firmware.
+
+```python
+from indevolt_modbus import IndevoltDevice
+
+# unit comes from your modbus-connection backend/connection.
+device = await IndevoltDevice.async_detect(unit)
+report = await device.async_update(["inverter_real_time_data"])
+for register in device.registers:
+    if register.component in report.updated:
+        print(register.name, device.value(register), register.unit)
+```
+
+Use typed subsystem attributes directly, for example
+`device.system_info.modbus_version_7534`. Other subsystem classes are exported
+from `indevolt_modbus.components`. `device.components` exposes the active models;
+`REGISTERS` describes their public attributes. Values are `None` before a read
+or when a known enumeration receives an unknown code.
+
+```sh
+uv sync
+uv run script/query.py 192.168.1.50 --port 8899 --unit 1 --component inverter_real_time_data
+uv run script/query.py 192.168.1.50 --port 8899 --raw --component system_info
+```
+
+Raw output contains unredacted device data. A full poll can take several minutes:
+the library requests five seconds of spacing around Modbus messages, following
+the vendor recommendation. Select the components you need. An explicit
+`message_spacing` of at least one second is supported for bench testing.
+
+## Writes
+
+```python
+register = next(r for r in device.registers if r.address == 1142)
+await device.async_write(register, 20)  # Backup SoC, percent
+await device.async_update([register.component])  # Read back actual state
+```
+
+Read-only fields reject writes. Numeric values must be finite integers within
+the documented range, or the wire type's range where no narrower limit is
+published. Packed dates/times are validated. Enumerations and protocol-version
+gates are enforced by `async_write`. Power commands at 1151 and in schedule
+slots use the single-unit 3600 W limit; parallel-system overrides are not exposed.
+Direct component writes enforce field validation but callers should use
+`async_write` for protocol-version-dependent enumeration restrictions.
+
+## Register coverage and source decisions
+
+[Register catalog](docs/registers.json) records all 194 explicit source rows,
+plus the documented intervening load-profile and schedule points (350 entries).
+344 numeric fields are implemented. Six serial fields remain catalog-only:
+the source does not specify their length. No serial length or product identity
+is guessed. Alarm words remain raw 32-bit integers because the source's `Value`
+column does not state its bit-index convention. Multiword values use big-endian
+word order, pending a real-device capture. The source does not specify a word
+swap. Scales, signedness and zero-based addresses are used as published.
+
+Register 7592 is labeled “Grid voltage” but has Hz units and a 0.01 scale; its
+catalog label is preserved. The power-factor unit `Pct` and 0.001 scale are also
+preserved, without assuming percent versus ratio. Capacity register 89 is not
+an accumulated-energy counter. Unsupported fields are removed before polling
+using protocol version register 7534. Optional/unavailable subsystems report
+failures independently; temporary failures are retried on subsequent polls.
+
+The linked vendor page contained a Markdown table, not a device YAML, when this
+library was prepared. The JSON catalog is the reviewed, deterministic input to
+`script/generate.py`. Source revisions are in [sources.json](docs/sources.json).
+See the [vendor register table](https://docs.indevolt.com/docs/hardware/open-data/modbus-register-table/)
+and [communication guide](https://docs.indevolt.com/docs/hardware/open-data/modbus/).
+
+## Development
+
+Layout, query helper, CI, release workflow and release procedure follow
+[sofar-modbus](https://github.com/darkrain-nl/sofar-modbus). Runtime modeling uses
+[modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
+
+```sh
+uv sync
+uv run script/generate.py
+uv run ruff check --fix .
+uv run ruff format .
+uv run ruff check .
+uv run mypy
+uv run pytest
+uv build
+```
+
+Two misplaced inverter fault continuation rows under grid charging were moved
+to the inverter alarm catalog; grid charging uses its explicitly documented
+0/1 values.
+
+Hardware behavior has not been verified. Tests use the actual modbus-connection
+mock backend; community captures are needed to resolve the documented gaps.
+See [RELEASING.md](RELEASING.md) for publishing setup.
+
+## Selective reads
+
+After `await device.async_ensure_setup()`, `device.read_groups(register_keys)` returns
+independent typed readers. Each reader covers one contiguous block of selected,
+supported fields (at most 125 registers), with no undocumented gaps. Call
+`await reader.async_update()` and read decoded attributes from that reader. Its
+cache is independent of `device.value()` and the full subsystem caches. This lets
+callers prioritize writes and fast telemetry between individual read requests
+without narrowing the device's writable fields. Schedule all access through one
+worker/connection and respect the device's message spacing.
+
+### Directional AC power correction
+
+The [vendor register table](https://docs.indevolt.com/docs/hardware/open-data/modbus-register-table/)
+checked on 2026-10-15 labels **ACOutW (1284)** as `uint16`, while its
+description defines directional inverter-plus-bypass power. A user hardware
+capture reported raw `63609`, consistent with signed `-1927 W` (`63609 - 65536`).
+The canonical catalog therefore overrides this field to `int16`, retaining the
+vendor type and rationale in `source_data_type` and `type_override_reason`.
+Generated decoding uses two's complement without reversing the sign.
+
+- **174, inverter AC power:** positive = AC charging/input; negative = AC discharging/output.
+- **6564, battery power:** positive = battery discharge; negative = battery charge.
+- **1284, total AC power:** inverter power plus bypass power; the vendor describes
+  bypass as positive for EPS and negative for a microinverter.
+
+Registers 174 and 6564 remain signed and retain their distinct conventions.
+
+### Presentation metadata
+
+`Register.display_format` describes documented decimal firmware versions and
+packed clock/schedule fields. Decoded protocol values remain numeric; consumers
+may render them as versions or text times while retaining the original value.
+This includes the forced-full-charge start time (7269), sleep times, and all
+24 schedule start/end pairs. Split device date/time words are not a timestamp:
+they are separate reads and carry no timezone.
+
+The vendor table leaves the unit column blank for 7268 and 7270, but explicitly
+specifies days and watts in their descriptions. The canonical catalog supplies
+`d` and `W` respectively. No wire scaling or write bounds change.
+
+Power factor (122) retains its signed 0.001 scale as a dimensionless ratio.
+The vendor labels it `Pct`, but a live 0.99 reading agrees with approximately
+173 W / 174 VA, not 0.99 percent. `source_unit` and `unit_override_reason`
+record this discrepancy in the canonical catalog.