Add deviceclass for power and Active Inverter Count for legacy

What's Changed

• Add missing device_class POWER by @PoppyPop in #181
• Add active inverter count for legacy Envoy by @catsmanac in #182

New Contributors

• @PoppyPop made their first contribution in #181

Full Changelog: v0.0.19...v0.0.20

Fix lifetime net production showing as negative lifetime consumption as of FW D7.6.x

New in this v0.0.19 release:

• Fix for #164 that reported that as of FW D7.6.175 lifetime net production (to grid) is showing as negative lifetime net consumption (from grid). This started with firmware D7.6.x where ivp/meters/reports has this as a change from older firmware that reported both as positive running numbers, just like ivp/meters/readings still does. Switched to using ivp/meters/readings for lifetime net production and consumption so these can be used with HA Energy dashboard as well when using this firmware.
• State class for lifetime net production entities changed from total to total_increasing.

NOTE: The entities Import Index and Export Index added in v0.0.17 have been renamed. This will make them unavailable and the new entities lifetime Net Energy Consumption (from grid) and Lifetime Net Energy Production (to grid) will start collecting this data. If Import and Export Index where used in the energy dashboard then also add these new ones for Grid consumption and Return to Grid.

Release history summary: https://github.com/briancmpbll/home_assistant_custom_envoy/releases

Use ivp/meters/reports, rename import/export index to lifetime net consumption/production and add Volts,Current,Frequency and Powerfactor

Note

Be aware that as of Envoy firmware D7.6.x lifetime net production as is reported as a negative Lifetime net consumption and Lifetime net production as zero. V0.0.19 with a fix for this is available.

New in this v0.0.18 release:

• New entities PF (power Factor), Voltage (Volt), Frequency (hz) , Current Consumption (amps) and Current Production (amps) from consumption CT by @cddu33
  • hidden by default, enable them on entities configuration screen
• Get consumption and production data from /ivp/meters/reports for Envoy metered with CT by @testuser7
  • Daily and last 7 days still come from /production
  • Configuration option added to allow a choice to only use data from ivp/meters/reports
    • this will make daily and last 7 day entities unavailable
    • New pages are more responsive and offer actual measurements when requested
• Rename Import / Export entities to Net Consumption / Net production
  • Old entities will show as unavailable.
• For legacy Envoy also use 404 status for inverters page as signal to no longer get these and not signal error back to HA.
• Updated French translation file by @cddu33
• Documentation updates by @cddu33, @testuser7, @OpenSourceSimon and @catsmanac

NOTE: The entities Import Index and Export Index added in v0.0.17 have been renamed. This will make them unavailable and the new entities Net Energy Consumption (from grid) and Net Energy Production (to grid) will start collecting this data. If Import and Export Index where used in the energy dashboard then also add these new ones for Grid consumption and Return to Grid.

Release history summary:

• Report Import / Export from ivp/meters/readings - V0.0.17
• Use certificate validation when communicating to Enlighten. - V0.0.16
• Configurable time-outs. Relaxed time-outs during initial configuration - V0.0.15
• Re-add support Legacy Envoy with firmware versions R3.x - V0.0.14
• Cache token until expired and auto-refresh
• Download Diagnostics option
• Supports IPV4 and IPV6 - V0.0.13
• Auto-detected 3 phase sensors - V0.0.12
• Auto-detected grid-status
• Configurable collection interval
• Support batteries capacity, % full, amount charged and amount discharged - V0.0,5
• Use Enphase tokens for newer firmware versions needed as of D7.x.x. - V0.0.3

Add Energy Import / Export Index from ivp/meters/readings by @cddu33

Report Import / Export from ivp/meters/readings by @cddu33. Adds Entities Index Import (actEnergyDlvd), Index Export (actEnergyRcvd) and Index Import Ln and Export Index Ln for reported phases. See Tech Brief-IQ Gateway Local API or UI Access using Token-EN-US-12-14-2022.pdf and readme.md

NOTE: Be aware that HA Core is expected to release a rewritten Enphase Envoy integration with support for tokens in September. The Energy import export in V0.0.17 is not (yet) part of HA core and when it gets added in a future version it may differ from this one. It may then cause history import/export to start fresh on new entities/variables. Depending how important that continuation is you may hold back on installing this one. On the other hand getting some data to see what it can bring could be considered better then no data at all even at the cause of a potential restart of history when switching to HA Core integration.

Release history summary:

• Report Import / Export from ivp/meters/readings - V0.0.17
• Use certificate validation when communicating to Enlighten. - V0.0.16
• Configurable time-outs. Relaxed time-outs during initial configuration - V0.0.15
• Re-add support Legacy Envoy with firmware versions R3.x - V0.0.14
• Cache token until expired and auto-refresh
• Download Diagnostics option
• Supports IPV4 and IPV6 - V0.0.13
• Auto-detected 3 phase sensors - V0.0.12
• Auto-detected grid-status
• Configurable collection interval
• Support batteries capacity, % full, amount charged and amount discharged - V0.0,5
• Use Enphase tokens for newer firmware versions needed as of D7.x.x. - V0.0.3

V0.0.16 Use Certificate validation when communicating with Enphase websites by @d1b

The Envoy custom integration is now validating certificates when communication with Enphase website. Provided by @d1b in #94

Release history summary:

• Use certificate validation when communicating to Enlighten.
• Configurable time-outs. Relaxed time-outs during initial configuration
• Re-add support Legacy Envoy with firmware versions R3.x
• Cache token until expired and auto-refresh
• Download Diagnostics option
• Supports IPV4 and IPV6
• Auto-detected 3 phase sensors
• Auto-detected grid-status
• Configurable collection interval
• Support batteries capacity, % full, amount charged and amount discharged
• Use Enphase tokens for newer firmware versions needed as of D7.x.x.

Fixed Battery charge/discharge not available, Improve configuration timing and troubleshooting

• v0.0.14 reported battery charged and discharged entities as not available. This is fixed in this release.
• Configuring slow Envoy was next to impossible. Timeout during initial configuration of the Envoy is relaxed to allow successful configuration.
• Timeout settings are now configurable in the Envoy configure menu. Defaults should cover most cases, only change settings in special cases, slow Envoy being the typical example. Refer to the documentation accessible from the Envoy Integration screen. You won't be able to make it respond faster but it will allow slow envoy to be used.
• Errors during initial configuration are now logged as warnings in the HA log file to assist with issues during this phase. Refer to the troubleshooting section of the documentation.
• Diagnostic report now also includes the raw data returned by the Envoy in the last collection to assist with troubleshooting. Confidential information like username/pw or tokens are hidden or not included.

V0.0.14: Improved support for Legacy, diagnostics, token cache and documentation

This version reports battery charged / discharged entities as not available. V0.0.15 is available that fixes this.

• Fix issues for Legacy ENVOY R/LCD.

  • Do not try to get / access inverter data
  • Do not try to get /access production.json data
  • Do not use authorization headers
  • Do not try to get /access grid status

• Enable diagnostics option to download diagnostic data

• Do not reveal token in debug log. Only show first 10 characters or show message token is hidden

• Do not send username/password when accessing inverters while using tokens

• Replace use of Enlighten login form by login.json site

• Cache token in HA store and always use it first, unless expired. Non need to access Enphase site at reload or HA restart

• Migrate documentation made during DEV-2-core work into readme.md and point to it for documentation and in HACS

• Show firmware version on device info and in diagnostics, read info.xml 1/hour.

This update is the result of the stopped effort to make this custom integration the successor of the HA core version. That effort was superseded by an other new build HA Core Enphase Envoy integration. All tested code of the effort is now migrated back into this custom repository.

Improved support for Legacy, diagnostics, token cache and documentation

• Fix issues for Legacy ENVOY R/LCD.

  • Do not try to get / access inverter data
  • Do not try to get /access production.json data
  • Do not use authorization headers
  • Do not try to get /access grid status

• Enable diagnostics option to download diagnostic data

• Do not reveal token in debug log. Only show first 10 characters or show message token is hidden

• Do not send username/password when accessing inverters while using tokens

• Replace use of Enlighten login form by login.json site

• Cache token in HA store and always use it first, unless expired. Non need to access Enphase site at reload or HA restart

• Migrate documentation made during DEV-2-core work into readme.md and point to it for documentation and in HACS

• Show firmware version on device info and in diagnostics, read info.xml 1/hour.

This update is the result of the stopped effort to make this custom integration the successor of the HA core version. That effort was superseded by an other new build HA Core Enphase Envoy integration. All tested code of the effort is now migrated back into this custom repository.

v0.0.13

• seven days production state_class fix
• fix for autodetect ipv6 on ipv4 networks

v0.0.12

• Implements 3-Phase sensors for 3-phase systems. Sensors are autodetected
• Autodetect grid status sensor
• Add option to change update interval
• Updated instructions on initial configuration screen
• some minor fixes