Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for SwitchBot via API integration."""
2 
3 from logging import getLogger
4 from typing import Any
5 
6 from switchbot_api import CannotConnect, InvalidAuth, SwitchBotAPI
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 from homeassistant.const import CONF_API_KEY, CONF_API_TOKEN
11 
12 from .const import DOMAIN, ENTRY_TITLE
13 
14 _LOGGER = getLogger(__name__)
15 
16 STEP_USER_DATA_SCHEMA = vol.Schema(
17  {
18  vol.Required(CONF_API_TOKEN): str,
19  vol.Required(CONF_API_KEY): str,
20  }
21 )
22 
23 
24 class SwitchBotCloudConfigFlow(ConfigFlow, domain=DOMAIN):
25  """Handle a config flow for SwitchBot via API."""
26 
27  VERSION = 1
28 
29  async def async_step_user(
30  self, user_input: dict[str, Any] | None = None
31  ) -> ConfigFlowResult:
32  """Handle the initial step."""
33  errors: dict[str, str] = {}
34  if user_input is not None:
35  try:
36  await SwitchBotAPI(
37  token=user_input[CONF_API_TOKEN], secret=user_input[CONF_API_KEY]
38  ).list_devices()
39  except CannotConnect:
40  errors["base"] = "cannot_connect"
41  except InvalidAuth:
42  errors["base"] = "invalid_auth"
43  except Exception:
44  _LOGGER.exception("Unexpected exception")
45  errors["base"] = "unknown"
46  else:
47  await self.async_set_unique_idasync_set_unique_id(
48  user_input[CONF_API_TOKEN], raise_on_progress=False
49  )
50  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
51  return self.async_create_entryasync_create_entryasync_create_entry(title=ENTRY_TITLE, data=user_input)
52 
53  return self.async_show_formasync_show_formasync_show_form(
54  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
55  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:31
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)