Skip to content
/ hm_caldav Public

A HomeMatic CCU-Addon to quering a caldav calendar (ics file) for events and populate system variables with the status (ongoing / not ongoing) of defined meetings.

License

Notifications You must be signed in to change notification settings

H2CK/hm_caldav

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CalDav integration for HomeMatic - hm_caldav

Release Downloads Issues License Donate

This CCU-Addon reads an ics file from the given url. In the configuration you can define which meeting are represented as system variables within the HomeMatic CCU environment. If a defined meeting is running this is represented by the value of the corresponding system variable. Additionally there are variables -TODAY and -TOMORROW which are set to active if a meeting is planned today or tommorow, even if the meeting only last for e.g. an hour.

Important: This addon is based on wget. On your CCU there might be an outdated version of wget, which might not support TLS 1.1 or TLS 1.2.

Supported CCU models

Installation as CCU Addon

  1. Download of recent Addon-Release from Github
  2. Installation of Addon archive (hm_caldav-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_caldav:

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

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

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

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

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

     vim hm_caldav.conf
    
  7. Execute hm_caldav manually:

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

Using 'system.Exec()'

Instead of automatically calling hm_caldav 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_caldav/run.sh <iterations> <waittime> &");

Please note the <iterations> and <waittime> which allows to additionally specify how many times hm_caldav 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_caldav/run.sh 5 2 &");

This will execute hm_caldav 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-2021 Thorsten Jagel <dev@jagel.net>

Notice

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

About

A HomeMatic CCU-Addon to quering a caldav calendar (ics file) for events and populate system variables with the status (ongoing / not ongoing) of defined meetings.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published