Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for the Aprilaire integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from pyaprilaire.const import Attribute
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_HOST, CONF_PORT
14 from homeassistant.helpers.device_registry import format_mac
15 
16 from .const import DOMAIN
17 from .coordinator import AprilaireCoordinator
18 
19 STEP_USER_DATA_SCHEMA = vol.Schema(
20  {
21  vol.Required(CONF_HOST): str,
22  vol.Required(CONF_PORT, default=7000): cv.port,
23  }
24 )
25 
26 _LOGGER = logging.getLogger(__name__)
27 
28 
29 class AprilaireConfigFlow(ConfigFlow, domain=DOMAIN):
30  """Handle a config flow for Aprilaire."""
31 
32  VERSION = 1
33 
34  async def async_step_user(
35  self, user_input: dict[str, Any] | None = None
36  ) -> ConfigFlowResult:
37  """Handle the initial step."""
38 
39  if user_input is None:
40  return self.async_show_formasync_show_formasync_show_form(
41  step_id="user", data_schema=STEP_USER_DATA_SCHEMA
42  )
43 
44  coordinator = AprilaireCoordinator(
45  self.hass, None, user_input[CONF_HOST], user_input[CONF_PORT]
46  )
47  await coordinator.start_listen()
48 
49  async def ready_callback(ready: bool):
50  if not ready:
51  _LOGGER.error("Failed to wait for ready")
52 
53  try:
54  ready = await coordinator.wait_for_ready(ready_callback)
55  finally:
56  coordinator.stop_listen()
57 
58  mac_address = coordinator.data.get(Attribute.MAC_ADDRESS)
59 
60  if ready and mac_address is not None:
61  await self.async_set_unique_idasync_set_unique_id(format_mac(mac_address))
62 
63  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
64 
65  return self.async_create_entryasync_create_entryasync_create_entry(title="AprilAire", data=user_input)
66 
67  return self.async_show_formasync_show_formasync_show_form(
68  step_id="user",
69  data_schema=STEP_USER_DATA_SCHEMA,
70  errors={"base": "connection_failed"},
71  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:36
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)