Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for kmtronic integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import aiohttp
9 from pykmtronic.auth import Auth
10 from pykmtronic.hub import KMTronicHubAPI
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import (
14  ConfigEntry,
15  ConfigFlow,
16  ConfigFlowResult,
17  OptionsFlow,
18 )
19 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
20 from homeassistant.core import HomeAssistant, callback
21 from homeassistant.exceptions import HomeAssistantError
22 from homeassistant.helpers import aiohttp_client
23 
24 from .const import CONF_REVERSE, DOMAIN
25 
26 _LOGGER = logging.getLogger(__name__)
27 
28 DATA_SCHEMA = vol.Schema(
29  {
30  vol.Required(CONF_HOST): str,
31  vol.Required(CONF_USERNAME): str,
32  vol.Required(CONF_PASSWORD): str,
33  }
34 )
35 
36 
37 async def validate_input(hass: HomeAssistant, data):
38  """Validate the user input allows us to connect."""
39  session = aiohttp_client.async_get_clientsession(hass)
40  auth = Auth(
41  session,
42  f"http://{data[CONF_HOST]}",
43  data[CONF_USERNAME],
44  data[CONF_PASSWORD],
45  )
46  hub = KMTronicHubAPI(auth)
47 
48  try:
49  await hub.async_get_status()
50  except aiohttp.client_exceptions.ClientResponseError as err:
51  raise InvalidAuth from err
52  except aiohttp.client_exceptions.ClientConnectorError as err:
53  raise CannotConnect from err
54 
55  return data
56 
57 
58 class KmtronicConfigFlow(ConfigFlow, domain=DOMAIN):
59  """Handle a config flow for kmtronic."""
60 
61  VERSION = 1
62 
63  @staticmethod
64  @callback
66  config_entry: ConfigEntry,
67  ) -> KMTronicOptionsFlow:
68  """Get the options flow for this handler."""
69  return KMTronicOptionsFlow()
70 
71  async def async_step_user(
72  self, user_input: dict[str, Any] | None = None
73  ) -> ConfigFlowResult:
74  """Handle the initial step."""
75  errors = {}
76  if user_input is not None:
77  try:
78  info = await validate_input(self.hass, user_input)
79 
80  return self.async_create_entryasync_create_entryasync_create_entry(title=info["host"], data=user_input)
81  except CannotConnect:
82  errors["base"] = "cannot_connect"
83  except InvalidAuth:
84  errors["base"] = "invalid_auth"
85  except Exception:
86  _LOGGER.exception("Unexpected exception")
87  errors["base"] = "unknown"
88 
89  return self.async_show_formasync_show_formasync_show_form(
90  step_id="user", data_schema=DATA_SCHEMA, errors=errors
91  )
92 
93 
95  """Error to indicate we cannot connect."""
96 
97 
99  """Error to indicate there is invalid auth."""
100 
101 
103  """Handle options."""
104 
105  async def async_step_init(
106  self, user_input: dict[str, Any] | None = None
107  ) -> ConfigFlowResult:
108  """Manage the options."""
109  if user_input is not None:
110  return self.async_create_entryasync_create_entry(title="", data=user_input)
111 
112  return self.async_show_formasync_show_form(
113  step_id="init",
114  data_schema=vol.Schema(
115  {
116  vol.Optional(
117  CONF_REVERSE,
118  default=self.config_entryconfig_entryconfig_entry.options.get(CONF_REVERSE),
119  ): bool,
120  }
121  ),
122  )
ConfigFlowResult async_step_init(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:107
KMTronicOptionsFlow async_get_options_flow(ConfigEntry config_entry)
Definition: config_flow.py:67
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:73
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)
None config_entry(self, ConfigEntry value)
_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)
def validate_input(HomeAssistant hass, data)
Definition: config_flow.py:37