Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Nightscout integration."""
2 
3 import logging
4 from typing import Any
5 
6 from aiohttp import ClientError, ClientResponseError
7 from py_nightscout import Api as NightscoutAPI
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_API_KEY, CONF_URL
12 from homeassistant.exceptions import HomeAssistantError
13 
14 from .const import DOMAIN
15 from .utils import hash_from_url
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 DATA_SCHEMA = vol.Schema({vol.Required(CONF_URL): str, vol.Optional(CONF_API_KEY): str})
20 
21 
22 async def _validate_input(data: dict[str, Any]) -> dict[str, str]:
23  """Validate the user input allows us to connect."""
24  url: str = data[CONF_URL]
25  api_key: str | None = data.get(CONF_API_KEY)
26  try:
27  api = NightscoutAPI(url, api_secret=api_key)
28  status = await api.get_server_status()
29  if status.settings.get("authDefaultRoles") == "status-only":
30  await api.get_sgvs()
31  except ClientResponseError as error:
32  raise InputValidationError("invalid_auth") from error
33  except (ClientError, TimeoutError, OSError) as error:
34  raise InputValidationError("cannot_connect") from error
35 
36  # Return info to be stored in the config entry.
37  return {"title": status.name}
38 
39 
40 class NightscoutConfigFlow(ConfigFlow, domain=DOMAIN):
41  """Handle a config flow for Nightscout."""
42 
43  VERSION = 1
44 
45  async def async_step_user(
46  self, user_input: dict[str, Any] | None = None
47  ) -> ConfigFlowResult:
48  """Handle the initial step."""
49  errors: dict[str, str] = {}
50 
51  if user_input is not None:
52  unique_id = hash_from_url(user_input[CONF_URL])
53  await self.async_set_unique_idasync_set_unique_id(unique_id)
54  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
55  try:
56  info = await _validate_input(user_input)
57  except InputValidationError as error:
58  errors["base"] = error.base
59  except Exception:
60  _LOGGER.exception("Unexpected exception")
61  errors["base"] = "unknown"
62  else:
63  return self.async_create_entryasync_create_entryasync_create_entry(title=info["title"], data=user_input)
64 
65  return self.async_show_formasync_show_formasync_show_form(
66  step_id="user", data_schema=DATA_SCHEMA, errors=errors
67  )
68 
69 
71  """Error to indicate we cannot proceed due to invalid input."""
72 
73  def __init__(self, base: str) -> None:
74  """Initialize with error base."""
75  super().__init__()
76  self.basebase = base
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:47
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)
dict[str, str] _validate_input(dict[str, Any] data)
Definition: config_flow.py:22