Merge pull request #277 from vincentwolsink/option_alternative_login

Add option for alternative DIY login method

Author: vincentwolsink

custom_components/enphase_envoy/__init__.py

@@ -41,6 +41,7 @@
     NAME,
     PLATFORMS,
     CONF_SERIAL,
+    CONF_TOKEN_ENVOY,
     READER,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_REALTIME_UPDATE_THROTTLE,
@@ -79,6 +80,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         enlighten_pass=config[CONF_PASSWORD],
         inverters=True,
         enlighten_serial_num=config[CONF_SERIAL],
+        token_method_envoy=config.get(CONF_TOKEN_ENVOY, False),
         store=store,
         disable_negative_production=options.get("disable_negative_production", False),
         disabled_endpoints=disabled_endpoints,

custom_components/enphase_envoy/config_flow.py

@@ -27,6 +27,7 @@
 from .const import (
     DOMAIN,
     CONF_SERIAL,
+    CONF_TOKEN_ENVOY,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_REALTIME_UPDATE_THROTTLE,
     ENABLE_ADDITIONAL_METRICS,
@@ -48,6 +49,7 @@ async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> EnvoyRead
         enlighten_pass=data[CONF_PASSWORD],
         inverters=False,
         enlighten_serial_num=data[CONF_SERIAL],
+        token_method_envoy=data.get(CONF_TOKEN_ENVOY, False),
     )
 
     try:
@@ -86,6 +88,7 @@ def _async_generate_schema(self):
         schema[vol.Required(CONF_SERIAL, default=self.unique_id)] = str
         schema[vol.Required(CONF_USERNAME, default=self.username)] = str
         schema[vol.Required(CONF_PASSWORD, default="")] = str
+        schema[vol.Optional(CONF_TOKEN_ENVOY, default=False)] = bool
 
         return vol.Schema(schema)
 

custom_components/enphase_envoy/const.py

@@ -47,6 +47,7 @@
 DEFAULT_GETDATA_TIMEOUT = 60
 
 CONF_SERIAL = "serial"
+CONF_TOKEN_ENVOY = "token_method_envoy"
 
 LIVE_UPDATEABLE_ENTITIES = "live-update-entities"
 ENABLE_ADDITIONAL_METRICS = "enable_additional_metrics"

custom_components/enphase_envoy/envoy_reader.py

@@ -28,6 +28,9 @@
 ENVOY_MODEL_M = "Metered"
 ENVOY_MODEL_S = "Standard"
 
+ENLIGHTEN_AUTH_URL = "https://enlighten.enphaseenergy.com/login/login.json?"
+ENLIGHTEN_TOKEN_URL = "https://entrez.enphaseenergy.com/tokens"
+
 # paths used for fetching enlighten token through envoy
 ENLIGHTEN_LOGIN_URL = "https://entrez.enphaseenergy.com/login"
 ENDPOINT_URL_GET_JWT = "https://{}/auth/get_jwt"
@@ -784,6 +787,7 @@ def __init__(
         disabled_endpoints=[],
         lifetime_production_correction=0,
         device_data_endpoint="endpoint_device_data",
+        token_method_envoy=False,
     ):
         """Init the EnvoyReader."""
         self.host = host.lower()
@@ -809,6 +813,7 @@ def __init__(
         self.disabled_endpoints = disabled_endpoints
         self.lifetime_production_correction = lifetime_production_correction
         self.device_data_endpoint = device_data_endpoint
+        self.token_method_envoy = token_method_envoy
 
         self.uri_registry = {}
         for key, endpoint in ENVOY_ENDPOINTS.items():
@@ -970,6 +975,36 @@ async def _async_put(self, url, data, **kwargs):
             _LOGGER.debug("TransportError: %s", e)
             raise e
 
+    async def _fetch_enlighten_token_json(self):
+        """
+        Try to fetch the token json from Enlighten API
+        :return:
+        """
+        _LOGGER.debug("Fetching enlighten token")
+        async with self.async_client as client:
+            # login to Enlighten
+            payload_login = {
+                "user[email]": self.enlighten_user,
+                "user[password]": self.enlighten_pass,
+            }
+            resp = await client.post(ENLIGHTEN_AUTH_URL, data=payload_login, timeout=30)
+            if resp.status_code >= 400:
+                raise EnlightenError("Could not Authenticate via Enlighten")
+
+            # now that we're in a logged in session, we can request the installer token
+            login_data = resp.json()
+            payload_token = {
+                "session_id": login_data["session_id"],
+                "serial_num": self.enlighten_serial_num,
+                "username": self.enlighten_user,
+            }
+            resp = await client.post(
+                ENLIGHTEN_TOKEN_URL, json=payload_token, timeout=30
+            )
+            if resp.status_code != 200:
+                raise EnlightenError("Could not get enlighten token")
+            return resp.text
+
     async def _fetch_envoy_token_json(self):
         """
         Fetch a token, using the same procedure envoy uses in the webUI
@@ -1039,7 +1074,10 @@ async def _fetch_envoy_token_json(self):
             return resp.json()["access_token"]
 
     async def _get_enphase_token(self):
-        self._token = await self._fetch_envoy_token_json()
+        if self.token_method_envoy:
+            self._token = await self._fetch_envoy_token_json()
+        else:
+            self._token = await self._fetch_enlighten_token_json()
 
         _LOGGER.debug("Envoy Token")
         if self._is_enphase_token_expired(self._token):

custom_components/enphase_envoy/translations/en.json

@@ -16,7 +16,8 @@
           "host": "Host",
           "password": "Enlighten Password",
           "username": "Enlighten Username",
-          "serial": "Envoy Serial Number"
+          "serial": "Envoy Serial Number",
+          "token_method_envoy": "Simulate local Web UI login (required for DIY account)"
         },
         "description": "Enter the hostname/ip and serial of your Envoy. Use your Enlighten (installer) account credentials."
       }

custom_components/enphase_envoy/translations/nl.json

@@ -16,7 +16,8 @@
                   "host": "Host",
                   "password": "Enlighten Wachtwoord",
                   "username": "Enlighten Gebruikersnaam",
-                  "serial": "Envoy Serienummer"
+                  "serial": "Envoy Serienummer",
+                  "token_method_envoy": "Simuleer lokale Web UI login (vereist voor DHZ account)"
               },
               "description": "Voer de hostname/ip en serienummer van je Envoy in. Gebruik je Enlighten (installer) account gegevens."
           }