Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for the Atag component."""
2 
3 from typing import Any
4 
5 import pyatag
6 import voluptuous as vol
7 
8 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
9 from homeassistant.const import CONF_HOST, CONF_PORT
10 from homeassistant.helpers.aiohttp_client import async_get_clientsession
11 
12 from . import DOMAIN
13 
14 DATA_SCHEMA = {
15  vol.Required(CONF_HOST): str,
16  vol.Required(CONF_PORT, default=pyatag.const.DEFAULT_PORT): vol.Coerce(int),
17 }
18 
19 
20 class AtagConfigFlow(ConfigFlow, domain=DOMAIN):
21  """Config flow for Atag."""
22 
23  VERSION = 1
24 
25  async def async_step_user(
26  self, user_input: dict[str, Any] | None = None
27  ) -> ConfigFlowResult:
28  """Handle a flow initialized by the user."""
29 
30  if not user_input:
31  return await self._show_form_show_form()
32 
33  atag = pyatag.AtagOne(session=async_get_clientsession(self.hass), **user_input)
34  try:
35  await atag.update()
36 
37  except pyatag.Unauthorized:
38  return await self._show_form_show_form({"base": "unauthorized"})
39  except pyatag.AtagException:
40  return await self._show_form_show_form({"base": "cannot_connect"})
41 
42  await self.async_set_unique_idasync_set_unique_id(atag.id)
43  self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates=user_input)
44 
45  return self.async_create_entryasync_create_entryasync_create_entry(title=atag.id, data=user_input)
46 
47  async def _show_form(
48  self, errors: dict[str, str] | None = None
49  ) -> ConfigFlowResult:
50  """Show the form to the user."""
51  return self.async_show_formasync_show_formasync_show_form(
52  step_id="user",
53  data_schema=vol.Schema(DATA_SCHEMA),
54  errors=errors if errors else {},
55  )
ConfigFlowResult _show_form(self, dict[str, str]|None errors=None)
Definition: config_flow.py:49
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:27
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)