config_flow.py

Go to the documentation of this file.

"""Config flow for Met Office integration."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import datapoint
import voluptuous as vol
 
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import config_validation as cv
 
from .const import DOMAIN
from .helpers import fetch_site
 
_LOGGER = logging.getLogger(__name__)
 
 
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> dict[str, str]:
    """Validate that the user input allows us to connect to DataPoint.
 
    Data has the keys from DATA_SCHEMA with values provided by the user.
    """
    latitude = data[CONF_LATITUDE]
    longitude = data[CONF_LONGITUDE]
    api_key = data[CONF_API_KEY]
 
    connection = datapoint.connection(api_key=api_key)
 
    site = await hass.async_add_executor_job(
        fetch_site, connection, latitude, longitude
    )
 
    if site is None:
        raise CannotConnect
 
    return {"site_name": site.name}
 
 
class MetOfficeConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Met Office weather integration."""
 
    VERSION = 1
 
    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:
            await self.async_set_unique_idasync_set_unique_id(
                f"{user_input[CONF_LATITUDE]}_{user_input[CONF_LONGITUDE]}"
            )
            self._abort_if_unique_id_configured_abort_if_unique_id_configured()
 
            try:
                info = await validate_input(self.hass, user_input)
            except CannotConnect:
                errors["base"] = "cannot_connect"
            except Exception:
                _LOGGER.exception("Unexpected exception")
                errors["base"] = "unknown"
            else:
                user_input[CONF_NAME] = info["site_name"]
                return self.async_create_entryasync_create_entryasync_create_entry(
                    title=user_input[CONF_NAME], data=user_input
                )
 
        data_schema = vol.Schema(
            {
                vol.Required(CONF_API_KEY): str,
                vol.Required(
                    CONF_LATITUDE, default=self.hass.config.latitude
                ): cv.latitude,
                vol.Required(
                    CONF_LONGITUDE, default=self.hass.config.longitude
                ): cv.longitude,
            },
        )
 
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user", data_schema=data_schema, errors=errors
        )
 
 
class CannotConnect(HomeAssistantError):
    """Error to indicate we cannot connect."""