Add config flow to Smarty

CODEOWNERS

@@ -1351,6 +1351,7 @@ build.json @home-assistant/supervisor
 /homeassistant/components/smarttub/ @mdz
 /tests/components/smarttub/ @mdz
 /homeassistant/components/smarty/ @z0mbieprocess
+/tests/components/smarty/ @z0mbieprocess
 /homeassistant/components/smhi/ @gjohansson-ST
 /tests/components/smhi/ @gjohansson-ST
 /homeassistant/components/smlight/ @tl-sl

homeassistant/components/smarty/__init__.py

@@ -7,17 +7,17 @@
 from pysmarty2 import Smarty
 import voluptuous as vol
 
+from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
 from homeassistant.const import CONF_HOST, CONF_NAME, Platform
-from homeassistant.core import HomeAssistant
-from homeassistant.helpers import discovery
+from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
+from homeassistant.data_entry_flow import FlowResultType
+from homeassistant.helpers import issue_registry as ir
 import homeassistant.helpers.config_validation as cv
-from homeassistant.helpers.dispatcher import dispatcher_send
-from homeassistant.helpers.event import track_time_interval
+from homeassistant.helpers.dispatcher import async_dispatcher_send
+from homeassistant.helpers.event import async_track_time_interval
 from homeassistant.helpers.typing import ConfigType
 
-DOMAIN = "smarty"
-DATA_SMARTY = "smarty"
-SMARTY_NAME = "Smarty"
+from .const import DOMAIN, SIGNAL_UPDATE_SMARTY
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -26,48 +26,94 @@
         DOMAIN: vol.Schema(
             {
                 vol.Required(CONF_HOST): vol.All(ipaddress.ip_address, cv.string),
-                vol.Optional(CONF_NAME, default=SMARTY_NAME): cv.string,
+                vol.Optional(CONF_NAME, default="Smarty"): cv.string,
             }
         )
     },
     extra=vol.ALLOW_EXTRA,
 )
 
-RPM = "rpm"
-SIGNAL_UPDATE_SMARTY = "smarty_update"
+PLATFORMS = [Platform.BINARY_SENSOR, Platform.FAN, Platform.SENSOR]
 
+type SmartyConfigEntry = ConfigEntry[Smarty]
 
-def setup(hass: HomeAssistant, config: ConfigType) -> bool:
-    """Set up the smarty environment."""
-
-    conf = config[DOMAIN]
-
-    host = conf[CONF_HOST]
-    name = conf[CONF_NAME]
 
-    _LOGGER.debug("Name: %s, host: %s", name, host)
-
-    smarty = Smarty(host=host)
-
-    hass.data[DOMAIN] = {"api": smarty, "name": name}
+async def async_setup(hass: HomeAssistant, hass_config: ConfigType) -> bool:
+    """Create a smarty system."""
+    if config := hass_config.get(DOMAIN):
+        hass.async_create_task(_async_import(hass, config))
+    return True
 
-    # Initial update
-    smarty.update()
 
-    # Load platforms
-    discovery.load_platform(hass, Platform.FAN, DOMAIN, {}, config)
-    discovery.load_platform(hass, Platform.SENSOR, DOMAIN, {}, config)
-    discovery.load_platform(hass, Platform.BINARY_SENSOR, DOMAIN, {}, config)
+async def _async_import(hass: HomeAssistant, config: ConfigType) -> None:
+    """Set up the smarty environment."""
 
-    def poll_device_update(event_time):
+    if not hass.config_entries.async_entries(DOMAIN):
+        # Start import flow
+        result = await hass.config_entries.flow.async_init(
+            DOMAIN, context={"source": SOURCE_IMPORT}, data=config
+        )
+        if result["type"] == FlowResultType.ABORT:
+            ir.async_create_issue(
+                hass,
+                DOMAIN,
+                f"deprecated_yaml_import_issue_{result['reason']}",
+                breaks_in_ha_version="2025.5.0",
+                is_fixable=False,
+                issue_domain=DOMAIN,
+                severity=ir.IssueSeverity.WARNING,
+                translation_key=f"deprecated_yaml_import_issue_{result['reason']}",
+                translation_placeholders={
+                    "domain": DOMAIN,
+                    "integration_title": "Smarty",
+                },
+            )
+            return
+
+    ir.async_create_issue(
+        hass,
+        HOMEASSISTANT_DOMAIN,
+        f"deprecated_yaml_{DOMAIN}",
+        breaks_in_ha_version="2025.5.0",
+        is_fixable=False,
+        issue_domain=DOMAIN,
+        severity=ir.IssueSeverity.WARNING,
+        translation_key="deprecated_yaml",
+        translation_placeholders={
+            "domain": DOMAIN,
+            "integration_title": "Smarty",
+        },
+    )
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: SmartyConfigEntry) -> bool:
+    """Set up the Smarty environment from a config entry."""
+
+    def _setup_smarty() -> Smarty:
+        smarty = Smarty(host=entry.data[CONF_HOST])
+        smarty.update()
+        return smarty
+
+    smarty = await hass.async_add_executor_job(_setup_smarty)
+
+    entry.runtime_data = smarty
+
+    async def poll_device_update(event_time) -> None:
         """Update Smarty device."""
         _LOGGER.debug("Updating Smarty device")
-        if smarty.update():
+        if await hass.async_add_executor_job(smarty.update):
             _LOGGER.debug("Update success")
-            dispatcher_send(hass, SIGNAL_UPDATE_SMARTY)
+            async_dispatcher_send(hass, SIGNAL_UPDATE_SMARTY)
         else:
             _LOGGER.debug("Update failed")
 
-    track_time_interval(hass, poll_device_update, timedelta(seconds=30))
+    async_track_time_interval(hass, poll_device_update, timedelta(seconds=30))
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
     return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: SmartyConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/smarty/binary_sensor.py

@@ -13,27 +13,25 @@
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
-from . import DOMAIN, SIGNAL_UPDATE_SMARTY
+from . import SIGNAL_UPDATE_SMARTY, SmartyConfigEntry
 
 _LOGGER = logging.getLogger(__name__)
 
 
-async def async_setup_platform(
+async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigType,
+    entry: SmartyConfigEntry,
     async_add_entities: AddEntitiesCallback,
-    discovery_info: DiscoveryInfoType | None = None,
 ) -> None:
     """Set up the Smarty Binary Sensor Platform."""
-    smarty: Smarty = hass.data[DOMAIN]["api"]
-    name: str = hass.data[DOMAIN]["name"]
+
+    smarty = entry.runtime_data
 
     sensors = [
-        AlarmSensor(name, smarty),
-        WarningSensor(name, smarty),
-        BoostSensor(name, smarty),
+        AlarmSensor(entry.title, smarty),
+        WarningSensor(entry.title, smarty),
+        BoostSensor(entry.title, smarty),
     ]
 
     async_add_entities(sensors, True)

homeassistant/components/smarty/config_flow.py

@@ -0,0 +1,63 @@
+"""Config flow for Smarty integration."""
+
+from typing import Any
+
+from pysmarty2 import Smarty
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import CONF_HOST, CONF_NAME
+
+from .const import DOMAIN
+
+
+class SmartyConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Smarty config flow."""
+
+    def _test_connection(self, host: str) -> str | None:
+        """Test the connection to the Smarty API."""
+        smarty = Smarty(host=host)
+        try:
+            if smarty.update():
+                return None
+        except Exception:  # noqa: BLE001
+            return "unknown"
+        else:
+            return "cannot_connect"
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle a flow initialized by the user."""
+        errors: dict[str, str] = {}
+
+        if user_input is not None:
+            self._async_abort_entries_match(user_input)
+            error = await self.hass.async_add_executor_job(
+                self._test_connection, user_input[CONF_HOST]
+            )
+            if not error:
+                return self.async_create_entry(
+                    title=user_input[CONF_HOST], data=user_input
+                )
+            errors["base"] = error
+        return self.async_show_form(
+            step_id="user",
+            data_schema=vol.Schema({vol.Required(CONF_HOST): str}),
+            errors=errors,
+        )
+
+    async def async_step_import(
+        self, import_config: dict[str, Any]
+    ) -> ConfigFlowResult:
+        """Handle a flow initialized by import."""
+        self._async_abort_entries_match({CONF_HOST: import_config[CONF_HOST]})
+        error = await self.hass.async_add_executor_job(
+            self._test_connection, import_config[CONF_HOST]
+        )
+        if not error:
+            return self.async_create_entry(
+                title=import_config[CONF_NAME],
+                data={CONF_HOST: import_config[CONF_HOST]},
+            )
+        return self.async_abort(reason=error)

homeassistant/components/smarty/const.py

@@ -0,0 +1,5 @@
+"""Constants for the Smarty component."""
+
+DOMAIN = "smarty"
+
+SIGNAL_UPDATE_SMARTY = "smarty_update"

homeassistant/components/smarty/fan.py

@@ -6,39 +6,35 @@
 import math
 from typing import Any
 
-from pysmarty2 import Smarty
-
 from homeassistant.components.fan import FanEntity, FanEntityFeature
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 from homeassistant.util.percentage import (
     percentage_to_ranged_value,
     ranged_value_to_percentage,
 )
 from homeassistant.util.scaling import int_states_in_range
 
-from . import DOMAIN, SIGNAL_UPDATE_SMARTY
+from . import SIGNAL_UPDATE_SMARTY, SmartyConfigEntry
 
 _LOGGER = logging.getLogger(__name__)
 
 DEFAULT_ON_PERCENTAGE = 66
 SPEED_RANGE = (1, 3)  # off is not included
 
 
-async def async_setup_platform(
+async def async_setup_entry(
     hass: HomeAssistant,
-    config: ConfigType,
+    entry: SmartyConfigEntry,
     async_add_entities: AddEntitiesCallback,
-    discovery_info: DiscoveryInfoType | None = None,
 ) -> None:
-    """Set up the Smarty Fan Platform."""
-    smarty: Smarty = hass.data[DOMAIN]["api"]
-    name: str = hass.data[DOMAIN]["name"]
+    """Set up the Smarty Binary Sensor Platform."""
+
+    smarty = entry.runtime_data
 
-    async_add_entities([SmartyFan(name, smarty)], True)
+    async_add_entities([SmartyFan(entry.title, smarty)], True)
 
 
 class SmartyFan(FanEntity):

homeassistant/components/smarty/manifest.json

@@ -2,6 +2,7 @@
   "domain": "smarty",
   "name": "Salda Smarty",
   "codeowners": ["@z0mbieprocess"],
+  "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/smarty",
   "integration_type": "hub",
   "iot_class": "local_polling",

homeassistant/components/smarty/sensor.py

@@ -15,11 +15,31 @@
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 import homeassistant.util.dt as dt_util
 
-from . import DOMAIN, SIGNAL_UPDATE_SMARTY
+from . import DOMAIN, SIGNAL_UPDATE_SMARTY, SmartyConfigEntry
 
 _LOGGER = logging.getLogger(__name__)
 
 
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: SmartyConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the Smarty Binary Sensor Platform."""
+
+    smarty = entry.runtime_data
+    sensors = [
+        SupplyAirTemperatureSensor(entry.title, smarty),
+        ExtractAirTemperatureSensor(entry.title, smarty),
+        OutdoorAirTemperatureSensor(entry.title, smarty),
+        SupplyFanSpeedSensor(entry.title, smarty),
+        ExtractFanSpeedSensor(entry.title, smarty),
+        FilterDaysLeftSensor(entry.title, smarty),
+    ]
+
+    async_add_entities(sensors, True)
+
+
 async def async_setup_platform(
     hass: HomeAssistant,
     config: ConfigType,

homeassistant/components/smarty/strings.json

@@ -0,0 +1,33 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "data": {
+          "host": "[%key:common::config_flow::data::host%]"
+        },
+        "data_description": {
+          "host": "The hostname or IP address of the Smarty device"
+        }
+      }
+    },
+    "error": {
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "unknown": "[%key:common::config_flow::error::unknown%]"
+    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "unknown": "[%key:common::config_flow::error::unknown%]"
+    }
+  },
+  "issues": {
+    "deprecated_yaml_import_issue_unknown": {
+      "title": "YAML import failed with unknown error",
+      "description": "Configuring {integration_title} using YAML is being removed but there was an unknown error while importing your existing configuration.\nSetup will not proceed.\n\nVerify that your {integration_title} is operating correctly and restart Home Assistant to attempt the import again.\n\nAlternatively, you may remove the `{domain}` configuration from your configuration.yaml entirely, restart Home Assistant, and add the {integration_title} integration manually."
+    },
+    "deprecated_yaml_import_issue_auth_error": {
+      "title": "YAML import failed due to an authentication error",
+      "description": "Configuring {integration_title} using YAML is being removed but there was an authentication error while importing your existing configuration.\nSetup will not proceed.\n\nVerify that your {integration_title} is operating correctly and restart Home Assistant to attempt the import again.\n\nAlternatively, you may remove the `{domain}` configuration from your configuration.yaml entirely, restart Home Assistant, and add the {integration_title} integration manually."
+    }
+  }
+}

homeassistant/generated/config_flows.py

@@ -539,6 +539,7 @@
         "smart_meter_texas",
         "smartthings",
         "smarttub",
+        "smarty",
         "smhi",
         "smlight",
         "sms",

homeassistant/generated/integrations.json

@@ -5654,7 +5654,7 @@
     "smarty": {
       "name": "Salda Smarty",
       "integration_type": "hub",
-      "config_flow": false,
+      "config_flow": true,
       "iot_class": "local_polling"
     },
     "smhi": {