Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the Twente Milieu integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from twentemilieu import (
8  TwenteMilieu,
9  TwenteMilieuAddressError,
10  TwenteMilieuConnectionError,
11 )
12 import voluptuous as vol
13 
14 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
15 from homeassistant.const import CONF_ID
16 from homeassistant.helpers.aiohttp_client import async_get_clientsession
17 
18 from .const import CONF_HOUSE_LETTER, CONF_HOUSE_NUMBER, CONF_POST_CODE, DOMAIN
19 
20 
21 class TwenteMilieuFlowHandler(ConfigFlow, domain=DOMAIN):
22  """Handle a Twente Milieu config flow."""
23 
24  VERSION = 1
25 
26  async def _show_setup_form(
27  self, errors: dict[str, str] | None = None
28  ) -> ConfigFlowResult:
29  """Show the setup form to the user."""
30  return self.async_show_formasync_show_formasync_show_form(
31  step_id="user",
32  data_schema=vol.Schema(
33  {
34  vol.Required(CONF_POST_CODE): str,
35  vol.Required(CONF_HOUSE_NUMBER): str,
36  vol.Optional(CONF_HOUSE_LETTER): str,
37  }
38  ),
39  errors=errors or {},
40  )
41 
42  async def async_step_user(
43  self, user_input: dict[str, Any] | None = None
44  ) -> ConfigFlowResult:
45  """Handle a flow initiated by the user."""
46  if user_input is None:
47  return await self._show_setup_form_show_setup_form(user_input)
48 
49  errors = {}
50 
51  session = async_get_clientsession(self.hass)
52 
53  twentemilieu = TwenteMilieu(
54  post_code=user_input[CONF_POST_CODE],
55  house_number=user_input[CONF_HOUSE_NUMBER],
56  house_letter=user_input.get(CONF_HOUSE_LETTER, ""),
57  session=session,
58  )
59 
60  try:
61  unique_id = await twentemilieu.unique_id()
62  except TwenteMilieuConnectionError:
63  errors["base"] = "cannot_connect"
64  return await self._show_setup_form_show_setup_form(errors)
65  except TwenteMilieuAddressError:
66  errors["base"] = "invalid_address"
67  return await self._show_setup_form_show_setup_form(errors)
68 
69  await self.async_set_unique_idasync_set_unique_id(str(unique_id))
70  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
71 
72  return self.async_create_entryasync_create_entryasync_create_entry(
73  title=str(unique_id),
74  data={
75  CONF_ID: unique_id,
76  CONF_POST_CODE: user_input[CONF_POST_CODE],
77  CONF_HOUSE_NUMBER: user_input[CONF_HOUSE_NUMBER],
78  CONF_HOUSE_LETTER: user_input.get(CONF_HOUSE_LETTER),
79  },
80  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:44
ConfigFlowResult _show_setup_form(self, dict[str, str]|None errors=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)
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)
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)