Enphase / Envoy / IQ-Gateway Solar Blockly Skript
-
Hallo,
für alle mit einer Photovoltaikanlage von der Firma Enphase habe ich ein ioBroker Blockly-Skript geschrieben, um aktuelle Daten der Anlage vom sogenannten Envoy/IQ-Gateway in ioBroker einzulesen.
Enphase ist sehr verbreitet in den USA, Frankreich und Benelux und ist seit kurzem auch in Deutschland gestartet. Der Hauptunterschied zu anderen PV-Systemen liegt im Microwechselrichter-Konzept, bei dem ein eigener Microwechselrichter für jedes PV-Modul vorhanden ist anstelle eines zentralen Wechselrichters. Gesteuert wird die Anlage über ein kleines IQ-Gateway auch "Envoy" genannt.
Enphase bietet leider nur die Möglichkeit die eigenen PV-Daten über eine Cloud API zu beziehen. Diese Lösung ist aber leider sehr limitiert im Umfang und Aktualität der Daten und wird richtig teuer, wenn man diese Einschränkungen etwas lockern möchte.
Zum Glück gibt es noch eine wenig dokumentierte Möglichkeit die Daten direkt via lokale API vom Envoy zu bekommen. Enphase hat allerdings die Authentifizierung von einem zuvor einfachen User/Passwort Login auf eine sichere und standardisierte sogenannte Bearer-Token-Authentication umgestellt, die etwas mehr Aufwand bereitet. Dabei wird zunächst nach Anmeldung mit User/Passwort an der Enphase-Cloud ein kryptographisch gesichertes Token erzeugt, welches zeitbeschränkt ist und die Rolle des Users beschreibt (z.B. "Owner" oder "Installer"). Ein normales "Besitzer/User"-Token ist derzeit 12 Monate gültig. Ein "Installer"-Token ist angeblich nur 1 Tag gültig. Mit diesem Token wird dann anschließend jeder API-Aufruf am lokalen Envoy authentifiziert.Genau um diese lokale Enphase Envoy API zum IQ-Gateway geht es hier (Envoy Version > v7.0.88).
Ich habe im Vorfeld verschiedene Lösungen im Netz gefunden und probiert, aber keine war einfach zu implementieren. Sie basieren auf eigenständigen Services wie z.B. Homebridge, die dann dauerhaft und nur für diesen speziellen Zweck betrieben werden müssen. Zudem ist die Integration mit ioBroker dann nur per MQTT möglich.
Mit diesem Skript haben Enphase Benutzer nun eine einfache native ioBroker Lösung.Das Skript löst die genannten Probleme in dem es
- mehrere hundert aktuelle und zeitnahe PV-Daten wie Produktions-, Verbrauchs-, und Einzelpanel Daten direkt in ioBroker bereitstellt
- minütliche Updates (kann bis in den Sekundenbereich beschleunigt werden)
- minimale Anforderungen an das ioBroker System stellt
- komplett in ioBroker integriert ist
- die ioBroker Datenstrukturen automatisch erzeugt und aktualisiert, wenn API-Änderungen von Enphase erfolgen
- Unix Timestamps in den Envoy Daten erkennt und automatisch als zusätzlicher Datenpunkt mit der Namenserweiterung "_str" als lesbarer Zeitstring erstellt
- Envoy Daten bietet, die es nicht in der App/Web für normale Benutzer gibt wie die "Aktuelle Modulleistung jedes einzelnen Panels" (Hinweis: Die Microinverter Daten werden abweichend nur alle 2-5 Minuten von Envoy aktualisiert)
- dem Anlagenbesitzer keine laufenden Kosten für Cloud API Zugriffe verursacht
- rein lokal ohne Internetzugriff läuft (für das automatische periodische Token Renewal ist aber eine Internetverbindung zur Enphase Cloud nötig)
Installationsanleitung:
- Das unten angefügte Skript "enphase.txt" in den ioBroker Skript Editor importieren
- Die eigenen Enphase Envoy Daten eingeben
Dazu im Skript die Kommentare mit "*** USER INPUT ***" suchen und anpassen.
Beispiele sind im Skript gegeben.
Wichtig sind:
a) Enphase Cloud Credentials (Enphase Cloud Username & Passwort)
b) Envoy Seriennummer (in der Enphase App oder Web zu finden unter SYSTEM…GERÄTE…GATEWAY…SN: [besteht aus 12 Ziffern])
c) Envoy lokale IP Adresse
- Das Skript speichern und starten
- Beim ersten Aufruf wird das Token erzeugt und ins ioBroker Log geschrieben
- Danach werden die Envoy Daten basierend aus 5 einzelnen API-Aufrufen als ioBroker Datenpunkte unter dem Pfad "0_userdata.0.enphase" erstellt. Darunter wird dann rekursiv die Datenstruktur des Envoys API Calls erstellt.
- Bei allen folgenden Aufrufen wird geprüft, ob der einzelne Datenpunkt existiert oder nicht. Entsprechend wird der Datenpunkt neu erzeugt oder aktualisiert. Man kann also gefahrlos den ganzen Enphase Baum, Zweige oder einzelne Datenpunkte löschen. Beim nächsten Aufruf wird die Struktur wieder erstellt. Hinweis: Falls Enphase die Datenstrukturen der lokalen API ändert, wird dies automatisch abgebildet. Datenpunkte, die Enphase im API Aufruf zukünftig nicht mehr schicken sollte, bleiben im ioBroker vorhanden und müssen ggf. von Hand gelöscht werden.
Hinweis:
Die 5 API-Aufrufe liefern teils gleiche Dateninhalte. Im Prinzip enthalten die API "3. Get PV METER READINGS" und "5. Get PV MICRO INVERTER" alle notwendigen Daten. Die anderen APIs bieten aber teilweise zusätzliche fertig berechnete Daten, so dass man sie schneller weiterverarbeiten kann. Ein Sonderfall ist der Tagesenergiezähler "whToday" [Wh], der nur in API "4. Get PV PRODUCTION.JSON" vorkommt. (Der Wochenzähler "whLastSevenDays" bietet leider keine brauchbaren Daten).Viel Spaß damit!
JörgEnphase-Skript:
enphase.txt -
In den Recherchen zum ioBroker Enphase Skript habe ich weitere local APIs gefunden und hier in einem Dokument zusammengetragen. Die offizielle Dokumentation von Enphase zur lokalen API mit Stand Januar 2023 bildet den Rahmen (basierend auf der aktuellen "token-based authentication", d.h. Envoy Version >= 7.0.x):
Hinweis: Die weiteren APIs in meinem Dokument sind möglicherweise älter und können in zukünftigen Envoy Firmware Updates unzuverlässig bzw. gar nicht mehr funktionieren.
Übersicht Enphase local APIs:
Enphase Envoy API Overview 19.7.23.pdf
-
@greoj , vielen vielen Danke danach habe ich schon lange gesucht
Ich habe mir noch:
INVENTORY (/ivp/ensemble/inventory) hinzufügen, da sieht man die Temperatur und den Ladezustand der Batterie
über LED Status kann man sehen, ob die Batterie Lädt, entlädt oder im Ruhezustand ist.
12 Akku lädt
13 Akku entlädt
14 Akku vollgeladen idle
16 Ladezustand zwischen 25 und 50% idle
17 Akku leer 5% idleund :
https://envoy/ivp/livedata/status hinzugefügt. Da kann man alle Daten (Netzbezug / Netzeeinspeisung, Batterieladung /-entladung und Hausverbrauch) einsehen.
Nach 15min muss mit der App oder Webseite der LiveStatus einmal neugestartet werden, da sonst der Status von "sc_stream": "enabled" auf "sc_stream": "disabled" geht.
Man muss an https://envoy/ivp/livedata/stream ein "POST, json to pass: {“enable”: 1}" schicken. Das kann man gut mit Postman testen (der Token ist hier auch wichtig)
Im Enphase Forum (Community nach "/ivp/livedata/" suchen, da steht das auch nochmal beschrieben.
...............................API ivp/livedata/stream needs to be used in POST, json to pass: {“enable”: 1}
Field ‘mains_admin_state’ is not a required field
Response should be,
{
"sc_stream": "enabled"
}
Gruss Steffen
-
@steffe-s Du hast das Script um die entsprechende Einträge selbst erweitert?
Wenn ja könntest Du bitte das veränderte Script hier posten?
Besten Dank -
@mk70 , mach ich dann.
Ich schreibe auch gleich noch was dazu. Bis denne...
-
BITTE MACHT VORHER EIN BACKUP VOM AKTUELLEN IOBROKERSYSTEM, BEVOR IHR DAS SKRIPT TESTET!!!
Hier die 4 Skripte:
.1. Skript
Abholen aller Daten einmal pro Minute ( erweitert um Punkt 6 und Punkt 7). Unter 1 Minute gibt es Fehler.
*edit 19.09.2024: Aktualisierung unter 1 Minute gelöst...
*edit 10.04.2024:
wenn man sich auf LiveDaten und Microwechselrichterdaten beschränkt geht auch eine Aktualisierungszeit von 15 Sekunden. Einfach die Zeit im Trigger auf 15 sec stellen.*
Enphase_Envoy_Datenabfrage.txt
Hier im Blockly den username / password / envoy_serialnummer / envoy_ip eintragen.
....................................................................
2.SkriptDas envoy bleibt mit den LiveDaten max 15 Minuten online, diese Skript aktualisiert sich alle 10 Minunten und hält das envoy im Onlinemodus.
Hier im Blockly den username / password / envoy_serialnummer / envoy_ip eintragen.
...................................................................
2.2. Datenpunkte erstellenIch habe diese Ordner und Datenpunkte vorher händisch erstellt.
--------------------------------------------
Edit 30.05.2024: oder über importieren hinzufügen
Datenpunkte aus Json importieren:
0_userdata.0.Enphase-Werte_durch_1000.json
0_userdata.0.Enphase-Batteriestatus.json
------------------------------------------
Bei diesem Datenpunkt den Wert "Min" auf 0 Stellen:
Auch diesen Datenpunkt erstellen und hier wieder diesem Datenpunkt den Wert "Min" auf 0 Stellen:
...................................................................
3. SkriptDie LiveDaten werden in MilliWatt ausgegeben. Dieses Skript rechnet die Daten im Watt um.
aktualisiert am 19.05.2024
DAS SKRIPT FUNKTIONIERT NUR MIT DEN DATENPUNKTEN AUS "PUNKT 2.2 DATENPUNKTE ERSTELLEN"!!!
Enphase Werte durch 1000 -19.05.2024-.txt
...............................................................
4.Skript für dynamische Batterieanzeige:
Der kleine Blitz neben der Batterie wechselt beim Laden und Entladen (recht unten daneben) in "+" und "-". Die Batterie ändert die Ladezustandsanzeige nach 26%, 47%, 68%, 89%.
.......................................................
Die Vis Anzeige kann sich dann ja auch jeder selber bauen. -
@steffe-s Vielen Dank!!
Wenn die Anlage bei mir läuft werd ich das ganze testen. -
Edit:18.11.2023: VIS.txt wurde hinzugefügt
Hier mal noch meine aktuelles VIS .... (wenn sich der Mond in eine Sonne ändern soll, müsst Ihr definieren wann tag und wann Nacht ist und dies dann dem Bild zuweisen) dazu noch 2 Datenpunkte (Sonne und Mond) anlegen / Skript siehe unten....
OK, das Wetter ist zur Zeit echt mies bei uns
Den Chart habe ich dem echart-adapter gebaut
-
@steffe-s sagte in Enphase / Envoy / IQ-Gateway Solar Blockly Skript:
Hier mal noch meine aktuelles VIS ....
Hi Steffe!
Würdest du von dieser Seite einen Export bereitstellen?
Danke -
@steffe-s sagte in Enphase / Envoy / IQ-Gateway Solar Blockly Skript:
Hier mal noch meine aktuelles VIS ....
Danke dir!!
-
@steffe-s sagte in Enphase / Envoy / IQ-Gateway Solar Blockly Skript:
Hier die 4 Skripte:
bin gerade beim einrichten
sind das alle DP?
0_userdata.0.enphase.production
0_userdata.0.enphase.meters
0_userdata.0.enphase.prod_stat
0_userdata.0.enphase.inverter
0_userdata.0.enphase.inventory
0_userdata.0.enphase.livedata
0_userdata.0.Enphase-Werte_durch_1000.Energienetz
0_userdata.0.Enphase-Werte_durch_1000.Hausverbrauch
0_userdata.0.Enphase-Werte_durch_1000.PV-Erzeugung
0_userdata.0.Enphase-Werte_durch_1000.Batterieladung
0_userdata.0.enphase.livedata.meters.grid.agg_p_mw
0_userdata.0.enphase.livedata.meters.load.agg_p_mw
0_userdata.0.enphase.livedata.meters.pv.agg_p_mw
0_userdata.0.enphase.livedata.meters.storage.agg_p_mwwird der Token benötigt?
und der "http_resp_json"? Wo/wie/was muss ich da in das Feld eintragen?
-
hier im Skript 1 und Skript 2 die jeweiligen Daten eintragen,
- email- Adresse und Password wie in der Enlighten App
- Serialnummer des Envoy gateways
- IP - Adresse des Envoy Gateways (am besten festvergeben)
der Token wird automatisch gezogen
-
@steffe-s sagte in Enphase / Envoy / IQ-Gateway Solar Blockly Skript:
Edit:18.11.2023: VIS.txt wurde hinzugefügt
kannst du noch die Bildchen hochladen?
-
Leute, ihr seid der Hammer!
Uff, da werde ich sehr viel herumzuprobieren haben. Ich habe hier eine Enphase-Testanlage mit zwei Modulen und will daran eine Encharge 3T hängen, um die Sonnenstrahlen in die Nacht und die Reste an einem sonnigen Tag ins Auto zu schieben.
Mit eurer Vorarbeit könnte mir das sogar gelingen. -
Sollten sich die Datenpunkte nicht automatisch erstellen, wenn das Script den ersten Durchlauf macht?
Bin nicht so firm bei den Datenpunkten, und hatte gehofft das ich nur das Script importiere, Creds eingebe, starte und es läuft.
Zumindest klang das im obigen Post mehr oder weniger so.
Nun bin ich ein wenig verunsichert... -
ja, die grundsätzlichen Datenpunkte werden selber erstellt nur der Rest aus meinem Post nicht
-
ich habe an Enphase eine Anfrage gesendet, ich der ich gefagt habe, ob es einen Web-Postbefehl gibt (ähnlich wie beim Livestaus), der sagt, jetzt Batterieentladung stoppen und dann einen Gegenbefehl Batterieentladung erlauben.
Die Frage wurde an das zuständige Team weitergeleitet
-
Hallo,
das Wichtigste zuerst: Die Skripten sind genau das, was ich gesucht habe, also herzlichen Dank dafür.
Eine Frage hätte ich als JS-Ignorant aber dann doch, naämlich zu den folgenden Infos im Log:
javascript.0 2024-02-27 13:59:00.494 info script.js.Enphase_komplett: Get Inv. data : : Error local Envoy IP: 172.28.1.99. Error: Unexpected token < in JSON at position 0 | Error cnt: -1 javascript.0 2024-02-27 13:59:00.425 info script.js.Enphase_komplett: Get production.json data: : Error local Envoy IP: 172.28.1.99. Error: Unexpected token < in JSON at position 0 | Error cnt: -2Sind ja nur Infos, sonst funktioniert ja alles, kann man das aber trotzdem abstellen?
Mod-Edit: Log in Code-Tags
-
@steffe-s
Hab nun alles mal ausprobiert, die Scripte funktionieren, Danke dafür.
Es wurden allerdings hunderte Datenpunkte erstellt.
Gibt es eine Auflistung was, was ist?
Manches kann ich mir aufgrund der reinkommenden Werte denken, aber anderes widerrum nicht.Vor Allem die Ordnerstruktur mit Ordner 0 oder 1 unter Meters z.b.
Oder auch die "Lines" unter produktion.Gibt es eine Erklärung dazu?
Mir reichen die wichtigsten Kennzahlen ja aus.
Wie Erzeugung, Verbrauch, LiveData(da kann ich mir die Daten auch nicht mehr zusammenreimen)
Im Grund die Daten die die enphase App in Zahlen anzeigt.
-
im zweiten Post gibt es eine PDF Datei, in der einiges beschrieben wird. Du kannst aber auch die Datenpunkte, die Du nicht benötigst einfach im Skript weglassen bzw löschen (ab hier: 1. GET PV ......)
