Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for melnor."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 import voluptuous as vol
8 
9 from homeassistant.components.bluetooth import async_discovered_service_info
10 from homeassistant.components.bluetooth.models import BluetoothServiceInfoBleak
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_ADDRESS
13 
14 from .const import DOMAIN, MANUFACTURER_DATA_START, MANUFACTURER_ID
15 
16 
17 class MelnorConfigFlow(ConfigFlow, domain=DOMAIN):
18  """Handle a config flow for melnor."""
19 
20  VERSION = 1
21 
22  def __init__(self) -> None:
23  """Initialize the config flow."""
24  self._discovered_address_discovered_address: str
25  self._discovered_addresses: list[str] = []
26 
27  def _create_entry(self, address: str) -> ConfigFlowResult:
28  """Create an entry for a discovered device."""
29 
30  return self.async_create_entryasync_create_entryasync_create_entry(
31  title=address,
32  data={
33  CONF_ADDRESS: address,
34  },
35  )
36 
38  self, user_input: dict[str, Any] | None = None
39  ) -> ConfigFlowResult:
40  """Handle user-confirmation of discovered device."""
41 
42  if user_input is not None:
43  return self._create_entry_create_entry(self._discovered_address_discovered_address)
44 
45  return self.async_show_formasync_show_formasync_show_form(
46  step_id="bluetooth_confirm",
47  description_placeholders={"name": self._discovered_address_discovered_address},
48  )
49 
51  self, discovery_info: BluetoothServiceInfoBleak
52  ) -> ConfigFlowResult:
53  """Handle a flow initialized by Bluetooth discovery."""
54 
55  address = discovery_info.address
56 
57  await self.async_set_unique_idasync_set_unique_id(address)
58  self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_ADDRESS: address})
59 
60  self._discovered_address_discovered_address = address
61 
62  self.context["title_placeholders"] = {"name": address}
63  return await self.async_step_bluetooth_confirmasync_step_bluetooth_confirm()
64 
66  self, user_input: dict[str, Any] | None = None
67  ) -> ConfigFlowResult:
68  """Handle the step to pick discovered device."""
69 
70  if user_input is not None:
71  address = user_input[CONF_ADDRESS]
72 
73  await self.async_set_unique_idasync_set_unique_id(address, raise_on_progress=False)
74  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
75 
76  return self._create_entry_create_entry(address)
77 
78  current_addresses = self._async_current_ids_async_current_ids()
79  for discovery_info in async_discovered_service_info(
80  self.hass, connectable=True
81  ):
82  if discovery_info.manufacturer_id == MANUFACTURER_ID and any(
83  manufacturer_data.startswith(MANUFACTURER_DATA_START)
84  for manufacturer_data in discovery_info.manufacturer_data.values()
85  ):
86  address = discovery_info.address
87  if (
88  address not in current_addresses
89  and address not in self._discovered_addresses
90  ):
91  self._discovered_addresses.append(address)
92 
93  addresses = {
94  address
95  for address in self._discovered_addresses
96  if address not in current_addresses
97  }
98 
99  # Check if there is at least one device
100  if not addresses:
101  return self.async_abortasync_abortasync_abort(reason="no_devices_found")
102 
103  return self.async_show_formasync_show_formasync_show_form(
104  step_id="pick_device",
105  data_schema=vol.Schema({vol.Required(CONF_ADDRESS): vol.In(addresses)}),
106  )
107 
108  async def async_step_user(
109  self, user_input: dict[str, Any] | None = None
110  ) -> ConfigFlowResult:
111  """Handle a flow initialized by the user."""
112 
113  return await self.async_step_pick_deviceasync_step_pick_device()
ConfigFlowResult async_step_bluetooth_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:39
ConfigFlowResult _create_entry(self, str address)
Definition: config_flow.py:27
ConfigFlowResult async_step_bluetooth(self, BluetoothServiceInfoBleak discovery_info)
Definition: config_flow.py:52
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:110
ConfigFlowResult async_step_pick_device(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:67
None _abort_if_unique_id_configured(self, dict[str, Any]|None updates=None, bool reload_on_update=True, *str error="already_configured")
set[str|None] _async_current_ids(self, bool include_ignore=True)
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)
Iterable[BluetoothServiceInfoBleak] async_discovered_service_info(HomeAssistant hass, bool connectable=True)
Definition: api.py:72