Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Tasmota."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 import voluptuous as vol
8 
9 from homeassistant.components.mqtt import valid_subscribe_topic
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.helpers.service_info.mqtt import MqttServiceInfo
12 
13 from .const import CONF_DISCOVERY_PREFIX, DEFAULT_PREFIX, DOMAIN
14 
15 
16 class FlowHandler(ConfigFlow, domain=DOMAIN):
17  """Handle a config flow."""
18 
19  VERSION = 1
20 
21  def __init__(self) -> None:
22  """Initialize flow."""
23  self._prefix_prefix = DEFAULT_PREFIX
24 
25  async def async_step_mqtt(
26  self, discovery_info: MqttServiceInfo
27  ) -> ConfigFlowResult:
28  """Handle a flow initialized by MQTT discovery."""
29  if self._async_in_progress_async_in_progress() or self._async_current_entries_async_current_entries():
30  return self.async_abortasync_abortasync_abort(reason="single_instance_allowed")
31 
32  await self.async_set_unique_idasync_set_unique_id(DOMAIN)
33 
34  # Validate the message, abort if it fails
35  if not discovery_info.topic.endswith("/config"):
36  # Not a Tasmota discovery message
37  return self.async_abortasync_abortasync_abort(reason="invalid_discovery_info")
38  if not discovery_info.payload:
39  # Empty payload, the Tasmota is not configured for native discovery
40  return self.async_abortasync_abortasync_abort(reason="invalid_discovery_info")
41 
42  # "tasmota/discovery/#" is hardcoded in Tasmota's manifest
43  assert discovery_info.subscribed_topic == "tasmota/discovery/#"
44  self._prefix_prefix = "tasmota/discovery"
45 
46  return await self.async_step_confirmasync_step_confirm()
47 
48  async def async_step_user(
49  self, user_input: dict[str, Any] | None = None
50  ) -> ConfigFlowResult:
51  """Handle a flow initialized by the user."""
52  if self._async_current_entries_async_current_entries():
53  return self.async_abortasync_abortasync_abort(reason="single_instance_allowed")
54 
55  if self.show_advanced_optionsshow_advanced_options:
56  return await self.async_step_configasync_step_config()
57  return await self.async_step_confirmasync_step_confirm()
58 
59  async def async_step_config(
60  self, user_input: dict[str, Any] | None = None
61  ) -> ConfigFlowResult:
62  """Confirm the setup."""
63  errors = {}
64  data = {CONF_DISCOVERY_PREFIX: self._prefix_prefix}
65 
66  if user_input is not None:
67  bad_prefix = False
68  prefix = user_input[CONF_DISCOVERY_PREFIX]
69  if prefix.endswith("/#"):
70  prefix = prefix[:-2]
71  try:
72  valid_subscribe_topic(f"{prefix}/#")
73  except vol.Invalid:
74  errors["base"] = "invalid_discovery_topic"
75  bad_prefix = True
76  else:
77  data[CONF_DISCOVERY_PREFIX] = prefix
78  if not bad_prefix:
79  return self.async_create_entryasync_create_entryasync_create_entry(title="Tasmota", data=data)
80 
81  fields = {}
82  fields[vol.Optional(CONF_DISCOVERY_PREFIX, default=self._prefix_prefix)] = str
83 
84  return self.async_show_formasync_show_formasync_show_form(
85  step_id="config", data_schema=vol.Schema(fields), errors=errors
86  )
87 
88  async def async_step_confirm(
89  self, user_input: dict[str, Any] | None = None
90  ) -> ConfigFlowResult:
91  """Confirm the setup."""
92 
93  data = {CONF_DISCOVERY_PREFIX: self._prefix_prefix}
94 
95  if user_input is not None:
96  return self.async_create_entryasync_create_entryasync_create_entry(title="Tasmota", data=data)
97 
98  return self.async_show_formasync_show_formasync_show_form(step_id="confirm")
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:50
ConfigFlowResult async_step_mqtt(self, MqttServiceInfo discovery_info)
Definition: config_flow.py:27
ConfigFlowResult async_step_config(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:61
ConfigFlowResult async_step_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:90
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)
list[ConfigEntry] _async_current_entries(self, bool|None include_ignore=None)
list[ConfigFlowResult] _async_in_progress(self, bool include_uninitialized=False, dict[str, Any]|None match_context=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)
bool show_advanced_options(self)
_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)
str valid_subscribe_topic(Any topic)
Definition: util.py:270