Plugin-Daten
AutorFabian Franzmann Ehemals: Thomas Galland
Logo
StatusSTABLE
Version0.1.4
Min. LB Version1.4.2
Release Downloadhttps://github.com/challo2018/LoxBerry-Plugin-Vitoconnect/archive/v0.1.2.zip
BeschreibungEinbinden der Viessmann Online API in Loxberry um Daten der Heizung über die Vitoconnect 100 abzufragen. Die zurückgelieferten Daten werden per HTTP bzw. MQTT bereitgestellt.
SprachenDE,EN
Diskussionhttps://www.loxforum.com/forum/projektforen/loxberry/plugins/226290-loxberry-vitoconnect

Vitoconnect

Version History...


Prämbel

  • 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:

Download

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

Siehe Download Sektion im Header

https://github.com/challo2018/LoxBerry-Plugin-Vitoconnect

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 Developer Portal Konto erforderlich. Im Plugin muss das dazugehörige Benutzerkonto (E-Mail Adresse), Kennwort sowie ein API-Key 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

  • WICHTIG: "Google reCAPTCHA" Schutz deaktivieren da es aktuell keine Möglichkeit gibt das Captcha zu lösen
  • Client ID kopieren und im Loxberry Plugin als "API-KEY" einfügen

Cron Job aktivieren

  • bei aktiviertem CronJob, kann das Aktualisierungsinterval angegeben werden:
    • 1 min
    • 5 min
    • 10 min
    • 15 min
    • 30 min 
    • 60min
  • Aktuell erlaubt Viessmann 1450 Anfragen in 24 Stunden.  Jeder get/set Data Zyklus enthält momentan 2 API-Zugriffe.

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)

Anzeige des Links zum manuellen antriggern des Datenabholens (bei deaktivierten CronJob)

Anzeige der allgemeinen Installationsinformation:

Anzeige der detaillierten Installationsinformation: (Ausschnitt)

Einrichtung in der Loxone Config Software

siehe Download im Anhang.

Ü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:

MQTT Topic Beschreibung
vitoconnect_aggregatedstatus Umschreibung für den Gesamtstatus  (WorksProperly = Alles in Ordnung)
vitoconnect_timestamp Zeitpunkt der Datenübermittlung
vitoconnect_heating_circuits_0_operating_modes_active_value aktueller Betriebsmodus
forcedNormal = Dauerbetrieb Normal
forcedReduces= Dauerbetrieb Reduzierte Temperatur / Eco
dhwAndHeating =Warmwasser und Heizung zeitgesteuert
dhw = Warmwasser zeitgesteuert
standby= aus
vitoconnect_heating_circuits_0_operating_programs_active_value Bei zeitgesteuerten Programmen wird hier der aktuelle Modus angezeigt

normal = erhöhte Temperatur
reduced = reduzierte Temperatur
standby = Standby
vitoconnect_heating_dhw_sensors_temperature_hotWaterStorage_valueaktuelle Temperatur im Pufferspeicher für Warmwasser
vitoconnect_heating_dhw_temperature_main_value aktuelle Solltemperatur für Warmwasser
vitoconnect_heating_burner_statistics_hours aktuelle Betriebsstunden
vitoconnect_heating_burner_statistics_hours_starts aktuelle Brennerstarts

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.main&value=50

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

Feature Description Value (Bitte auf korrekte Schreibweise achten, sonst geht es nicht !!!)
heating.dhw.temperature.main Warmwassertemperatur min. 10

max. 60
heating.dhw.temperature.temp2 Warmwassertemperatur 2 min. 10

max. 60
heating.dhw.temperature.hysteresis WW-Hysterese min. 10

max. 60
heating.circuits.0.operating.modes.active Betriebsmodus Heizkreis 1 forcedNormal

forcedReduced

dhwAndHeating

dhw

standby
heating.circuits.1.operating.modes.active Betriebsmodus Heizkreis 2 forcedNormal

forcedReduced

dhwAndHeating

dhw

standby
heating.circuits.0.operating.programs.normal Temperatur Heizkreis 1 Normalbetrieb min. 3

max. 37
heating.circuits.1.operating.programs.normal Temperatur Heizkreis 2 Normalbetrieb min. 3

max. 37
heating.circuits.0.operating.programs.reducedTemperatur Heizkreis 1 Reduzierter Betrieb min. 3

max. 37
heating.circuits.1.operating.programs.reducedTemperatur Heizkreis 2 Reduzierter Betrieb min. 3

max. 37
heating.circuits.0.operating.programs.comfortTemperatur Heizkreis 1 Komfortbetrieb min. 3

max. 37
heating.circuits.1.operating.programs.comfortTemperatur Heizkreis 2 Komfortbetrieb min. 3

max. 37
heating.dhw.oneTimeCharge Einmalige Aufladung des Warmwasserspeichers (soweit das Modell es unterstützt)start

stop
ventilation.schedule Zeitplan Vitovent Lüftungsanlage Reduziert:

{"mon":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"tue":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"wed":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"thu":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"fri":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"sat":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}],"sun":[{"start":"00:00","end":"24:00","mode":"reduced","position":0}]}

Normal:

{"mon":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"tue":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"wed":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"thu":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"fri":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"sat":[{"start":"00:00","end":"24:00","mode":"standard","position":0}],"sun":[{"start":"00:00","end":"24:00","mode":"standard","position":0}]}

Intensiv:

{"mon":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"tue":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"wed":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"thu":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"fri":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"sat":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}],"sun":[{"start":"00:00","end":"24:00","mode":"intensive","position":0}]}

Aus:

{"sun":[],"tue":[],"thu":[],"sat":[],"fri":[],"wed":[],"mon":[]}
heating.dhw.schedule Zeitplan Warmwasser Zeitplan:

{"mon":[{"start":"05:50","end":"08:30","mode":"top","position":0},{"start":"17:00","end":"22:30","mode":"normal","position":1}],"tue":[{"start":"05:50","end":"08:30","mode":"top","position":0},{"start":"17:00","end":"22:30","mode":"normal","position":1}],"wed":[{"start":"05:50","end":"08:30","mode":"normal","position":0},{"start":"17:00","end":"22:30","mode":"normal","position":1}],"thu":[{"start":"05:50","end":"08:30","mode":"normal","position":0},{"start":"17:00","end":"22:30","mode":"normal","position":1}],"fri":[{"start":"05:50","end":"08:30","mode":"normal","position":0},{"start":"17:00","end":"22:30","mode":"normal","position":1}],"sat":[{"start":"07:30","end":"10:00","mode":"normal","position":0},{"start":"18:00","end":"23:30","mode":"normal","position":1}],"sun":[{"start":"08:00","end":"10:00","mode":"normal","position":0},{"start":"18:00","end":"23:30","mode":"normal","position":1}]}
heating.dhw.pumps.circulation.schedule Zeitplan Warmwasser Zirkulationspumpe Zeitplan:

{"mon":[{"start":"05:40","end":"09:00","mode":"5\/10-cycles","position":0},{"start":"17:00","end":"24:00","mode":"5\/10-cycles","position":1}],"tue":[{"start":"05:40","end":"09:00","mode":"5\/10-cycles","position":0},{"start":"17:00","end":"24:00","mode":"5\/10-cycles","position":1}],"wed":[{"start":"05:40","end":"09:00","mode":"5\/10-cycles","position":0},{"start":"17:00","end":"24:00","mode":"5\/10-cycles","position":1}],"thu":[{"start":"05:40","end":"09:00","mode":"5\/10-cycles","position":0},{"start":"17:00","end":"24:00","mode":"5\/10-cycles","position":1}],"fri":[{"start":"05:40","end":"09:00","mode":"5\/10-cycles","position":0},{"start":"17:00","end":"24:00","mode":"5\/10-cycles","position":1}],"sat":[{"start":"07:20","end":"10:00","mode":"5\/10-cycles","position":0},{"start":"19:00","end":"24:00","mode":"5\/10-cycles","position":1}],"sun":[{"start":"07:30","end":"10:00","mode":"5\/10-cycles","position":0},{"start":"19:00","end":"24:00","mode":"5\/10-cycles","position":1}]}

An: 

{"mon":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"tue":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"wed":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"thu":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"fri":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"sat":[{"start":"00:00","end":"24:00","mode":"on","position":0}],
"sun":[{"start":"00:00","end":"24:00","mode":"on","position":0}]}

Aus:

{"sun":[],"tue":[],"thu":[],"sat":[],"fri":[],"wed":[],"mon":[]}

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

Fragen stellen und Fehler melden