Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure Goodwe inverters using their local API."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from goodwe import InverterError, connect
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_HOST
13 
14 from .const import CONF_MODEL_FAMILY, DEFAULT_NAME, DOMAIN
15 
16 CONFIG_SCHEMA = vol.Schema(
17  {
18  vol.Required(CONF_HOST): str,
19  }
20 )
21 
22 _LOGGER = logging.getLogger(__name__)
23 
24 
25 class GoodweFlowHandler(ConfigFlow, domain=DOMAIN):
26  """Handle a Goodwe config flow."""
27 
28  VERSION = 1
29 
30  async def async_step_user(
31  self, user_input: dict[str, Any] | None = None
32  ) -> ConfigFlowResult:
33  """Handle a flow initialized by the user."""
34  errors = {}
35  if user_input is not None:
36  host = user_input[CONF_HOST]
37 
38  try:
39  inverter = await connect(host=host, retries=10)
40  except InverterError:
41  errors[CONF_HOST] = "connection_error"
42  else:
43  await self.async_set_unique_idasync_set_unique_id(inverter.serial_number)
44  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
45 
46  return self.async_create_entryasync_create_entryasync_create_entry(
47  title=DEFAULT_NAME,
48  data={
49  CONF_HOST: host,
50  CONF_MODEL_FAMILY: type(inverter).__name__,
51  },
52  )
53 
54  return self.async_show_formasync_show_formasync_show_form(
55  step_id="user", data_schema=CONFIG_SCHEMA, errors=errors
56  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:32
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)