Update Envoy sensor to configure credentials and grab Inverter Date from updated API (#28837)

* Update manifest.json

Updated sensor to use the latest version of the API to be able to use the new features.

* Updated sensor to use new API features.  Configurable credentials and Inverter last reported date.

* EnvoyReader is passed to Envoy uses async update()

* Fixed pydocstyle warnings

* Fixed merge issue. Had extra variable.

* Added warning message when authentication for Inverter data fails

* Added continue after exception for loop

* Moved if statement outside of try/except

* Removed unneeded boolean attribute

homeassistant/components/enphase_envoy/manifest.json

@@ -3,7 +3,7 @@
   "name": "Enphase envoy",
   "documentation": "https://www.home-assistant.io/integrations/enphase_envoy",
   "requirements": [
-    "envoy_reader==0.8.6"
+    "envoy_reader==0.10.0"
   ],
   "dependencies": [],
   "codeowners": []

homeassistant/components/enphase_envoy/sensor.py

@@ -2,6 +2,7 @@
 import logging
 
 from envoy_reader.envoy_reader import EnvoyReader
+import requests
 import voluptuous as vol
 
 from homeassistant.components.sensor import PLATFORM_SCHEMA
@@ -9,6 +10,8 @@ from homeassistant.const import (
     CONF_IP_ADDRESS,
     CONF_MONITORED_CONDITIONS,
     CONF_NAME,
+    CONF_PASSWORD,
+    CONF_USERNAME,
     ENERGY_WATT_HOUR,
     POWER_WATT,
 )
@@ -42,6 +45,8 @@ CONST_DEFAULT_HOST = "envoy"
 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
     {
         vol.Optional(CONF_IP_ADDRESS, default=CONST_DEFAULT_HOST): cv.string,
+        vol.Optional(CONF_USERNAME, default="envoy"): cv.string,
+        vol.Optional(CONF_PASSWORD, default=""): cv.string,
         vol.Optional(CONF_MONITORED_CONDITIONS, default=list(SENSORS)): vol.All(
             cv.ensure_list, [vol.In(list(SENSORS))]
         ),
@@ -52,30 +57,42 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
 
 async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
     """Set up the Enphase Envoy sensor."""
-
     ip_address = config[CONF_IP_ADDRESS]
     monitored_conditions = config[CONF_MONITORED_CONDITIONS]
     name = config[CONF_NAME]
+    username = config[CONF_USERNAME]
+    password = config[CONF_PASSWORD]
+
+    envoy_reader = EnvoyReader(ip_address, username, password)
 
     entities = []
     # Iterate through the list of sensors
     for condition in monitored_conditions:
         if condition == "inverters":
-            inverters = await EnvoyReader(ip_address).inverters_production()
+            try:
+                inverters = await envoy_reader.inverters_production()
+            except requests.exceptions.HTTPError:
+                _LOGGER.warning(
+                    "Authentication for Inverter data failed during setup: %s",
+                    ip_address,
+                )
+                continue
+
             if isinstance(inverters, dict):
                 for inverter in inverters:
                     entities.append(
                         Envoy(
-                            ip_address,
+                            envoy_reader,
                             condition,
                             f"{name}{SENSORS[condition][0]} {inverter}",
                             SENSORS[condition][1],
                         )
                     )
+
         else:
             entities.append(
                 Envoy(
-                    ip_address,
+                    envoy_reader,
                     condition,
                     f"{name}{SENSORS[condition][0]}",
                     SENSORS[condition][1],
@@ -87,13 +104,14 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
 class Envoy(Entity):
     """Implementation of the Enphase Envoy sensors."""
 
-    def __init__(self, ip_address, sensor_type, name, unit):
+    def __init__(self, envoy_reader, sensor_type, name, unit):
         """Initialize the sensor."""
-        self._ip_address = ip_address
+        self._envoy_reader = envoy_reader
+        self._type = sensor_type
         self._name = name
         self._unit_of_measurement = unit
-        self._type = sensor_type
         self._state = None
+        self._last_reported = None
 
     @property
     def name(self):
@@ -115,11 +133,18 @@ class Envoy(Entity):
         """Icon to use in the frontend, if any."""
         return ICON
 
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes."""
+        if self._type == "inverters":
+            return {"last_reported": self._last_reported}
+
+        return None
+
     async def async_update(self):
         """Get the energy production data from the Enphase Envoy."""
-
         if self._type != "inverters":
-            _state = await getattr(EnvoyReader(self._ip_address), self._type)()
+            _state = await getattr(self._envoy_reader, self._type)()
             if isinstance(_state, int):
                 self._state = _state
             else:
@@ -127,9 +152,17 @@ class Envoy(Entity):
                 self._state = None
 
         elif self._type == "inverters":
-            inverters = await (EnvoyReader(self._ip_address).inverters_production())
+            try:
+                inverters = await (self._envoy_reader.inverters_production())
+            except requests.exceptions.HTTPError:
+                _LOGGER.warning(
+                    "Authentication for Inverter data failed during update: %s",
+                    self._envoy_reader.host,
+                )
+
             if isinstance(inverters, dict):
                 serial_number = self._name.split(" ")[2]
-                self._state = inverters[serial_number]
+                self._state = inverters[serial_number][0]
+                self._last_reported = inverters[serial_number][1]
             else:
                 self._state = None

requirements_all.txt

@@ -483,7 +483,7 @@ env_canada==0.0.30
 # envirophat==0.0.6
 
 # homeassistant.components.enphase_envoy
-envoy_reader==0.8.6
+envoy_reader==0.10.0
 
 # homeassistant.components.season
 ephem==3.7.7.0