Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Airtouch 5 integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from airtouch5py.airtouch5_simple_client import Airtouch5SimpleClient
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_HOST
13 
14 from .const import DOMAIN
15 
16 _LOGGER = logging.getLogger(__name__)
17 
18 STEP_USER_DATA_SCHEMA = vol.Schema({vol.Required(CONF_HOST): str})
19 
20 
21 class AirTouch5ConfigFlow(ConfigFlow, domain=DOMAIN):
22  """Handle a config flow for Airtouch 5."""
23 
24  VERSION = 1
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle the initial step."""
30  errors: dict[str, str] | None = None
31  if user_input is not None:
32  client = Airtouch5SimpleClient(user_input[CONF_HOST])
33  try:
34  await client.test_connection()
35  except Exception: # noqa: BLE001
36  errors = {"base": "cannot_connect"}
37  else:
38  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_HOST])
39  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
40  return self.async_create_entryasync_create_entryasync_create_entry(
41  title=user_input[CONF_HOST], data=user_input
42  )
43 
44  return self.async_show_formasync_show_formasync_show_form(
45  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
46  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:28
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)