config_flow.py

Go to the documentation of this file.

"""Config flow for BSB-Lan integration."""
 
from __future__ import annotations
 
from typing import Any
 
from bsblan import BSBLAN, BSBLANConfig, BSBLANError
import voluptuous as vol
 
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
from homeassistant.core import callback
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.device_registry import format_mac
 
from .const import CONF_PASSKEY, DEFAULT_PORT, DOMAIN
 
 
class BSBLANFlowHandler(ConfigFlow, domain=DOMAIN):
    """Handle a BSBLAN config flow."""
 
    VERSION = 1
 
    host: str
    port: int
    mac: str
    passkey: str | None = None
    username: str | None = None
    password: str | None = None
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initiated by the user."""
        if user_input is None:
            return self._show_setup_form()
 
        self.hosthost = user_input[CONF_HOST]
        self.portport = user_input[CONF_PORT]
        self.passkeypasskey = user_input.get(CONF_PASSKEY)
        self.usernameusername = user_input.get(CONF_USERNAME)
        self.passwordpassword = user_input.get(CONF_PASSWORD)
 
        try:
            await self._get_bsblan_info()
        except BSBLANError:
            return self._show_setup_form({"base": "cannot_connect"})
 
        return self._async_create_entry()
 
    @callback
    def _show_setup_form(self, errors: dict | None = None) -> ConfigFlowResult:
        """Show the setup form to the user."""
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user",
            data_schema=vol.Schema(
                {
                    vol.Required(CONF_HOST): str,
                    vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
                    vol.Optional(CONF_PASSKEY): str,
                    vol.Optional(CONF_USERNAME): str,
                    vol.Optional(CONF_PASSWORD): str,
                }
            ),
            errors=errors or {},
        )
 
    @callback
    def _async_create_entry(self) -> ConfigFlowResult:
        return self.async_create_entryasync_create_entryasync_create_entry(
            title=format_mac(self.macmac),
            data={
                CONF_HOST: self.hosthost,
                CONF_PORT: self.portport,
                CONF_PASSKEY: self.passkeypasskey,
                CONF_USERNAME: self.usernameusername,
                CONF_PASSWORD: self.passwordpassword,
            },
        )
 
    async def _get_bsblan_info(self, raise_on_progress: bool = True) -> None:
        """Get device information from an BSBLAN device."""
        config = BSBLANConfig(
            host=self.hosthost,
            passkey=self.passkeypasskey,
            port=self.portport,
            username=self.usernameusername,
            password=self.passwordpassword,
        )
        session = async_get_clientsession(self.hass)
        bsblan = BSBLAN(config, session)
        device = await bsblan.device()
        self.macmac = device.MAC
 
        await self.async_set_unique_idasync_set_unique_id(
            format_mac(self.macmac), raise_on_progress=raise_on_progress
        )
        self._abort_if_unique_id_configured_abort_if_unique_id_configured(
            updates={
                CONF_HOST: self.hosthost,
                CONF_PORT: self.portport,
            }
        )