Adds ConfigFlow for London Underground (home-assistant#152050)

Co-authored-by: Norbert Rittel <[email protected]>
Co-authored-by: Joost Lekkerkerker <[email protected]>

Author: 3 people

homeassistant/components/london_underground/__init__.py

@@ -1 +1,36 @@
 """The london_underground component."""
+
+from __future__ import annotations
+
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import DOMAIN as DOMAIN
+from .coordinator import LondonTubeCoordinator, LondonUndergroundConfigEntry, TubeData
+
+PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: LondonUndergroundConfigEntry
+) -> bool:
+    """Set up London Underground from a config entry."""
+
+    session = async_get_clientsession(hass)
+    data = TubeData(session)
+    coordinator = LondonTubeCoordinator(hass, data, config_entry=entry)
+    await coordinator.async_config_entry_first_refresh()
+
+    entry.runtime_data = coordinator
+    # Forward the setup to the sensor platform
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(
+    hass: HomeAssistant, entry: LondonUndergroundConfigEntry
+) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/london_underground/config_flow.py

@@ -0,0 +1,152 @@
+"""Config flow for London Underground integration."""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+from typing import Any
+
+from london_tube_status import TubeData
+import voluptuous as vol
+
+from homeassistant.config_entries import (
+    ConfigEntry,
+    ConfigFlow,
+    ConfigFlowResult,
+    OptionsFlowWithReload,
+)
+from homeassistant.core import callback
+from homeassistant.helpers import selector
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+from homeassistant.helpers.typing import ConfigType
+
+from .const import CONF_LINE, DEFAULT_LINES, DOMAIN, TUBE_LINES
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class LondonUndergroundConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for London Underground."""
+
+    VERSION = 1
+    MINOR_VERSION = 1
+
+    @staticmethod
+    @callback
+    def async_get_options_flow(
+        _: ConfigEntry,
+    ) -> LondonUndergroundOptionsFlow:
+        """Get the options flow for this handler."""
+        return LondonUndergroundOptionsFlow()
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial step."""
+        errors: dict[str, str] = {}
+
+        if user_input is not None:
+            session = async_get_clientsession(self.hass)
+            data = TubeData(session)
+            try:
+                async with asyncio.timeout(10):
+                    await data.update()
+            except TimeoutError:
+                errors["base"] = "timeout_connect"
+            except Exception:
+                _LOGGER.exception("Unexpected error")
+                errors["base"] = "cannot_connect"
+            else:
+                return self.async_create_entry(
+                    title="London Underground",
+                    data={},
+                    options={CONF_LINE: user_input.get(CONF_LINE, DEFAULT_LINES)},
+                )
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=vol.Schema(
+                {
+                    vol.Optional(
+                        CONF_LINE,
+                        default=DEFAULT_LINES,
+                    ): selector.SelectSelector(
+                        selector.SelectSelectorConfig(
+                            options=TUBE_LINES,
+                            multiple=True,
+                            mode=selector.SelectSelectorMode.DROPDOWN,
+                        )
+                    ),
+                }
+            ),
+            errors=errors,
+        )
+
+    async def async_step_import(self, import_data: ConfigType) -> ConfigFlowResult:
+        """Handle import from configuration.yaml."""
+        session = async_get_clientsession(self.hass)
+        data = TubeData(session)
+        try:
+            async with asyncio.timeout(10):
+                await data.update()
+        except Exception:
+            _LOGGER.exception(
+                "Unexpected error trying to connect before importing config, aborting import "
+            )
+            return self.async_abort(reason="cannot_connect")
+
+        _LOGGER.warning(
+            "Importing London Underground config from configuration.yaml: %s",
+            import_data,
+        )
+        # Extract lines from the sensor platform config
+        lines = import_data.get(CONF_LINE, DEFAULT_LINES)
+        if "London Overground" in lines:
+            _LOGGER.warning(
+                "London Overground was removed from the configuration as the line has been divided and renamed"
+            )
+            lines.remove("London Overground")
+        return self.async_create_entry(
+            title="London Underground",
+            data={},
+            options={CONF_LINE: import_data.get(CONF_LINE, DEFAULT_LINES)},
+        )
+
+
+class LondonUndergroundOptionsFlow(OptionsFlowWithReload):
+    """Handle options."""
+
+    async def async_step_init(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Manage the options."""
+        if user_input is not None:
+            _LOGGER.debug(
+                "Updating london underground with options flow user_input: %s",
+                user_input,
+            )
+            return self.async_create_entry(
+                title="",
+                data={CONF_LINE: user_input[CONF_LINE]},
+            )
+
+        return self.async_show_form(
+            step_id="init",
+            data_schema=vol.Schema(
+                {
+                    vol.Optional(
+                        CONF_LINE,
+                        default=self.config_entry.options.get(
+                            CONF_LINE,
+                            self.config_entry.data.get(CONF_LINE, DEFAULT_LINES),
+                        ),
+                    ): selector.SelectSelector(
+                        selector.SelectSelectorConfig(
+                            options=TUBE_LINES,
+                            multiple=True,
+                            mode=selector.SelectSelectorMode.DROPDOWN,
+                        )
+                    ),
+                }
+            ),
+        )

homeassistant/components/london_underground/const.py

@@ -6,7 +6,6 @@
 
 CONF_LINE = "line"
 
-
 SCAN_INTERVAL = timedelta(seconds=30)
 
 TUBE_LINES = [
@@ -18,7 +17,7 @@
     "Elizabeth line",
     "Hammersmith & City",
     "Jubilee",
-    "London Overground",
+    "London Overground",  # no longer supported
     "Metropolitan",
     "Northern",
     "Piccadilly",
@@ -31,3 +30,20 @@
     "Weaver",
     "Windrush",
 ]
+
+# Default lines to monitor if none selected
+DEFAULT_LINES = [
+    "Bakerloo",
+    "Central",
+    "Circle",
+    "District",
+    "DLR",
+    "Elizabeth line",
+    "Hammersmith & City",
+    "Jubilee",
+    "Metropolitan",
+    "Northern",
+    "Piccadilly",
+    "Victoria",
+    "Waterloo & City",
+]

homeassistant/components/london_underground/coordinator.py

@@ -8,23 +8,31 @@
 
 from london_tube_status import TubeData
 
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
 from .const import DOMAIN, SCAN_INTERVAL
 
 _LOGGER = logging.getLogger(__name__)
 
+type LondonUndergroundConfigEntry = ConfigEntry[LondonTubeCoordinator]
+
 
 class LondonTubeCoordinator(DataUpdateCoordinator[dict[str, dict[str, str]]]):
     """London Underground sensor coordinator."""
 
-    def __init__(self, hass: HomeAssistant, data: TubeData) -> None:
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        data: TubeData,
+        config_entry: LondonUndergroundConfigEntry,
+    ) -> None:
         """Initialize coordinator."""
         super().__init__(
             hass,
             _LOGGER,
-            config_entry=None,
+            config_entry=config_entry,
             name=DOMAIN,
             update_interval=SCAN_INTERVAL,
         )

homeassistant/components/london_underground/manifest.json

@@ -2,9 +2,12 @@
   "domain": "london_underground",
   "name": "London Underground",
   "codeowners": ["@jpbede"],
+  "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/london_underground",
+  "integration_type": "service",
   "iot_class": "cloud_polling",
   "loggers": ["london_tube_status"],
   "quality_scale": "legacy",
-  "requirements": ["london-tube-status==0.5"]
+  "requirements": ["london-tube-status==0.5"],
+  "single_config_entry": true
 }

homeassistant/components/london_underground/sensor.py

@@ -5,23 +5,26 @@
 import logging
 from typing import Any
 
-from london_tube_status import TubeData
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
     PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
     SensorEntity,
 )
-from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import PlatformNotReady
-from homeassistant.helpers import config_validation as cv
-from homeassistant.helpers.aiohttp_client import async_get_clientsession
-from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.config_entries import SOURCE_IMPORT
+from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
+from homeassistant.data_entry_flow import FlowResultType
+from homeassistant.helpers import config_validation as cv, issue_registry as ir
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.helpers.entity_platform import (
+    AddConfigEntryEntitiesCallback,
+    AddEntitiesCallback,
+)
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from .const import CONF_LINE, TUBE_LINES
-from .coordinator import LondonTubeCoordinator
+from .const import CONF_LINE, DOMAIN, TUBE_LINES
+from .coordinator import LondonTubeCoordinator, LondonUndergroundConfigEntry
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -38,18 +41,54 @@ async def async_setup_platform(
 ) -> None:
     """Set up the Tube sensor."""
 
-    session = async_get_clientsession(hass)
-
-    data = TubeData(session)
-    coordinator = LondonTubeCoordinator(hass, data)
+    # If configuration.yaml config exists, trigger the import flow.
+    # If the config entry already exists, this will not be triggered as only one config is allowed.
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_IMPORT}, data=config
+    )
+    if (
+        result.get("type") is FlowResultType.ABORT
+        and result.get("reason") != "already_configured"
+    ):
+        ir.async_create_issue(
+            hass,
+            DOMAIN,
+            f"deprecated_yaml_import_issue_{result.get('reason')}",
+            is_fixable=False,
+            issue_domain=DOMAIN,
+            severity=ir.IssueSeverity.WARNING,
+            translation_key="deprecated_yaml_import_issue",
+            translation_placeholders={
+                "domain": DOMAIN,
+                "integration_title": "London Underground",
+            },
+        )
+        return
+
+    ir.async_create_issue(
+        hass,
+        HOMEASSISTANT_DOMAIN,
+        "deprecated_yaml",
+        is_fixable=False,
+        issue_domain=DOMAIN,
+        severity=ir.IssueSeverity.WARNING,
+        translation_key="deprecated_yaml",
+        translation_placeholders={
+            "domain": DOMAIN,
+            "integration_title": "London Underground",
+        },
+    )
 
-    await coordinator.async_refresh()
 
-    if not coordinator.last_update_success:
-        raise PlatformNotReady
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: LondonUndergroundConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up the London Underground sensor from config entry."""
 
     async_add_entities(
-        LondonTubeSensor(coordinator, line) for line in config[CONF_LINE]
+        LondonTubeSensor(entry.runtime_data, line) for line in entry.options[CONF_LINE]
     )
 
 
@@ -58,11 +97,21 @@ class LondonTubeSensor(CoordinatorEntity[LondonTubeCoordinator], SensorEntity):
 
     _attr_attribution = "Powered by TfL Open Data"
     _attr_icon = "mdi:subway"
+    _attr_has_entity_name = True  # Use modern entity naming
 
     def __init__(self, coordinator: LondonTubeCoordinator, name: str) -> None:
         """Initialize the London Underground sensor."""
         super().__init__(coordinator)
         self._name = name
+        # Add unique_id for proper entity registry
+        self._attr_unique_id = f"tube_{name.lower().replace(' ', '_')}"
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, DOMAIN)},
+            name="London Underground",
+            manufacturer="Transport for London",
+            model="Tube Status",
+            entry_type=DeviceEntryType.SERVICE,
+        )
 
     @property
     def name(self) -> str: