Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure flood monitoring gauges."""
2 
3 from typing import Any
4 
5 from aioeafm import get_stations
6 import voluptuous as vol
7 
8 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
9 from homeassistant.helpers.aiohttp_client import async_get_clientsession
10 
11 from .const import DOMAIN
12 
13 
14 class UKFloodsFlowHandler(ConfigFlow, domain=DOMAIN):
15  """Handle a UK Environment Agency flood monitoring config flow."""
16 
17  VERSION = 1
18 
19  def __init__(self) -> None:
20  """Handle a UK Floods config flow."""
21  self.stationsstations: dict[str, str] = {}
22 
23  async def async_step_user(
24  self, user_input: dict[str, Any] | None = None
25  ) -> ConfigFlowResult:
26  """Handle a flow start."""
27  errors: dict[str, str] = {}
28 
29  if user_input is not None:
30  selected_station = self.stationsstations[user_input["station"]]
31  await self.async_set_unique_idasync_set_unique_id(selected_station, raise_on_progress=False)
32  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
33  return self.async_create_entryasync_create_entryasync_create_entry(
34  title=user_input["station"],
35  data={"station": selected_station},
36  )
37 
38  session = async_get_clientsession(hass=self.hass)
39  stations = await get_stations(session)
40 
41  self.stationsstations = {}
42  for station in stations:
43  label = station["label"]
44 
45  # API annoyingly sometimes returns a list and some times returns a string
46  # E.g. L3121 has a label of ['Scurf Dyke', 'Scurf Dyke Dyke Level']
47  if isinstance(label, list):
48  label = label[-1]
49 
50  self.stationsstations[label] = station["stationReference"]
51 
52  if not self.stationsstations:
53  return self.async_abortasync_abortasync_abort(reason="no_stations")
54 
55  return self.async_show_formasync_show_formasync_show_form(
56  step_id="user",
57  errors=errors,
58  data_schema=vol.Schema(
59  {vol.Required("station"): vol.In(sorted(self.stationsstations))}
60  ),
61  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=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_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)