Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Duke Energy integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from aiodukeenergy import DukeEnergy
9 from aiohttp import ClientError, ClientResponseError
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, CONF_USERNAME
14 from homeassistant.helpers.aiohttp_client import async_get_clientsession
15 
16 from .const import DOMAIN
17 
18 _LOGGER = logging.getLogger(__name__)
19 
20 STEP_USER_DATA_SCHEMA = vol.Schema(
21  {
22  vol.Required(CONF_USERNAME): str,
23  vol.Required(CONF_PASSWORD): str,
24  }
25 )
26 
27 
28 class DukeEnergyConfigFlow(ConfigFlow, domain=DOMAIN):
29  """Handle a config flow for Duke Energy."""
30 
31  VERSION = 1
32 
33  async def async_step_user(
34  self, user_input: dict[str, Any] | None = None
35  ) -> ConfigFlowResult:
36  """Handle the initial step."""
37  errors: dict[str, str] = {}
38  if user_input is not None:
39  session = async_get_clientsession(self.hass)
40  api = DukeEnergy(
41  user_input[CONF_USERNAME], user_input[CONF_PASSWORD], session
42  )
43  try:
44  auth = await api.authenticate()
45  except ClientResponseError as e:
46  errors["base"] = "invalid_auth" if e.status == 404 else "cannot_connect"
47  except (ClientError, TimeoutError):
48  errors["base"] = "cannot_connect"
49  except Exception:
50  _LOGGER.exception("Unexpected exception")
51  errors["base"] = "unknown"
52  else:
53  username = auth["cdp_internal_user_id"].lower()
54  await self.async_set_unique_idasync_set_unique_id(username)
55  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
56  email = auth["email"].lower()
57  data = {
58  CONF_EMAIL: email,
59  CONF_USERNAME: username,
60  CONF_PASSWORD: user_input[CONF_PASSWORD],
61  }
62  self._async_abort_entries_match_async_abort_entries_match(data)
63  return self.async_create_entryasync_create_entryasync_create_entry(title=email, data=data)
64 
65  return self.async_show_formasync_show_formasync_show_form(
66  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
67  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:35
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)
None _async_abort_entries_match(self, dict[str, Any]|None match_dict=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)