Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Airgradient."""
2 
3 from typing import Any
4 
5 from airgradient import (
6  AirGradientClient,
7  AirGradientError,
8  AirGradientParseError,
9  ConfigurationControl,
10 )
11 from awesomeversion import AwesomeVersion
12 import voluptuous as vol
13 
14 from homeassistant.components import zeroconf
15 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
16 from homeassistant.const import CONF_HOST, CONF_MODEL
17 from homeassistant.helpers.aiohttp_client import async_get_clientsession
18 
19 from .const import DOMAIN
20 
21 MIN_VERSION = AwesomeVersion("3.1.1")
22 
23 
24 class AirGradientConfigFlow(ConfigFlow, domain=DOMAIN):
25  """AirGradient config flow."""
26 
27  def __init__(self) -> None:
28  """Initialize the config flow."""
29  self.data: dict[str, Any] = {}
30  self.clientclient: AirGradientClient | None = None
31 
32  async def set_configuration_source(self) -> None:
33  """Set configuration source to local if it hasn't been set yet."""
34  assert self.clientclient
35  config = await self.clientclient.get_config()
36  if config.configuration_control is ConfigurationControl.NOT_INITIALIZED:
37  await self.clientclient.set_configuration_control(ConfigurationControl.LOCAL)
38 
40  self, discovery_info: zeroconf.ZeroconfServiceInfo
41  ) -> ConfigFlowResult:
42  """Handle zeroconf discovery."""
43  self.data[CONF_HOST] = host = discovery_info.host
44  self.data[CONF_MODEL] = discovery_info.properties["model"]
45 
46  await self.async_set_unique_idasync_set_unique_id(discovery_info.properties["serialno"])
47  self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_HOST: host})
48 
49  if AwesomeVersion(discovery_info.properties["fw_ver"]) < MIN_VERSION:
50  return self.async_abortasync_abortasync_abort(reason="invalid_version")
51 
52  session = async_get_clientsession(self.hass)
53  self.clientclient = AirGradientClient(host, session=session)
54  await self.clientclient.get_current_measures()
55 
56  self.context["title_placeholders"] = {
57  "model": self.data[CONF_MODEL],
58  }
59  return await self.async_step_discovery_confirmasync_step_discovery_confirm()
60 
62  self, user_input: dict[str, Any] | None = None
63  ) -> ConfigFlowResult:
64  """Confirm discovery."""
65  if user_input is not None:
66  await self.set_configuration_sourceset_configuration_source()
67  return self.async_create_entryasync_create_entryasync_create_entry(
68  title=self.data[CONF_MODEL],
69  data={CONF_HOST: self.data[CONF_HOST]},
70  )
71 
72  self._set_confirm_only_set_confirm_only()
73  return self.async_show_formasync_show_formasync_show_form(
74  step_id="discovery_confirm",
75  description_placeholders={
76  "model": self.data[CONF_MODEL],
77  },
78  )
79 
80  async def async_step_user(
81  self, user_input: dict[str, Any] | None = None
82  ) -> ConfigFlowResult:
83  """Handle a flow initialized by the user."""
84  errors: dict[str, str] = {}
85  if user_input:
86  session = async_get_clientsession(self.hass)
87  self.clientclient = AirGradientClient(user_input[CONF_HOST], session=session)
88  try:
89  current_measures = await self.clientclient.get_current_measures()
90  except AirGradientParseError:
91  return self.async_abortasync_abortasync_abort(reason="invalid_version")
92  except AirGradientError:
93  errors["base"] = "cannot_connect"
94  else:
95  await self.async_set_unique_idasync_set_unique_id(
96  current_measures.serial_number, raise_on_progress=False
97  )
98  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
99  await self.set_configuration_sourceset_configuration_source()
100  return self.async_create_entryasync_create_entryasync_create_entry(
101  title=current_measures.model,
102  data={CONF_HOST: user_input[CONF_HOST]},
103  )
104  return self.async_show_formasync_show_formasync_show_form(
105  step_id="user",
106  data_schema=vol.Schema({vol.Required(CONF_HOST): str}),
107  errors=errors,
108  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:82
ConfigFlowResult async_step_discovery_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:63
ConfigFlowResult async_step_zeroconf(self, zeroconf.ZeroconfServiceInfo discovery_info)
Definition: config_flow.py:41
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_abort(self, *str reason, Mapping[str, str]|None description_placeholders=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)
_FlowResultT async_abort(self, *str reason, 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)