pykoplenti 1.5.0__tar.gz

pykoplenti-1.5.0/.github/workflows/ci.yaml

@@ -0,0 +1,61 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+      - name: Lint with ruff
+        run: |
+          uv run --group dev --python ${{ matrix.python-version }} ruff check --output-format=github .
+      - name: Type check with mypy
+        run: |
+          uv run --group dev --extra cli --python ${{ matrix.python-version }} mypy pykoplenti/ tests/
+      - name: Test with pytest
+        run: |
+          uv run --group dev --extra cli --python ${{ matrix.python-version }} pytest --junitxml=junit/test-results.xml --cov pykoplenti --cov-report=xml --cov-report=html
+      - name: Test with tox
+        run: |
+          uv run --group dev --extra cli --python ${{ matrix.python-version }} tox
+      - name: Build package
+        run: |
+          uv build --python ${{ matrix.python-version }}
+      - name: Upload packages to github
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.python-version }}
+          path: dist/*
+
+  deploy:
+    if: startsWith(github.event.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pykoplenti
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishi
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+      - name: Build package
+        run: |
+          uv build --python 3.10
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pykoplenti-1.5.0/.gitignore

@@ -0,0 +1,12 @@
+/secrets
+/credentials*
+/venv
+__pycache__
+*.egg-info
+build/
+dist/
+.tox/
+pip-wheel-metadata/
+.env.local
+coverage.xml
+.coverage

pykoplenti-1.5.0/.python-version

@@ -0,0 +1 @@
+3.10

pykoplenti-1.5.0/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Start CLI",
+      "type": "python",
+      "request": "launch",
+      "envFile": "${workspaceFolder}/.env.local",
+      "program": "${workspaceFolder}/pykoplenti/cli.py",
+      "args": ["repl"],
+      "console": "integratedTerminal",
+      "justMyCode": true
+    }
+  ]
+}

pykoplenti-1.5.0/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "python.formatting.provider": "black",
+  "editor.formatOnSave": true,
+  "ruff.organizeImports": true
+}

pykoplenti-1.5.0/CHANGELOG.md

@@ -0,0 +1,100 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.5.0] - 2026-01-07
+
+### Fixed
+
+- `get_settings_values` returns an API 500 error in case the overload variant `(str, Iterable[str])`
+  was used on newer models (like Plenticore plus G2).
+
+### Internally
+
+- Migrate to uv from pipenv
+
+## [1.4.0] - 2025-04-01
+
+### Changed
+
+- The cli now supports installer authentication, see `--service-code` option
+- New credential file format for cli that supports password and service code
+
+## Deprecated
+
+- Option `--password-file` is now deprecated. Use `--credentials` instead.
+
+## [1.3.0] - 2024-11-13
+
+## Changed
+
+- Added support for pydantic 2.x (>=2.0.0) while maintaining compatibility
+  with pydantic 1.x (>=1.9.0).
+- Dropped support for Python 3.8 and added 3.11/3.12.
+
+## Fixed
+
+- Fixed error in cli for printing events.
+
+## [1.2.2] - 2023-11-12
+
+## Changed
+
+- Loosen version for required package aiohttp (Dependency to Home Assistant).
+
+## [1.2.1] - 2023-11-11
+
+### Changed
+
+- Downgrade pydantic to 1.x (Dependency to Home Assistant).
+
+## [1.2.0] - 2023-11-06
+
+### Changed
+
+- All models are now based on pydantic - interface is still the same.
+- Code is refactored into separate modules - imports are still provided by using `import pykoplenti`
+
+### Fixed
+
+- If a request is anwered with 401, an automatic re-login is triggered (like this was already the case for 400 response).
+
+### Added
+
+- A new api client `ExtendedApiClient` was added which provides virtual process data values. See [Virtual Process Data](doc/virtual_process_data.md) for details.
+- Package provide type hints via `py.typed`.
+
+## [1.1.0]
+
+### Added
+
+- Add installer authentication
+- Add a new class `pykoplenti.ExtendedApiClient` which provides virtual process ids for some common missing values.
+
+## [1.0.0] - 2021-05-04
+
+### Fixed
+
+- ProcessDataCollection can now return raw json response.
+
+### Changed
+
+- Minimum Python Version is now 3.7
+- Change package metadata
+- Changed naming to simpler unique name
+
+### Added
+
+- new function to read events from the inverter
+- new sub-command `read-events` for reading events
+- download of log data
+
+## [0.2.0] - 2020-11-17
+
+### Changed
+
+- Prepared for PyPI-Publishing
+- Allow reading setting values from multiple modules

pykoplenti-1.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

pykoplenti-1.5.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: pykoplenti
+Version: 1.5.0
+Summary: Python REST-Client for Kostal Plenticore Solar Inverters
+Project-URL: repository, https://github.com/stegm/pykoplenti
+Project-URL: changelog, https://github.com/stegm/pykoplenti/blob/master/CHANGELOG.md
+Project-URL: issues, https://github.com/stegm/pykoplenti/issues
+Author: @stegm
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: kostal,plenticore,rest,solar
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Requires-Dist: aiohttp~=3.8
+Requires-Dist: pycryptodome~=3.19
+Requires-Dist: pydantic<3,>=1.10
+Provides-Extra: cli
+Requires-Dist: click>=8.0; extra == 'cli'
+Requires-Dist: prompt-toolkit>=3.0; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# Python Library for Accessing Kostal Plenticore Inverters
+
+This repository provides a python library and command line interface for the REST-API of Kostal Plenticore Solar Inverter.
+
+This library is not affiliated with Kostal and is no offical product. It uses the interfaces of the inverter like other libs (eg. https://github.com/kilianknoll/kostal-RESTAPI) and uses information from their swagger documentation (ip-addr/api/v1/).
+
+![CI](https://github.com/stegm/pykoplenti/workflows/CI/badge.svg)
+
+## Features
+
+- Authenticate
+- Read/Write settings
+- Read process data
+- Read events
+- Download of log data
+- Full async-Support for reading and writing data
+- [Commandline interface](doc/command_line.md) for shell access
+- Dynamic data model - adapts automatically to new process data or settings
+- [Virtual Process Data](doc/virtual_process_data.md) values
+
+## Getting Started
+
+### Prerequisites
+
+You will need Python >=3.9.
+
+### Installing the library
+
+Packages of this library are released on [PyPI](https://pypi.org/project/kostal-plenticore/) and can be
+installed with `pip`. Alternatively the packages can also be downloaded from
+[GitHub](https://github.com/stegm/pykoplenti/releases/).
+
+I recommend to use a [virtual environment](https://docs.python.org/3/library/venv.html) for this,
+because it installs the dependecies independently from the system. The installed CLI tools can then be called
+without activating the virtual environment it.
+
+```shell
+# Install with command line support
+$ pip install pykoplenti[cli]
+
+# Install without command line support (library only)
+$ pip install pykoplenti
+```
+
+### Using the command line interface
+
+After installing with CLI support, you can use the command:
+
+```shell
+$ pykoplenti --help
+Usage: python -m pykoplenti.cli [OPTIONS] COMMAND [ARGS]...
+
+  Handling of global arguments with click
+
+Options:
+  --host TEXT           Hostname or IP of the inverter
+  --port INTEGER        Port of the inverter  [default: 80]
+  --password TEXT       Password or master key (also device id)
+  --service-code TEXT   service code for installer access
+  --password-file FILE  Path to password file - deprecated, use --credentials
+                        [default: secrets]
+  --credentials FILE    Path to the credentials file. This has a simple ini-
+                        format without sections. For user access, use the
+                        'password'. For installer access, use the 'master-key'
+                        and 'service-key'.
+  --help                Show this message and exit.
+
+Commands:
+  all-processdata   Returns a list of all available process data.
+  all-settings      Returns the ids of all settings.
+  download-log      Download the log data from the inverter to a file.
+  read-events       Returns the last events
+  read-processdata  Returns the values of the given process data.
+  read-settings     Read the value of the given settings.
+  repl              Provides a simple REPL for executing API requests to...
+  write-settings    Write the values of the given settings.
+```
+
+Visit [Command Line Help](doc/command_line.md) for example usage.
+
+### Using the library from python
+
+The library is fully async, there for you need an async loop and an async `ClientSession`. Please refer to the
+example directory for full code.
+
+Import the client module:
+
+```python
+from pykoplenti import ApiClient
+```
+
+To communicate with the inverter you need to instantiate the client:
+
+```python
+# session is a aiohttp ClientSession
+client = ApiClient(session, '192.168.1.100')
+```
+
+Login to gain full access to process data and settings:
+
+```python
+await client.login(passwd)
+```
+
+Now you can access the API. For example to read process data values:
+
+```python
+data = await client.get_process_data_values('devices:local', ['Inverter:State', 'Home_P'])
+
+device_local = data['devices:local']
+inverter_state = device_local['Inverter:State']
+home_p = device_local['Home_P']
+```
+
+See the full example here: [read_process_data.py](examples/read_process_data.py).
+
+If you should need installer access use the master key (printed on a label at the side of the inverter)
+and additionally pass your service code:
+
+```python
+await client.login(my_master_key, service_code=my_service_code)
+```
+
+## Documentation
+
+- [Command Line Interface](doc/command_line.md)
+- [Examples](examples/)
+- [Virtual Process Data](doc/virtual_process_data.md)
+- [Notes about Process Data](doc/process_data.md)
+
+## Built With
+
+- [AIOHTTPO](https://docs.aiohttp.org/en/stable/) - asyncio for HTTP
+- [click](https://click.palletsprojects.com/) - command line interface framework
+- [black](https://github.com/psf/black) - Python code formatter
+- [ruff](https://github.com/astral-sh/ruff) - Python linter
+- [pydantic](https://docs.pydantic.dev/latest/) - Data validation library
+- [pytest](https://docs.pytest.org/) - Python test framework
+- [mypy](https://mypy-lang.org/) - Python type checker
+- [hatchling](https://hatch.pypa.io/) - Modern Python build backend
+- [tox](https://tox.wiki) - Automate testing
+
+## License
+
+apache-2.0
+
+## Acknowledgments
+
+- [kilianknoll](https://github.com/kilianknoll) for the kostal-RESTAPI project