Skip to main content

package to communicate with Kostal Piko inverters

Project description

pykostal - a python based kostal bridge

PyPI version PyPI - Status Tests

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

pykostal-0.1.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pykostal-0.1.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

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

Hashes for pykostal-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fc442c1d90df1160bde0bb4d24bf4c4328084cd466668e6e177aa2bd581e52bb
MD5 4017b3d0ebf42f7fb2738b226f1720bc
BLAKE2b-256 0bda5d3f176d00a2b9452f15d9211b0cabf1cd7abf05f51bf44b48c1ddea5e3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pykostal-0.1.0.tar.gz:

Publisher: release.yml on DAMEK86/pykostal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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

Hashes for pykostal-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 113f54baf5891621612d8f35b1e69c9883058f13df59dbd155da50bdc314d726
MD5 21cfa3fd805bb7158a77157e488a60a9
BLAKE2b-256 04312878c54fb41f8784ae797eaa205c74d6ec99d0151ce426b63dc88dfd17a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pykostal-0.1.0-py3-none-any.whl:

Publisher: release.yml on DAMEK86/pykostal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page