Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Airthings integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import airthings
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_ID
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import CONF_SECRET, DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 STEP_USER_DATA_SCHEMA = vol.Schema(
20  {
21  vol.Required(CONF_ID): str,
22  vol.Required(CONF_SECRET): str,
23  }
24 )
25 
26 
27 class AirthingsConfigFlow(ConfigFlow, domain=DOMAIN):
28  """Handle a config flow for Airthings."""
29 
30  VERSION = 1
31 
32  async def async_step_user(
33  self, user_input: dict[str, Any] | None = None
34  ) -> ConfigFlowResult:
35  """Handle the initial step."""
36  if user_input is None:
37  return self.async_show_formasync_show_formasync_show_form(
38  step_id="user",
39  data_schema=STEP_USER_DATA_SCHEMA,
40  description_placeholders={
41  "url": (
42  "https://dashboard.airthings.com/integrations/api-integration"
43  ),
44  },
45  )
46 
47  errors = {}
48 
49  try:
50  await airthings.get_token(
51  async_get_clientsession(self.hass),
52  user_input[CONF_ID],
53  user_input[CONF_SECRET],
54  )
55  except airthings.AirthingsConnectionError:
56  errors["base"] = "cannot_connect"
57  except airthings.AirthingsAuthError:
58  errors["base"] = "invalid_auth"
59  except Exception:
60  _LOGGER.exception("Unexpected exception")
61  errors["base"] = "unknown"
62  else:
63  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_ID])
64  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
65 
66  return self.async_create_entryasync_create_entryasync_create_entry(title="Airthings", data=user_input)
67 
68  return self.async_show_formasync_show_formasync_show_form(
69  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
70  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:34
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)