Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Sanix integration."""
2 
3 import logging
4 from typing import Any
5 
6 from sanix import Sanix
7 from sanix.exceptions import SanixException, SanixInvalidAuthException
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_TOKEN
12 
13 from .const import CONF_SERIAL_NUMBER, DOMAIN, MANUFACTURER
14 
15 _LOGGER = logging.getLogger(__name__)
16 
17 
18 STEP_USER_DATA_SCHEMA = vol.Schema(
19  {
20  vol.Required(CONF_SERIAL_NUMBER): str,
21  vol.Required(CONF_TOKEN): str,
22  }
23 )
24 
25 
26 class SanixConfigFlow(ConfigFlow, domain=DOMAIN):
27  """Handle a config flow for Sanix."""
28 
29  VERSION = 1
30 
31  async def async_step_user(
32  self, user_input: dict[str, Any] | None = None
33  ) -> ConfigFlowResult:
34  """Handle the initial step."""
35  errors: dict[str, str] = {}
36 
37  if user_input:
38  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_SERIAL_NUMBER])
39  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
40 
41  sanix_api = Sanix(user_input[CONF_SERIAL_NUMBER], user_input[CONF_TOKEN])
42 
43  try:
44  await self.hass.async_add_executor_job(sanix_api.fetch_data)
45  except SanixInvalidAuthException:
46  errors["base"] = "invalid_auth"
47  except SanixException:
48  errors["base"] = "unknown"
49  else:
50  return self.async_create_entryasync_create_entryasync_create_entry(
51  title=MANUFACTURER,
52  data=user_input,
53  )
54 
55  return self.async_show_formasync_show_formasync_show_form(
56  step_id="user",
57  description_placeholders={"dashboard_url": "https://sanix.bitcomplex.pl/"},
58  data_schema=STEP_USER_DATA_SCHEMA,
59  errors=errors,
60  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:33
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)