Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Blue Current integration."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 from typing import Any
7 
8 from bluecurrent_api import Client
9 from bluecurrent_api.exceptions import (
10  AlreadyConnected,
11  InvalidApiToken,
12  RequestLimitReached,
13  WebsocketError,
14 )
15 import voluptuous as vol
16 
17 from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlow, ConfigFlowResult
18 from homeassistant.const import CONF_API_TOKEN
19 
20 from .const import DOMAIN, LOGGER
21 
22 DATA_SCHEMA = vol.Schema({vol.Required(CONF_API_TOKEN): str})
23 
24 
25 class BlueCurrentConfigFlow(ConfigFlow, domain=DOMAIN):
26  """Handle the config flow for Blue Current."""
27 
28  VERSION = 1
29 
30  async def async_step_user(
31  self, user_input: dict[str, Any] | None = None
32  ) -> ConfigFlowResult:
33  """Handle the initial step."""
34  errors = {}
35  if user_input is not None:
36  client = Client()
37  api_token = user_input[CONF_API_TOKEN]
38 
39  try:
40  customer_id = await client.validate_api_token(api_token)
41  email = await client.get_email()
42  except WebsocketError:
43  errors["base"] = "cannot_connect"
44  except RequestLimitReached:
45  errors["base"] = "limit_reached"
46  except AlreadyConnected:
47  errors["base"] = "already_connected"
48  except InvalidApiToken:
49  errors["base"] = "invalid_token"
50  except Exception: # noqa: BLE001
51  LOGGER.exception("Unexpected exception")
52  errors["base"] = "unknown"
53 
54  else:
55  if self.sourcesourcesource != SOURCE_REAUTH:
56  await self.async_set_unique_idasync_set_unique_id(customer_id)
57  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
58  return self.async_create_entryasync_create_entryasync_create_entry(title=email, data=user_input)
59 
60  reauth_entry = self._get_reauth_entry_get_reauth_entry()
61  if reauth_entry.unique_id == customer_id:
62  return self.async_update_reload_and_abortasync_update_reload_and_abort(
63  reauth_entry, data=user_input
64  )
65 
66  return self.async_abortasync_abortasync_abort(
67  reason="wrong_account",
68  description_placeholders={"email": email},
69  )
70  return self.async_show_formasync_show_formasync_show_form(
71  step_id="user", data_schema=DATA_SCHEMA, errors=errors
72  )
73 
74  async def async_step_reauth(
75  self, entry_data: Mapping[str, Any]
76  ) -> ConfigFlowResult:
77  """Handle a reauthorization flow request."""
78  return await self.async_step_userasync_step_userasync_step_user()
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:76
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:32
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_update_reload_and_abort(self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
ConfigFlowResult async_abort(self, *str reason, Mapping[str, str]|None description_placeholders=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)
str|None source(self)
_FlowResultT async_abort(self, *str reason, Mapping[str, str]|None description_placeholders=None)