Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Pure Energie integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from gridnet import Device, GridNet, GridNetConnectionError
8 import voluptuous as vol
9 
10 from homeassistant.components import zeroconf
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_HOST, CONF_NAME
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 from homeassistant.helpers.selector import TextSelector
15 
16 from .const import DOMAIN
17 
18 
19 class PureEnergieFlowHandler(ConfigFlow, domain=DOMAIN):
20  """Config flow for Pure Energie integration."""
21 
22  VERSION = 1
23  discovered_host: str
24  discovered_device: Device
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle a flow initialized by the user."""
30 
31  errors = {}
32 
33  if user_input is not None:
34  try:
35  device = await self._async_get_device_async_get_device(user_input[CONF_HOST])
36  except GridNetConnectionError:
37  errors["base"] = "cannot_connect"
38  else:
39  await self.async_set_unique_idasync_set_unique_id(device.n2g_id, raise_on_progress=False)
40  self._abort_if_unique_id_configured_abort_if_unique_id_configured(
41  updates={CONF_HOST: user_input[CONF_HOST]}
42  )
43  return self.async_create_entryasync_create_entryasync_create_entry(
44  title="Pure Energie Meter",
45  data={
46  CONF_HOST: user_input[CONF_HOST],
47  },
48  )
49 
50  return self.async_show_formasync_show_formasync_show_form(
51  step_id="user",
52  data_schema=vol.Schema(
53  {
54  vol.Required(CONF_HOST): TextSelector(),
55  }
56  ),
57  errors=errors or {},
58  )
59 
61  self, discovery_info: zeroconf.ZeroconfServiceInfo
62  ) -> ConfigFlowResult:
63  """Handle zeroconf discovery."""
64  self.discovered_hostdiscovered_host = discovery_info.host
65  try:
66  self.discovered_devicediscovered_device = await self._async_get_device_async_get_device(discovery_info.host)
67  except GridNetConnectionError:
68  return self.async_abortasync_abortasync_abort(reason="cannot_connect")
69 
70  await self.async_set_unique_idasync_set_unique_id(self.discovered_devicediscovered_device.n2g_id)
71  self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_HOST: discovery_info.host})
72 
73  self.context.update(
74  {
75  "title_placeholders": {
76  CONF_NAME: "Pure Energie Meter",
77  CONF_HOST: self.discovered_hostdiscovered_host,
78  "model": self.discovered_devicediscovered_device.model,
79  },
80  }
81  )
82  return await self.async_step_zeroconf_confirmasync_step_zeroconf_confirm()
83 
85  self, user_input: dict[str, Any] | None = None
86  ) -> ConfigFlowResult:
87  """Handle a flow initiated by zeroconf."""
88  if user_input is not None:
89  return self.async_create_entryasync_create_entryasync_create_entry(
90  title="Pure Energie Meter",
91  data={
92  CONF_HOST: self.discovered_hostdiscovered_host,
93  },
94  )
95 
96  return self.async_show_formasync_show_formasync_show_form(
97  step_id="zeroconf_confirm",
98  description_placeholders={
99  CONF_NAME: "Pure Energie Meter",
100  "model": self.discovered_devicediscovered_device.model,
101  },
102  )
103 
104  async def _async_get_device(self, host: str) -> Device:
105  """Get device information from Pure Energie device."""
106  session = async_get_clientsession(self.hass)
107  gridnet = GridNet(host, session=session)
108  return await gridnet.device()
ConfigFlowResult async_step_zeroconf(self, zeroconf.ZeroconfServiceInfo discovery_info)
Definition: config_flow.py:62
ConfigFlowResult async_step_zeroconf_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:86
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:28
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_abort(self, *str reason, Mapping[str, str]|None description_placeholders=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)
_FlowResultT async_abort(self, *str reason, Mapping[str, str]|None description_placeholders=None)
IssData update(pyiss.ISS iss)
Definition: __init__.py:33
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)