Rework from core

Author: CoMPaTech

custom_components/plugwise/config_flow.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 from copy import deepcopy
-from types import MappingProxyType
 from typing import Any, Self
 
 from plugwise import Smile
@@ -42,7 +41,6 @@
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
-from homeassistant.helpers.selector import TextSelector
 
 from .const import (
     ANNA_WITH_ADAM,
@@ -73,8 +71,15 @@
 
 # Upstream basically the whole file (excluding the pw-beta options)
 
+SMILE_RECONF_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_HOST): str,
+        vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
+    }
+)
+
 
-def base_schema(
+def SMILE_USER_SCHEMA(
     cf_input: ZeroconfServiceInfo | dict[str, Any] | None,
 ) -> vol.Schema:
     """Generate base schema for gateways."""
@@ -105,23 +110,10 @@ def base_schema(
     )
 
 
-def reconfigure_schema(reconfigure_data: MappingProxyType[str, Any]) -> vol.Schema:
-    """Generate reconfigure schema for gateways."""
-    return vol.Schema(
-        {
-            vol.Required(
-                CONF_HOST, default=reconfigure_data.get(CONF_HOST)
-            ): TextSelector(),
-            vol.Required(
-                CONF_PORT, default=reconfigure_data.get(CONF_PORT)
-            ): vol.Coerce(int),
-        }
-    )
-
 async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> Smile:
     """Validate whether the user input allows us to connect to the gateway.
 
-    Data has the keys from base_schema() with values provided by the user.
+    Data has the keys from the schema with values provided by the user.
     """
     websession = async_get_clientsession(hass, verify_ssl=False)
     api = Smile(
@@ -216,7 +208,7 @@ def is_matching(self, other_flow: Self) -> bool:
     async def _verify_connection(
          self, user_input: dict[str, Any]
      ) -> tuple[Smile | None, dict[str, str]]:
-         """Verify gateway connection helper function user and reconfiguration steps."""
+         """Verify and return the gateway connection using helper function."""
          errors: dict[str, str] = {}
 
          try:
@@ -234,9 +226,6 @@ async def _verify_connection(
          except Exception:  # noqa: BLE001
              errors[CONF_BASE] = "unknown"
          else:
-             await self.async_set_unique_id(
-                 api.smile_hostname or api.gateway_id, raise_on_progress=False
-             )
              return (api, errors)
          return (None, errors)
 
@@ -255,12 +244,15 @@ async def async_step_user(
 
             api, errors = await self._verify_connection(user_input)
             if not errors and api:
+                await self.async_set_unique_id(
+                    api.smile_hostname or api.gateway_id, raise_on_progress=False
+                )
                 self._abort_if_unique_id_configured()
                 return self.async_create_entry(title=api.smile_name, data=user_input)
 
         return self.async_show_form(
             step_id=SOURCE_USER,
-            data_schema=base_schema(self.discovery_info),
+            data_schema=SMILE_USER_SCHEMA(self.discovery_info),
             errors=errors,
         )
 
@@ -274,27 +266,31 @@ async def async_step_reconfigure(
 
         if user_input:
             # Redefine ingest existing username and password
-            user_input = {
+            full_input = {
                 CONF_HOST: user_input.get(CONF_HOST),
                 CONF_PORT: user_input.get(CONF_PORT),
                 CONF_USERNAME: reconfigure_entry.data.get(CONF_USERNAME),
                 CONF_PASSWORD: reconfigure_entry.data.get(CONF_PASSWORD),
             }
 
-            _, errors = await self._verify_connection(user_input)
-            if not errors:
+            api, errors = await self._verify_connection(full_input)
+            if not errors and api:
+                await self.async_set_unique_id(
+                    api.smile_hostname or api.gateway_id, raise_on_progress=False
+                )
                 self._abort_if_unique_id_mismatch(reason="not_the_same_smile")
                 return self.async_update_reload_and_abort(
                     self._get_reconfigure_entry(),
-                    data_updates=user_input,
+                    data_updates=full_input,
                 )
 
         return self.async_show_form(
             step_id="reconfigure",
-            data_schema=reconfigure_schema(reconfigure_entry.data),
-            description_placeholders={
-                "title": reconfigure_entry.title,
-            },
+            data_schema=self.add_suggested_values_to_schema(
+                data_schema=SMILE_RECONF_SCHEMA,
+                suggested_values=reconfigure_entry.data,
+            ),
+            description_placeholders={"title": reconfigure_entry.title},
             errors=errors,
         )
 

custom_components/plugwise/translations/en.json

@@ -4,7 +4,7 @@
             "already_configured": "This device is already configured",
             "anna_with_adam": "Both Anna and Adam detected. Add your Adam instead of your Anna",
             "not_the_same_smile": "The configured Smile ID does not match the Smile ID on the requested IP address.",
-            "reconfigure_successful": "Re-configuration was successful"
+            "reconfigure_successful": "Reconfiguration successful"
         },
         "error": {
             "cannot_connect": "Failed to connect",
@@ -20,16 +20,16 @@
         "step": {
             "reconfigure": {
                 "data": {
-                    "host": "IP address",
-                    "port": "Port"
+                    "host": "IP-address",
+                    "port": "Port number"
                 },
                 "description": "Update configuration for {title}."
             },
             "user": {
                 "data": {
-                    "host": "IP address",
+                    "host": "IP-address",
                     "password": "ID",
-                    "port": "Port",
+                    "port": "Port number",
                     "username": "Username"
                 },
                 "description": "Enter your Plugwise device: (setup can take up to 90s)",
@@ -57,9 +57,6 @@
             "heating_state": {
                 "name": "Heating"
             },
-            "low_battery": {
-                "name": "Battery state"
-            },
             "plugwise_notification": {
                 "name": "Plugwise notification"
             },
@@ -288,6 +285,26 @@
             }
         }
     },
+    "exceptions": {
+        "authentication_failed": {
+            "message": "Invalid authentication"
+        },
+        "data_incomplete_or_missing": {
+            "message": "Data incomplete or missing."
+        },
+        "error_communicating_with_api": {
+            "message": "Error communicating with API: {error}."
+        },
+        "failed_to_connect": {
+            "message": "Failed to connect"
+        },
+        "invalid_xml_data": {
+            "message": "Invalid XML data, or error indication received from the Plugwise Adam/Smile/Stretch"
+        },
+        "unsupported_firmware": {
+            "message": "Device with unsupported firmware"
+        }
+    },
     "options": {
         "step": {
             "init": {

tests/components/plugwise/test_select.py

@@ -11,7 +11,6 @@
 )
 from homeassistant.const import ATTR_ENTITY_ID
 from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import ServiceValidationError
 
 from tests.common import MockConfigEntry
 
@@ -89,18 +88,18 @@ async def test_legacy_anna_select_entities(
     assert not hass.states.get("select.anna_thermostat_schedule")
 
 
-async def test_adam_select_unavailable_regulation_mode(
-    hass: HomeAssistant, mock_smile_anna: MagicMock, init_integration: MockConfigEntry
-) -> None:
-    """Test a regulation_mode non-available preset."""
-
-    with pytest.raises(ServiceValidationError, match="valid options"):
-        await hass.services.async_call(
-            SELECT_DOMAIN,
-            SERVICE_SELECT_OPTION,
-            {
-                ATTR_ENTITY_ID: "select.anna_thermostat_schedule",
-                ATTR_OPTION: "freezing",
-            },
-            blocking=True,
-        )
+#async def test_anna_select_unavailable_regulation_mode(
+#    hass: HomeAssistant, mock_smile_anna: MagicMock, init_integration: MockConfigEntry
+#) -> None:
+#    """Test a regulation_mode non-available preset."""
+#
+#    with pytest.raises(ServiceValidationError, match="valid options"):
+#        await hass.services.async_call(
+#            SELECT_DOMAIN,
+#            SERVICE_SELECT_OPTION,
+#            {
+#                ATTR_ENTITY_ID: "select.anna_thermostat_schedule",
+#                ATTR_OPTION: "freezing",
+#            },
+#            blocking=True,
+#        )