mirror of
https://github.com/home-assistant/core.git
synced 2026-08-24 10:13:52 -05:00
124 lines
3.8 KiB
Python
124 lines
3.8 KiB
Python
"""Config flow for AirNow integration."""
|
|
|
|
import logging
|
|
from typing import Any, override
|
|
|
|
from pyairnow import WebServiceAPI
|
|
from pyairnow.errors import AirNowError, EmptyResponseError, InvalidKeyError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
|
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
|
|
|
from .const import DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
# Documentation URL for API key generation
|
|
_API_KEY_URL = "https://docs.airnowapi.org/account/request/"
|
|
|
|
|
|
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> bool:
|
|
"""Validate the user input allows us to connect.
|
|
|
|
Data has the keys from DATA_SCHEMA with values provided by the user.
|
|
"""
|
|
session = async_get_clientsession(hass)
|
|
client = WebServiceAPI(data[CONF_API_KEY], session=session)
|
|
|
|
lat = data[CONF_LATITUDE]
|
|
lng = data[CONF_LONGITUDE]
|
|
|
|
# Check that the provided latitude/longitude provide a response
|
|
try:
|
|
test_data = await client.observations.latLong(lat, lng)
|
|
|
|
except InvalidKeyError as exc:
|
|
raise InvalidAuth from exc
|
|
except AirNowError as exc:
|
|
raise CannotConnect from exc
|
|
except EmptyResponseError as exc:
|
|
raise InvalidLocation from exc
|
|
|
|
if not test_data:
|
|
raise InvalidLocation
|
|
|
|
# Validation Succeeded
|
|
return True
|
|
|
|
|
|
class AirNowConfigFlow(ConfigFlow, domain=DOMAIN):
|
|
"""Handle a config flow for AirNow."""
|
|
|
|
VERSION = 3
|
|
|
|
@override
|
|
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:
|
|
# Set a unique id based on latitude/longitude
|
|
await self.async_set_unique_id(
|
|
f"{user_input[CONF_LATITUDE]}-{user_input[CONF_LONGITUDE]}"
|
|
)
|
|
self._abort_if_unique_id_configured()
|
|
|
|
try:
|
|
# Validate inputs
|
|
await validate_input(self.hass, user_input)
|
|
|
|
except CannotConnect:
|
|
errors["base"] = "cannot_connect"
|
|
except InvalidAuth:
|
|
errors["base"] = "invalid_auth"
|
|
except InvalidLocation:
|
|
errors["base"] = "invalid_location"
|
|
except Exception:
|
|
_LOGGER.exception("Unexpected exception")
|
|
errors["base"] = "unknown"
|
|
else:
|
|
# Create Entry
|
|
return self.async_create_entry(
|
|
title=(
|
|
f"AirNow Sensor at {user_input[CONF_LATITUDE]},"
|
|
f" {user_input[CONF_LONGITUDE]}"
|
|
),
|
|
data=user_input,
|
|
)
|
|
|
|
return self.async_show_form(
|
|
step_id="user",
|
|
data_schema=vol.Schema(
|
|
{
|
|
vol.Required(CONF_API_KEY): str,
|
|
vol.Optional(
|
|
CONF_LATITUDE, default=self.hass.config.latitude
|
|
): cv.latitude,
|
|
vol.Optional(
|
|
CONF_LONGITUDE, default=self.hass.config.longitude
|
|
): cv.longitude,
|
|
}
|
|
),
|
|
description_placeholders={"api_key_url": _API_KEY_URL},
|
|
errors=errors,
|
|
)
|
|
|
|
|
|
class CannotConnect(HomeAssistantError):
|
|
"""Error to indicate we cannot connect."""
|
|
|
|
|
|
class InvalidAuth(HomeAssistantError):
|
|
"""Error to indicate there is invalid auth."""
|
|
|
|
|
|
class InvalidLocation(HomeAssistantError):
|
|
"""Error to indicate the location is invalid."""
|