[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (2024)

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (1)
[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (2)

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (3)

Er is meer dan Enlighten en de Enphase app: lokale toegang tot de IQ Gateway

Degene die net als ik een PV-systeem van Enphase hebben, halen de meeste informatie uit de online omgeving Enlighten, of via de app, welke gevoed wordt door de IQ Gateway (voorheen Envoy genoemd). Voor de doorsnee gebruiker is dat prima informatie, maar wij tweakers willen altijd meer! Tijdens mijn zoektocht naar de firmware versie van mijn micro omvormers, welke standaard niet zichtbaar zijn in Enlighten of in de Installer Toolkit, stuitte ik op een website / blog waar iemand verschillende pagina's met data van je PV-systeem vanuit de IQ Gateway bespreekt. Sommige als webpagina's, anderen in .json-formaat.

Een aantal van deze pagina's zijn vrij toegankelijk, d.w.z. benaderbaar via je webbrowser in het lokale netwerk, zonder inloggegevens. Een bekende is http://envoy/home (evt. envoy vervangen door het lokale ip-adres van de Envoy). Deze geeft een configuratieoverzicht van je PV-systeem (klik voor voorbeeld), met o.a. de huidige productie en eventuele consumptie. Verder kan je er weinig. Echter is er ook een installateurs deel van de API, te weten op http://envoy/installer/setup/home. Maar daar heb je een gebruikersnaam en wachtwoord voor nodig. En dat zijn niet de gegevens die je gebruikt om in te loggen bij Enlighten of in de app.

Nu is er ook lokaal, dus binnen je eigen netwerk, toegang te krijgen tot de IQ Gateway. Het maakt wel uit of je firmware versie 5 of 7/8 hebt, want de aanvliegroute verschilt tussen deze twee. Versie 5 komt steeds minder voor, Enphase heeft onlangs actief versie 7 gepushed naar gateways die nog op versie 5 draaide (ook als automatisch updaten uit staat!), wegens een beveiligingslek. Inmiddels is versie 8 uit, en worden steeds meer gateways geupdate van versie 7 naar versie 8.

Hoe weet ik welke firmware versie mijn IQ Gateway heeft?
In de Enphase app: Menu -> Systeem -> Apparaten -> Gateway (voorbeeld)
In Enlighten: Menu -> Systeem -> Apparaten en dan over Gateway (voorbeeld)

Nu je weet of je IQ Gateway firmware versie 5 of 7/8 heeft, kan skippen naar juiste onderdeel:

  • Toegang krijgen tot de IQ Gateway met firmware versie 5
  • Toegang krijgen tot de IQ Gateway met firmware versie 7/8

Heb je al toegang? Gebruik maken van domotica

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (4)

Om toegang te krijgen tot de IQ Gateway met firmwareversie 5, heb een gebruikersnaam en wachtwoord nodig. Deze verschillen van je inloggegevens die je bij Enphase gebruikt. De gebruikersnaam is altijd installer, maar het wachtwoord zit hard-coded ingebakken in de firmware. Deze is het makkelijkst via deze website op te vragen. Het kan heel eenvoudig op basis van je serienummer het wachtwoord van de IQ Gateway geven. Het serienummer is op een sticker op je IQ Gateway te vinden. Vul dit in bij het veld Serial Number en je krijgt het wachtwoord van je IQ Gateway.

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (5)

Wat kun je met deze lokale toegang?

Samen met de gebruikersnaam installer en het wachtwoord kan je nu wel toegang krijgen tot http://envoy/installer/setup/home. In feite is dit de webbased versie van de Installer Toolkit van Enphase. En je hoeft niet meer perse met de telefoon verbinding te maken met de IQ Gateway!

Nu zijn er dus veel meer pagina's op de IQ Gateway die lokaal via je webbrowser benaderbaar zijn. Veel zijn zonder inloggegevens te bekijken, voor andere heb je het IQ Gateway wachtwoord nodig. Een overzicht van de gevonden pagina's:

URLGebruikersnaamWachtwoordOpmerkingen
http://envoy/home[nvt][nvt]Systeemoverzicht en configuratie
http://envoy/home.json[nvt][nvt]Database grootte, datum en tijd, netwerk status en instellingen, update status
http://envoy/production.json[nvt][nvt]Productie en consumptie data
http://envoy/inventory.json[nvt][nvt]Details over de micro omvormers, ook firmware versie
http://envoy/api/v1/production[nvt][nvt]Totale en huidig vermogen / productie van het hele systeem
http://envoy/api/v1/consumption[nvt][nvt]Totale en huidig consumptie van het hele net (huis)
http://envoy/ivp/meters/reports/consumption[nvt][nvt]Gedetailleerd consumptie overzicht, totaal en per fase
http://envoy/ivp/meters/reports/production[nvt][nvt]Gedetailleerd productie overzicht, totaal en per fase
http://envoy/api/v1/production/invertersinstaller[gateway ww]Geeft huidig en maximaal vermogen per micro omvormer weer
http://envoy/ivp/meters[nvt][nvt]Overzicht van productie / verbruiksmeters
http://envoy/ivp/meters/readings[nvt][nvt]Metingen per fase
http://envoy/ivp/peb/newscan[nvt][nvt]Scan van het systeem
http://envoy/prov[nvt][nvt]O.a. serienummers van apparaten in het systeem
http://envoy/admin/lib/wireless_display.json?site_info=0[nvt][nvt]Overzicht wifi settings
http://envoy/installer/setup/homeinstaller[gateway ww]Installer Toolkit interface
http://envoy/stream/meterinstaller[gateway ww]Continu datastroom van de productie (*nog uitzoeken*)
http://envoy/event.jsoninstaller[gateway ww]Overzicht van storingen in het systeem op micro omvormer en Envoy niveau

Verder heb ik nog meer pagina's gevonden, maar daar kom ik niet in, met geen enkele gebruikersnaam / wachtwoord combinatie die ik heb. Te weten:
http://envoy/home?classic=1
http://envoy/admin/home?locale=nl
http://envoy/admin/lib/network_display?locale=nl
http://envoy/admin/lib/security_display?locale=nl
Wellicht zijn het gegevens die terug te vinden zijn in andere pagina's.

Importeren in Excel

Het is ook mogelijk om bijvoorbeeld .json bestand te importeren in Excel, rechtstreeks vanuit de IQ Gateway. Dit doe je in Excel via Gegevens -> Nieuwe query -> Uit andere bronnen -> Van het web (Excel 2019 NL, kan bij andere versies iets anders zijn). Vul daar bijvoorbeeld http://envoy/production.json in. Je kunt dan verschillende tabellen importeren in Excel. Een gifje dat ik online vond:

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (7)

Wellicht dat hiermee ook iets van scriptje te maken is om bijvoorbeeld met een druk op de knop de nieuwste data binnen te halen, maar zover reikt mijn kennis niet. Het voorzetje is gegeven [Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (8)

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (9)

Vanaf firmware versie 7 (eerste versie is v7.0.88) of versie 8 (eerste versie v8.2.4225), is de manier om lokale toegang tot de IQ Gateway te krijgen grondig veranderd. Het wachtwoord is niet meer op basis van het serienummer te achterhalen. Daarvoor in de plaats moet een token worden opgehaald in de Enphase cloud. Met die token kan lokale toegang tot de IQ Gateway worden gekregen.

Waarom werkt Enphase met een token?

Er zijn helaas installaties waar de IQ Gateway rechtstreeks aan internet hangt. Met de oude firmware (v5) konden wildvreemden op die IQ Gateway komen. Dat is natuurlijk niet de bedoeling. De token is een manier voor Enphase om dit probleem op te lossen.

Hoe werkt dat met zo'n token?

Je installateur (of jijzelf, als je DHZ'er bent) koppelt het serienummer van je IQ Gateway aan je Enphase cloud account. Vervolgens kun je met dat account in de Enphase cloud een token ophalen op basis van je serienummer. Dit token heb je nodig om lokaal tegen je IQ Gateway aan te praten:

  1. Met serienummer in de Enphase cloud je token ophalen:
    a. via browser @ https://entrez.enphaseenergy.com/entrez_tokens
    b. via API @ https://entrez.enphaseenergy.com/tokens (zie post van @wnwiigrtz) of https://enlighten.enphase...token?serial_num=<serial>
  2. Met dit token een sessie creeren: https://envoy/auth/check_jwt
  3. API van IQ Gateway lokaal aanspreken, zie lijst van API endpoints

Maar wacht even, ben ik dan afhankelijk van de cloud?

Voor het opnieuw ophalen van een token helaas wel, ja. Voor gewone 'system owner' cloud accounts zijn de tokens 1 jaar geldig. Sommige gebruikers hebben een installer account, en Enphase zegt dat hun tokens 1 of 12 uur geldig zijn. Als je die langdurige token eenmaal hebt, hoef je niet meer naar de cloud om je IQ Gateway lokaal aan te spreken. Wel kan het zijn dat je IQ Gateway de cloud moet kunnen aanspreken.

Welke API endpoints zijn lokaal aan te spreken op de IQ Gateway?
API endpointAuthenticatie
https://envoy/home.jsonopen
https://envoy/info.xmlopen
https://envoy/auth/check_jwtopen
https://envoy/admin/home?locale=envereist token
https://envoy/admin/lib/wireless_display.json?site_info=0vereist token
https://envoy/api/v1/productionvereist token
https://envoy/api/v1/production/invertersvereist token
https://envoy/event?locale=envereist token
https://envoy/event.jsonvereist token
https://envoy/homevereist token
https://envoy/installer/setup/homevereist token
https://envoy/inventory?locale=envereist token
https://envoy/inventory.jsonvereist token
https://envoy/inventory.json?deleted=1vereist token
https://envoy/ivp/ensemble/inventoryvereist token
https://envoy/ivp/livedata/statusvereist token
https://envoy/ivp/metersvereist token
https://envoy/ivp/meters/readingsvereist token
https://envoy/ivp/meters/reports/consumptionvereist token
https://envoy/ivp/peb/newscanvereist token
https://envoy/production.jsonvereist token
https://envoy/production.json?details=1vereist token
https://envoy/provvereist token
https://envoy/stream/metervereist token

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (10)

Bovenstaande, individuele pagina's zijn leuk om in de browser te bekijken, maar het is natuurlijk nog leuker om die toegangelijke data slim te gebruiken. Bijvoorbeeld in Home Assistant of Domoticz.

  • Bij Domoticz was voorheen een plugin nodig, maar momenteel heeft Domoticz dit standaard ingebouwd zitten. Meer info op de wiki-pagina.
  • Voor Home Assistant bestaat er ook een officiële plugin / integratie.
    Daarnaast is er ook een veel uitgebreidere integratie van briancmpbll, je vinden op Github. Deze kan je ook installeren via HACS in Home Assistant.
  • Voor Home Assistant heeft ook @vinniefireman een integratie gemaakt (let op: vereist installer account), zodat je enkel username/wachtwoord van je Enphase cloud account en IP-adres van je IQ Gateway hoeft in te stellen. Zie https://github.com/vincen...t_enphase_envoy_installer.
  • HomeWizard heeft ook een Enphase plugin (maar hier is geen lokale toegang voor nodig, wordt uit de cloud gehaald via je Enphase account)
  • Je kunt je data ook laten uitlezen door PVOutput. Zie hier voor een korte instructie.

Een paar voorbeelden van dashboards waarbij de data van de IQ Gateway gebruikt wordt:

Home Assitant:

Domoticz:

HomeWizard:

PVOutput:

Wat voor verkeer is er tussen de IQ Gateway en de Enphase cloud?

De IQ Gateway stuurt gegevens naar de Enphase cloud, onder meer zodat je je productie in de mobiele app kan bekijken. Maar ook bij het initieel aanmelden van het systeem, om firmware op te halen, etc.

Voor zover we nu weten genereert de IQ Gateway het volgende verkeer:

  • reports.enphaseenergy.com (voor het periodiek versturen van je productie, en voor het ophalen van taken, zie deze post van @mielus)
  • entrez.enphaseenergy.com (waarschijnlijk voor het genereren of valideren van tokens)
  • ping-udp.enphaseenergy.com
  • provisioning.enphaseenergy.com
  • revocations.enphase.com
  • *.iot.us-east-1.amazonaws.com
  • ICMP echo naar dns.google (8.8.8.8)

Change log
DatumDoorOmschrijving
11-06-2021PazoStart topic
14-11-2021PazoLink toegevoegd naar website met installer password generator
14-11-2022iKiddoInformatie toegevoegd over lokale toegang tot Envoy bij firmware v7
30-1-2024PazoAanpassing gemaakt mbt Domoticz en wat kleine updates / aanpassingen
15-2-2024PazoGrote functionele en visuele update van het topic
28-8-2024PazoKleine toevoegingen mbt firmware versie 8

[ Voor 255% gewijzigd door Pazo op 30-08-2024 10:45 ]

[Enphase] Envoy / IQ Gateway lokaal uitlezen voor domotica - Duurzame energie en installaties (2024)
Top Articles
Latest Posts
Article information

Author: Maia Crooks Jr

Last Updated:

Views: 6339

Rating: 4.2 / 5 (43 voted)

Reviews: 90% of readers found this page helpful

Author information

Name: Maia Crooks Jr

Birthday: 1997-09-21

Address: 93119 Joseph Street, Peggyfurt, NC 11582

Phone: +2983088926881

Job: Principal Design Liaison

Hobby: Web surfing, Skiing, role-playing games, Sketching, Polo, Sewing, Genealogy

Introduction: My name is Maia Crooks Jr, I am a homely, joyous, shiny, successful, hilarious, thoughtful, joyous person who loves writing and wants to share my knowledge and understanding with you.