Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for edge integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 import re
7 from typing import Any
8 
9 from Tami4EdgeAPI import Tami4EdgeAPI, exceptions
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.exceptions import HomeAssistantError
15 
16 from .const import CONF_PHONE, CONF_REFRESH_TOKEN, DOMAIN
17 
18 _LOGGER = logging.getLogger(__name__)
19 
20 _STEP_PHONE_NUMBER_SCHEMA = vol.Schema({vol.Required(CONF_PHONE): cv.string})
21 
22 _STEP_OTP_CODE_SCHEMA = vol.Schema({vol.Required("otp"): cv.string})
23 _PHONE_MATCHER = re.compile(r"^(\+?972)?0?(?P<number>\d{8,9})$")
24 
25 
26 class Tami4ConfigFlow(ConfigFlow, domain=DOMAIN):
27  """Handle a config flow for Tami4Edge."""
28 
29  VERSION = 1
30 
31  phone: str
32 
33  async def async_step_user(
34  self, user_input: dict[str, Any] | None = None
35  ) -> ConfigFlowResult:
36  """Handle the otp request step."""
37  errors = {}
38  if user_input is not None:
39  phone = user_input[CONF_PHONE].strip()
40 
41  try:
42  if m := _PHONE_MATCHER.match(phone):
43  self.phonephone = f"+972{m.group('number')}"
44  else:
45  raise InvalidPhoneNumber # noqa: TRY301
46  await self.hass.async_add_executor_job(
47  Tami4EdgeAPI.request_otp, self.phonephone
48  )
49  except InvalidPhoneNumber:
50  errors["base"] = "invalid_phone"
51  except exceptions.Tami4EdgeAPIException:
52  errors["base"] = "cannot_connect"
53  except Exception:
54  _LOGGER.exception("Unexpected exception")
55  errors["base"] = "unknown"
56  else:
57  return await self.async_step_otpasync_step_otp()
58 
59  return self.async_show_formasync_show_formasync_show_form(
60  step_id="user", data_schema=_STEP_PHONE_NUMBER_SCHEMA, errors=errors
61  )
62 
63  async def async_step_otp(
64  self, user_input: dict[str, Any] | None = None
65  ) -> ConfigFlowResult:
66  """Handle the otp submission step."""
67  errors = {}
68  if user_input is not None:
69  otp = user_input["otp"]
70  try:
71  refresh_token = await self.hass.async_add_executor_job(
72  Tami4EdgeAPI.submit_otp, self.phonephone, otp
73  )
74  api = await self.hass.async_add_executor_job(
75  Tami4EdgeAPI, refresh_token
76  )
77  except exceptions.OTPFailedException:
78  errors["base"] = "invalid_auth"
79  except exceptions.Tami4EdgeAPIException:
80  errors["base"] = "cannot_connect"
81  except Exception:
82  _LOGGER.exception("Unexpected exception")
83  errors["base"] = "unknown"
84  else:
85  device_name = api.device_metadata.name
86  if device_name is None:
87  device_name = "Tami4"
88  return self.async_create_entryasync_create_entryasync_create_entry(
89  title=device_name,
90  data={CONF_REFRESH_TOKEN: refresh_token},
91  )
92 
93  return self.async_show_formasync_show_formasync_show_form(
94  step_id="otp", data_schema=_STEP_OTP_CODE_SCHEMA, errors=errors
95  )
96 
97 
99  """Error to indicate that the phone number is invalid."""
ConfigFlowResult async_step_otp(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:65
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:35
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)