Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the Lutron integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 from urllib.error import HTTPError
8 
9 from pylutron import Lutron
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 
20 class LutronConfigFlow(ConfigFlow, domain=DOMAIN):
21  """User prompt for Main Repeater configuration information."""
22 
23  VERSION = 1
24 
25  async def async_step_user(
26  self, user_input: dict[str, Any] | None = None
27  ) -> ConfigFlowResult:
28  """First step in the config flow."""
29  errors = {}
30 
31  if user_input is not None:
32  ip_address = user_input[CONF_HOST]
33 
34  main_repeater = Lutron(
35  ip_address,
36  user_input.get(CONF_USERNAME),
37  user_input.get(CONF_PASSWORD),
38  )
39 
40  try:
41  await self.hass.async_add_executor_job(main_repeater.load_xml_db)
42  except HTTPError:
43  _LOGGER.exception("Http error")
44  errors["base"] = "cannot_connect"
45  except Exception:
46  _LOGGER.exception("Unknown error")
47  errors["base"] = "unknown"
48  else:
49  guid = main_repeater.guid
50 
51  if len(guid) <= 10:
52  errors["base"] = "cannot_connect"
53 
54  if not errors:
55  await self.async_set_unique_idasync_set_unique_id(guid)
56  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
57 
58  return self.async_create_entryasync_create_entryasync_create_entry(title="Lutron", data=user_input)
59 
60  return self.async_show_formasync_show_formasync_show_form(
61  step_id="user",
62  data_schema=vol.Schema(
63  {
64  vol.Required(CONF_HOST): str,
65  vol.Required(CONF_USERNAME, default="lutron"): str,
66  vol.Required(CONF_PASSWORD, default="integration"): str,
67  }
68  ),
69  errors=errors,
70  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:27
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)