Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Knocki integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from knocki import KnockiClient, KnockiConnectionError, KnockiInvalidAuthError
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_PASSWORD, CONF_TOKEN, CONF_USERNAME
12 from homeassistant.exceptions import HomeAssistantError
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import DOMAIN, LOGGER
16 
17 DATA_SCHEMA = vol.Schema(
18  {
19  vol.Required(CONF_USERNAME): str,
20  vol.Required(CONF_PASSWORD): str,
21  }
22 )
23 
24 
25 class KnockiConfigFlow(ConfigFlow, domain=DOMAIN):
26  """Handle a config flow for Knocki."""
27 
28  async def async_step_user(
29  self, user_input: dict[str, Any] | None = None
30  ) -> ConfigFlowResult:
31  """Handle the initial step."""
32  errors: dict[str, str] = {}
33  if user_input is not None:
34  client = KnockiClient(session=async_get_clientsession(self.hass))
35  try:
36  token_response = await client.login(
37  user_input[CONF_USERNAME], user_input[CONF_PASSWORD]
38  )
39  await self.async_set_unique_idasync_set_unique_id(token_response.user_id)
40  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
41  client.token = token_response.token
42  await client.link()
43  except HomeAssistantError:
44  # Catch the unique_id abort and reraise it to keep the code clean
45  raise
46  except KnockiConnectionError:
47  errors["base"] = "cannot_connect"
48  except KnockiInvalidAuthError:
49  errors["base"] = "invalid_auth"
50  except Exception: # noqa: BLE001
51  LOGGER.exception("Error logging into the Knocki API")
52  errors["base"] = "unknown"
53  else:
54  return self.async_create_entryasync_create_entryasync_create_entry(
55  title=user_input[CONF_USERNAME],
56  data={
57  CONF_TOKEN: token_response.token,
58  },
59  )
60  return self.async_show_formasync_show_formasync_show_form(
61  step_id="user",
62  errors=errors,
63  data_schema=DATA_SCHEMA,
64  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:30
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)
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)