Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 1.28 KB

README.md

File metadata and controls

74 lines (52 loc) · 1.28 KB

pykostal - a python based kostal bridge

PyPI version PyPI - Python Version PyPI - Status

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

Initially run the following in your virtualenv:

python setup.py bdist_wheel

Everytime you update setup.py, run the following in your virtualenv:

pip install -e .

To install pykostal, along with the tools you need to develop and run tests, run the following in your virtualenv:

pip install -e .[dev]

publishing

python setup.py bdist_wheel sdist
twine upload dist/*