Quick App - Enphase Envoy Monitor by Sankotronic

[Sankotronic]

Enphase Envoy Monitor QA standalone v1.1

INTRODUCTION

Enphase Envoy Monitor QA brings seamless integration of the Enphase Envoy Metering EU with Fibaro Home Center.

 

PREREQUISITES

• Fibaro HC3, HC3Lite or Yubii Home with firmware 5.161 or greater
• Enphase Envoy Metering EU gateway with firmware D7.6.177 or greater
• User account on https://enlighten.enphaseenergy.com/login/login.json

 

FEATURES 

• The QA retrieves production, consumption and net-balance from Enphase Envoy gateway and show on child devices.

• The QA also retrieves production data from all Enphase micro-inverters found in the system and can show on separately added inverter child devices.

• Today production, today consumption and instantaneous production and consumption child devices can be selected in Fibaro Home Center energy panel settings.

• After setting up Envoy gateway IP address and user name and password QA will immediately get all other necessary data like gateway serial number, session number and access token. Time of access token generation is stored and used to refresh after period of 180 days. NOTE – for now, generated token lifetime is 1 year according to the Enphase information.

• This version of Enphase Envoy Monitor QA provides calculated values for today’s exported energy and today’s imported energy shown on child devices. It also provides child devices for calculated values of grid dependence and production capacity

• QA has built in multi-language support with 32 languages included (see APPENDIX 1 for the list). QA can use HC selected language or user can select any other available language.

 

NOT SUPPORTED BY THIS VERSION

• Q-relays
• Battery packs

 

DOWNLOAD PACKAGE CONTENT 

• Enphase Envoy Monitor QA v1.1
• Enphase Envoy Monitor QA User manual v1.1
• Icon set

 

INSTALLATION

Please download ZIP package from:

Fibaro marketplace: https://marketplace.fibaro.com/items/enphase-envoy-monitor-qa-v1-1

Fibaro forum download: https://forum.fibaro.com/files/file/526-enphase-envoy-monitor-qa/

 

NOTE - I know that some users will not like that this QA is encrypted. Since license is now changed to donation-ware, I can send original code or even unencrypted QA, but only to users that will donate. For more information please check provided user manual, Thank you for understanding!

 

TERMS AND CONDITIONS 

Permission to use, copy and distribute this software and its documentation for educational, research, personal use and non-profit purposes, without fee and without a signed licensing agreement is hereby granted, provided that the copyright notice, with "Terms and conditions" and "Disclaimer" appear in all copies, modifications and distributions. It is strictly forbidden to sell, rent, lease and/or lend this software for profit without prior consent from the Author.

 

DISCLAIMER

This software is provided by copyright owner "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the author and distributor be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. 

Fibaro a Nice company and their employees are not responsible for support of this QA. Please contact the author Sankotronic, on the Fibaro Forum, for any questions or support required. 

 

VERSION HISTORY 

• 1.1 - first public release as donation-ware.

 

LOOK & FEEL  

 

 

 

 

 

NOTE - Pictures are not taken at the same time. In Yubii app main QA is not visible.

 

ENPHASE ENVOY MONITOR QA CHILD DEVICES AND ENLIGHTEN APP COMPARISON

What you get with this integration is best explained with the next few pictures:

 

• Enlighten status screen with appropriate QA child devices:

 

• Enlighten live status screen with appropriate QA child devices:

 

• Enlighten Total Energy screen with appropriate QA child devices:

 

Here are provided icons that can be found inside the ZIP package:

- Envoy main icon

- Envoy updating icon (shown during communication with Envoy gateway)

- Envoy exporting icon (shown when production is higher than consumption and energy is exported to the grid)

- Envoy production/importing icon (shown when production is lower than consumption and part of the consumption power is importing from the grid)

- Envoy importing icon (show when there is no production and all consumption power is importing from the grid)

- Envoy error icon (only shown if there is a communication problem with the Envoy gateway)

- Envoy production icon (all child devices related to the production get this icon)

-  Envoy consumption icon (all child devices related to the consumption get this icon)

- Envoy net-ballance icon (all child devices related to the net-balance [import/export from the grid] get this icon)

- Envoy voltmeter icon for child device showing system voltage

-  Envoy amp meter icon (for child devices showing consumption, production and net-ballance current)

- Envoy inverter icon (for all child devices related to micro-inverters)

 

NOTE - This QA code is not fork or modified version of any existing similar QA. There are several Enphase Envoy QA available here on the french forum:

and Fibaro marketplace ( (JJSM, Twan van Eijk, ReneNL), but none of them were used to build this QA.

 

Enjoy coding and your new Enphase Envoy Monitor QA! 

Sankotronic

Modifié le 16 septembre par Sankotronic
corrected title

[Nico]

Top !

[TitiXsi]

Hey ! The variable main_icon is a very good ID .

Did you try to get values more than 30secondsd ?

I am interested to see the report if you are more agressive with the refresh (10secondsd ?)
Because my envoy seems very low and the Inventory.json response is around 20-25 seconds

 

Modifié le 17 septembre par TitiXsi

[Sankotronic]

Hi @TitiXsi,

 

I use only two calls to Envoy:

 

1) https://xxx.xxx.xxx.xxx/production.json

2) https://xxx.xxx.xxx.xxx/api/v1/production/inverters

 

to get all data that I need. I do not query for inventory and currently my QA do not support batteries since I do not have them and don't really know what response look like when there is a battery pack present. I did ask for this on Fibaro forum, but never get any response, so I guess there is no one there that have battery pack installed.

 

I can set interval to less than every 30 seconds, but there is a catch. Every 10 minutes I do a REST API call to recalculate today's exported and today's imported energy which then I use to calculate e.g. grid dependence. Problem is that this REST API calls seems to take few seconds each (slow). Also, when inverters are off (no production) then Envoy takes much longer time to send response for inverters production, so I decided that 30 second interval is up to the task and good enough. Please, correct me if I'm wrong. Thanks!

 

There are also few problems with Envoy API, I guess bugs:

 

1) Current production reported is almost never 0W which is a bit strange during night and that makes calculation for grid dependence a bit off on my QA

2) Today's net or grid consumption is always reported as 0W so must be calculated by QA and this requires power sensor device for currently importing power from which then can be calculated today's imported energy. Same is for today's exported energy for which to be calculated power sensor device for currently exporting power is needed.

 

 

[TitiXsi]

By night, my production is -17w for 3qrelay and 23 micro.inverters. clearly it depends where thé clamps are placed. On my side, the computation is quite similar to enphase.

 

Concerning the time to report, more the system has micro.inverters, more the lag IS important. 30sd is clearly the minus for me.

Modifié le 3 novembre par TitiXsi

[Sankotronic]

il y a 24 minutes, TitiXsi a dit :

Concerning the time to report, more the system has micro.inverters, more the lag IS important. 30sd is clearly the minus for me.

 

I totally agree. Currently I have 15 micro inverters, but I plan to add more in near future and even battery pack to get as much independent as possible. Will see then if refresh rate of 30 seconds will be enough. Problem for me is that I have single phase system on my house so I'm quite limited to the expansion of the solar system and also installing heat pumps etc.

[Lazer]

@TitiXsi I remember this old conversation we already had, but my Envoy S Metered has no problem being polled by my QuickApp with a 5 seconds interval.

It's monitoring 2 Q-Relays and 16 IQ7+ micro-inverters.

 

Most API requests are delivered within less than 1s, sometimes a little more, but still less than 2 seconds.

[Sankotronic]

Il y a 1 heure, Lazer a dit :

Most API requests are delivered within less than 1s, sometimes a little more, but still less than 2 seconds.

 

Hi @Lazer,

I guess your Envoy is connected with Ethernet cable? My Envoy works over WiFi 5GHz to the Ubiquiti Alien router mesh, so I think it is OK if responses take a bit longer. Just guessing.

 

@TitiXsi how is your Envoy connected, wire or WiFi?

[Lazer]

Yes, wired Ethernet for all my equipment, including the Envoy gateway.

 

Despite having an excellent Wi-Fi thanks to my 3 Unifi AP, it is only used by mobile devices such as phones, tablets, or some few devices without any Ethernet port such as ESP32 or Netatmo.

Nothing cas beat Ethernet connection, not even the latest WiFi 7 protocol.

It took me hours, days, weeks of work to be able to bring Ethernet cables to almost everywhere in my house, from the basement to (literally) the roof.

[Sankotronic]

Il y a 3 heures, Lazer a dit :

t took me hours, days, weeks of work to be able to bring Ethernet cables to almost everywhere in my house, from the basement to (literally) the roof.

That is something that I still have to do. At the moment I use network power adapters, good ones, but still not as good as network cable. Some of my devices still have to connect over the WiFi.

[TitiXsi]

Il y a 6 heures, Sankotronic a dit :

 

Hi @Lazer,

I guess your Envoy is connected with Ethernet cable? My Envoy works over WiFi 5GHz to the Ubiquiti Alien router mesh, so I think it is OK if responses take a bit longer. Just guessing.

 

@TitiXsi how is your Envoy connected, wire or WiFi?

@LazerIknow what WE have talk a lot about it... Clearly it's strange...

 

 

@SankotronicI have added an ethernet câble because the latency was very long in wifi. But this is not very performante. 30sd was the minimum for me...

I let you trying with ethernet and try to détresse the delay. It Can be a good test to know if it was m'y metered which is very "not efficient" or if it is due to the type of envoy.

 

[TitiXsi]

Le 03/11/2024 à 13:59, Lazer a dit :

@TitiXsi I remember this old conversation we already had, but my Envoy S Metered has no problem being polled by my QuickApp with a 5 seconds interval.

It's monitoring 2 Q-Relays and 16 IQ7+ micro-inverters.

 

Most API requests are delivered within less than 1s, sometimes a little more, but still less than 2 seconds.

@LazerJust to confirm tant I have the same comportement with tour QA on m'y installation, 30sd min . But i know thzt you don't have condumption clamps, is it right ?

Modifié le 4 novembre par TitiXsi

[Lazer]

Indeed, no consumption clamp on my system because I can't connect it (too far away).
However I have the production clamp.

 

Aside from the Ethernet/Wi-Fi connexion, the missing clamp may explain the difference, my Envoy has less computing to do.

[TitiXsi]

I @Sankotronic did you try to Get a new token since your first version ?

I am facing an issue on all QAenphase (yours, Lazer, mine)

 

Thanks.

[Sankotronic]

Le 19/11/2024 à 11:25, TitiXsi a dit :

I @Sankotronic did you try to Get a new token since your first version ?

 

Hello @TitiXsi,

 

I will test getting new token on my QA again and let you know. BTW sorry for late replay, I just came home yesterday after 4 weeks of work.