Skip to main content

A library and CLI-tool to fetch the data from a Kostal Piko inverter

Project description

Contributors Forks Stargazers Issues MIT License


pykostalpiko

A simple python library to interface with a Kostal Piko Solar inverter
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

This project aims to support the same functionallity as the web interface of the Piko inverter and provide a friendly way to access it using python.

(back to top)

Usage

Installation

pip install pykostalpiko

Examples

Print the current values of the inverter

import asyncio

from aiohttp import ClientSession

from pykostalpiko import Piko
from pykostalpiko.dxs.current_values import LIST

async def asnyc_main():
    async with ClientSession() as session:
        async with Piko(session, "<ip-address>") as piko:
            print(await piko.async_fetch_multiple(LIST))


asyncio.run(asnyc_main())

Change the name of the inverter

import asyncio

from aiohttp import ClientSession

from pykostalpiko import Piko
from pykostalpiko.dxs.inverter import NAME

async def asnyc_main():
    async with ClientSession() as session:
        async with Piko(session, "<ip-address>", "username", "password") as piko:
            await piko.async_set_descriptors([(NAME, "<new-name>")])

asyncio.run(asnyc_main())

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Florian Schmidt - floriansch7843@gmail.com

Project Link: https://github.com/Florian7843/pykostalpiko

(back to top)

Acknowledgments

(back to top)

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

pykostalpiko-1.1.2.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

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

pykostalpiko-1.1.2-py2.py3-none-any.whl (12.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pykostalpiko-1.1.2.tar.gz.

File metadata

  • Download URL: pykostalpiko-1.1.2.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.10.6

File hashes

Hashes for pykostalpiko-1.1.2.tar.gz
Algorithm Hash digest
SHA256 ab16d861be8a646761e252b7f29dfaf75b7f05336125e5884b29ae74a7a2c779
MD5 6c19a5c2f3213be2d8eea2fffd117d29
BLAKE2b-256 3a356d0aad30e8242b269a2e61d707ce7aabc26fb290ded997a891a58d774046

See more details on using hashes here.

File details

Details for the file pykostalpiko-1.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pykostalpiko-1.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.10.6

File hashes

Hashes for pykostalpiko-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e9d15ac9d07a57dd6f14348ad1f9ccc80d40e7f63ce69ef419792bf42d9281b8
MD5 c34fa927d98b4cb2f990b0ffab8a6242
BLAKE2b-256 aa9210b5bab77fe42b9f7767feb04b3d60b562ea954c90dfb78ff1aab16eac01

See more details on using hashes here.

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