Software-Projekt: Wolf Anlagen mit ISM8i Schnittstellenmodul überwachen und in FHEM auswerten

Worum geht es?

Wir haben 2016 eine neue Brennwertheizung inklusive Solarmodul von der Firma Wolf bekommen . Da ich zu der Zeit bereits eine gut funktionierende Hausautomatisierung mit FHEM am laufen hatte in der u. a. auch den Gasverbrauch mitgeloggt wurde sowie das was unsere Fußbodenheizung macht (siehe Link zum Projekt), war es für mich interessant zu sehen was die einzelnen Bestandteile der neuen Wolf Therme so tun und ob sich noch Anhaltspunkte für weiter Optimierungen am Verbrauch ergeben. Ich wusste dass die Wolf Anlage mit ihren Komponenten via Ebus kommuniziert. Deswegen habe ich versucht mit einem Ebus-USB-Koppler die Daten der Anlage abzugreifen und mit Ebusd auszuwerten. Daten kamen zwar massig an, doch leider waren diese verschlüsselt und  im Netz gibt es keine Anleitung wie man diese entschlüsseln kann, Weil die Firma Wolf keine Informationen darüber rausgibt.

Da stieß ich auf das Wolf ISM8i Schnittstellenmodul, welches mit etwas Suchen im Netz für ca. 100 Euro zu haben ist und Statusdaten der Wolf Anlage via Ethernet ausgibt. Leider sind auch diese Daten verschlüsselt, aber in der beiliegenden Montage- und Bedienungsanleitung ist beschrieben wie die Daten zu entschlüsseln sind. Die Kommunikation des Schnittstellenmodul läuft so, dass es TCP Datagramme an eine in seinem Webinterface zuvor eingestellte IPv4 Adresse schickt.

An der entsprechenden Adresse muss es einen Server als Kommunikationspartner geben, der die Datagramme entgegennimmt, entschlüsselt und so aufbereitet, dass FHEM diese versteht und dann diese Daten FHEM zur Verfügung stellt. Diesen Server habe ich entwickelt. Weiterhin habe ich das zugehörige FHEM Modul entwickelt. Bei mir ist der Server und das FHEM Modul jetzt einige Zeit am laufen und ich habe bislang keine Probleme erlebt.

 

Voraussetzungen

Ihr müsst das ISM8i in eurer Wolf Anlage einbauen (lassen). Ich habe es selbst gemacht, fand es auch nicht schwierig. WICHTIG ist nur dass ihr eure Anlage stromlos macht. Nur am Ein/Aus Knopf ausschalten macht die Anlage nicht stromlos! Da das Schnittstellenmodul via Ethernet kommuniziert, müsst ihr eine Netzwerkdose in der Nähe eurer Heizanlage haben oder eben mit Powerline oder WLAN arbeiten; gibt ja heutzutage genug Möglichkeiten .

Eurem ISM8i Modul solltet ihr eine feste IP Adresse in eurem Netzwerk vergeben (z.B. als festes Lease von einem DHCP Server),  da ihr unter dieser IP Adresse später auf das Webinterface des Moduls zugreifen und Einstellungen vornehmen müsst. Per Default sucht euer ISM8i Modul nach einem DHCP Server im Netzwerk um eine Adresse zu leasen. Ihr könnt aber im Webinterface eine feste Adresse vergeben. Allerdings solltet ihr wissen was ihr tut, denn wenn ihr eine Adresse nehmt die außerhalb eures LANs oder sonst wie Quatsch ist, dann ist das Schnittstellenmodul nicht mehr ansprechbar. Zu beachten ist, dass sämtliche Einstellungen erst nach Reboot (aus- und wieder einschalten) eurer Wolf Anlage aktiviert werden.

Ihr braucht einen PC oder Mini-PC wie einen Raspberry Pi der in eurem Netzwerk integriert ist und eine feste IP Adresse hat (z.B. als festes Lease von einem DHCP Server). Auf diesem PC muss Linux als Betriebssystem laufen, wie z.B. Debian. Eine GUI Version eurer Linux Distribution ist nicht nötig bzw. eher hinderlich. Weiterhin muss Perl in eurer Linux Distribution installiert sein.

Wenn ihr die Daten die die Server Software liefert in FHEM benutzen wollt, braucht ihr eine laufende FHEM Installation.

Natürlich kann man die Wolf Server Software auch an der Maschine installieren auf der euer FHEM läuft.

Auf den Rechnern wo FHEM und die Wolf Server Software laufen müsst ihr noch 2 Perl Module installieren:

• Perl Modul: IO::Socket::Multicast. Auf Debian Systemen installieren mit:  apt install libio-socket-multicast-perl
• Perl Modul: Math::Round. Auf Debian Systemen installieren mit: apt install libmath-round-perl

 

Vorgehensweise und Installation

Wolf Server:

1. Server Software downloaden: [download id=“179″] und entpacken. Sämtliche Dateien in das Verzeichnis /opt/wolf/ speichern.
2. Dateien wolf_ism8i.pl , ism8i_comtest.pl und wolfserver ausführbar machen (chmod 755 oder 777).
3. Datei wolfserver in das Verzeichnis /etc/init.d/ kopieren und mit dem Befehl update-rc.d wolfserver defaults dafür sorgen dass der Wolf Server bei jedem Systemstart automatisch gestartet wird.
4. Den Server mit dem Befehl /etc/init.d/wolfserver start starten.

Der Wolf Server sollte nur mit folgenden Befehlen angesprochen werden:

• Um den Server zu starten: /etc/init.d/wolfserver start
• Um den Server zu stoppen: /etc/init.d/wolfserver stop
• Um den Server zu restarten (z.B. nach Änderungen der Config Datei): /etc/init.d/wolfserver restart
• Um den Status des Servers anzufragen: /etc/init.d/wolfserver status

Nach dem Start der Servers wird im Verzeichnis /opt/wolf/ ein Unterverzeichniss /log angelegt in dem dann sämtliche Logs ausgegeben werden. Weiterhin wird eine Config Datei namens wolf_ism8i.conf angelegt, die bereits die Default Einstellungen und eine genaue Beschreibung enthält. Nach Änderungen an der Config muss die Wolf Server Software neu gestartet werden um die Änderungen wirksam zu machen.

In der Config müsst ihr die Firmware Version eures ISM8i Moduls eintragen. Möglich ist 1.4 oder 1.5. Die Firmware Version eures Moduls erfahrt ihr im Webinterface der ISM8i Moduls. Das sieht so aus:

Bitte beachtet, dass FW-Versionen kleiner als 1.5 nicht alle Datenpunkte moderner Wolf Geräte erfassen können. Ihr könnt aber die Firmware auf dem neusten Stand bringen lassen, Dazu müsst ihr nach vorhergehender Kontaktaufnahme mit dem Wolf Support euer Modul an die Firma Wolf schicken und die updaten das kostenlos (Stand der Info: Frühjahr 2017).

Die entschlüsselten Daten stellt der Wolf Server als Multicast Sendung im Netzwerk zur Verfügung. Wenn ihr in der Config die Default IP der Multicastgruppe ändern wollt, dann achtet darauf, dass ihr eine IP Adresse verwendet, die für Multicast taugt und tragt nicht einfach irgendwie eine LAN IP (192.168.x.x) ein.

BITTE BEACHTEN: Das ISM8i Modul ist in der Lage auch Datagramme zu empfangen. Ich habe aber meine Server Software so gestaltet dass nur gelesen wird. Durch Setzen falscher Parameter kann man seine Wolf Anlage nämlich möglicherweise beschädigen und das Risiko will ich nicht eingehen.

EBENFALLS BEACHTEN: Das Copyright für die Software liegt bei mir, allerdings dürft ihr sie frei für den privaten und schulischen Einsatz gebrauchen und weitergeben. Lediglich verbiete ich den kommerziellen Einsatz. Falls jemand meine Software kommerziell einsetzen will, dann bitte vorher Kontakt mit mir aufnehmen.

Tips zum Wolf Server

Alle Datenpunkte-Vorlagen liegen als CSV Datei im Verzeichnis des Wolf Servers und heißen je nach FW-Version des ISM8i Moduls wolf_datenpunkte_14.csv und wolf_datenpunkte_15.csv. Wenn euch die von Wolf vorgegebenen Namen der Geräte etc. nicht gefallen, so könnt ihr das individuell abändern. Danach den Server restarten (s.o.) und schon tauchen in FHEM die neuen Datenpunkte als Reading auf. Die alten könnt ihr zuvor mit deletereading MyWolf .*im Einfabefeld von FHEM löschen.

Bei jedem Starten vom Wolf Server wird eine Menschen-lesbare Datei namens  wolf_ism8i_datenpunkte.log im /log Verzeichnis eures Wolf Servers erstellt. Anhand dieser Datei kann man nachprüfen ob Änderungen an wolf_datenpunkte_14.csv und wolf_datenpunkte_15.csv vom Wolf Server akzeptiert werden. Sollten einzelne Datenpunkte fehlen, dann entsprechen eure Einträge nicht den Vorgaben. Ändern sollte man nur die Einträge nach dem ersten und zweiten Semikolon. Wenn ihr was an den Nummern oder den hinteren Teile der Einträge ändert, dann kann der Wolf Server die verschlüsselten Datagramme nicht mehr entschlüsseln, also Vorsicht!  Die erste Zeile der CSV Dateien sollte ein Kommentar sein oder leer bleiben.

ISM8i Netzwerk Einstellung

Wenn eure Server Software läuft, dann müsst ihr eurem Schnittstellenmodul sagen an welche IP Adresse er seine Datagramme schicken soll. Dass könnt ihr im Webinterface eures ISM8i Moduls bei Netzwerk eintragen.

Im Abschnitt Kommunikationspartner müsst ihr bei Zielserver-IP die IP Adresse des PCs eintragen auf der euer Wolf Server läuft (s.o.). Wenn nichts dagegen spricht, dann würde ich den Zielserver-Port auf die Default Einstellung (12004) belassen. Dieser ist nämlich auch als Default in der Server Config eingetragen. Jetzt die Einstellungen durch klicken auf Einstellungen speichern sichern.

Nach einem Reboot (aus- und einschalten) eurer Wolf Anlage werden alle eben gemachten Einstellungen wirksam und der Wolf Server sollte Daten empfangen. Das könnt ihr leicht prüfen, wenn ihr im Verzeichnis eures Wolf Servers die Datei ism8i_comtest.pl mit dem Befehl /opt/wolf/perl ism8i_comtest.plstartet. Es werden die Datagramme die der Wolf Server entschlüsselt und an die Multicastgruppe gesendet hat angezeigt. Allerdings sind in dem Perl Script die Default IPs und die Ports hardgecodet. Wenn ihr andere IPs oder Ports verwendet, dann diese einfach im Script ändern.

Normal solltet ihr schon nach wenigen Sekunden reinkommende Datagramme sehen. Bei mir ist der Abstand zwischen zwei Transmissionen nie größer als eine Minute.

FHEM Modul:

1. Das FHEM Modul hier downloaden: [download id=“189″] und entpacken.
2. Die enthaltene Datei 49_ISM8I.pm ins Verzeichnis /opt/fhem/FHEM/ kopieren und Rechte auf 755 ändern sowie den Besitzer und die Gruppe so ändern, dass sie mit den anderen FHEM Modulen übereinstimmt.
3. das Modul in FHEM mit define MyWolf ism8iinstallieren.
4. In den Attributen des Moduls könnt ihr ggf. die IP und den Port der Multicastgruppe so ändern, dass er mit der IP und dem Port in der Config des Wolf Servers übereinstimmt. Wenn ihr an der Config nichts geändert habt, dann sollten in wenigen Sekunden schon die ersten Readings eintreffen. Bei mir sind es insgesamt 92.
5. Änderungen an den Attributen bedürfen des Neutsarts des FHEM Moduls mit set MyWolf reset.

Natürlich müsst ihr euer Device nicht MyWolf nennen sondern wie ihr wollt.

Bei mir sehen die Readings dann so aus:

Tips zum FHEM Modul

Aufbau der Readings:

Die empfangenen Daten sind folgendermaßen aufgebaut:

Es wird ein String empfangen der aus verschiedenen Bestandteilen besteht die mit einem Punkt (.) verbunden sind.
Das sieht z.B. so aus: Heizgeraet_1_TOB_CGB_2_MGK_2.1.Stoerung oder Mischermodul_1.115.Warmwassertemperatur.C.

Die Bedeutung der einzelnen Bestandteile ist:

• Teil 1 : Die Bezeichnung des Gerätes welches die Daten schickt.
• Teil 2 : Die Nummer/ID das Datenpunkts.
• Teil 3 : Der Bestandteil des Gerätes welches die Daten schickt.
• Teil 4 : Die Einheit des übertragenen Wertes. Teil 4 ist optional und kommt nicht bei allen Datenpnkten vor.
  Die Bedeutung der Einheiten lautet: C = °C, proz = %, Pa = Pascal, l_h = Liter/Stunde, m3_h = Kubikmeter/Stunde etc.

Weiterhin gibt es das Reading Readings_Count welches die Anzahl der verschiedenen Readings angibt die das ISM8i Modul gesendet hat.

Das Reading Readings_LastUpdate zeigt den Zeitpunkt an an dem das letzte Reading empfangen wurde. so kann man sehen ob noch Daten ankommen. Wenn da mehr als 10 Minuten nichts mehr kommt, dann auf Fehlersuche gehen.

Das Reading Ignores_Count gibt die Anzahl der im Attribut ignoreDatapoints (s.u.) angegebenen Datenpunkte.

Ignores:

Es kommt vor, dass in den Readings Datenpunkte sind, die nur angeben, dass irgendwas nicht vorhanden ist, z.B. dass bei einem Mischmodul auf einem oder mehreren Ausgängen nichts angeschlossen ist. Deswegen ist es evtl. störend wenn diese Datenpunkte mitgeloggt werden.

Beim Attribut ignoreDatapoints könnt ihr die Nummern/IDs der Datenpunkte (s.o.) eingeben die das FHEM Modul ignorieren soll. nach dem Bestätigen, werden in den Readings alle angegebenen Datenpunkte gelöscht und nicht weiter gespeichert. Wenn ihr Nummern aus dem Attribut oder das ganze Attribut löscht, dann werden die entsprechenden Datenpunkte auch wieder gespeichert.

Icons:

Bei mir habe ich dem FHEM Modul sowie den States Icons zugewiesen:

attr MyWolf devStateIcon reception:radio_checked@lime initialized:radio_unchecked@yellow timeout:time_timer@red disconnected:radio_unchecked@red closed:control_x@red

attr MyWolf icon sani_boiler_temp@SkyBlue

Filelog:

Um die Readings zu speichern müsst ihr ein Filelog anlegen. Hier gebe ich euch das Define samt Regex an, damit nur die Datenpunkte gespeichert werden und nicht die Anzahl der Readings oder die Ignores:

define MyWolfLog filelog ./log/MyWolf-%Y.log MyWolf:.*\.\d+\..*

Ergebnisse

So könnten eure Auswertungen aussehen:

 

Pumpenstaus Plot verschönern:

Um die Lücken beim Pumpenstaus zu vermeiden kann man mit einem AT jede Stunde den aktuellen Staus ins Filelog schreiben lassen. Hier das define:

define Wolf_Pumpen.Plot.Aktualisator at +*01:00 { 
  addLog("MyWolf","Heizgeraet_1_TOB_CGB_2_MGK_2.10.Status_Heizkreispumpe");; 
  addLog("MyWolf","Heizgeraet_1_TOB_CGB_2_MGK_2.11.Status_Speicherladepumpe");; 
  addLog("MyWolf","Mischermodul_1.117.Status_Mischerkreispumpe");; 
  addLog("MyWolf","Mischermodul_2.124.Status_Mischerkreispumpe");; 
  addLog("MyWolf","Solarmodul.141.Status_Solarkreispumpe_SKP1");; 
}
attr Wolf_Pumpen.Plot.Aktualisator alignTime 00:02:00
attr Wolf_Pumpen.Plot.Aktualisator room Wolf

So sieht der Pumpenplot jetzt aus:

Gedanken zum Schluss

Es könnte sein, dass mein Wolf Server auch mit einem eBus-LAN-Koppler funktioniert. Allerdings habe ich keinen. Falls jemand so was hat und es mal mit meine Modulen testen will fände ich es gut wenn ihr in die Kommentare schreibt ob es funktioniert.

Nachtrag: Inzwischen habe ich es mit einem eBus-USB-Koppler probiert. Leider geht es nicht. Allerdings könnte ich anhand der rel. zeitgleich ankommenden Daten über ISM8i und eBus-USB-Koppler diverse Korrelationen erarbeiten. Im Moment fehlt mir leider die Zeit dazu.

Das Allerletzte

Alles was ich hier beschrieben habe hat bei mir gut funktioniert und ist so jetzt einige Zeit im Einsatz. Wenn ihr es verhaut oder die Elektronik eurer Wolf Anlage schrottet dann kann ich nichts dafür. Rückfragen versuche ich aber so gut es mir möglich ist zu beantworten.

So, jetzt aber viel Spaß bei der Umsetzung und lasst mit Feedback da! Würde mich freuen zu hören ob das bei euch ach alles geklappt hat.

Update

Beim Attribut Timeout hat es sich herausgestellt, dass 3600 Sekunden ein guter Wert ist, da nachts die Anlage nur wenige Daten sendet und man so keine fehlerhaften Warnungen erhält falls man wie ich sich bei einem Timeout von FHEM eine Mail schicken lässt dass man seine Wolf Anlage prüfen möge.

Spenden

Wenn Dir der Beitrag hier gefallen oder geholfen hat und Du mir etwas zukommen lassen willst, dann erfährst du hier wie: http://tips-und-mehr.de/spenden/

Versionsupdate

05.06.2017: Das FHEM ISM8i Modul liegt in der neuen Version 1.1 vor in der diverse kleine Bugfixes sowie die Timeout Funktion umgesetzt wurden.

31.08.2017: Nach dem Upgraden von Debian Jessie auf Debian Stretch konnte das FHEM ISM8i Modul nicht mehr starten da es offenbar auch einige Updates in Perl gab. Inzwischen habe ich das Modul aber gefixt und es liegt in der aktuellen Version 1.2 zum Download bereit.

06.02.2018: Ein aufmerksamer User hat mich auf einen Bug im FHEM ISM8i Modul sowie in der wolfserver Datei aufmerksam gemacht. Diese Dateien sind geupdatet und liegen in der Version 1.3 bzw. 1.2 unten zum Download bereit.

07.02.2018: Im Zusammenhang mit mit dem Update vom 06.02. hat mich User Andreas auf einen weiteren Bug aufmerksam gemacht. Die gepatchte Version 1.4 des FHEM Moduls steht unten zum Download bereit.

28.02.2018: User Jörg hat mich auf einen Bug bei CWLs aufmerksam gemacht. Die gepatchte Server Version 1.3 steht zum Download bereit.

01.11.2019: User Andy hat die falsche Zuordnung bei den Betriebsmodi bemerkt. Das wurde beim Wolf Server berichtigt. Version 1.4 ist zum Download verfügbar.

05.10.2022: User Klinki hat von einem Bug im Zusammenspiel mit einem anderen FHEM Modul berichtet. Habe die vorgeschlagenen Veränderungen vorgenommen. Download der neuen Version wie üblich auf Github.

Nochmal die beiden Downloads:

Nachtrag

Inzwischen habe ich das ganze FHEM Modul neu gecoded. Es it jetzt sende-fähig und braucht den zwischengeschalteten Server nicht mehr. Files und Details unter https://github.com/qyqsoft/ISM8I .