Skip to content

DAMEK86/pykostal

Repository files navigation

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/*

About

Python library for kostal piko devices

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages