Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for huum integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from huum.exceptions import Forbidden, NotAuthenticated
9 from huum.huum import Huum
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
14 from homeassistant.helpers.aiohttp_client import async_get_clientsession
15 
16 from .const import DOMAIN
17 
18 _LOGGER = logging.getLogger(__name__)
19 
20 STEP_USER_DATA_SCHEMA = vol.Schema(
21  {
22  vol.Required(CONF_USERNAME): str,
23  vol.Required(CONF_PASSWORD): str,
24  }
25 )
26 
27 
28 class HuumConfigFlow(ConfigFlow, domain=DOMAIN):
29  """Handle a config flow for huum."""
30 
31  VERSION = 1
32 
33  async def async_step_user(
34  self, user_input: dict[str, Any] | None = None
35  ) -> ConfigFlowResult:
36  """Handle the initial step."""
37  errors = {}
38  if user_input is not None:
39  try:
40  huum_handler = Huum(
41  user_input[CONF_USERNAME],
42  user_input[CONF_PASSWORD],
43  session=async_get_clientsession(self.hass),
44  )
45  await huum_handler.status()
46  except (Forbidden, NotAuthenticated):
47  # Most likely Forbidden as that is what is returned from `.status()` with bad creds
48  _LOGGER.error("Could not log in to Huum with given credentials")
49  errors["base"] = "invalid_auth"
50  except Exception:
51  _LOGGER.exception("Unknown error")
52  errors["base"] = "unknown"
53  else:
54  self._async_abort_entries_match_async_abort_entries_match(
55  {CONF_USERNAME: user_input[CONF_USERNAME]}
56  )
57  return self.async_create_entryasync_create_entryasync_create_entry(
58  title=user_input[CONF_USERNAME], data=user_input
59  )
60 
61  return self.async_show_formasync_show_formasync_show_form(
62  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
63  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:35
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)
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)