Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """The config_flow for APsystems local API integration."""
2 
3 from typing import Any
4 
5 from aiohttp.client_exceptions import ClientConnectionError
6 from APsystemsEZ1 import APsystemsEZ1M
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 from homeassistant.const import CONF_IP_ADDRESS, CONF_PORT
11 from homeassistant.helpers.aiohttp_client import async_get_clientsession
13 
14 from .const import DEFAULT_PORT, DOMAIN
15 
16 DATA_SCHEMA = vol.Schema(
17  {
18  vol.Required(CONF_IP_ADDRESS): cv.string,
19  vol.Optional(CONF_PORT): cv.port,
20  }
21 )
22 
23 
24 class APsystemsLocalAPIFlow(ConfigFlow, domain=DOMAIN):
25  """Config flow for Apsystems local."""
26 
27  VERSION = 1
28 
29  async def async_step_user(
30  self, user_input: dict[str, Any] | None = None
31  ) -> ConfigFlowResult:
32  """Handle a flow initialized by the user."""
33  errors = {}
34 
35  if user_input is not None:
36  session = async_get_clientsession(self.hass, False)
37  api = APsystemsEZ1M(
38  ip_address=user_input[CONF_IP_ADDRESS],
39  port=user_input.get(CONF_PORT, DEFAULT_PORT),
40  session=session,
41  )
42  try:
43  device_info = await api.get_device_info()
44  except (TimeoutError, ClientConnectionError):
45  errors["base"] = "cannot_connect"
46  else:
47  await self.async_set_unique_idasync_set_unique_id(device_info.deviceId)
48  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
49  return self.async_create_entryasync_create_entryasync_create_entry(
50  title="Solar",
51  data=user_input,
52  )
53 
54  return self.async_show_formasync_show_formasync_show_form(
55  step_id="user",
56  data_schema=DATA_SCHEMA,
57  errors=errors,
58  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:31
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)