Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Antifurto365 iAlarm integration."""
2 
3 import logging
4 from typing import Any
5 
6 from pyialarm import IAlarm
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 from homeassistant.const import CONF_HOST, CONF_PORT
11 from homeassistant.core import HomeAssistant
12 
13 from .const import DEFAULT_PORT, DOMAIN
14 
15 _LOGGER = logging.getLogger(__name__)
16 
17 DATA_SCHEMA = vol.Schema(
18  {
19  vol.Required(CONF_HOST): str,
20  vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
21  }
22 )
23 
24 
25 async def _get_device_mac(hass: HomeAssistant, host, port):
26  ialarm = IAlarm(host, port)
27  return await hass.async_add_executor_job(ialarm.get_mac)
28 
29 
30 class IAlarmConfigFlow(ConfigFlow, domain=DOMAIN):
31  """Handle a config flow for Antifurto365 iAlarm."""
32 
33  VERSION = 1
34 
35  async def async_step_user(
36  self, user_input: dict[str, Any] | None = None
37  ) -> ConfigFlowResult:
38  """Handle the initial step."""
39  errors = {}
40  mac = None
41 
42  if user_input is None:
43  return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=DATA_SCHEMA)
44 
45  host = user_input[CONF_HOST]
46  port = user_input[CONF_PORT]
47 
48  try:
49  # If we are able to get the MAC address, we are able to establish
50  # a connection to the device.
51  mac = await _get_device_mac(self.hass, host, port)
52  except ConnectionError:
53  errors["base"] = "cannot_connect"
54  except Exception:
55  _LOGGER.exception("Unexpected exception")
56  errors["base"] = "unknown"
57 
58  if errors:
59  return self.async_show_formasync_show_formasync_show_form(
60  step_id="user", data_schema=DATA_SCHEMA, errors=errors
61  )
62 
63  await self.async_set_unique_idasync_set_unique_id(mac)
64  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
65 
66  return self.async_create_entryasync_create_entryasync_create_entry(title=user_input[CONF_HOST], data=user_input)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:37
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)
def _get_device_mac(HomeAssistant hass, host, port)
Definition: config_flow.py:25