Inhalt

Prämbel

• Es gibt keine offizielle Dokumentation der API von Viessmann
• Sollte Viessmann  die API ändern, kann es zu fehlenden Daten bzw. im schlimmsten Fall zu einem Ausfall des Plugins kommen
• Es ist mein erstes Plugin für Loxberry. Von daher bitte um Nachsicht bei eventuellen Fehlern
• das Plugin wurde mit Unterstützung folgender Quellen erstellt:
  • FHEM Plugin 98_vitoconnect.pm von andreas13 https://wiki.fhem.de/wiki/Vitoconnect
  • Viessmann-Api von TheTrueAvatar https://github.com/thetrueavatar/Viessmann-Api
• Herzlichen Dank anChristian Fenzl für die Unterstützung bzw. die Basis des Plugins

Download

Das Plugin ist auf Github veröffentlicht und kann direkt von dort bezogen werden

https://github.com/eloka080677/loxberry_vitoconnect/archive/0.0.5.zip

Funktion des Plugins

Nach Installation des Plugins ist eine Ersteinrichtung erforderlich um die Daten von Viessmann abrufen zu können bzw. die Daten per MQTT / HTML übermitteln zu können.

Für die Nutzung ist ein Viessmann Online Konto erforderlich. Im Plugin muss das dazugehörige Benutzerkonto (E-Mail Adresse) und Kennwort hinterlegt werden.

Aufgrund der Menge der übermittelten Daten wird eine Nutzung des MQTT Plugins von Christian Fenzl empfohlen. 

Es sollte immer nur eine Übermittlungsart (MQTT oder HTML) aktiv sein.

Das Abholen der Daten kann entweder manuell über einen virtuellen Ausgang im Miniserver oder aber automatisiert per CRON Job erfolgen.

Konfigurationsoptionen (Registerkarte Settings)

Die Konfigurationsdatei am Loxberry wird erst nach dem ersten Aufrufen der Settings Seite und Abspeichern erstellt und abgespeichert (JSON Format)

Viessmann Online Anmeldedaten

• Benutzername und Kennwort des Viessmann Online Account hinterlegen

Cron Job aktivieren

• bei aktiviertem Cron Job, kann das Aktualisierungsinterval angegeben werden

Datenübermittlung per MQTT

• Wenn du das MQTT Gateway Plugin  installiert hast, sind keine weiteren Daten zwingend erforderlich und die Felder können leer gelassen werden
  • Base Topic:  vitoconnect (default, wenn Feld leergelassen wird)
  • Broker Hostname:Port: 127.0.0.1:1883(default, wenn Feld leergelassen wird)
  • Broker Username: wird automatisch aus dem MQTT Plugin ausgelassen (default)
  • Broker  Passwort: wird automatisch aus dem MQTT Plugin ausgelassen (default)
• Die Angabe des Base Topics erfolgt ohne führendem und abschließendem Schrägstrich, z.B. vitoconnect
• Die Daten der Viessmann Installation können am Tab Query links and data angesehen werden.

Wichtig: Bevor das VitoConnect Plugin die Daten an das MQTT Plugin senden kann, muss unter den "Subscriptions" im MQTT Plugin das "Base Topic" des Vitoconnect Plugins hinterlegt werden.
Default Base Topic: vitoconnect => Subscription: vitoconnect /#.

Viessmann übermittelt einige Werte z.B. Zeiträume für Eco-/Normalbetrieb oder aber den aktuellen/vergangenen Fehlerstatus als Array zurück.

Damit dieses Array bei MQTT aufgelöst und die Daten als Einzelwerte übertragen werden, muss im MQTT Plugin in den Einstellungen zwingend der Haken "Expand JSON Data" aktiviert werden

Datenübermittlung HTTP

• Den Miniserver anwählen.
• Den Cache kannst du am Anfang zum Einrichten ausschalten (→ "No Cache"), du solltest ihn aber danach einschalten (→ "Cache").
• Die Daten werden an virtuelle Eingänge (VI) bzw. virtuelle Texteingänge (VIT) gesendet. Diese VI's/VIT's musst du selbst anlegen. Wie diese heißen, findest du auf dem Tab Query links and data
  (Es werden nur die Daten übertragen, welche unter Installationsdaten Detail angezeigt werden)

Daten (Registerkarte Query Links and data)

Anzeige des Links zum manuellen antriggern des Datenabholens (bei deaktivierten Cron Job)

Anzeige der allgemeinen Installationsinformation:

Anzeige der detaillierten Installationsinformation: (Ausschnitt)

Einrichtung in der Loxone Config Software

Ein Beispiel File für die virtuellen Einfänge wird noch bereitgestellt...

Übertragung per MQTT:

Für die Einrichtung der virtuellen Eingänge für MQTT siehe: MQTT - Schritt für Schritt: MQTT -> Loxone

Für jeden zu übertragenden Wert ist ein virtueller Eingang in LoxConfig anzulegen.
Abhängig davon welche Werte übertragen werden sollen, ist ein virtueller Eingang ( Boolean, Zahlen) oder ein virtueller Texteingang (String) nötig.
Werden Zahlen übertragen (Ganzzahlen oder Gleitkomma) so ist im virtuellen Eingang der Haken bei "Als Digitaleingang verwenden" zu entfernen

Der Name (Bezeichnung) des Eingangs ist der Name des MQTT Topic (Siehe MQTT Plugin → Incoming View)

Unter Beschreibung kann ein sprechender Name für die Darstellung in der App/Webseite vergeben werden

Beispiele für relevante Werte:

Setzen von Werten per HTTP Ausgangsbefehl:

das Setzen von Werten ist über einen HTTP Befehl möglich.

http://<lbuser>:<lbpass>@loxberry:80/admin/plugins/Vitoconnect/vitoconnect.php?action=setvalue

das gewünschte Feature wird per option=YYY addressiert.

Der zu setzende Wert wird über value=XXX mitgegeben.

Um z.B. die Warmwassertemperatur auf 50 Grad zu setzen wäre der gesamte Befehl dann

http://<lbuser>:<lbpass>@loxberry:80/admin/plugins/Vitoconnect/vitoconnect.php?action=setvalue&option=heating.dhw.temperature&value=50

In nachfolgender Tabelle werden die aktuell implementierten Set Befehle näher beschrieben

Beispieldatei für Input per MQTT und Ausgabe per HTTP Befehle

VitoConnect_Sample.Loxone

Fragen stellen und Fehler melden

https://www.loxforum.com/forum/projektforen/loxberry/plugins/226290-loxberry-vitoconnect