Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Roth Touchline SL integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from pytouchlinesl import TouchlineSL
9 from pytouchlinesl.client import RothAPIError
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 STEP_USER_DATA_SCHEMA = vol.Schema(
20  {
21  vol.Required(CONF_USERNAME): str,
22  vol.Required(CONF_PASSWORD): str,
23  }
24 )
25 
26 
27 class TouchlineSLConfigFlow(ConfigFlow, domain=DOMAIN):
28  """Handle a config flow for Roth Touchline SL."""
29 
30  async def async_step_user(
31  self, user_input: dict[str, Any] | None = None
32  ) -> ConfigFlowResult:
33  """Handle the initial step that gathers username and password."""
34  errors: dict[str, str] = {}
35 
36  if user_input is not None:
37  try:
38  account = TouchlineSL(
39  username=user_input[CONF_USERNAME],
40  password=user_input[CONF_PASSWORD],
41  )
42  await account.user_id()
43  except RothAPIError as e:
44  if e.status == 401:
45  errors["base"] = "invalid_auth"
46  else:
47  errors["base"] = "cannot_connect"
48  except Exception:
49  _LOGGER.exception("Unexpected exception")
50  errors["base"] = "unknown"
51  else:
52  unique_account_id = await account.user_id()
53  await self.async_set_unique_idasync_set_unique_id(str(unique_account_id))
54  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
55 
56  return self.async_create_entryasync_create_entryasync_create_entry(
57  title=user_input[CONF_USERNAME], data=user_input
58  )
59 
60  return self.async_show_formasync_show_formasync_show_form(
61  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
62  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:32
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)
str
_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)