Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for flo integration."""
2 
3 from typing import Any
4 
5 from aioflo import async_get_api
6 from aioflo.errors import RequestError
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
11 from homeassistant.core import HomeAssistant
12 from homeassistant.exceptions import HomeAssistantError
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import DOMAIN, LOGGER
16 
17 DATA_SCHEMA = vol.Schema(
18  {vol.Required(CONF_USERNAME): str, vol.Required(CONF_PASSWORD): str}
19 )
20 
21 
22 async def validate_input(hass: HomeAssistant, data):
23  """Validate the user input allows us to connect.
24 
25  Data has the keys from DATA_SCHEMA with values provided by the user.
26  """
27 
28  session = async_get_clientsession(hass)
29  try:
30  await async_get_api(data[CONF_USERNAME], data[CONF_PASSWORD], session=session)
31  except RequestError as request_error:
32  LOGGER.error("Error connecting to the Flo API: %s", request_error)
33  raise CannotConnect from request_error
34 
35 
36 class FloConfigFlow(ConfigFlow, domain=DOMAIN):
37  """Handle a config flow for flo."""
38 
39  VERSION = 1
40 
41  async def async_step_user(
42  self, user_input: dict[str, Any] | None = None
43  ) -> ConfigFlowResult:
44  """Handle the initial step."""
45  errors = {}
46  if user_input is not None:
47  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_USERNAME])
48  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
49  try:
50  await validate_input(self.hass, user_input)
51  return self.async_create_entryasync_create_entryasync_create_entry(
52  title=user_input[CONF_USERNAME], data=user_input
53  )
54  except CannotConnect:
55  errors["base"] = "cannot_connect"
56 
57  return self.async_show_formasync_show_formasync_show_form(
58  step_id="user", data_schema=DATA_SCHEMA, errors=errors
59  )
60 
61 
63  """Error to indicate we cannot connect."""
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:43
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 validate_input(HomeAssistant hass, data)
Definition: config_flow.py:22
API async_get_api(HomeAssistant hass, str api_key)
Definition: config_flow.py:60
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)