Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure Met Éireann component."""
2 
3 from typing import Any
4 
5 import voluptuous as vol
6 
7 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
8 from homeassistant.const import CONF_ELEVATION, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
10 
11 from .const import DOMAIN, HOME_LOCATION_NAME
12 
13 
14 class MetEireannFlowHandler(ConfigFlow, domain=DOMAIN):
15  """Config flow for Met Eireann component."""
16 
17  VERSION = 1
18 
19  async def async_step_user(
20  self, user_input: dict[str, Any] | None = None
21  ) -> ConfigFlowResult:
22  """Handle a flow initialized by the user."""
23  if user_input is not None:
24  # Check if an identical entity is already configured
25  await self.async_set_unique_idasync_set_unique_id(
26  f"{user_input.get(CONF_LATITUDE)},{user_input.get(CONF_LONGITUDE)}"
27  )
28  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
29  else:
30  return self.async_show_formasync_show_formasync_show_form(
31  step_id="user",
32  data_schema=vol.Schema(
33  {
34  vol.Required(CONF_NAME, default=HOME_LOCATION_NAME): str,
35  vol.Required(
36  CONF_LATITUDE, default=self.hass.config.latitude
37  ): cv.latitude,
38  vol.Required(
39  CONF_LONGITUDE, default=self.hass.config.longitude
40  ): cv.longitude,
41  vol.Required(
42  CONF_ELEVATION, default=self.hass.config.elevation
43  ): int,
44  }
45  ),
46  )
47  return self.async_create_entryasync_create_entryasync_create_entry(title=user_input[CONF_NAME], data=user_input)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:21
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)