Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for myStrom integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import pymystrom
9 from pymystrom.exceptions import MyStromConnectionError
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_HOST, CONF_NAME
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 DEFAULT_NAME = "myStrom Device"
20 
21 STEP_USER_DATA_SCHEMA = vol.Schema(
22  {
23  vol.Optional(CONF_NAME, default=DEFAULT_NAME): str,
24  vol.Required(CONF_HOST): str,
25  }
26 )
27 
28 
29 class MyStromConfigFlow(ConfigFlow, domain=DOMAIN):
30  """Handle a config flow for myStrom."""
31 
32  VERSION = 1
33 
34  async def async_step_user(
35  self, user_input: dict[str, Any] | None = None
36  ) -> ConfigFlowResult:
37  """Handle the initial step."""
38  errors: dict[str, str] = {}
39 
40  if user_input is not None:
41  try:
42  info = await pymystrom.get_device_info(user_input[CONF_HOST])
43  except MyStromConnectionError:
44  errors["base"] = "cannot_connect"
45  else:
46  await self.async_set_unique_idasync_set_unique_id(info["mac"])
47  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
48  data = {CONF_HOST: user_input[CONF_HOST]}
49  title = user_input.get(CONF_NAME) or DEFAULT_NAME
50  return self.async_create_entryasync_create_entryasync_create_entry(title=title, data=data)
51 
52  schema = self.add_suggested_values_to_schemaadd_suggested_values_to_schema(STEP_USER_DATA_SCHEMA, user_input)
53  return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=schema, errors=errors)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:36
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)
vol.Schema add_suggested_values_to_schema(self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_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)