config_flow.py

Go to the documentation of this file.

"""Config flow to configure the devolo home control integration."""
 
from __future__ import annotations
 
from collections.abc import Mapping
from typing import Any
 
import voluptuous as vol
 
from homeassistant.components import zeroconf
from homeassistant.config_entries import (
    SOURCE_REAUTH,
    ConfigEntry,
    ConfigFlow,
    ConfigFlowResult,
)
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import callback
 
from . import configure_mydevolo
from .const import CONF_MYDEVOLO, DEFAULT_MYDEVOLO, DOMAIN, SUPPORTED_MODEL_TYPES
from .exceptions import CredentialsInvalid, UuidChanged
 
 
class DevoloHomeControlFlowHandler(ConfigFlow, domain=DOMAIN):
    """Handle a devolo HomeControl config flow."""
 
    VERSION = 1
 
    _reauth_entry: ConfigEntry
 
    def __init__(self) -> None:
        """Initialize devolo Home Control flow."""
        self.data_schemadata_schema = {
            vol.Required(CONF_USERNAME): str,
            vol.Required(CONF_PASSWORD): str,
        }
        self._url_url = DEFAULT_MYDEVOLO
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initiated by the user."""
        if self.show_advanced_optionsshow_advanced_options:
            self.data_schemadata_schema[vol.Required(CONF_MYDEVOLO, default=self._url_url)] = str
        if user_input is None:
            return self._show_form_show_form(step_id="user")
        try:
            return await self._connect_mydevolo_connect_mydevolo(user_input)
        except CredentialsInvalid:
            return self._show_form_show_form(step_id="user", errors={"base": "invalid_auth"})
 
    async def async_step_zeroconf(
        self, discovery_info: zeroconf.ZeroconfServiceInfo
    ) -> ConfigFlowResult:
        """Handle zeroconf discovery."""
        # Check if it is a gateway
        if discovery_info.properties.get("MT") in SUPPORTED_MODEL_TYPES:
            await self._async_handle_discovery_without_unique_id_async_handle_discovery_without_unique_id()
            return await self.async_step_zeroconf_confirmasync_step_zeroconf_confirm()
        return self.async_abortasync_abortasync_abort(reason="Not a devolo Home Control gateway.")
 
    async def async_step_zeroconf_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initiated by zeroconf."""
        if user_input is None:
            return self._show_form_show_form(step_id="zeroconf_confirm")
        try:
            return await self._connect_mydevolo_connect_mydevolo(user_input)
        except CredentialsInvalid:
            return self._show_form_show_form(
                step_id="zeroconf_confirm", errors={"base": "invalid_auth"}
            )
 
    async def async_step_reauth(
        self, entry_data: Mapping[str, Any]
    ) -> ConfigFlowResult:
        """Handle reauthentication."""
        self._reauth_entry_reauth_entry = self._get_reauth_entry_get_reauth_entry()
        self._url_url = entry_data[CONF_MYDEVOLO]
        self.data_schemadata_schema = {
            vol.Required(CONF_USERNAME, default=entry_data[CONF_USERNAME]): str,
            vol.Required(CONF_PASSWORD): str,
        }
        return await self.async_step_reauth_confirmasync_step_reauth_confirm()
 
    async def async_step_reauth_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initiated by reauthentication."""
        if user_input is None:
            return self._show_form_show_form(step_id="reauth_confirm")
        try:
            return await self._connect_mydevolo_connect_mydevolo(user_input)
        except CredentialsInvalid:
            return self._show_form_show_form(
                step_id="reauth_confirm", errors={"base": "invalid_auth"}
            )
        except UuidChanged:
            return self._show_form_show_form(
                step_id="reauth_confirm", errors={"base": "reauth_failed"}
            )
 
    async def _connect_mydevolo(self, user_input: dict[str, Any]) -> ConfigFlowResult:
        """Connect to mydevolo."""
        user_input[CONF_MYDEVOLO] = user_input.get(CONF_MYDEVOLO, self._url_url)
        mydevolo = configure_mydevolo(conf=user_input)
        credentials_valid = await self.hass.async_add_executor_job(
            mydevolo.credentials_valid
        )
        if not credentials_valid:
            raise CredentialsInvalid
        uuid = await self.hass.async_add_executor_job(mydevolo.uuid)
 
        if self.sourcesourcesource != SOURCE_REAUTH:
            await self.async_set_unique_idasync_set_unique_id(uuid)
            self._abort_if_unique_id_configured_abort_if_unique_id_configured()
            return self.async_create_entryasync_create_entryasync_create_entry(
                title="devolo Home Control",
                data={
                    CONF_PASSWORD: mydevolo.password,
                    CONF_USERNAME: mydevolo.user,
                    CONF_MYDEVOLO: mydevolo.url,
                },
            )
 
        if self._reauth_entry_reauth_entry.unique_id != uuid:
            # The old user and the new user are not the same. This could mess-up everything as all unique IDs might change.
            raise UuidChanged
 
        return self.async_update_reload_and_abortasync_update_reload_and_abort(
            self._reauth_entry_reauth_entry, data=user_input, unique_id=uuid
        )
 
    @callback
    def _show_form(
        self, step_id: str, errors: dict[str, str] | None = None
    ) -> ConfigFlowResult:
        """Show the form to the user."""
        return self.async_show_formasync_show_formasync_show_form(
            step_id=step_id,
            data_schema=vol.Schema(self.data_schemadata_schema),
            errors=errors if errors else {},
        )