Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the RDW integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from vehicle import RDW, RDWError, RDWUnknownLicensePlateError
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.helpers.aiohttp_client import async_get_clientsession
12 
13 from .const import CONF_LICENSE_PLATE, DOMAIN
14 
15 
16 class RDWFlowHandler(ConfigFlow, domain=DOMAIN):
17  """Config flow for RDW."""
18 
19  VERSION = 1
20 
21  async def async_step_user(
22  self, user_input: dict[str, Any] | None = None
23  ) -> ConfigFlowResult:
24  """Handle a flow initialized by the user."""
25  errors = {}
26 
27  if user_input is not None:
28  session = async_get_clientsession(self.hass)
29  rdw = RDW(session=session)
30  try:
31  vehicle = await rdw.vehicle(
32  license_plate=user_input[CONF_LICENSE_PLATE]
33  )
34  except RDWUnknownLicensePlateError:
35  errors["base"] = "unknown_license_plate"
36  except RDWError:
37  errors["base"] = "cannot_connect"
38  else:
39  await self.async_set_unique_idasync_set_unique_id(vehicle.license_plate)
40  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
41  return self.async_create_entryasync_create_entryasync_create_entry(
42  title=user_input[CONF_LICENSE_PLATE],
43  data={
44  CONF_LICENSE_PLATE: vehicle.license_plate,
45  },
46  )
47 
48  return self.async_show_formasync_show_formasync_show_form(
49  step_id="user",
50  data_schema=vol.Schema(
51  {
52  vol.Required(CONF_LICENSE_PLATE): str,
53  }
54  ),
55  errors=errors,
56  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:23
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)
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)