Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Adds config flow for Trafikverket Camera integration."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 from typing import Any
7 
8 from pytrafikverket import (
9  CameraInfoModel,
10  InvalidAuthentication,
11  NoCameraFound,
12  TrafikverketCamera,
13  UnknownError,
14 )
15 import voluptuous as vol
16 
17 from homeassistant.config_entries import (
18  SOURCE_RECONFIGURE,
19  ConfigFlow,
20  ConfigFlowResult,
21 )
22 from homeassistant.const import CONF_API_KEY, CONF_ID, CONF_LOCATION
23 from homeassistant.helpers.aiohttp_client import async_get_clientsession
25  SelectOptionDict,
26  SelectSelector,
27  SelectSelectorConfig,
28  SelectSelectorMode,
29  TextSelector,
30 )
31 
32 from .const import DOMAIN
33 
34 
35 class TVCameraConfigFlow(ConfigFlow, domain=DOMAIN):
36  """Handle a config flow for Trafikverket Camera integration."""
37 
38  VERSION = 3
39 
40  cameras: list[CameraInfoModel]
41  api_key: str
42 
43  async def validate_input(
44  self, sensor_api: str, location: str
45  ) -> tuple[dict[str, str], list[CameraInfoModel] | None]:
46  """Validate input from user input."""
47  errors: dict[str, str] = {}
48  cameras: list[CameraInfoModel] | None = None
49 
50  web_session = async_get_clientsession(self.hass)
51  camera_api = TrafikverketCamera(web_session, sensor_api)
52  try:
53  cameras = await camera_api.async_get_cameras(location)
54  except NoCameraFound:
55  errors["location"] = "invalid_location"
56  except InvalidAuthentication:
57  errors["base"] = "invalid_auth"
58  except UnknownError:
59  errors["base"] = "cannot_connect"
60 
61  return (errors, cameras)
62 
63  async def async_step_reauth(
64  self, entry_data: Mapping[str, Any]
65  ) -> ConfigFlowResult:
66  """Handle re-authentication with Trafikverket."""
67 
68  return await self.async_step_reauth_confirmasync_step_reauth_confirm()
69 
71  self, user_input: dict[str, Any] | None = None
72  ) -> ConfigFlowResult:
73  """Confirm re-authentication with Trafikverket."""
74  errors: dict[str, str] = {}
75 
76  if user_input:
77  api_key = user_input[CONF_API_KEY]
78 
79  reauth_entry = self._get_reauth_entry_get_reauth_entry()
80  errors, _ = await self.validate_inputvalidate_input(api_key, reauth_entry.data[CONF_ID])
81 
82  if not errors:
83  return self.async_update_reload_and_abortasync_update_reload_and_abort(
84  reauth_entry, data_updates={CONF_API_KEY: api_key}
85  )
86 
87  return self.async_show_formasync_show_formasync_show_form(
88  step_id="reauth_confirm",
89  data_schema=vol.Schema(
90  {
91  vol.Required(CONF_API_KEY): TextSelector(),
92  }
93  ),
94  errors=errors,
95  )
96 
98  self, user_input: dict[str, Any] | None = None
99  ) -> ConfigFlowResult:
100  """Handle re-configuration with Trafikverket."""
101  errors: dict[str, str] = {}
102  reconfigure_entry = self._get_reconfigure_entry_get_reconfigure_entry()
103 
104  if user_input:
105  api_key = user_input[CONF_API_KEY]
106  location = user_input[CONF_LOCATION]
107 
108  errors, cameras = await self.validate_inputvalidate_input(api_key, location)
109 
110  if not errors and cameras:
111  if len(cameras) > 1:
112  self.camerascameras = cameras
113  self.api_keyapi_key = api_key
114  return await self.async_step_multiple_camerasasync_step_multiple_cameras()
115  await self.async_set_unique_idasync_set_unique_id(f"{DOMAIN}-{cameras[0].camera_id}")
116  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
117  return self.async_update_reload_and_abortasync_update_reload_and_abort(
118  reconfigure_entry,
119  unique_id=f"{DOMAIN}-{cameras[0].camera_id}",
120  title=cameras[0].camera_name or "Trafikverket Camera",
121  data={CONF_API_KEY: api_key, CONF_ID: cameras[0].camera_id},
122  )
123 
124  schema = self.add_suggested_values_to_schemaadd_suggested_values_to_schema(
125  vol.Schema(
126  {
127  vol.Required(CONF_API_KEY): TextSelector(),
128  vol.Required(CONF_LOCATION): TextSelector(),
129  }
130  ),
131  {**reconfigure_entry.data, **(user_input or {})},
132  )
133 
134  return self.async_show_formasync_show_formasync_show_form(
135  step_id="reconfigure",
136  data_schema=schema,
137  errors=errors,
138  )
139 
140  async def async_step_user(
141  self, user_input: dict[str, str] | None = None
142  ) -> ConfigFlowResult:
143  """Handle the initial step."""
144  errors: dict[str, str] = {}
145 
146  if user_input:
147  api_key = user_input[CONF_API_KEY]
148  location = user_input[CONF_LOCATION]
149 
150  errors, cameras = await self.validate_inputvalidate_input(api_key, location)
151 
152  if not errors and cameras:
153  if len(cameras) > 1:
154  self.camerascameras = cameras
155  self.api_keyapi_key = api_key
156  return await self.async_step_multiple_camerasasync_step_multiple_cameras()
157  await self.async_set_unique_idasync_set_unique_id(f"{DOMAIN}-{cameras[0].camera_id}")
158  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
159  return self.async_create_entryasync_create_entryasync_create_entry(
160  title=cameras[0].camera_name or "Trafikverket Camera",
161  data={CONF_API_KEY: api_key, CONF_ID: cameras[0].camera_id},
162  )
163 
164  return self.async_show_formasync_show_formasync_show_form(
165  step_id="user",
166  data_schema=vol.Schema(
167  {
168  vol.Required(CONF_API_KEY): TextSelector(),
169  vol.Required(CONF_LOCATION): TextSelector(),
170  }
171  ),
172  errors=errors,
173  )
174 
176  self, user_input: dict[str, str] | None = None
177  ) -> ConfigFlowResult:
178  """Handle when multiple cameras."""
179 
180  if user_input:
181  errors, cameras = await self.validate_inputvalidate_input(
182  self.api_keyapi_key, user_input[CONF_ID]
183  )
184 
185  if not errors and cameras:
186  if self.sourcesourcesourcesource == SOURCE_RECONFIGURE:
187  return self.async_update_reload_and_abortasync_update_reload_and_abort(
188  self._get_reconfigure_entry_get_reconfigure_entry(),
189  unique_id=f"{DOMAIN}-{cameras[0].camera_id}",
190  title=cameras[0].camera_name or "Trafikverket Camera",
191  data={
192  CONF_API_KEY: self.api_keyapi_key,
193  CONF_ID: cameras[0].camera_id,
194  },
195  )
196  await self.async_set_unique_idasync_set_unique_id(f"{DOMAIN}-{cameras[0].camera_id}")
197  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
198  return self.async_create_entryasync_create_entryasync_create_entry(
199  title=cameras[0].camera_name or "Trafikverket Camera",
200  data={CONF_API_KEY: self.api_keyapi_key, CONF_ID: cameras[0].camera_id},
201  )
202 
203  camera_choices = [
205  value=f"{camera_info.camera_id}",
206  label=f"{camera_info.camera_id} - {camera_info.camera_name} - {camera_info.location}",
207  )
208  for camera_info in self.camerascameras
209  ]
210 
211  return self.async_show_formasync_show_formasync_show_form(
212  step_id="multiple_cameras",
213  data_schema=vol.Schema(
214  {
215  vol.Required(CONF_ID): SelectSelector(
217  options=camera_choices, mode=SelectSelectorMode.LIST
218  )
219  ),
220  }
221  ),
222  )
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:65
ConfigFlowResult async_step_user(self, dict[str, str]|None user_input=None)
Definition: config_flow.py:142
ConfigFlowResult async_step_multiple_cameras(self, dict[str, str]|None user_input=None)
Definition: config_flow.py:177
tuple[dict[str, str], list[CameraInfoModel]|None] validate_input(self, str sensor_api, str location)
Definition: config_flow.py:45
ConfigFlowResult async_step_reauth_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:72
ConfigFlowResult async_step_reconfigure(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:99
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_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)
vol.Schema add_suggested_values_to_schema(self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_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)