ical-Abfallkalender in openHAB verwenden

openhab-logo-square2Ein Beitrag in einem Forum brachte mich auf die Idee, mich in openHAB über anstehendene Abholtermine für die verschiedenen Abfallbehälter informieren zu lassen. Viele örtliche Abfallunternehmen bieten den jährlichen Kalender mittlerweile auch digital im ICAL-Format an. Diesen können wir nutzen, um ihn zunächst via JavaScript zu parsen und anschließend die anstehenden Termine in openHAB anzuzeigen. Dazu musste das ursprüngliche Script ein wenig angepasst und verschiedene Bereiche in openHAB konfiguriert werden. Näheres zeigt dieser Beitrag.

Verfügbare Artikel zu openHAB

little_blue_dot Einleitunglittle_blue_dot Einbinden der Internetgeschwindigkeitlittle_blue_dot RFID-Lesegerät einbinden
little_blue_dot Installationlittle_blue_dot Präsenzerkennung via Bluetooth und Pinglittle_blue_dot Einbinden von DS18B20-Sensoren
little_blue_dot Konfigurationlittle_blue_dot Kleines Netzwerkmonitoringlittle_blue_dot ical-Abfallkalender einbinden
little_blue_dot Reverse-Proxy für OpenHABlittle_blue_dot Einbinden von LG-Fernsehern [Update]little_blue_dot openHAB als Wecker
little_blue_dot Datenspeicherung und Statistikenlittle_blue_dot Einbinden Schaltern und Kontaktenlittle_blue_dot Einbinden von Bewegungssensoren
little_blue_dot Regeln planen und konfigurierenlittle_blue_dot Einbinden von Funksteckdosen (433 MHz)little_blue_dot Einbinden einer FritzBox
little_blue_dot Einbinden von USB-Steckdosenleisten (SIS-PMS)little_blue_dot Infrarotgesteuerte Geräte einbindenlittle_blue_dot Sprachausgabe auf einem Raspberry
little_blue_dot Einbinden von Temperatursensorenlittle_blue_dot Steuerung mit NFC-Tagslittle_blue_dot Schaltbare Steckdosenleiste mit Relais
little_blue_dot Externer Zugriff mit my.openhab

 

 

Quelle und Dank

Zunächst möchte ich jedoch den eigentlichen Ursprung dieser Methode erwähnen. Vielen Dank dazu an „seppy“, der den „icalendar JavaScript parser“ für seine Zwecke angepasst hat und die Umsetzung für diesen Beitrag deutlich erleichtert hat. Ich muss zugeben, dass meine Java(-Script)-Skills gegen Null tendieren.

http://openhabforum.de/viewtopic.php?t=11

 

Abfallkalender finden

Zunächst benötigen wir den Abfallkalender im bereits erwähnten ical-Format. Dazu bemühen wir am besten eine Suchmaschine unserer Wahl und kämpfen uns durch bis zu unserem örtlichen Entsorgungsunternehmen. In unserem Beispiel arbeiten wir mit der „Entsorgungswirtschaft Soest GmbH“. Wenn das Unternehmen vor Ort einen solchen Service nicht anbietet, könnte man vielleicht mit diesem Kontakt aufnehmen und die Idee der digitalen Bereitstellung vorschlagen. In unserem Fall haben wir die genaue Adresse (URL) für den ical-Abfallkalender herausgefunden:

http://esg-soest.de/ak_ics.php?ak_ortid=11&ak_strid=8033&ak_j=2016

 

Addon installieren

Falls wir das „HTTP-Addon“ bisher für kein anderes Item einsetzen und dieses folglich noch nicht „installiert“ wurde, holen wir dieses nun nach. Dazu verwenden wir einfach die apt-Paketverwaltung:

In diesem Fall arbeite ich mit der Version 1.8.0. Das einbinden neuer Addons kann auch im laufenden Betrieb von openHAB durchgeführt werden.

 

Items definieren

Anschließend konfigurieren wir openHAB und beginnen mit dem Anlegen neuer Items. Dazu kann übersichtshalber eine neue .item-Datei verwendet werden. Für unsere Abfall-Events benötigen wir drei neue Items:

Das erste Item wird mit dem Inhalt des in der URL angegebenen Kalenders befüllt. Dieser Inhalt wird jedoch zuvor mit dem Script „abfall_heute.js“ geparst und erhält als Rückgabe entweder „false“ oder den Wert der heutigen Abholung. Im zweiten Item definieren wir einen Schalter, der später auf aktiv gesetzt wird, wenn heute eine Abholung ansteht. Und zu guter Letzt befindet sich im dritten Item der Name der Abholung, wenn diese aktiv sein sollte.

 

Das Transform-Script

Kommen wir zum eigentlichen Kernstück des heutigen Beitrages, dem JavaScript. Dieses basiert auf ein bereits veröffentlichtes Script, um ical-Kalender zu durchsuchen und bei bestimmten Übereinstimmungen den aktuellen Termin als Rückgabewert zu liefern. Dieses wurde leicht verändert, so dass ein Termin nur bei absoluter Übereinstimmung mit dem heutigen Tag ausgegeben wird. Dieses Script speichern wird beispielsweise unter dem Namen „abfall_heute.js“ im Ordner „/ect/openhab/configurations/transform„.

 

Möchten wir anstatt der heutigen lieber die morgigen Abholtermine anzeigen, ändern wir die Zeile 96 in

und die Zeile 109 in

 

Dieses Script speichern wir ebenfalls im Ordner „/etc/openhab/configurations/transform/“ unter dem Dateinamen „abfall_morgen.js„. Daraufhin erstellen wir zusätzliche Items für die morgige Abfallabholung.

 

openHAB-Regeln erstellen

Nun können wir bereits jetzt den openHAB-Stream beobachten und warten ab, ob ein etwaiger Termin in das Item „ABFALL_ICAL“ geschrieben wird. Für die weitere Verwendung benötigen wir jedoch noch ein paar Regeln, die wir wie gewohnt in einer „.rules„-Datei im Ordner „rules“ erstellen:

Hier wird geprüft, ob das Item „ABFALL_ICAL“ über einen Terminwert verfügt. In diesem Fall wird das Item „ABFALL_AKTIV“ auf aktiv gesetzt und der Name der Abfallabholung in das Textitem „ABFALL_NAME“ geschrieben. Ansonsten wird das Item „ABFALL_AKTIV“ deaktiviert und das Item „ABFALL_NAME“ geleert.

 

Ein interessanter Anwendungszweck ist, sich beim Verlassen der Wohnung an das Rausstellen des Mülls erinnern zu lassen. Dazu erweitern wir beispielsweise eine bereits bestehenden Präsenz-Regel wie folgt:

In diesem Beispiel, dass wie ich zugeben muss, stark an die eigenen Gegebenheiten angepasst werden muss, wird beim verlassen der Wohnung geprüft, ob ein Abholtermin vorliegt. In diesem Fall werden die Lautsprecher im Esszimmer aktiviert und ein entsprechender Warnhinweis vorgelesen. Das Vorlesen mittels Text-to-Speach auf dem Raspberry habe ich bereits in diesem Artikel vorgestellt.

 

Die Sitemap erweitern

Sollte kein Abholtermin vorliegen, fände ich es weniger interessant, darüber eine Meldung anzeigen zu lassen. Daher nutze ich in diesem Fall ein dynamisches Item. Unser oben gezeigtes Regelwerk erlaubt es, zunächst festzustellen, ob ein Termin vorliegt oder nicht (Item „ABFALL_AKTIV„). Wenn dem so sein sollte, können wir in unserer Sitemap an gewünschter Stelle den Namen der Abholung anzeigen lassen:

 

Das Icon „abfall“ habe ich wie immer aus der Bildersuche einer Suchmaschine gefunden ( im Format 32×32 Pixel) und unter „/opt/openhab/webapps/images“ gespeichert. Für den Privatgebrauch sehe ich da kein Problem. Bei Fragen oder Anregungen kann gerne das Kommentarsystem genutzt werden.

 

 

Update
Peter fragte mich, ob es auch möglich wäre, die nächsten zwei Abholtermine anzuzeigen. Auch wenn meine Java-Script Kenntnisse gegen Null tendieren, habe ich eine Möglichkeit gefunden

 

Wir benötigen für die Umsetzung vier neue Transform-Scripte:

  • Script 1 für die Ausgabe des Namens der nächsten Abholung
  • Script 2 für die Ausgabe des Datums der nächsten Abholung
  • Script 3 für die Ausgabe des Namens der übernächsten Abholung
  • Script 4 für die Ausgabe des Datums der übernächsten Abholung

Die Scripte speichern wir wie gewohnt unter „/etc/openhab/configurations/transform„.

 

Zudem definieren wir 4 neue Items…

 

…und binden die beiden nächsten Termine wie folgt in die Sitemap ein:

 

Wenn jemand mit JavaScript-Kenntnissen einen bessere Weg kennt, möge er sich bitte in den Kommentaren melden.