Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the Sensor.Community integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from luftdaten import Luftdaten
8 from luftdaten.exceptions import LuftdatenConnectionError
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_SHOW_ON_MAP
13 from homeassistant.core import callback
15 
16 from .const import CONF_SENSOR_ID, DOMAIN
17 
18 
19 class SensorCommunityFlowHandler(ConfigFlow, domain=DOMAIN):
20  """Handle a Sensor.Community config flow."""
21 
22  VERSION = 1
23 
24  @callback
25  def _show_form(self, errors: dict[str, str] | None = None) -> ConfigFlowResult:
26  """Show the form to the user."""
27  return self.async_show_formasync_show_formasync_show_form(
28  step_id="user",
29  data_schema=vol.Schema(
30  {
31  vol.Required(CONF_SENSOR_ID): cv.positive_int,
32  vol.Optional(CONF_SHOW_ON_MAP, default=False): bool,
33  }
34  ),
35  errors=errors or {},
36  )
37 
38  async def async_step_user(
39  self, user_input: dict[str, Any] | None = None
40  ) -> ConfigFlowResult:
41  """Handle the start of the config flow."""
42  if user_input is None:
43  return self._show_form_show_form()
44 
45  await self.async_set_unique_idasync_set_unique_id(str(user_input[CONF_SENSOR_ID]))
46  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
47 
48  sensor_community = Luftdaten(user_input[CONF_SENSOR_ID])
49  try:
50  await sensor_community.get_data()
51  valid = await sensor_community.validate_sensor()
52  except LuftdatenConnectionError:
53  return self._show_form_show_form({CONF_SENSOR_ID: "cannot_connect"})
54 
55  if not valid:
56  return self._show_form_show_form({CONF_SENSOR_ID: "invalid_sensor"})
57 
58  return self.async_create_entryasync_create_entryasync_create_entry(
59  title=str(user_input[CONF_SENSOR_ID]), data=user_input
60  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:40
ConfigFlowResult _show_form(self, dict[str, str]|None errors=None)
Definition: config_flow.py:25
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)