Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure IPMA component."""
2 
3 import logging
4 from typing import Any
5 
6 from pyipma import IPMAException
7 from pyipma.api import IPMA_API
8 from pyipma.location import Location
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_LATITUDE, CONF_LONGITUDE
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
15 
16 from .const import DOMAIN
17 
18 _LOGGER = logging.getLogger(__name__)
19 
20 
21 class IpmaFlowHandler(ConfigFlow, domain=DOMAIN):
22  """Config flow for IPMA component."""
23 
24  VERSION = 1
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle a flow initialized by the user."""
30  errors = {}
31 
32  if user_input is not None:
33  self._async_abort_entries_match_async_abort_entries_match(user_input)
34 
35  api = IPMA_API(async_get_clientsession(self.hass))
36 
37  try:
38  location = await Location.get(
39  api,
40  user_input[CONF_LATITUDE],
41  user_input[CONF_LONGITUDE],
42  )
43  except IPMAException:
44  _LOGGER.exception("Unexpected exception")
45  errors["base"] = "unknown"
46  else:
47  return self.async_create_entryasync_create_entryasync_create_entry(title=location.name, data=user_input)
48 
49  return self.async_show_formasync_show_formasync_show_form(
50  step_id="user",
51  data_schema=self.add_suggested_values_to_schemaadd_suggested_values_to_schema(
52  vol.Schema(
53  {
54  vol.Required(CONF_LATITUDE): cv.latitude,
55  vol.Required(CONF_LONGITUDE): cv.longitude,
56  }
57  ),
58  {
59  CONF_LATITUDE: self.hass.config.latitude,
60  CONF_LONGITUDE: self.hass.config.longitude,
61  },
62  ),
63  errors=errors,
64  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:28
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)
None _async_abort_entries_match(self, dict[str, Any]|None match_dict=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)
vol.Schema add_suggested_values_to_schema(self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_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)