core/homeassistant/components/vallox/config_flow.py

133 lines
3.9 KiB
Python

"""Config flow for the Vallox integration."""
from __future__ import annotations
import logging
from typing import Any
from vallox_websocket_api import Vallox
from vallox_websocket_api.exceptions import ValloxApiException
import voluptuous as vol
from homeassistant import config_entries
from homeassistant.const import CONF_HOST, CONF_NAME
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResult
from homeassistant.exceptions import HomeAssistantError
from homeassistant.loader import async_get_integration
from homeassistant.util.network import is_ip_address
from .const import DEFAULT_NAME, DOMAIN
_LOGGER = logging.getLogger(__name__)
STEP_USER_DATA_SCHEMA = vol.Schema(
{
vol.Required(CONF_HOST): str,
}
)
VALLOX_CONNECTION_EXCEPTIONS = (
OSError,
ValloxApiException,
)
async def validate_host(hass: HomeAssistant, host: str) -> None:
"""Validate that the user input allows us to connect."""
if not is_ip_address(host):
raise InvalidHost(f"Invalid IP address: {host}")
client = Vallox(host)
await client.get_info()
class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle a config flow for the Vallox integration."""
VERSION = 1
async def async_step_import(self, data: dict[str, Any]) -> FlowResult:
"""Handle import from YAML."""
# We need to use the name from the YAML configuration to avoid
# breaking existing entity IDs.
name = data.get(CONF_NAME, DEFAULT_NAME)
host = data[CONF_HOST]
self._async_abort_entries_match({CONF_HOST: host})
reason = None
try:
await validate_host(self.hass, host)
except InvalidHost:
_LOGGER.error("An invalid host is configured for Vallox: %s", host)
reason = "invalid_host"
except VALLOX_CONNECTION_EXCEPTIONS:
_LOGGER.error("Cannot connect to Vallox host %s", host)
reason = "cannot_connect"
except Exception: # pylint: disable=broad-except
_LOGGER.exception("Unexpected exception")
reason = "unknown"
else:
return self.async_create_entry(
title=name,
data={
**data,
CONF_NAME: name,
},
)
return self.async_abort(reason=reason)
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle the initial step."""
integration = await async_get_integration(self.hass, DOMAIN)
if user_input is None:
return self.async_show_form(
step_id="user",
description_placeholders={
"integration_docs_url": integration.documentation
},
data_schema=STEP_USER_DATA_SCHEMA,
)
errors = {}
host = user_input[CONF_HOST]
self._async_abort_entries_match({CONF_HOST: host})
try:
await validate_host(self.hass, host)
except InvalidHost:
errors[CONF_HOST] = "invalid_host"
except VALLOX_CONNECTION_EXCEPTIONS:
errors[CONF_HOST] = "cannot_connect"
except Exception: # pylint: disable=broad-except
_LOGGER.exception("Unexpected exception")
errors[CONF_HOST] = "unknown"
else:
return self.async_create_entry(
title=DEFAULT_NAME,
data={
**user_input,
CONF_NAME: DEFAULT_NAME,
},
)
return self.async_show_form(
step_id="user",
description_placeholders={
"integration_docs_url": integration.documentation
},
data_schema=STEP_USER_DATA_SCHEMA,
errors=errors,
)
class InvalidHost(HomeAssistantError):
"""Error to indicate an invalid host was input."""