config_flow.py

Go to the documentation of this file.

"""Define a config flow manager for AirVisual Pro."""
 
from __future__ import annotations
 
from collections.abc import Mapping
from dataclasses import dataclass, field
from typing import Any
 
from pyairvisual.node import (
    InvalidAuthenticationError,
    NodeConnectionError,
    NodeProError,
    NodeSamba,
)
import voluptuous as vol
 
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_IP_ADDRESS, CONF_PASSWORD
 
from .const import DOMAIN, LOGGER
 
STEP_REAUTH_SCHEMA = vol.Schema(
    {
        vol.Required(CONF_PASSWORD): str,
    }
)
 
STEP_USER_SCHEMA = vol.Schema(
    {
        vol.Required(CONF_IP_ADDRESS): str,
        vol.Required(CONF_PASSWORD): str,
    }
)
 
 
@dataclass
class ValidationResult:
    """Define a validation result."""
 
    serial_number: str | None = None
    errors: dict[str, Any] = field(default_factory=dict)
 
 
async def async_validate_credentials(
    ip_address: str, password: str
) -> ValidationResult:
    """Validate an IP address/password combo."""
    node = NodeSamba(ip_address, password)
    errors = {}
 
    try:
        await node.async_connect()
        measurements = await node.async_get_latest_measurements()
    except InvalidAuthenticationError as err:
        LOGGER.error("Invalid password for Pro at IP address %s: %s", ip_address, err)
        errors["base"] = "invalid_auth"
    except NodeConnectionError as err:
        LOGGER.error("Cannot connect to Pro at IP address %s: %s", ip_address, err)
        errors["base"] = "cannot_connect"
    except NodeProError as err:
        LOGGER.error("Unknown Pro error while connecting to %s: %s", ip_address, err)
        errors["base"] = "unknown"
    except Exception as err:  # noqa: BLE001
        LOGGER.exception("Unknown error while connecting to %s: %s", ip_address, err)
        errors["base"] = "unknown"
    else:
        return ValidationResult(serial_number=measurements["serial_number"])
    finally:
        await node.async_disconnect()
 
    return ValidationResult(errors=errors)
 
 
class AirVisualProFlowHandler(ConfigFlow, domain=DOMAIN):
    """Handle an AirVisual Pro config flow."""
 
    VERSION = 1
 
    _reauth_entry_data: Mapping[str, Any]
 
    async def async_step_import(self, import_data: dict[str, Any]) -> ConfigFlowResult:
        """Import a config entry from `airvisual` integration (see #83882)."""
        return await self.async_step_userasync_step_userasync_step_user(import_data)
 
    async def async_step_reauth(
        self, entry_data: Mapping[str, Any]
    ) -> ConfigFlowResult:
        """Handle configuration by re-auth."""
        self._reauth_entry_data_reauth_entry_data = entry_data
        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 the re-auth step."""
        if user_input is None:
            return self.async_show_formasync_show_formasync_show_form(
                step_id="reauth_confirm", data_schema=STEP_REAUTH_SCHEMA
            )
 
        validation_result = await async_validate_credentials(
            self._reauth_entry_data_reauth_entry_data[CONF_IP_ADDRESS], user_input[CONF_PASSWORD]
        )
 
        if validation_result.errors:
            return self.async_show_formasync_show_formasync_show_form(
                step_id="reauth_confirm",
                data_schema=STEP_REAUTH_SCHEMA,
                errors=validation_result.errors,
            )
 
        return self.async_update_reload_and_abortasync_update_reload_and_abort(
            self._get_reauth_entry_get_reauth_entry(), data_updates=user_input
        )
 
    async def async_step_user(
        self, user_input: dict[str, str] | None = None
    ) -> ConfigFlowResult:
        """Handle the initial step."""
        if not user_input:
            return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=STEP_USER_SCHEMA)
 
        ip_address = user_input[CONF_IP_ADDRESS]
 
        validation_result = await async_validate_credentials(
            ip_address, user_input[CONF_PASSWORD]
        )
 
        if validation_result.errors:
            return self.async_show_formasync_show_formasync_show_form(
                step_id="user",
                data_schema=STEP_USER_SCHEMA,
                errors=validation_result.errors,
            )
 
        await self.async_set_unique_idasync_set_unique_id(validation_result.serial_number)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured()
 
        return self.async_create_entryasync_create_entryasync_create_entry(title=ip_address, data=user_input)