Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Arve integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from asyncarve import Arve, ArveConnectionError, ArveCustomer
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_ACCESS_TOKEN, CONF_CLIENT_SECRET
13 
14 from .const import DOMAIN
15 
16 _LOGGER = logging.getLogger(__name__)
17 
18 
19 class ArveConfigFlowHandler(ConfigFlow, domain=DOMAIN):
20  """Handle a config flow for Arve."""
21 
22  async def async_step_user(
23  self, user_input: dict[str, Any] | None = None
24  ) -> ConfigFlowResult:
25  """Handle the initial step."""
26 
27  errors: dict[str, str] = {}
28  if user_input is not None:
29  arve = Arve(
30  user_input[CONF_ACCESS_TOKEN],
31  user_input[CONF_CLIENT_SECRET],
32  )
33  try:
34  customer: ArveCustomer = await arve.get_customer_id()
35  except ArveConnectionError:
36  errors["base"] = "cannot_connect"
37  else:
38  await self.async_set_unique_idasync_set_unique_id(customer.customerId)
39  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
40  return self.async_create_entryasync_create_entryasync_create_entry(
41  title="Arve",
42  data=user_input,
43  )
44  return self.async_show_formasync_show_formasync_show_form(
45  step_id="user",
46  data_schema=vol.Schema(
47  {
48  vol.Required(CONF_ACCESS_TOKEN): str,
49  vol.Required(CONF_CLIENT_SECRET): str,
50  }
51  ),
52  errors=errors,
53  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:24
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)