Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Efergy integration."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 from typing import Any
7 
8 from pyefergy import Efergy, exceptions
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_API_KEY
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import DEFAULT_NAME, DOMAIN, LOGGER
16 
17 
18 class EfergyFlowHandler(ConfigFlow, domain=DOMAIN):
19  """Handle a config flow for Efergy."""
20 
21  VERSION = 1
22 
23  async def async_step_user(
24  self, user_input: dict[str, Any] | None = None
25  ) -> ConfigFlowResult:
26  """Handle a flow initiated by the user."""
27  errors = {}
28  if user_input is not None:
29  api_key = user_input[CONF_API_KEY]
30 
31  self._async_abort_entries_match_async_abort_entries_match({CONF_API_KEY: api_key})
32  hid, error = await self._async_try_connect_async_try_connect(api_key)
33  if error is None:
34  entry = await self.async_set_unique_idasync_set_unique_id(hid)
35  if entry:
36  return self.async_update_reload_and_abortasync_update_reload_and_abort(entry, data=user_input)
37  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
38  return self.async_create_entryasync_create_entryasync_create_entry(
39  title=DEFAULT_NAME,
40  data={CONF_API_KEY: api_key},
41  )
42  errors["base"] = error
43 
44  return self.async_show_formasync_show_formasync_show_form(
45  step_id="user",
46  data_schema=vol.Schema(
47  {
48  vol.Required(CONF_API_KEY): str,
49  }
50  ),
51  errors=errors,
52  )
53 
54  async def async_step_reauth(
55  self, entry_data: Mapping[str, Any]
56  ) -> ConfigFlowResult:
57  """Handle a reauthorization flow request."""
58  return await self.async_step_userasync_step_userasync_step_user()
59 
60  async def _async_try_connect(self, api_key: str) -> tuple[str | None, str | None]:
61  """Try connecting to Efergy servers."""
62  api = Efergy(
63  api_key,
64  session=async_get_clientsession(self.hass),
65  utc_offset=self.hass.config.time_zone,
66  )
67  try:
68  await api.async_status()
69  except exceptions.ConnectError:
70  return None, "cannot_connect"
71  except exceptions.InvalidAuth:
72  return None, "invalid_auth"
73  except Exception: # noqa: BLE001
74  LOGGER.exception("Unexpected exception")
75  return None, "unknown"
76  return api.info["hid"], None
tuple[str|None, str|None] _async_try_connect(self, str api_key)
Definition: config_flow.py:60
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:25
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:56
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_update_reload_and_abort(self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
None _async_abort_entries_match(self, dict[str, Any]|None match_dict=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)
aiohttp.ClientSession async_get_clientsession(HomeAssistant hass, bool verify_ssl=True, socket.AddressFamily family=socket.AF_UNSPEC, ssl_util.SSLCipherList ssl_cipher=ssl_util.SSLCipherList.PYTHON_DEFAULT)