Enphase Envoy with Energy Dashboard

del13r · December 4, 2023, 8:26am

Hi @mvana, ah yes, you are correct, my apologies for the mix up

I was easily confused by HASS and I wrongly assumed you meant HACS.
HASS = Home Assistant (Native Integrations)
HACS = Home Assistant Community Store (3rd party repositories)

In answer to your question, the code for the native integration is found here.
homeassistant/components/enphase_envoy

I’m quite novice on python code, so unfortunately I can’t help you find where the token is stored.

At the moment, I am using my own solution via the rest sensor, originally because the native integration didn’t support d7 at the time, but now mainly so I can have efficient 10 second updates instead of 60 second updates. The downside is that it is slightly more complicated to setup than the native implementation and I have to manually refresh my token once a year.
Now that the native implementation supports token authentication, I recommend my solution less than the native one for general use.
I still also use the native Enphase integration for recording sensors like “today_s_energy_production” and “today_s_energy_consumption” so I can verify my figures against what the Envoy reports and also check in on the functionality of the native implementation.

del13r · December 4, 2023, 8:35am

One thing that I notice is that your Grid doesnt have an export sensor.
Is this on purpose?

Here is my config for comparison at https://homeassistant.local/config/energy

Mine is a bit more complicated as I have different costs at different times of the day but I recommend having at least an import (grid consumption) and export (return to grid) sensor as well as a production sensor.

del13r · December 4, 2023, 7:24pm

I found where it might be stored in the code here

github.com

home-assistant/core/blob/516966db332a843f257f727453d677efc14f6b27/homeassistant/components/enphase_envoy/coordinator.py#L135


      
              if not isinstance(envoy.auth, EnvoyTokenAuth):
                  return
              # update token in config entry so we can
              # startup without hitting the Cloud API
              # as long as the token is valid
              _LOGGER.debug("%s: Updating token in config entry from auth", self.name)
              self.hass.config_entries.async_update_entry(
                  self.entry,
                  data={
                      **self.entry.data,
                      CONF_TOKEN: envoy.auth.token,
                  },
              )
          
          async def _async_update_data(self) -> dict[str, Any]:
              """Fetch all device and sensor data from api."""
              envoy = self.envoy
              for tries in range(2):
                  try:
                      if not self._setup_complete:
                          await self._async_setup_and_authenticate()

mvana · December 5, 2023, 5:08am

The underlying issue I am fighting with is that I do not see the
https://homeassistant.local/config/energy you have shown.

What I have related in the '“config” is http://homeassistant.local:8123/config/entities
and I can see Envoy in integrations or devices
but I didn’t find any configurable properties.
Either I do not know where to look or it isn’t there(?)
May be the time to delete this (native?) integration and install the custom one.
Thanks!

mvana · December 5, 2023, 5:10am

Thanks for the Python pointer. Will look how to dump the key into the log file.

del13r · December 5, 2023, 8:13pm

Have you tried
http://homeassistant.local:8123/config/energy

Is there anything there that looks like my screenshot?

I recommend you stick with the native integration, because none of the enphase integrations will automatically provide you with import and export sensors because the envoy doesn’t supply import and export readings. This is a gap that home assistant needs to fill using calculations.

The only exception to this statement is
my own solution via the rest sensor which is not an integration, but simply a rest sensor that targets a different source of information than what the enphase integrations use.

For every enphase integration, native or hacs, the following needs to be done.

What you have to do is go to the first post at top of this article and follow the instructions using:

Step1. Template sensors to calculate power import and power export.

del13r:

template:
  - sensor:
        name: Grid Import Power
        state_class: measurement
        icon: mdi:transmission-tower
        unit_of_measurement: W
        device_class: power
        state: >
            {{ [0, states('sensor.envoy_SERIALNUMBER_current_power_consumption') | int(0) - states('sensor.envoy_SERIALNUMBER_current_power_production') | int(0) ] | max }}
  - sensor:
        name: Grid Export Power
        state_class: measurement
        icon: mdi:transmission-tower
        unit_of_measurement: W
        device_class: power
        state: >
            {{ [0, states('sensor.envoy_SERIALNUMBER_current_power_production') | int(0) - states('sensor.envoy_SERIALNUMBER_current_power_consumption') | int(0) ] | max }}

Step2. The integration sensor to convert instant power to energy over time.

del13r:

sensor:
  - platform: integration
    name: Grid Import Energy
    source: sensor.grid_import_power
    unit_prefix: k
    unit_time: h
    method: left
    
  - platform: integration
    name: Grid Export Energy
    source: sensor.grid_export_power
    unit_prefix: k
    unit_time: h
    method: left

Once you do those 2 steps, you should be able to choose the new energy sensors in the energy dashboard here

http://homeassistant.local:8123/config/energy

Keith3 · December 6, 2023, 9:44pm

Hi @del13r , thank your for this awesome guide. Quick Question, I’m on latest everything. When I check my unit of measurement for _current_power_consumption and production, it is in kW by default.

Do I need to then change the unit_of_measurement in your template sensor to “kW”.?
If so, then do I also need to remove the unit_prefix of “k” in sensor platform?

Please if you can help / update?

del13r · December 6, 2023, 10:02pm

Hmm, that is different to what I get.

My model is an envoy-s-metered-eu (env-s-wm-230). May I ask what model of envoy you have?

Also, are you using the native (built in) enphase integration or a home assistant community store repository (HACS)?

Keith3 · December 6, 2023, 10:10pm

Yes, so they just installed mine 2 months ago and mine is env-iq-am1-240.
And I’m using the native built in new enphase integration.

I changed my YAML to say kW, and remove the prefix, but not sure if that is correct, hence asking you.

here is a screenshot

del13r · December 6, 2023, 10:31pm

Was that via the GUI

Or via /homeassistant/customize.yaml

or did you have to write a new template sensor to divide by 1000W to get 1KW?

Keith3 · December 6, 2023, 10:36pm

no sorry, I meant your code, where you have

unit_of_measurement: W
I changed it to
unit_of_measurement: kW

AND

where you had
unit_prefix: k
I removed that line.

So I don’t know if it will work correctly?

Keith3 · December 6, 2023, 10:46pm

Let me rephrase question.
How should I re-write your code to support my situation, while keeping my defaults?

This code:

del13r · December 6, 2023, 10:50pm

Looking at this screenshot, the W to kW conversion appears to be correct.

I would say yes to changing the unit_of_measurement in your template sensor to “kW".

looking at this link:
https://www.home-assistant.io/integrations/integration/#unit_prefix

It says the following:

unit_prefix string (optional, default: None)

Metric unit to prefix the integration result. Available units are k, M, G and T.

Given that statement, I would leave that line as it was with k as the unit_prefix.

Keith3 · December 6, 2023, 10:59pm

Thanks, so that’s what I originally did.
Which is changed W to kW and left the prefix = k.
But then in the chart (graph), it would show kkW (it was adding that prefix).

So now, I just want to make sure I get correct calculus.
I can see the correct on enphase app.

del13r · December 6, 2023, 11:26pm

ah ok, in that case, then remove the unit_prefix line

Keith3 · December 6, 2023, 11:59pm

Hi @del13r , Ok so I’ll let it collect for 24 hours, and then switch my energy dashboard. Hopefully, I would be able to see the perfect graph, and what I’m using myself VS what I’m exporting

I’ll revert back here with my screenshot.

Only worried if somewhere I need to divide or multiple by 1000

del13r · December 7, 2023, 12:00am

Energy dashboard will only show data from the moment you add the sensors to the energy dashboard onwards.

Just making sure you arent expecting to have a full day of data visible in energy dashboard as soon as you add them.

Keith3 · December 7, 2023, 12:04am

Right, so for now, since I just added these sensors, energy dashboard doesn’t show anything correct for today.

del13r · December 7, 2023, 12:07am

The long term statistics which energy dashboard uses as a data source used to be calculated at 12 mins past the hour for the previous hour which is why Energy Dashboard warns you with this message:

After setting up a new device, it can take up to 2 hours for new data to arrive in your energy dashboard.

del13r · December 7, 2023, 12:49am

Hi @automateme1,

I have @fireheadman asking a similar question to what you were asking about at Enphase Envoy with Energy Dashboard - #573 by automateme1

Just checking to see if you were able to successfully turn this into a sensor using rest?