Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Epion."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from epion import Epion, EpionAuthenticationError, EpionConnectionError
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_API_KEY
13 
14 from .const import DOMAIN
15 
16 _LOGGER = logging.getLogger(__name__)
17 
18 
19 class EpionConfigFlow(ConfigFlow, domain=DOMAIN):
20  """Handle a config flow for Epion."""
21 
22  VERSION = 1
23 
24  async def async_step_user(
25  self, user_input: dict[str, Any] | None = None
26  ) -> ConfigFlowResult:
27  """Handle a flow initiated by the user."""
28  errors = {}
29  if user_input:
30  api = Epion(user_input[CONF_API_KEY])
31  try:
32  api_data = await self.hass.async_add_executor_job(api.get_current)
33  except EpionAuthenticationError:
34  errors["base"] = "invalid_auth"
35  except EpionConnectionError:
36  _LOGGER.error("Unexpected problem when configuring Epion API")
37  errors["base"] = "cannot_connect"
38  else:
39  await self.async_set_unique_idasync_set_unique_id(api_data["accountId"])
40  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
41  return self.async_create_entryasync_create_entryasync_create_entry(
42  title="Epion integration",
43  data=user_input,
44  )
45 
46  return self.async_show_formasync_show_formasync_show_form(
47  step_id="user",
48  data_schema=vol.Schema(
49  {
50  vol.Required(CONF_API_KEY): str,
51  }
52  ),
53  errors=errors,
54  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:26
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)