mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
219 lines
7.2 KiB
Python
219 lines
7.2 KiB
Python
"""Config flow for System Bridge integration."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from collections.abc import Mapping
|
|
import logging
|
|
from typing import Any
|
|
|
|
import async_timeout
|
|
from systembridgeconnector.exceptions import (
|
|
AuthenticationException,
|
|
ConnectionClosedException,
|
|
ConnectionErrorException,
|
|
)
|
|
from systembridgeconnector.models.get_data import GetData
|
|
from systembridgeconnector.models.system import System
|
|
from systembridgeconnector.websocket_client import WebSocketClient
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import config_entries, exceptions
|
|
from homeassistant.components import zeroconf
|
|
from homeassistant.const import CONF_API_KEY, CONF_HOST, CONF_PORT
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResult
|
|
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__)
|
|
|
|
STEP_AUTHENTICATE_DATA_SCHEMA = vol.Schema({vol.Required(CONF_API_KEY): cv.string})
|
|
STEP_USER_DATA_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_PORT, default=9170): cv.string,
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
async def _validate_input(
|
|
hass: HomeAssistant,
|
|
data: dict[str, Any],
|
|
) -> dict[str, str]:
|
|
"""Validate the user input allows us to connect.
|
|
|
|
Data has the keys from STEP_USER_DATA_SCHEMA with values provided by the user.
|
|
"""
|
|
host = data[CONF_HOST]
|
|
|
|
websocket_client = WebSocketClient(
|
|
host,
|
|
data[CONF_PORT],
|
|
data[CONF_API_KEY],
|
|
)
|
|
try:
|
|
async with async_timeout.timeout(30):
|
|
await websocket_client.connect(session=async_get_clientsession(hass))
|
|
hass.async_create_task(websocket_client.listen())
|
|
response = await websocket_client.get_data(GetData(modules=["system"]))
|
|
_LOGGER.debug("Got response: %s", response.json())
|
|
if response.data is None or not isinstance(response.data, System):
|
|
raise CannotConnect("No data received")
|
|
system: System = response.data
|
|
except AuthenticationException as exception:
|
|
_LOGGER.warning(
|
|
"Authentication error when connecting to %s: %s", data[CONF_HOST], exception
|
|
)
|
|
raise InvalidAuth from exception
|
|
except (
|
|
ConnectionClosedException,
|
|
ConnectionErrorException,
|
|
) as exception:
|
|
_LOGGER.warning(
|
|
"Connection error when connecting to %s: %s", data[CONF_HOST], exception
|
|
)
|
|
raise CannotConnect from exception
|
|
except asyncio.TimeoutError as exception:
|
|
_LOGGER.warning("Timed out connecting to %s: %s", data[CONF_HOST], exception)
|
|
raise CannotConnect from exception
|
|
except ValueError as exception:
|
|
raise CannotConnect from exception
|
|
|
|
_LOGGER.debug("Got System data: %s", system.json())
|
|
|
|
return {"hostname": host, "uuid": system.uuid}
|
|
|
|
|
|
async def _async_get_info(
|
|
hass: HomeAssistant,
|
|
user_input: dict[str, Any],
|
|
) -> tuple[dict[str, str], dict[str, str] | None]:
|
|
errors = {}
|
|
|
|
try:
|
|
info = await _validate_input(hass, user_input)
|
|
except CannotConnect:
|
|
errors["base"] = "cannot_connect"
|
|
except InvalidAuth:
|
|
errors["base"] = "invalid_auth"
|
|
except Exception: # pylint: disable=broad-except
|
|
_LOGGER.exception("Unexpected exception")
|
|
errors["base"] = "unknown"
|
|
else:
|
|
return errors, info
|
|
|
|
return errors, None
|
|
|
|
|
|
class ConfigFlow(
|
|
config_entries.ConfigFlow,
|
|
domain=DOMAIN,
|
|
):
|
|
"""Handle a config flow for System Bridge."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(self):
|
|
"""Initialize flow."""
|
|
self._name: str | None = None
|
|
self._input: dict[str, Any] = {}
|
|
self._reauth = False
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResult:
|
|
"""Handle the initial step."""
|
|
if user_input is None:
|
|
return self.async_show_form(
|
|
step_id="user", data_schema=STEP_USER_DATA_SCHEMA
|
|
)
|
|
|
|
errors, info = await _async_get_info(self.hass, user_input)
|
|
if not errors and info is not None:
|
|
# Check if already configured
|
|
await self.async_set_unique_id(info["uuid"], raise_on_progress=False)
|
|
self._abort_if_unique_id_configured(updates={CONF_HOST: info["hostname"]})
|
|
|
|
return self.async_create_entry(title=info["hostname"], data=user_input)
|
|
|
|
return self.async_show_form(
|
|
step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
|
|
)
|
|
|
|
async def async_step_authenticate(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResult:
|
|
"""Handle getting the api-key for authentication."""
|
|
errors: dict[str, str] = {}
|
|
|
|
if user_input is not None:
|
|
user_input = {**self._input, **user_input}
|
|
errors, info = await _async_get_info(self.hass, user_input)
|
|
if not errors and info is not None:
|
|
# Check if already configured
|
|
existing_entry = await self.async_set_unique_id(info["uuid"])
|
|
|
|
if self._reauth and existing_entry:
|
|
self.hass.config_entries.async_update_entry(
|
|
existing_entry, data=user_input
|
|
)
|
|
await self.hass.config_entries.async_reload(existing_entry.entry_id)
|
|
return self.async_abort(reason="reauth_successful")
|
|
|
|
self._abort_if_unique_id_configured(
|
|
updates={CONF_HOST: info["hostname"]}
|
|
)
|
|
|
|
return self.async_create_entry(title=info["hostname"], data=user_input)
|
|
|
|
return self.async_show_form(
|
|
step_id="authenticate",
|
|
data_schema=STEP_AUTHENTICATE_DATA_SCHEMA,
|
|
description_placeholders={"name": self._name},
|
|
errors=errors,
|
|
)
|
|
|
|
async def async_step_zeroconf(
|
|
self, discovery_info: zeroconf.ZeroconfServiceInfo
|
|
) -> FlowResult:
|
|
"""Handle zeroconf discovery."""
|
|
properties = discovery_info.properties
|
|
host = properties.get("ip")
|
|
uuid = properties.get("uuid")
|
|
|
|
if host is None or uuid is None:
|
|
return self.async_abort(reason="unknown")
|
|
|
|
# Check if already configured
|
|
await self.async_set_unique_id(uuid)
|
|
self._abort_if_unique_id_configured(updates={CONF_HOST: host})
|
|
|
|
self._name = host
|
|
self._input = {
|
|
CONF_HOST: host,
|
|
CONF_PORT: properties.get("port"),
|
|
}
|
|
|
|
return await self.async_step_authenticate()
|
|
|
|
async def async_step_reauth(self, entry_data: Mapping[str, Any]) -> FlowResult:
|
|
"""Perform reauth upon an API authentication error."""
|
|
self._name = entry_data[CONF_HOST]
|
|
self._input = {
|
|
CONF_HOST: entry_data[CONF_HOST],
|
|
CONF_PORT: entry_data[CONF_PORT],
|
|
}
|
|
self._reauth = True
|
|
return await self.async_step_authenticate()
|
|
|
|
|
|
class CannotConnect(exceptions.HomeAssistantError):
|
|
"""Error to indicate we cannot connect."""
|
|
|
|
|
|
class InvalidAuth(exceptions.HomeAssistantError):
|
|
"""Error to indicate there is invalid auth."""
|