Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Airzone Cloud."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from aioairzone_cloud.cloudapi import AirzoneCloudApi
8 from aioairzone_cloud.common import ConnectionOptions
9 from aioairzone_cloud.const import AZD_ID, AZD_NAME, AZD_WEBSERVERS
10 from aioairzone_cloud.exceptions import AirzoneCloudError, LoginError
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
14 from homeassistant.const import CONF_ID, CONF_PASSWORD, CONF_USERNAME
15 from homeassistant.helpers import aiohttp_client
17  SelectOptionDict,
18  SelectSelector,
19  SelectSelectorConfig,
20  SelectSelectorMode,
21 )
22 
23 from .const import DOMAIN
24 
25 
26 class AirZoneCloudConfigFlow(ConfigFlow, domain=DOMAIN):
27  """Handle config flow for an Airzone Cloud device."""
28 
29  airzone: AirzoneCloudApi
30 
32  self, user_input: dict[str, Any] | None = None
33  ) -> ConfigFlowResult:
34  """Handle the installation selection."""
35  errors = {}
36  options: dict[str, str] = {}
37 
38  inst_desc = None
39  inst_id = None
40  if user_input is not None:
41  inst_id = user_input[CONF_ID]
42 
43  try:
44  inst_list = await self.airzoneairzone.list_installations()
45  except AirzoneCloudError:
46  errors["base"] = "cannot_connect"
47  else:
48  for inst in inst_list:
49  _data = inst.data()
50  _id = _data[AZD_ID]
51  options[_id] = f"{_data[AZD_NAME]} {_data[AZD_WEBSERVERS][0]} ({_id})"
52  if _id is not None and _id == inst_id:
53  inst_desc = options[_id]
54 
55  if user_input is not None and inst_desc is not None:
56  await self.async_set_unique_idasync_set_unique_id(inst_id)
57  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
58 
59  user_input[CONF_USERNAME] = self.airzoneairzone.options.username
60  user_input[CONF_PASSWORD] = self.airzoneairzone.options.password
61 
62  return self.async_create_entryasync_create_entryasync_create_entry(title=inst_desc, data=user_input)
63 
64  return self.async_show_formasync_show_formasync_show_form(
65  step_id="user",
66  data_schema=vol.Schema(
67  {
68  vol.Required(CONF_ID): SelectSelector(
70  options=[
71  SelectOptionDict(value=k, label=v)
72  for k, v in options.items()
73  ],
74  mode=SelectSelectorMode.DROPDOWN,
75  )
76  ),
77  }
78  ),
79  errors=errors,
80  )
81 
82  async def async_step_user(
83  self, user_input: dict[str, Any] | None = None
84  ) -> ConfigFlowResult:
85  """Handle the initial step."""
86  errors = {}
87 
88  if user_input is not None:
89  if CONF_ID in user_input:
90  return await self.async_step_inst_pickasync_step_inst_pick(user_input)
91 
92  self.airzoneairzone = AirzoneCloudApi(
93  aiohttp_client.async_get_clientsession(self.hass),
94  ConnectionOptions(
95  user_input[CONF_USERNAME],
96  user_input[CONF_PASSWORD],
97  False,
98  ),
99  )
100 
101  try:
102  await self.airzoneairzone.login()
103  except (AirzoneCloudError, LoginError):
104  errors["base"] = "cannot_connect"
105  else:
106  return await self.async_step_inst_pickasync_step_inst_pick()
107 
108  return self.async_show_formasync_show_formasync_show_form(
109  step_id="user",
110  data_schema=vol.Schema(
111  {
112  vol.Required(CONF_USERNAME): str,
113  vol.Required(CONF_PASSWORD): str,
114  }
115  ),
116  errors=errors,
117  )
ConfigFlowResult async_step_inst_pick(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_step_user(self, dict[str, Any]|None user_input=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)