H2CK / hm_kostalpiko

A HomeMatic CCU-Addon to regularly query KOSTAL Piko inverter for status information
GNU Lesser General Public License v3.0
0 stars 0 forks source link
ccu ccu2 ccu3 hm-kostalpiko

KOSTAL Piko status information for HomeMatic - hm_kostalpiko

Release Downloads Issues License Donate

This CCU-Addon reads the current status informationen from a KOSTAL Piko inverter an provides these informations as system variables within the HomeMatic CCU environment.

Features

Following values are requested from a KOSTAL Piko inverter:

Supported CCU models

Installation as CCU Addon

  1. Download of recent Addon-Release from Github
  2. Installation of Addon archive (hm_kostalpiko-X.X.tar.gz) via WebUI interface of CCU device
  3. Configuration of Addon using the WebUI accessible config pages

Manual Installation as stand-alone script (e.g. on RaspberryPi)

  1. Create a new directory for hm_kostalpiko:

    mkdir /opt/hm_kostalpiko
  2. Change to new directory:

    cd /opt/hm_kostalpiko
  3. Download latest hm_kostalpiko.sh:

    wget https://github.com/H2CK/hm_kostalpiko/raw/master/hm_kostalpiko.sh
  4. Download of sample config:

    wget https://github.com/H2CK/hm_kostalpiko/raw/master/hm_kostalpiko.conf.sample
  5. Rename sample config to active one:

    mv hm_kostalpiko.conf.sample hm_kostalpiko.conf
  6. Modify configuration according to comments in config file:

    vim hm_kostalpiko.conf
  7. Execute hm_kostalpiko manually:

    /opt/hm_kostalpiko/hm_kostalpiko.sh
  8. If you want to automatically start hm_kostalpiko on system startup a startup script

Using 'system.Exec()'

Instead of automatically calling hm_kostalpiko on a predefined interval one can also trigger its execution using the system.Exec() command within HomeMatic scripts on the CCU following the following syntax:

    system.Exec("/usr/local/addons/hm_kostalpiko/run.sh <iterations> <waittime> &");

Please note the <iterations> and <waittime> which allows to additionally specify how many times hm_kostalpiko should be executed with a certain amount of wait time in between. One example of such an execution can be:

    system.Exec("/usr/local/addons/hm_kostalpiko/run.sh 5 2 &");

This will execute hm_kostalpiko for a total amount of 5 times with a waittime of 2 seconds between each execution.

Support

In case of problems/bugs or if you have any feature requests please feel free to open a new ticket at the Github project pages.

License

The use and development of this addon is based on version 3 of the LGPL open source license.

Authors

Copyright (c) 2018 Thorsten Jagel <dev@jagel.net>

Notice

This Addon uses KnowHow that was developed throughout the following projects: