Diese Bibliothek beinhaltet zwei Module zur Einbindung von Kalenderdateien/-feeds im iCal-Format in IP Symcon:
- iCal Calendar Reader
- iCal Calendar Notifier
Inhaltverzeichnis
- Funktionsumfang
- Voraussetzungen
- Software-Installation
- Einrichten der Instanzen in IP-Symcon
- Statusvariablen und Profile
- WebFront
- PHP-Befehlsreferenz
Mit dem Modul iCal Calendar Reader werden Kalenderdaten eingelesen (getestet mit Google Calendar, ownCloud Calendar, Synology Calendar und iCloud), das Modul iCal Calendar Notifier reagiert mit einstellbaren Vor- und Nachlaufzeiten mit einer Statusvariable auf Kalenderereignisse. Zum aktuellen Status kann ein Skript weitere Kalenderdaten des/der auslösende(n) Ereigniss(e) abfragen. Es sind beliebig viele iCal Calendar Notifier-Instanzen mit unterschiedlichen Einstellungen an eine iCal Calendar Reader-Instanz koppelbar.
Damit ist es z.B. sehr einfach möglich einen zentralen Anwesenheitskalender im Internet zu pflegen, IP Symcon steuert damit automatisch Heizung, Alarmanlage und Anwesenheitssimulation. Mit der Auswertung von zusätzlichen Informationen im Kalendereintrag durch ein Skript können z.B. bestimmte Transponder für den Zugang gesperrt bzw. freigeschaltet werden.
Auch die Visualisierung von Einträgen in öffentlichen Kalendern (z.B. Müllabfuhrtermine, Kinoprogramm, ...) im Webfront können mit mehreren iCal Calendar Notifier-Instanzen ohne viel Skript-Programmierung gesteuert werden. Z.B. können Abfuhrtermine immer bereits 1 Tag vorher angezeigt werden, das Kinoprogramm zeigt prominent den Spielplan des aktuellen Tages, weiter unten folgt die restliche Woche.
Kalender werden beim Laden unter Berücksichtigung ihrer jeweiligen Zeitzone in die lokale Zeitzone umgerechnet, sich wiederholende Termine als mehrere Einzeltermine abgespeichert.
Diese Bibliothek nutzt folgende externe Bibliotheken im Verzeichnis /lib:
- iCalcreator (Version 2.26)
https://github.com/iCalcreator/iCalcreator, AGPLv3-Lizenz - RRule for PHP (Stand 2019-05-11)
https://github.com/rlanvin/php-rrule, MIT-Lizenz
- IP-Symcon ab Version 4.x
- Kalender im iCal-Format
Über das Modul-Control folgende URL hinzufügen.
git://github.com/skyslasher/iCal-Calendar
Unter "Instanz hinzufügen" eine I/O-Instanz iCal Calendar Reader hinzufügen. Dieser ist unter dem Hersteller ergomation systems aufgeführt.
Konfigurationsseite:
| Name | Beschreibung |
|---|---|
| Calendar URL | URL zum iCal-Feed |
| Username | Benutzer für den Zugriff auf den Feed |
| Passwort | Passwort dieses Benutzers |
| Synchronization | |
| Cachesize (days) | Anzahl der Tage für die Ereignisse in der Zukunft gelesen werden sollen |
| Update-freq. (mins) | Nach wie vielen Minuten soll ein Update des Feeds gelesen werden |
Auf folgendes URL-Format ist bei den unterschiedlichen iCal-Servern zu achten:
Google:
https://calendar.google.com/calendar/ical/(google-username)/private-(secret-hash-string)/basic.ics
Zu findem im Google Kalender. Im Hauptbildschirm rechts oben auf das Zahnrad klicken, dort "Einstellungen" auswählen. Im folgenden Bildschirm den Tab "Kalender" auswählen, dann in der Kalenderliste links auf den zu importierenden Kalendernamen klicken. Es folgt ein neuer Bildschirm "Kalenderdetails", dort in der Zeile "Privatadresse" mit der rechten Maustaste auf das "ICAL"-Icon klicken und den dahinter liegenden Link kopieren.
OwnCloud:
http[s]://(server-name)[:server-port]/remote.php/dav/calendars/(user-name)/(calendar-name)?export
Zu finden in der Kalender-App. Links in der Liste der Kalender auf "..." klicken, dann auf "Link". Den erscheinenden Link kopieren und das Suffix ?export anhängen.
Synology:
http[s]://(server-name)[:server-port]/caldav/(user-name)/(calendar.name)--(suffix)
Zu finden in der Calendar-App. Rechts in der Liste der Kalender das nach unten zeigende Dreieck neben dem Kalendernamen anklicken, "CalDAV-Konto" auswählen, in dem PopUp die Adresse für Thunderbird kopieren.
iCloud:
https://(server).icloud.com/published/(number)/(secret-hash-string-1)-(secret-hash-string-2)
Im macOS Kalender-Programm mit der rechten Maustaste auf den zu importierenden iCloud-Kalender klicken, "Teilen" auswählen und "Öffentlicher Kalender" auswählen. Den erscheinenden Link kopieren und das Protokoll webcal gegen https tauschen.
Sobald eine URL angegeben und gespeichert wurde beginnt die Synchronisierung. Fehler beim Zugriff auf den Kalender stehen im Systemlog (Tabreiter Meldungen in der IP-Symcon Management Konsole). Bei jeder Änderung der Parameter wird eine sofortige Synchronisation und ein Update auf alle angemeldeten Notifier gegeben.
Mit "Instanz hinzufügen" nun eine Instanz iCal Calendar Notifier hinzufügen. Diese ist ebenfalls unter dem Hersteller ergomation systems aufgeführt.
Die iCal Calendar Notifier haben folgende Konfigurationsoptionen:
Konfigurationsseite:
| Name | Beschreibung |
|---|---|
| Lagged Notification | |
| Prenotify (mins) | Wie viele Minuten vor dem Ereignisstart soll die Statusvariable "Presence" auf "true" gesetzt werden |
| Delay (mins) | Wie viele Minuten nach dem Ereignisende soll die Statusvariable "Presence" auf "false" gesetzt werden |
Wichtig! Im unteren Teil der Konfigurationsseite als übergeordnete Instanz die zugehörige iCal Calendar Reader-Instanz auswählen.
Bei jeder Änderung der Parameter oder der übergeordneten Instanz wird eine sofortige Synchronisation angestoßen und ein Update auf alle angemeldeten Notifier gegeben.
Nur iCal Calendar Notifier-Instanzen haben eine Statusvariable, diese wird automatisch angelegt. Das Löschen führt zu Fehlfunktionen.
Die iCal Calendar Notifier-Instanzen haben folgende Statusvariable:
| Name | Typ | Beschreibung |
|---|---|---|
| Presence | Boolean | Zeigt an ob ein Kalendereintrag unter Berücksichtigung der im Modul angegebenen Zeiten aktiv ist |
Es werden keine Variablenprofile angelegt.
Die Statusvariable ist mit Profilen für das WebFront vorbereitet.
json_string ICCR_GetClientConfig(integer $InstanceID);
Gibt ein Array mit sämtlichen registrierten Notifier-Konfigurationen als JSON-codierten String aus.
json_string ICCR_GetCachedCalendar(integer $InstanceID);
Gibt ein Array mit den zwischengespeicherten und in die lokale Zeitzone übertragenen Kalenderdaten als JSON-codierten String aus.
void ICCR_TriggerNotifications(integer $InstanceID);
Forciert eine sofortige Überprüfung, ob Notifications an die registrierten Notifier gesendet werden müssen.
Diese Funktion wird intern jede Minute aufgerufen.
Die Funktion liefert keinerlei Rückgabewert.
void ICCR_UpdateCalendar(integer $InstanceID);
Forciert eine sofortiges Neuladen des Kalenders.
Diese Funktion wird intern regelmäßig, wie in "Update-freq. (mins)" konfiguriert, aufgerufen.
Die Funktion liefert keinerlei Rückgabewert.
void ICCR_UpdateClientConfig(integer $InstanceID);
Forciert ein sofortiges Neuladen der Konfigurationen aller registrierten Notifier.
Die Funktion liefert keinerlei Rückgabewert.
boolean ICCN_GetNotifierPresence(integer $InstanceID);
Gibt den Wert der Statusvariable "Presence" zurück.
json_string ICCN_GetNotifierPresenceReason(integer $InstanceID);
Gibt ein Array der den "Presence"-Status bedingenden Ereignisse als JSON-codierten String aus.