Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the EcoNet component."""
2 
3 from typing import Any
4 
5 from pyeconet import EcoNetApiInterface
6 from pyeconet.errors import InvalidCredentialsError, PyeconetError
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
11 
12 from .const import DOMAIN
13 
14 
15 class EcoNetFlowHandler(ConfigFlow, domain=DOMAIN):
16  """Handle an EcoNet config flow."""
17 
18  VERSION = 1
19 
20  def __init__(self) -> None:
21  """Initialize the config flow."""
22  self.data_schemadata_schema = vol.Schema(
23  {
24  vol.Required(CONF_EMAIL): str,
25  vol.Required(CONF_PASSWORD): str,
26  }
27  )
28 
29  async def async_step_user(
30  self, user_input: dict[str, Any] | None = None
31  ) -> ConfigFlowResult:
32  """Handle the start of the config flow."""
33  if not user_input:
34  return self.async_show_formasync_show_formasync_show_form(
35  step_id="user",
36  data_schema=self.data_schemadata_schema,
37  )
38 
39  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_EMAIL])
40  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
41  errors = {}
42 
43  try:
44  await EcoNetApiInterface.login(
45  user_input[CONF_EMAIL], user_input[CONF_PASSWORD]
46  )
47  except InvalidCredentialsError:
48  errors["base"] = "invalid_auth"
49  except PyeconetError:
50  errors["base"] = "cannot_connect"
51 
52  if errors:
53  return self.async_show_formasync_show_formasync_show_form(
54  step_id="user",
55  data_schema=self.data_schemadata_schema,
56  errors=errors,
57  )
58 
59  return self.async_create_entryasync_create_entryasync_create_entry(
60  title=user_input[CONF_EMAIL],
61  data={
62  CONF_EMAIL: user_input[CONF_EMAIL],
63  CONF_PASSWORD: user_input[CONF_PASSWORD],
64  },
65  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:31
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)