Define config flow

home-assistant · joostlek · Jun 23, 2025 · Feb 23, 2025 · Feb 23, 2025 · Feb 23, 2025
commit f13ecb3c1d0654f15b9532c03906e7206bac9ee5
diff --git a/homeassistant/components/tilt_pi/config_flow.py b/homeassistant/components/tilt_pi/config_flow.py
@@ -1,18 +1,66 @@
-"""Config flow for the Tilt Pi integration."""
+"""Config flow for Tilt Pi integration."""
 
-import my_pypi_dependency
+from __future__ import annotations
 
-from homeassistant.core import HomeAssistant
-from homeassistant.helpers import config_entry_flow
+from typing import Any
+
+import aiohttp
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PORT
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .const import DOMAIN
 
+USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_NAME): str,
+        vol.Required(CONF_HOST): str,
+        vol.Optional(CONF_PORT, default=1880): int,
+    }
+)
+
+
+class TiltPiConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Tilt Pi."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial configuration step."""
+
+        if user_input is None:
+            return self.async_show_form(
+                step_id="user",
+                data_schema=USER_DATA_SCHEMA,
+            )
+
+        # Check if device is already configured
+        await self.async_set_unique_id(f"tiltpi_{user_input[CONF_HOST]}")
+        self._abort_if_unique_id_configured()
 
-async def _async_has_devices(hass: HomeAssistant) -> bool:
-    """Return if there are devices that can be discovered."""
-    # TODO Check if there are any devices that can be discovered in the network.
-    devices = await hass.async_add_executor_job(my_pypi_dependency.discover)
-    return len(devices) > 0
+        errors = {}
 
+        try:
+            session = async_get_clientsession(self.hass)
+            async with session.get(
+                f"http://{user_input[CONF_HOST]}:{user_input[CONF_PORT]}/macid/all",
+                timeout=aiohttp.ClientTimeout(10),
+            ) as resp:
+                resp.raise_for_status()
+                await resp.json()
 
-config_entry_flow.register_discovery_flow(DOMAIN, "Tilt Pi", _async_has_devices)
+            return self.async_create_entry(
+                title=user_input[CONF_NAME],
+                data=user_input,
+            )
+        except (TimeoutError, aiohttp.ClientError):
+            errors["base"] = "cannot_connect"
+            return self.async_show_form(
+                step_id="user",
+                data_schema=USER_DATA_SCHEMA,
+                errors=errors,
+            )
diff --git a/tests/components/tilt_pi/conftest.py b/tests/components/tilt_pi/conftest.py
@@ -0,0 +1,16 @@
+"""Common fixtures for the Tilt Pi tests."""
+
+import pytest
+
+
+@pytest.fixture
+def tiltpi_api_all_response() -> list[dict[str, any]]:
+    """Fixture for TiltPi API response."""
+    return [
+        {
+            "mac": "00:1A:2B:3C:4D:5E",
+            "Color": "red",
+            "Temp": "68.5",
+            "SG": "1.052",
+        }
+    ]
diff --git a/tests/components/tilt_pi/test_config_flow.py b/tests/components/tilt_pi/test_config_flow.py
@@ -0,0 +1,83 @@
+"""Test the Tilt config flow."""
+
+from typing import Final
+
+import aiohttp
+
+from homeassistant import config_entries
+from homeassistant.components.tilt_pi.const import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PORT
+from homeassistant.core import HomeAssistant
+from homeassistant.data_entry_flow import FlowResultType
+
+from tests.test_util.aiohttp import AiohttpClientMocker
+
+TEST_TILTPI_DATA: Final = {
+    CONF_NAME: "Test TiltPi",
+    CONF_HOST: "192.168.1.100",
+    CONF_PORT: 1880,
+}
+
+
+async def test_async_step_user_gets_form(hass: HomeAssistant) -> None:
+    """Test that we can view the form when there is no previous user input."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN,
+        context={"source": config_entries.SOURCE_USER},
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] is None
+
+
+async def test_async_step_user_creates_entry(
+    hass: HomeAssistant,
+    aioclient_mock: AiohttpClientMocker,
+    tiltpi_api_all_response: list[dict[str, any]],
+) -> None:
+    """Test that the config flow creates an entry."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN,
+        context={"source": config_entries.SOURCE_USER},
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] is None
+
+    aioclient_mock.get(
+        "http://192.168.1.100:1880/macid/all",
+        json=tiltpi_api_all_response,
+    )
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input=TEST_TILTPI_DATA,
+    )
+    await hass.async_block_till_done()
+
+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["data"] == TEST_TILTPI_DATA
+
+
+async def test_async_step_user_returns_error_form_client_error(
+    hass: HomeAssistant, aioclient_mock: AiohttpClientMocker
+) -> None:
+    """Test that the config flow creates an entry."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN,
+        context={"source": config_entries.SOURCE_USER},
+    )
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] is None
+
+    aioclient_mock.get(
+        "http://192.168.1.100:1880/macid/all",
+        exc=aiohttp.ClientError,
+    )
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input=TEST_TILTPI_DATA,
+    )
+    await hass.async_block_till_done()
+
+    assert result["type"] is FlowResultType.FORM
+    assert result["errors"] == {"base": "cannot_connect"}