Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for zeversolar integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import voluptuous as vol
9 import zeversolar
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_HOST
13 from homeassistant.helpers import config_validation as cv
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 STEP_USER_DATA_SCHEMA = vol.Schema(
20  {
21  vol.Required(CONF_HOST): cv.string,
22  },
23 )
24 
25 
26 class ZeverSolarConfigFlow(ConfigFlow, domain=DOMAIN):
27  """Handle a config flow for zeversolar."""
28 
29  VERSION = 1
30 
31  async def async_step_user(
32  self, user_input: dict[str, Any] | None = None
33  ) -> ConfigFlowResult:
34  """Handle the initial step."""
35  if user_input is None:
36  return self.async_show_formasync_show_formasync_show_form(
37  step_id="user", data_schema=STEP_USER_DATA_SCHEMA
38  )
39 
40  errors = {}
41 
42  client = zeversolar.ZeverSolarClient(host=user_input[CONF_HOST])
43  try:
44  data = await self.hass.async_add_executor_job(client.get_data)
45  except zeversolar.ZeverSolarHTTPNotFound:
46  errors["base"] = "invalid_host"
47  except zeversolar.ZeverSolarHTTPError:
48  errors["base"] = "cannot_connect"
49  except zeversolar.ZeverSolarTimeout:
50  errors["base"] = "timeout_connect"
51  except Exception:
52  _LOGGER.exception("Unexpected exception")
53  errors["base"] = "unknown"
54  else:
55  await self.async_set_unique_idasync_set_unique_id(data.serial_number)
56  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
57  return self.async_create_entryasync_create_entryasync_create_entry(title="Zeversolar", data=user_input)
58 
59  return self.async_show_formasync_show_formasync_show_form(
60  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
61  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:33
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)