Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Ecoforest integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from httpx import BasicAuth
9 from pyecoforest.api import EcoforestApi
10 from pyecoforest.exceptions import EcoforestAuthenticationRequired
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
14 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
15 
16 from .const import DOMAIN, MANUFACTURER
17 
18 _LOGGER = logging.getLogger(__name__)
19 
20 STEP_USER_DATA_SCHEMA = vol.Schema(
21  {
22  vol.Required(CONF_HOST): str,
23  vol.Required(CONF_USERNAME): str,
24  vol.Required(CONF_PASSWORD): str,
25  }
26 )
27 
28 
29 class EcoForestConfigFlow(ConfigFlow, domain=DOMAIN):
30  """Handle a config flow for Ecoforest."""
31 
32  VERSION = 1
33 
34  async def async_step_user(
35  self, user_input: dict[str, Any] | None = None
36  ) -> ConfigFlowResult:
37  """Handle the initial step."""
38  errors: dict[str, str] = {}
39 
40  if user_input is not None:
41  try:
42  api = EcoforestApi(
43  user_input[CONF_HOST],
44  BasicAuth(user_input[CONF_USERNAME], user_input[CONF_PASSWORD]),
45  )
46  device = await api.get()
47  except EcoforestAuthenticationRequired:
48  errors["base"] = "invalid_auth"
49  except Exception:
50  _LOGGER.exception("Unexpected exception")
51  errors["base"] = "cannot_connect"
52  else:
53  await self.async_set_unique_idasync_set_unique_id(device.serial_number)
54  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
55  return self.async_create_entryasync_create_entryasync_create_entry(
56  title=f"{MANUFACTURER} {device.serial_number}", data=user_input
57  )
58 
59  return self.async_show_formasync_show_formasync_show_form(
60  step_id="user",
61  data_schema=STEP_USER_DATA_SCHEMA,
62  errors=errors,
63  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:36
None _abort_if_unique_id_configured(self, dict[str, Any]|None updates=None, bool reload_on_update=True, *str error="already_configured")
ConfigEntry|None async_set_unique_id(self, str|None unique_id=None, *bool raise_on_progress=True)
ConfigFlowResult async_create_entry(self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
ConfigFlowResult async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_create_entry(self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)