package to communicate with Kostal Piko inverters
Project description
pykostal - a python based kostal bridge
Python 3.9+ compatible - Tested on Python 3.9, 3.10, 3.11, 3.12, and 3.13.
Python module for Kostal piko inverters supporting:
- current-values
- analog-inputs
- battery
- grid
- home
- pv-generator
- s0-in
- home
- info.versions
- statistics
- day
- log-data
- total
not supported:
- all settings
- events
ongoing:
- response code mapping (e.g. status code)
Installation
Run the following to install:
pip install pykostal
Usage
import kostal
# create instance
inverter = kostal.Piko(aiohttp.ClientSession(), url)
Developing pykostal
Prerequisites
- Python 3.9 or higher (tested up to Python 3.13)
Initial setup
Run the following in your virtual environment:
python -m build
Development installation
Every time you update the project, run the following in your virtual environment:
pip install -e .
To install pykostal along with the tools you need to develop and run tests, run the following in your virtual environment:
pip install -e '.[dev]'
Running tests
pytest
Testing across Python versions
tox
Publishing
Modern approach (recommended)
python -m build
twine upload dist/*
Legacy approach
python setup.py bdist_wheel sdist
twine upload dist/*
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pykostal-0.1.0.tar.gz.
File metadata
- Download URL: pykostal-0.1.0.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc442c1d90df1160bde0bb4d24bf4c4328084cd466668e6e177aa2bd581e52bb
|
|
| MD5 |
4017b3d0ebf42f7fb2738b226f1720bc
|
|
| BLAKE2b-256 |
0bda5d3f176d00a2b9452f15d9211b0cabf1cd7abf05f51bf44b48c1ddea5e3d
|
Provenance
The following attestation bundles were made for pykostal-0.1.0.tar.gz:
Publisher:
release.yml on DAMEK86/pykostal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pykostal-0.1.0.tar.gz -
Subject digest:
fc442c1d90df1160bde0bb4d24bf4c4328084cd466668e6e177aa2bd581e52bb - Sigstore transparency entry: 418274817
- Sigstore integration time:
-
Permalink:
DAMEK86/pykostal@e39a74bd8969dbdf184a9b4d0a0286bea2dd1849 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/DAMEK86
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e39a74bd8969dbdf184a9b4d0a0286bea2dd1849 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file pykostal-0.1.0-py3-none-any.whl.
File metadata
- Download URL: pykostal-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
113f54baf5891621612d8f35b1e69c9883058f13df59dbd155da50bdc314d726
|
|
| MD5 |
21cfa3fd805bb7158a77157e488a60a9
|
|
| BLAKE2b-256 |
04312878c54fb41f8784ae797eaa205c74d6ec99d0151ce426b63dc88dfd17a5
|
Provenance
The following attestation bundles were made for pykostal-0.1.0-py3-none-any.whl:
Publisher:
release.yml on DAMEK86/pykostal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pykostal-0.1.0-py3-none-any.whl -
Subject digest:
113f54baf5891621612d8f35b1e69c9883058f13df59dbd155da50bdc314d726 - Sigstore transparency entry: 418274831
- Sigstore integration time:
-
Permalink:
DAMEK86/pykostal@e39a74bd8969dbdf184a9b4d0a0286bea2dd1849 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/DAMEK86
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e39a74bd8969dbdf184a9b4d0a0286bea2dd1849 -
Trigger Event:
workflow_dispatch
-
Statement type: