7678be8e2b
Simplify config flow for suez water. Counter_id can now be automatically be fetched by the integration. The value is provided only in the source code of suez website and therefore not easily accessible to user not familiar with devlopment. Still possible to explicitly set the value for user with multiple value or value defined elsewhere.
95 lines
2.8 KiB
Python
95 lines
2.8 KiB
Python
"""Config flow for Suez Water integration."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import Any
|
|
|
|
from pysuez import PySuezError, SuezClient
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
|
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
|
|
from .const import CONF_COUNTER_ID, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
STEP_USER_DATA_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(CONF_USERNAME): str,
|
|
vol.Required(CONF_PASSWORD): str,
|
|
vol.Optional(CONF_COUNTER_ID): str,
|
|
}
|
|
)
|
|
|
|
|
|
async def validate_input(data: dict[str, Any]) -> None:
|
|
"""Validate the user input allows us to connect.
|
|
|
|
Data has the keys from STEP_USER_DATA_SCHEMA with values provided by the user.
|
|
"""
|
|
try:
|
|
counter_id = data.get(CONF_COUNTER_ID)
|
|
client = SuezClient(
|
|
data[CONF_USERNAME],
|
|
data[CONF_PASSWORD],
|
|
counter_id,
|
|
)
|
|
if not await client.check_credentials():
|
|
raise InvalidAuth
|
|
except PySuezError as ex:
|
|
raise CannotConnect from ex
|
|
|
|
if counter_id is None:
|
|
try:
|
|
data[CONF_COUNTER_ID] = await client.find_counter()
|
|
except PySuezError as ex:
|
|
raise CounterNotFound from ex
|
|
|
|
|
|
class SuezWaterConfigFlow(ConfigFlow, domain=DOMAIN):
|
|
"""Handle a config flow for Suez Water."""
|
|
|
|
VERSION = 1
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> ConfigFlowResult:
|
|
"""Handle the initial step."""
|
|
errors: dict[str, str] = {}
|
|
if user_input is not None:
|
|
await self.async_set_unique_id(user_input[CONF_USERNAME])
|
|
self._abort_if_unique_id_configured()
|
|
try:
|
|
await validate_input(user_input)
|
|
except CannotConnect:
|
|
errors["base"] = "cannot_connect"
|
|
except InvalidAuth:
|
|
errors["base"] = "invalid_auth"
|
|
except CounterNotFound:
|
|
errors["base"] = "counter_not_found"
|
|
except Exception:
|
|
_LOGGER.exception("Unexpected exception")
|
|
errors["base"] = "unknown"
|
|
else:
|
|
return self.async_create_entry(
|
|
title=user_input[CONF_USERNAME], data=user_input
|
|
)
|
|
|
|
return self.async_show_form(
|
|
step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
|
|
)
|
|
|
|
|
|
class CannotConnect(HomeAssistantError):
|
|
"""Error to indicate we cannot connect."""
|
|
|
|
|
|
class InvalidAuth(HomeAssistantError):
|
|
"""Error to indicate there is invalid auth."""
|
|
|
|
|
|
class CounterNotFound(HomeAssistantError):
|
|
"""Error to indicate we cannot automatically found the counter id."""
|