Skip to content

Latest commit

 

History

History
executable file
·
152 lines (100 loc) · 11.5 KB

README.md

File metadata and controls

executable file
·
152 lines (100 loc) · 11.5 KB

Logo

ioBroker.netatmo-energy

NPM version Downloads Number of Installations (latest) Number of Installations (stable) Known Vulnerabilities Test and Release Translation status

NPM

Dieser Adapter verwendet Sentry Bibliotheken, um einen automatischen Report von Abbrüchen und Programmcode Fehlern an die Entwickler zu senden. Für weitere Details und für Informationen zur Deaktivierung dieser Funktion beachten sie bitte Sentry-Plugin Documentation! Sentry reporting ist verfügbar ab js-controller 3.0.

Voraussetzungen & Konfiguration

Netatmo Energy Hardware (Thermostat, Ventile) Konto bei Netatmo Cloud

  • Der Adapter arbeitet mit admin >= 3 und nodejs >= 16
  • Erstelle dein eigenes Konto https://auth.netatmo.com/de-de/access/signup
  • Login in die API durchführen https://dev.netatmo.com/apidocumentation/energy
  • Erzeuge deine eigene APP durch Anklicken deines Kontos (oben / links), und drücke den Knopf "Create"
    • Fülle das Formular aus und speichere es
    • Übernimm die erhaltene client-ID und client-secret-ID in die Adapter Konfiguration
    • Gehen sie zur API-Dokumentation https://dev.netatmo.com/apidocumentation/energy
    • Wählen sie "GET homesdata" - "Try it out" - "EXECUTE / HOMESDATA"
      • du wirst ein response erhalten in der du deine home-ID findest
      • Übernimm sie in die Adapter Konfiguration
      • Starte den Netatmo-Energy Adapter und authentifiziere dich bei Netatmo API
        • Bestätigen sie den Knopf "Authentifizieren Sie sich bei Netatmo"
        • Loggen sie sich in ihr Konto ein, sofern es notwendig ist
        • Bestätigen sie die Berechtigung für Drittanbieter für ihre Netatmo-APP
        • Schließen sie das Browserfenster
    • Wähle die gewünschten Optionen in den "API-Einstellungen" und speichern sie die Adapterkonfiguration
      • Temperaturänderungen sofort übertragen ... sofortiges übertragen der Temperaturänderungen in State "SetTemp" an die API
      • API Zustände nach Änderung sofort lesen ... API Daten mittels homestatus sofort nach Aktualisierung der API abholen
      • Aktualisierung der API-states nach x Sekunden ... Permanentes Aktualisieren der API Daten. (0 = Keine Aktualisierung)
    • Wenn gewünscht kann auch Benachrichtigungsdienst eingerichtet werden um bestimmte Statusänderungen zugesandt zu bekommen. Dabei ist es möglich sich Informationsmeldungen, Warnungen bzw. Fehlermeldungen zu erhalten. Hierfür ist es notwendig die Option "Benachrichtigungen aktivieren/deaktivieren" in den "Anmeldeinformationen" zu aktivieren und danach die Einstellungen im Menü "Benachrichtigungen" einzurichten.
    • Zusätzlich ist es möglich die Tür-/Fenstersensoren in der Sensorik einzutragen und die gewünschte Aktion zu hinterlegen. Diese Funktionen können auf der Loginseite generell aktiviert bzw. deaktiviert werden.

Eine detaillierte Beschreibung ist als wiki verfügbar (https://github.com/Homemade-Disaster/ioBroker.netatmo-energy/wiki).

settingsLogin

settingsAPI

netatmo-energy Adapter für ioBroker

Mittels der Netatmo-Energy API werden die aktuellen Einstellungen abgeholt bzw. geändert. Der Adapter verwendet den fetch Request für den Datentransfer zur Netatmo Energy API. Offizielle Dokumentation der API: https://dev.netatmo.com/apidocumentation/energy.

Der Adapter erzeugt ein eigenes Device "energyAPP" welches die "APIRequests" und "trigger" beinhaltet.

API Requests

  • homesdata ... holt die gesamte Struktur der Netatmo Energy Installation (dabei wird der Parameter NAPlug verwendet). Sie können alle weiteren Parameter für manuelle Requests selbst auswählen.

  • homestatus ... ermittelt und überträgt den Status und die technischen Informationen ihrer zugeordneten Ventile. Wenn sie Informationen zu einem spezifischen Geräteart möchten, können sie diese selbst auswählen.

  • getroommeasure ... Hiermit erhalten sie historische Daten ihrer Räume. Das Ergebnis wird in das "response" Feld eingetragen.

  • getmeasure ... Hiermit erhalten sie die historischen Daten ihres Boilers. Das Ergebnis wird in das "response" Feld eingetragen.

  • setthermmode_schedule ... Setzt den Betriebsmodus der Netatmo Energy Installation auf "Schedule" (Standard)

  • setthermmode_hq ... Setzt den Betriebsmodus der Netatmo Energy Installation auf "hq" (Frostwächter)

  • setthermmode_away ... Setzt den Betriebsmodus der Netatmo Energy Installation auf "away" (nicht zu Hause)

  • switchhomeschedule ... Setzt den "schedule mode" der Netatmo Energy API. Alle möglichen Modi sind im Channel "switchhomeschedule" aufgelistet.

  • createnewhomeschedule ... Setzt den "schedule mode" der Netatmo Energy API. Alle möglichen Modi sind im Channel "switchhomeschedule" aufgelistet.

  • synchomeschedule ... Setzt die Heizpläne deiner Netatmo Energy APP. Um einen spezifischen Heizplan zu ändern, geben sie eine an. Andernfalls wird der aktuell eingestellte abgeändert. Bitte tragen sie die notwendigen Parameter ein und lösen sie den synchomeschedule Request aus.

  • createnewhomeschedule ... Erstellt einen neuen Heizplan für deine Netatmo Energy APP. Bitte tragen sie die notwendigen Parameter ein und lösen sie den createnewhomeschedule Request aus.

Wenn ein API Request Parameter benötigt, können sie diese im korrespondierenden Request Channel im Channel "parameters" finden.

Trigger

  • applychanges ... übermittelt alle noch offenen manuellen Änderungen deiner Ventile an die Netatmo Energy APP
  • refresh_structure ... erzeuge die Requests homesdata und homestatus hintereinander

Änderungs-Requests

  • setroomthermpoint ... abhängig von den manuellen Änderungen im Channel "setting" werden die Änderungen an die Netatmo Energy APP übertragen. (entweder sofort oder selbst getriggert - "Temperaturänderungen sofort übertragen").
  • set_mode_to_home ... Der Button "set_mode_to_home" im channel "setting" setzt den Ventil-mode "set_mode_to_home" auf "home". Außerdem wird der API Request sofort ausgelöst, um die Änderung zu übertragen.

Nachrichten

  • message_text ... alle Nachrichten werden in diesem Datenpunkt übertragen

Status

  • running ... hier kann man erkenne ob derzeit ein API Request läuft

Requeststruktur

settingsLoginsettingsLogin

Strukturen aufbauen

Beim Start des Adapters wird der aktuelle Status der gesamten Netatmo Energy APP aufgefrischt und der Status aller Ventile und Thermostate übertragen. Abhängig von den Allgemeinen Einstellungen (API Zustände nach Änderung sofort lesen) werden die Status der Ventile und Thermostate nach Änderung der API sofort wieder abgeholt (es wird sofort ein homestatus Request abgesetzt). Beim Starten des Adapters wird die Initialisierung durchgeführt.

Benachrichtigungen

Wenn sie in der Adapterkonfiguration einen Benachrichtigungsdienst aktiviert haben werden diverse Meldungen an sie versandt. Folgende Dienste sind verfügbar.

notifications

Bitte geben sie für den von ihnen gewählten Benachrichtigungsdienst die notwendigen Verbindungsdaten an.

notifications

Nachrichten

Hier können sie bestimmte Nachrichten bei bestimmten Statusänderungen auslösen. Die gewünschte Nachricht können sie hinterlegen. Diese werden immer in den Datenpunkt "message_text" übertragen.

messages

Durch Drücken des Knopfes " TESTMITTEILUNG SENDEN" ist es möglich das Nachrichtenservice zu testen. Vor dem Test ist es notwendig alle Einstellungen für das Nachrichten Service zu speichern.

Sensorik

In der Tabelle können Sie auf das "Fenster-/Türsensor" Attribut pro Raum reagieren. Der Status der jeweiligen Fenstersensoren kann beim Ändern eine Aktion auslösen, welche hier einzutragen ist. Es ist möglich hier alle Sensoren auszuwählen, welche vom Typ bool sind. Somit können auch externe Sensoren eingebunden werden.

Folgende Aktionen können ausgelöst werden:

  • Temperatur eingestellen
  • Home Mode setzen
  • Heizmodus einstellen
    • Frostwächter
    • Nicht zu Hause
    • Normalbetrieb
  • Heizplan aktivieren
    • alle existierenden Heizpläne der Netatmo-Energy App werden angeboten

Somit kann beim Öffnen oder beim Schließen eines Fensters / Tür die Temperatur eines Ventils eingestellt werden. Durch eingeben einer Verzögerungszeit (in Sekunden) wird die hinterlegte Aktion verzögert ausgeführt. Wird innerhalb der Verzögerungszeit der auslösende Sensor wieder geändert, werden die noch austehenden Aktionen nicht durchgeführt.

sensors

Admin-Tab

Auf der Admin-Tab können sie alle Thermostate, Bridges und Ventile ihrer netatmo energy instance anzeigen lassen. Dort ist es auch möglich diese Ansicht zu aktualisieren bzw. eine vollständige API Aktualisierung zu starten. Zusätzlich hat man die Möglichkeit die Änderungen in die Cloud zu übertragen und von einem eventuellen manuellen Modus wieder auf den Standardmodus umzuschalten.

admintab

Auf jeder Karte werden Statussymbole angezeigt, welche den aktuellen Zustand des Thermostats, der Ventile und des Steckers darstellt. Auf der zweiten Seite des Thermostats finden sie diverse API Requests, um den Thermostat-Mode bzw. den Heizplan einzustellen.

Widget

Widget für VIS, um ein komplettes Thermostat anzuzeigen. Sie müssen nur den "SetTemp" - Datenpunkt eintragen. Alle anderen Informationen werden dynamisch aus der "rooms"-Struktur ermittelt.

widget