JUDO iSoft Plus

JUDO iSoft Plus
JUDO iSoft Plus Wasserenthärtungsanlage
Allgemein
Protokoll	IP
Typ	Wasserenthärter
Kategorie	IP
Technische Details
Kommunikation	n/a
Kanäle	n/a
Betriebsspannung	230 V
Leistungsaufnahme	?
Versorgung	AC
Abmessungen	39x67x45 cm (BxHxT)
Sonstiges
Modulname	HTTPMOD
Hersteller	Judo GmbH

Die JUDO i-soft plus Enthärtungsanlage [1] ist eine Wasserenthärtungsanlage mit IP-Konnektivität. Sie verfügt über LAN und WLAN-Anschluss und ist auf die Steuerung via App des Herstellers ausgelegt.

Für eine erfolgreiche Integration in FHEM muss die Anlage über das Menü beim Hersteller registriert werden. Die folgenden Informationen sind erforderlich:

• Benutzername: Selbst gewählter Login-Name auf der iSoft plus (vgl. Gerätehandbuch)
• Kennwort: Selbst gewähltes Kennwort
• Seriennummer: Seriennummer des Geräts. Diese ist entweder über das Menü auslesbar oder alternativ auch über die APP des Herstellers.
• IP-Adresse: Die IP-Adresse des Geräts im Heimnetz.

Einbindung in FHEM

Das Gerät wird mittels des Moduls HTTPMOD eingebunden. Dazu gilt zunächst die folgende Konfiguration als Basis. Zunächst legen wir die Standardanfrage an das Modul fest. Die Portnummer 8124 ist vom Hersteller vorgegeben. Wir vergeben gleich ein paar Platzhalter, die später in den Aufrufen und den Antworten ersetzt werden, damit wir die Werte nur an einer zentralen Stelle konfigurieren müssen.

define JUDO_iSoft HTTPMOD https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20current&msgnumber=1&token=%token%

Nach erfolgreicher Authentifizierung wird von der iSoft ein Token generiert und muss bei jedem Aufruf übergeben werden:

attr JUDO_iSoft replacement01Mode reading
attr JUDO_iSoft replacement01Regex %token%
attr JUDO_iSoft replacement01Value token

Anschließend legen wir die Ersetzungen für die anderen Platzhalter fest:

attr JUDO_iSoft replacement02Mode text
attr JUDO_iSoft replacement02Regex %JUDO_ipaddress%
attr JUDO_iSoft replacement02Value <hier eigene IP Adresse im lokalen Netz eintragen>
attr JUDO_iSoft replacement03Mode text
attr JUDO_iSoft replacement03Regex %JUDO_password%
attr JUDO_iSoft replacement03Value <hier Kennwort eintragen>
attr JUDO_iSoft replacement04Mode text
attr JUDO_iSoft replacement04Regex %JUDO_username%
attr JUDO_iSoft replacement04Value <hier Benutzername eintragen>
attr JUDO_iSoft replacement05Mode text
attr JUDO_iSoft replacement05Regex %JUDO_serial%
attr JUDO_iSoft replacement05Value <hier Seriennummer eintragen>

Die Authentifizierung der Anlage erfolgt zwei-stufig. Zunächst muss ein Aufruf mit Benutzername und Kennwort erfolgen. Als Antwort erhält man einen JSON-String, der das Token beinhaltet. Mit diesem Token wird anschließend die Funktion connect aufgerufen und die Seriennummer des Geräts mit übergeben. HTTPMOD erkennt, wenn ein neues Login erforderlich ist, wenn die Judo die Rückmeldung "no token" oder "not logged in" liefert.

Achtung: Als Parameter muss ebenfalls der Typ "i-soft plus" übergeben werden. Vermutlich ist dieser bei anderen Geräten des Herstellers anders. Ich habe ihn hier fix eingetragen, da ich keine Möglichkeit zum Testen anderer Geräte habe.

attr JUDO_iSoft showError 1
attr JUDO_iSoft authRetries 2
attr JUDO_iSoft reAuthRegex (no token)|(not logged in)
attr JUDO_iSoft sid01ParseResponse 1
attr JUDO_iSoft sid01URL https://%JUDO_ipaddress%:8124/?group=register&command=login&msgnumber=1&name=login&user=%JUDO_username%&password=%JUDO_password%&role=customer
attr JUDO_iSoft sid02URL https://%JUDO_ipaddress%:8124/?group=register&command=connect&msgnumber=6&token=%token%&parameter=i-soft%20plus&serial%20number=%JUDO_serial%

Damit ist die Grundkonfiguration hergestellt und die Anlage kann sich connecten. In den einzelnen JSON-Rückantworten der Anlage werden die Werte zur jeweilige Anfrage immer als "data" zurück geliefert. Mit der Standard-Konfiguration

attr JUDO_iSoft extractAllJSON 1

werden daraus automatisch entsprechernde Readings angelegt. Da wir aber dann immer das Reading "data" überschreiben würde, kommt eine weitere Ersetzung zum Einsatz. In der Antwort steht neben einer Kaskadierung (group) auch der zugehörige Befehl (command). Ich habe mich dafür entschieden, ein neues Reading mit dem jeweiligen Command-Namen anzulegen. Die zugehörigen Ersetzungen sind wie folg:

attr JUDO_iSoft reading01JSON data
attr JUDO_iSoft reading01Name token
attr JUDO_iSoft reading01Regex "token":"([^"]+)"
attr JUDO_iSoft reading02JSON group
attr JUDO_iSoft reading03JSON command
attr JUDO_iSoft reading03OExpr readingsBulkUpdate($hash,$val,ReadingsVal("JUDO_iSoft","data",""))

Noch ein paar ergänzende Attribute gesetzt:

attr JUDO_iSoft enableControlSet 1
attr JUDO_iSoft getHeader1 Content-Type: application/json
attr JUDO_iSoft getHeader2 Accept: */*
attr JUDO_iSoft room 10_Räume->UG->Keller,
attr JUDO_iSoft showError 
attr JUDO_iSoft timeout 5

Damit sind alle Voraussetzungen erledigt. Ab jetzt können wir die einzelnen Get-Befehle implementieren:

attr JUDO_iSoft get01Name SerialNumber
attr JUDO_iSoft get01URL https://%JUDO_ipaddress%:8124/?group=spare%20part&command=serial%20number&msgnumber=5&token=%token%

attr JUDO_iSoft get02Name WaterCurrent
attr JUDO_iSoft get02URL https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20current&msgnumber=1&token=%token%

attr JUDO_iSoft get03Name SaltRange
attr JUDO_iSoft get03URL https://%JUDO_ipaddress%:8124/?group=consumption&command=salt%20range&msgnumber=1&token=%token%

attr JUDO_iSoft get04Name SaltQuantity
attr JUDO_iSoft get04URL https://%JUDO_ipaddress%:8124/?group=consumption&command=salt%20quantity&msgnumber=1&token=%token%

attr JUDO_iSoft get05Name ResidualHardness
attr JUDO_iSoft get05URL https://%JUDO_ipaddress%:8124/?group=settings&command=residual%20hardness&msgnumber=1&token=%token%

attr JUDO_iSoft get06Name NaturalHardness
attr JUDO_iSoft get06URL https://%JUDO_ipaddress%:8124/?group=info&command=natural%20hardness&msgnumber=1&token=%token%

attr JUDO_iSoft get07Name WaterStop
attr JUDO_iSoft get07URL https://%JUDO_ipaddress%:8124/?group=waterstop&command=valve&msgnumber=1&token=%token%

attr JUDO_iSoft get08Name FlowRate
attr JUDO_iSoft get08URL https://%JUDO_ipaddress%:8124/?group=waterstop&command=flow%20rate&msgnumber=1&token=%token%

attr JUDO_iSoft get09Name SoftwareVersion
attr JUDO_iSoft get09URL https://%JUDO_ipaddress%:8124/?group=version&command=software%20version&msgnumber=1&token=%token%

attr JUDO_iSoft get10Name HardwareVersion
attr JUDO_iSoft get10URL https://%JUDO_ipaddress%:8124/?group=version&command=hardware%20version&msgnumber=1&token=%token%

attr JUDO_iSoft get11Name InstallationDate
attr JUDO_iSoft get11URL https://%JUDO_ipaddress%:8124/?group=contract&command=init%20date&msgnumber=1&token=%token%

attr JUDO_iSoft get12Name ServiceDate
attr JUDO_iSoft get12URL https://%JUDO_ipaddress%:8124/?group=contract&command=service%20date&msgnumber=1&token=%token%

attr JUDO_iSoft get13Name WaterTotal
attr JUDO_iSoft get13URL https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20total&msgnumber=1&token=%token%

attr JUDO_iSoft get14Name WaterAverage
attr JUDO_iSoft get14URL https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20average&msgnumber=1&token=%token%

attr JUDO_iSoft get14Name WaterAverage
attr JUDO_iSoft get14URL https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20average&msgnumber=1&token=%token%

attr JUDO_iSoft get14Name WaterAverage
attr JUDO_iSoft get14URL https://%JUDO_ipaddress%:8124/?group=consumption&command=water%20average&msgnumber=1&token=%token%

Weitere Befehle insbesondere zum Setzen und die Auswertung der Verbrauchswerte folgen.

Links

[2] Forumsbeitrag [3] ursprünglicher Beitrag bzgl. des verwendeten Protokolls