config_flow.py

Go to the documentation of this file.

"""Config flow for Steamist integration."""
 
from __future__ import annotations
 
import logging
from typing import Any, Self
 
from aiosteamist import Steamist
from discovery30303 import Device30303, normalize_mac
import voluptuous as vol
 
from homeassistant.components import dhcp
from homeassistant.config_entries import ConfigEntryState, ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_DEVICE, CONF_HOST, CONF_MODEL, CONF_NAME
from homeassistant.core import callback
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.typing import DiscoveryInfoType
 
from .const import CONNECTION_EXCEPTIONS, DISCOVER_SCAN_TIMEOUT, DOMAIN
from .discovery import (
    async_discover_device,
    async_discover_devices,
    async_is_steamist_device,
    async_update_entry_from_discovery,
)
 
_LOGGER = logging.getLogger(__name__)
 
 
class SteamistConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Steamist."""
 
    VERSION = 1
 
    host: str | None = None
 
    def __init__(self) -> None:
        """Initialize the config flow."""
        self._discovered_devices_discovered_devices: dict[str, Device30303] = {}
        self._discovered_device_discovered_device: Device30303 | None = None
 
    async def async_step_dhcp(
        self, discovery_info: dhcp.DhcpServiceInfo
    ) -> ConfigFlowResult:
        """Handle discovery via dhcp."""
        self._discovered_device_discovered_device = Device30303(
            ipaddress=discovery_info.ip,
            name="",
            mac=normalize_mac(discovery_info.macaddress),
            hostname=discovery_info.hostname,
        )
        return await self._async_handle_discovery_async_handle_discovery()
 
    async def async_step_integration_discovery(
        self, discovery_info: DiscoveryInfoType
    ) -> ConfigFlowResult:
        """Handle integration discovery."""
        self._discovered_device_discovered_device = Device30303(
            ipaddress=discovery_info["ipaddress"],
            name=discovery_info["name"],
            mac=discovery_info["mac"],
            hostname=discovery_info["hostname"],
        )
        return await self._async_handle_discovery_async_handle_discovery()
 
    async def _async_handle_discovery(self) -> ConfigFlowResult:
        """Handle any discovery."""
        device = self._discovered_device_discovered_device
        assert device is not None
        mac_address = device.mac
        mac = dr.format_mac(mac_address)
        host = device.ipaddress
        await self.async_set_unique_idasync_set_unique_id(mac)
        for entry in self._async_current_entries_async_current_entries(include_ignore=False):
            if entry.unique_id == mac or entry.data[CONF_HOST] == host:
                if (
                    async_update_entry_from_discovery(self.hass, entry, device)
                    and entry.state is not ConfigEntryState.SETUP_IN_PROGRESS
                ):
                    self.hass.config_entries.async_schedule_reload(entry.entry_id)
                return self.async_abortasync_abortasync_abort(reason="already_configured")
        self.hosthost = host
        if self.hass.config_entries.flow.async_has_matching_flow(self):
            return self.async_abortasync_abortasync_abort(reason="already_in_progress")
        if not device.name:
            discovery = await async_discover_device(self.hass, device.ipaddress)
            if not discovery:
                return self.async_abortasync_abortasync_abort(reason="cannot_connect")
            self._discovered_device_discovered_device = discovery
        assert self._discovered_device_discovered_device is not None
        if not async_is_steamist_device(self._discovered_device_discovered_device):
            return self.async_abortasync_abortasync_abort(reason="not_steamist_device")
        return await self.async_step_discovery_confirmasync_step_discovery_confirm()
 
    def is_matching(self, other_flow: Self) -> bool:
        """Return True if other_flow is matching this flow."""
        return other_flow.host == self.hosthost
 
    async def async_step_discovery_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Confirm discovery."""
        assert self._discovered_device_discovered_device is not None
        device = self._discovered_device_discovered_device
        if user_input is not None:
            return self._async_create_entry_from_device_async_create_entry_from_device(self._discovered_device_discovered_device)
        self._set_confirm_only_set_confirm_only()
        placeholders = {
            "name": device.name,
            "ipaddress": device.ipaddress,
        }
        self.context["title_placeholders"] = placeholders
        return self.async_show_formasync_show_formasync_show_form(
            step_id="discovery_confirm", description_placeholders=placeholders
        )
 
    @callback
    def _async_create_entry_from_device(self, device: Device30303) -> ConfigFlowResult:
        """Create a config entry from a device."""
        self._async_abort_entries_match_async_abort_entries_match({CONF_HOST: device.ipaddress})
        data = {CONF_HOST: device.ipaddress, CONF_NAME: device.name}
        if device.hostname:
            data[CONF_MODEL] = device.hostname.split("-", maxsplit=1)[0]
        return self.async_create_entryasync_create_entryasync_create_entry(
            title=device.name,
            data=data,
        )
 
    async def async_step_pick_device(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the step to pick discovered device."""
        if user_input is not None:
            mac = user_input[CONF_DEVICE]
            await self.async_set_unique_idasync_set_unique_id(mac, raise_on_progress=False)
            device = self._discovered_devices_discovered_devices[mac]
            return self._async_create_entry_from_device_async_create_entry_from_device(device)
 
        current_unique_ids = self._async_current_ids_async_current_ids()
        current_hosts = {
            entry.data[CONF_HOST]
            for entry in self._async_current_entries_async_current_entries(include_ignore=False)
        }
        self._discovered_devices_discovered_devices = {
            dr.format_mac(device.mac): device
            for device in await async_discover_devices(self.hass, DISCOVER_SCAN_TIMEOUT)
        }
        devices_name = {
            mac: f"{device.name} ({device.ipaddress})"
            for mac, device in self._discovered_devices_discovered_devices.items()
            if mac not in current_unique_ids and device.ipaddress not in current_hosts
        }
        # Check if there is at least one device
        if not devices_name:
            return self.async_abortasync_abortasync_abort(reason="no_devices_found")
        return self.async_show_formasync_show_formasync_show_form(
            step_id="pick_device",
            data_schema=vol.Schema({vol.Required(CONF_DEVICE): vol.In(devices_name)}),
        )
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the initial step."""
        errors = {}
 
        if user_input is not None:
            if not (host := user_input[CONF_HOST]):
                return await self.async_step_pick_deviceasync_step_pick_device()
            websession = async_get_clientsession(self.hass)
            try:
                await Steamist(host, websession).async_get_status()
            except CONNECTION_EXCEPTIONS:
                errors["base"] = "cannot_connect"
            except Exception:
                _LOGGER.exception("Unexpected exception")
                errors["base"] = "unknown"
            else:
                if discovery := await async_discover_device(self.hass, host):
                    await self.async_set_unique_idasync_set_unique_id(
                        dr.format_mac(discovery.mac), raise_on_progress=False
                    )
                    return self._async_create_entry_from_device_async_create_entry_from_device(discovery)
                self._async_abort_entries_match_async_abort_entries_match({CONF_HOST: host})
                return self.async_create_entryasync_create_entryasync_create_entry(title=host, data=user_input)
 
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user",
            data_schema=vol.Schema({vol.Optional(CONF_HOST, default=""): str}),
            errors=errors,
        )