DebMatic Plugin

Version History...

Das Plugin installiert DebMatic von Alexander Reinert auf dem LoxBerry. Damit steht eine vollwertige Homematic CCU3 auf dem LoxBerry bereit, die über Node Red und MQTT direkt mit dem LoxBerry bzw. Miniserver kommuniziert. Sämtliche Homematic Sensoren und Aktoren können ausgelesen und gesteuert werden. Zur Nutzung des Plugins ist ein Homematic Funkadapter notwendig, den es als Modul für den Raspberry Pi in verschiedenen Ausführungen gibt (siehe unten unter Hardware). Die Anbindung der Funkmodule kann anstelle über die GPIO Leiste auch über die USB- oder Ethernet-Platine von Alexander Reinert erfolgen. Damit ist ein Betreiben des Plugins auch in einer VM möglich. Eine separate CCU2/CCU3 ist nicht mehr nötig. Die Sensoren/Aktoren stehen als vollwertige Geräte in Loxone Config zur Verfügung.

• Das Plugin-Archiv (ZIP) kann auf GIT-Hub heruntergeladen werden: https://github.com/mschlenstedt/LoxBerry-Plugin-Debmatic/releases
• Der Sourcecode ist auf GitHub verfügbar: https://github.com/mschlenstedt/LoxBerry-Plugin-Debmatic

Das Plugin wird über die Pluginschnittstelle installiert. Es werden spezielle Kernelmodule während der Installation aus den Quelltexten kompiliert. Wird der Kernel bei einem LoxBerry update erneuert, ist ein Update des Plugins notwendig, damit für den neuen Kernel die entsprechenden Kernelmodule neu kompiliert werden.

Da verschiedene Komponenten während der Installation aus den Quelltexten kompiliert werden, kann die Installation etwas Zeit in Anspruch nehmen. Unterstützt werden aktuell folgende Hardware-Architekturen: Arm64, Arm7l, x64.

Das Plugin läuft auf den folgenden Hardware Architekturen:

• Arm64, z. B. Raspberry Pi, Odroid, Rock Pi
• Arm7l, z. B. Raspberry Pi 2
• x64, z. B. VMs (getestet: Virtual Box und Proxmox, andere sollten ebenfalls laufen)

Aufgestecktes HM-MOD-RPI-PCB auf einem Raspberry Pi, Quelle: ELV Webshop

Das ältere Funkmodul HM-MOD-RPI-PCB als Aufsteckvariante für die GPIO-Schnittstelle des Raspberry Pi wird von DebMatic voll unterstützt. Das Modul besteht aus zwei Einzel-Platinen, die von eQ-3 über den Webshop von ELV (als Bausatz ab etwa 20€) verkauft werden. Der Zusammenbau gelingt leicht. Das Funkmodul funktioniert auch auf anderen Single Board Computern, deren GPIO-Leiste kompatibel mit der des Raspberry Pi sind: https://github.com/alexreinert/debmatic#voraussetzung-f%C3%BCr-hm-mod-rpi-pcb-und-rpi-rf-mod

Aufgestecktes RPI-RF-MOD auf einem Raspberry Pi, Quelle: ELV Internetshop

Das neue Funkmodul RPI-RF-MOD als Aufsteckvariante für die GPIO-Schnittstelle des Raspberry Pi wird von DebMatic voll unterstützt. Gegenüber dem älteren Modul soll das neue Modul eine bessere Reichweite besitzen und bringt zudem eine Real Time Clock mit. Zudem hat das Modul eine Status RGB-LED sowie eine Reset-Taste. Das Modul wird von eQ-3 über den Webshop von ELV (als Bausatz ab etwa 40€) verkauft. Der Zusammenbau gelingt leicht. Das Funkmodul funktioniert auch auf anderen Single Board Computern, deren GPIO-Leiste kompatibel mit der des Raspberry Pi sind: https://github.com/alexreinert/debmatic#voraussetzung-f%C3%BCr-hm-mod-rpi-pcb-und-rpi-rf-mod

HB-RF-USB-TK Platine, Quelle: Smartkram Webshop

Diese USB-Platine ist eine Eigenentwicklung von Alexander Reinert! Sie bietet eine USB-Schnittstelle zu den Original-GPIO-Aufsteckmodulen von eQ3. Es ist also zusätzlich zur Platine auch noch die Aufsteckplatine RPI-RF-MOD bzw. HM-MOD-RPI-PCB notwendig (siehe oben). Der große Vorteil liegt darin, dass damit die GPIO-Leiste des Raspberry für andere Erweiterungen frei bleibt und auf Grund der freien Platzierung des Aufsteckmoduls kann dieses außerhalb vom Schaltschrank installiert werden. Passende Gehäuse gibt es auf Thingiverse.

Die Designvorlagen für die Platine sind frei zugänglich: https://github.com/alexreinert/PCB/tree/master

Die Platine kann auch als Bausatz fertig bestellt werden: https://smartkram.de/hardware-shop/produkte/bauteile-zentralen/diy-bausaetze/platine-hb-rf-usb-tk/

HB-RF-USB-2 Platine, Quelle: Smartkram Webshop

Diese USB-Platine ist eine Eigenentwicklung von Alexander Reinert! Sie bietet eine USB-Schnittstelle zu den Original-GPIO-Aufsteckmodulen von eQ3. Es ist also zusätzlich zur Platine auch noch die Aufsteckplatine RPI-RF-MOD bzw. HM-MOD-RPI-PCB notwendig (siehe oben). Der große Vorteil liegt darin, dass damit die GPIO-Leiste des Raspberry für andere Erweiterungen frei bleibt und auf Grund der freien Platzierung des Aufsteckmoduls kann dieses außerhalb vom Schaltschrank installiert werden. Passende Gehäuse gibt es auf Thingiverse

Die Designvorlagen für die Platine sind frei zugänglich: https://github.com/alexreinert/PCB/tree/master

Die Platine kann auch als Bausatz fertig bestellt werden: https://smartkram.de/hardware-shop/produkte/bauteile-zentralen/diy-bausaetze/platine-hb-rf-usb-2/

HB-RF-ETH Platine, Quelle: Smartkram Webshop

Diese Ethernet-Platine ist eine Eigenentwicklung von Alexander Reinert! Sie bietet eine Ethernet-Schnittstelle zu den Original-GPIO-Aufsteckmodulen von eQ3. Es ist also zusätzlich zur Platine auch noch die Aufsteckplatine RPI-RF-MOD bzw. HM-MOD-RPI-PCB notwendig (siehe oben). Der große Vorteil liegt darin, dass damit die GPIO-Leiste des Raspberry für andere Erweiterungen frei bleibt und auf Grund der freien Platzierung des Aufsteckmoduls kann dieses außerhalb vom Schaltschrank oder irgendwo im Gebäude installiert werden. Passende Gehäuse gibt es auf Thingiverse

Die Designvorlagen für die Platine sind frei zugänglich: https://github.com/alexreinert/PCB/tree/master

Die Platine kann auch als Bausatz fertig bestellt werden: https://smartkram.de/hardware-shop/produkte/bauteile-zentralen/diy-bausaetze/platine-hb-rf-eth/

Das Plugin benutzt das Übertragungsprotokoll MQTT. Daher muss das MQTT Widget korrekt konfiguriert sein. Bei der Konfiguration des MQTT Widget setzt bitte unter MQTT Gateway → Gateway Settings die folgenden 2 Optionen, damit die Daten vom DebMatic Plugin im Gateway korrekt aufbereitet werden:

Ihr solltet zudem einen Usernamen und ein Passwort für den MQTT Broker vergeben. Ihr benötigt beide Angaben später zur Konfiguration im Plugin.

Im Plugin können die Ports der Homematic WebUI, von Node Red und von CCU-Jack konfiguriert werden. Ändert diese Werte nur, wenn ihr wisst was ihr tut und wenn dieses bei Konflikten mit anderen Diensten unbedingt notwendig ist. Wenn ihr die Ethernet-Platine von Alexander Reinert nutzt, dann könnt ihr hier die IP-Adresse der Platine eingeben oder auch automatisch danach suchen lassen. Wenn das Plugin das Ethernet-Modul automatisch gefunden und aktiviert hat, ihr es aber z. B. in einer anderen Installation im Haus nutzen wollt, könnt ihr es hier wieder deaktivieren.

Die Einrichtung der Homematic CCU wird hier nicht weiter beschrieben. Alles funktioniert wie auf einer Original-CCU von Homematic. Erweiterungen lassen sich auf DebMatic allerdings nicht installieren bzw. dieses muss über apt-get auf der Kommandozeile geschehen. Alle verfügbaren Erweiterungen (wie z. B. CuxD) sind aber bereits vorinstalliert. Näheres auf der Debmatic Homepage.

Wer auf die XML-Api zugreifen möchte, nutzt folgenden Link:

https://<LOXBERRY IP>:8081/addons/xmlapi/info.html

Debmatic bietet insgesamt 3 Möglichkeiten an, eure Loxone-Installation an die Homematic anzubinden. Alle 3 Möglichkeiten funktionieren und können uneingeschränkt verwendet werden. Wählt die Variante, die Euch am Besten zusagt. Ich persönlich verwende die Anbindung per CCU-Jack.

CCU-Jack wird aktiv weiterentwickelt und verbindet die Homematic-Welt mit MQTT und damit auch über den LoxBerry mit der Loxone-Welt. Eigentlich wurde es entwickelt, um Nicht-Homematic-Geräte wie z. B. einen Shelly über MQTT an Homematic anzubinden. Diese Funktion ist für Loxone eher uninteressant. Es bindet aber auch alle Homematicgeräte an MQTT an und so kann man diese über MQTT und den LoxBerry auslesen und auch steuern.

Eine Anleitung zur Konfiguration findet sich unten.

Eine Anbindung über NodeRed und MQTT war lange Zeit die beste Möglichkeit, die Homematic-Welt mit Loxone zu verbinden. Leider wird das NodeRed-Modul seit mehreren Jahren nicht mehr aktiv weiterentwickelt. Noch funktioniert es aber einwandfrei und ohne Probleme. Weitere Infos zur Einrichtung unten und auf der NodeRed Homepage: https://flows.nodered.org/node/node-red-contrib-ccu

Das Modul wird automatisch mit Debmatic mit installiert.

Debmatic installiert eine vollwertige CCU, daher kann auch diese "klassische" Variante nach wie vor verwendet werden. Eine Anleitung dazu findet sich im LoxWiki: https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1529023557/Homematic+in+Loxone+integrieren

Vergebt zunächst ein sicheres Passwort für den Zugriff auf CCU-Jack. Die entsprechenden Konfigurationsmöglichkeiten findet ihr unter Konfiguration –> Zugriffsberechtigungen

CCU-Jack bietet zwei Möglichkeiten an, wie Werte von der Homematic eingelesen und auch Werte an die Homematic gesendet werden können: HTTP (REST API) und MQTT. Wir verwenden die MQTT-Schnittstelle im LoxBerry. Wer lieber HTTP verwenden möchte, der findet hier die entsprechende Anleitung dazu: https://github.com/mdzio/ccu-jack/wiki/CURL

Die Dokumentation zur MQTT Anbindung von CCU-Jack findet ihr hier: https://github.com/mdzio/ccu-jack/wiki/MQTT-Server

CCU-Jack bringt dabei seinen eigenen MQTT-Server mit, der direkt an die Homematic CCU angebunden ist. Diesen MQTT Server nutzen wir nicht. Wir verwenden den sogenannten Bridge Mode, der alle Datenpunkte des internen MQTT-Servers an den LoxBerry MQTT-Server (Mosquitto) durchreicht. Die Kommunikation erfolgt dabei in beiden Richtungen. Daher ist es wichtig, dass der interne MQTT-Server von CCU-Jack nicht auf den Standardports des LoxBerry MQTT-Servers läuft (siehe oben unter Konfiguration. Nutzt hier auf keinen Fall die Ports 1883 und 8883!). Letztendlich haben wir mit dem internen MQTT-Server von CCU-Jack "nichts zu tun". Das Plugin hat den Bridge Mode während der Installation konfiguriert - ihr braucht Euch darum nicht zu kümmern.

Sämtliche Datenpunkte der Homematic (Geräte und entsprechend konfigurierte Systemvariablen - zur Nutzung von Systemvariablen siehe Dokumentation) werden automatisch unter dem Topic ccu-jack an den LoxBerry MQTT Server übermittelt und können dort wie gewohnt weiterverwendet werden. Die Topics folgen dabei dem Schema:

ccujack/device/status/Seriennr./Kanalnr./Parametername

Um Werte an einen Aktor zu senden, verwendet ihr folgendes Topic-Schema:

ccujack/device/set/Seriennr./Kanalnr./Parametername

Wie ihr einen entsprechenden VIrtuellen Ausgang anlegt, findet ihr in der Dokumentation des MQTT Widgets: MQTT - Schritt für Schritt: Loxone -> MQTT

Meine Funksteckdose vom Typ HM-ES-PMSw1-Pl zum Beispiel wird so eingeschaltet:

http://username:passwort@loxberry/admin/plugins/mqttgateway/mqtt.php?topic=ccujack/device/set/OEQ0731234/1/STATE&value=true

Für die Anbindung der Homematic CCU an das MQTT Gateway des LoxBerry und damit später an die Loxone Config nutzen wir RedMatic. Hier ist nur ein sehr kurzer Flow für eine komplette MQTT-Anbindung in beide Richtungen notwendig. Startet die Red Matic WebUI über das Plugin.

In Node Red seht ihr auf der linken Seite verschiedene Ein- und Ausgänge und Funktionsbausteine. Zunächst zieht ihr 2 Bausteine Netzwerk → MQTT in in euren Flow. Mit Doppelklick konfiguriert ihr folgende beiden Topics, an die ihr später entsprechende Befehle senden könnt, die von Homematic dann an die Aktoren weitergegeben werden:

hm/set/#

hm/paramset/#

Über den Bleistift neben Server konfiguriert ihr nun einmalig den MQTT Server. Diesen wählt ihr dann bei den folgenden Ein- und Ausgängen einfach aus - er muss also nur einmal eingerichtet werden. Die Serveradresse ist 127.0.0.1 (localhost), unter Sicherheit setzt ihr noch Username und Passwort für den MQTT Server, welche ihr aus dem MQTT Widget entnehmt:

Als nächstes zieht ihr einen Baustein Netzwerk → MQTT out in euren Flow. Dieser wird wie folgt konfiguriert:

Als letztes zieht ihr noch unter ccu → mqtt einen CCU-MQTT-Baustein in die Config. An diesen Baustein verbindet ihr die drei oben erstellten Ein- und Ausgänge. Seht ihr die CCU-Bausteine nicht, könnt ihr diese über Menü –> Palette verwalten nachinstallieren. Sucht dazu nach "node-red-contrib-ccu".

Zunächst fügt ihr über den Bleistift bei CCU eine neue CCU hinzu. Als IP Adresse wird hier 127.0.0.1 (localhost) eingetragen. Hakt weiter unten die Services an, die ihr über das MQTT Gateway übertragen wollt.

Anschließend konfiguriert ihr Euch den Node passend: Die Topics lasst ihr voreingestellt, je nachdem welche Daten ihr später in der Loxone Config weiterwenden wollt, setzt ihr unten JSON auf "Extended" (Achtung! Sehr viele Daten) oder "Basic" (empfohlen).

Zum Schluss aktiviert ihr euren neuen Flow über die Schaltfläche rechts oben "Übernahme (deploy)":

Sämtliche Datenpunkte der Homematic werden nun automatisch von NodeRed unter dem Topic hm an den LoxBerry MQTT Server übermittelt und können dort wie gewohnt weiterverwendet werden. Die Topics folgen dabei dem Schema:

hm/status/Seriennr. oder Name:Kanalnr./Parametername

Um Werte an einen Aktor zu senden, verwendet ihr folgendes Topic-Schema:

hm/set/Seriennr. oder Name:Kanalnr./Parametername

Wie ihr einen entsprechenden Virtuellen Ausgang anlegt, findet ihr in der Dokumentation des MQTT Widgets: MQTT - Schritt für Schritt: Loxone -> MQTT

Meine Funksteckdose vom Typ HM-ES-PMSw1-Pl zum Beispiel wird so eingeschaltet:

http://username:passwort@loxberry/admin/plugins/mqttgateway/mqtt.php?topic=hm/set/OEQ0731234:1/STATE&value=true

Die Einrichtung in der Loxone Config wird im MQTT Widget näher beschrieben und an dieser Stelle nicht weiter ausgeführt. Ihr findet in der Widget-Dokumentation detaillierte Anleitungen:

MQTT - Schritt für Schritt: Loxone -> MQTT

MQTT - Schritt für Schritt: MQTT -> Loxone

Weiter oben in den Kapiteln findet ihr entsprechende Informationen, wie die Topics aufgebaut werden müssen.

Wenn ihr das Homematic-Modul über einen HB-RF-USB oder HB-RF-ETH Adapter an Euren LoxBerry angeschlossen habt, dann könnt ihr die GPIOs natürlich noch anderweitig nutzen (z. B. mit einem 1-Wire-Aufsteckmodul oder ähnlichem). Standardmäßig blockiert aber DebMatic die GPIOs für sich. Damit Homematic die GPIOs freigibt, loggt Euch per SSH auf Eurem LoxBerry ein (Eine SSH-Verbindung mit putty aufbauen / Shell-Zugriff) und führt anschließend folgenden Befehl aus - danach einmal rebooten.

sudo apt-get purge pivccu-modules-raspberrypi

Update von DebMatic über die Pluginoberfläche

https://www.loxforum.com/forum/projektforen/loxberry/plugins/124452-plugin-homematic-auf-dem-loxberry