Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Volvo On Call integration."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 import logging
7 from typing import Any
8 
9 import voluptuous as vol
10 from volvooncall import Connection
11 
12 from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlow, ConfigFlowResult
13 from homeassistant.const import (
14  CONF_PASSWORD,
15  CONF_REGION,
16  CONF_UNIT_SYSTEM,
17  CONF_USERNAME,
18 )
19 from homeassistant.helpers.aiohttp_client import async_get_clientsession
20 
21 from .const import (
22  CONF_MUTABLE,
23  DOMAIN,
24  UNIT_SYSTEM_IMPERIAL,
25  UNIT_SYSTEM_METRIC,
26  UNIT_SYSTEM_SCANDINAVIAN_MILES,
27 )
28 from .errors import InvalidAuth
29 from .models import VolvoData
30 
31 _LOGGER = logging.getLogger(__name__)
32 
33 
34 class VolvoOnCallConfigFlow(ConfigFlow, domain=DOMAIN):
35  """VolvoOnCall config flow."""
36 
37  VERSION = 1
38 
39  async def async_step_user(
40  self, user_input: dict[str, Any] | None = None
41  ) -> ConfigFlowResult:
42  """Handle user step."""
43  errors = {}
44  defaults = {
45  CONF_USERNAME: "",
46  CONF_PASSWORD: "",
47  CONF_REGION: None,
48  CONF_MUTABLE: True,
49  CONF_UNIT_SYSTEM: UNIT_SYSTEM_METRIC,
50  }
51 
52  if user_input is not None:
53  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_USERNAME])
54 
55  if self.sourcesourcesourcesource != SOURCE_REAUTH:
56  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
57 
58  try:
59  await self.is_validis_valid(user_input)
60  except InvalidAuth:
61  errors["base"] = "invalid_auth"
62  except Exception:
63  _LOGGER.exception("Unhandled exception in user step")
64  errors["base"] = "unknown"
65  if not errors:
66  if self.sourcesourcesourcesource == SOURCE_REAUTH:
67  return self.async_update_reload_and_abortasync_update_reload_and_abort(
68  self._get_reauth_entry_get_reauth_entry(), data_updates=user_input
69  )
70 
71  return self.async_create_entryasync_create_entryasync_create_entry(
72  title=user_input[CONF_USERNAME], data=user_input
73  )
74  elif self.sourcesourcesourcesource == SOURCE_REAUTH:
75  reauth_entry = self._get_reauth_entry_get_reauth_entry()
76  for key in defaults:
77  defaults[key] = reauth_entry.data.get(key)
78 
79  user_schema = vol.Schema(
80  {
81  vol.Required(CONF_USERNAME, default=defaults[CONF_USERNAME]): str,
82  vol.Required(CONF_PASSWORD, default=defaults[CONF_PASSWORD]): str,
83  vol.Required(CONF_REGION, default=defaults[CONF_REGION]): vol.In(
84  {"na": "North America", "cn": "China", None: "Rest of world"}
85  ),
86  vol.Optional(
87  CONF_UNIT_SYSTEM, default=defaults[CONF_UNIT_SYSTEM]
88  ): vol.In(
89  {
90  UNIT_SYSTEM_METRIC: "Metric",
91  UNIT_SYSTEM_SCANDINAVIAN_MILES: (
92  "Metric with Scandinavian Miles"
93  ),
94  UNIT_SYSTEM_IMPERIAL: "Imperial",
95  }
96  ),
97  vol.Optional(CONF_MUTABLE, default=defaults[CONF_MUTABLE]): bool,
98  },
99  )
100 
101  return self.async_show_formasync_show_formasync_show_form(
102  step_id="user", data_schema=user_schema, errors=errors
103  )
104 
105  async def async_step_reauth(
106  self, entry_data: Mapping[str, Any]
107  ) -> ConfigFlowResult:
108  """Perform reauth upon an API authentication error."""
109  return await self.async_step_userasync_step_userasync_step_user()
110 
111  async def is_valid(self, user_input):
112  """Check for user input errors."""
113 
114  session = async_get_clientsession(self.hass)
115 
116  region: str | None = user_input.get(CONF_REGION)
117 
118  connection = Connection(
119  session=session,
120  username=user_input[CONF_USERNAME],
121  password=user_input[CONF_PASSWORD],
122  service_url=None,
123  region=region,
124  )
125 
126  test_volvo_data = VolvoData(self.hass, connection, user_input)
127 
128  await test_volvo_data.auth_is_valid()
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:41
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:107
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_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)
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)