Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for govee ble integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from govee_ble import GoveeBluetoothDeviceData as DeviceData
8 import voluptuous as vol
9 
11  BluetoothServiceInfoBleak,
12  async_discovered_service_info,
13 )
14 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
15 from homeassistant.const import CONF_ADDRESS
16 
17 from .const import CONF_DEVICE_TYPE, DOMAIN
18 
19 
20 class GoveeConfigFlow(ConfigFlow, domain=DOMAIN):
21  """Handle a config flow for govee."""
22 
23  VERSION = 1
24 
25  def __init__(self) -> None:
26  """Initialize the config flow."""
27  self._discovery_info_discovery_info: BluetoothServiceInfoBleak | None = None
28  self._discovered_device_discovered_device: DeviceData | None = None
29  self._discovered_devices: dict[
30  str, tuple[DeviceData, BluetoothServiceInfoBleak]
31  ] = {}
32 
34  self, discovery_info: BluetoothServiceInfoBleak
35  ) -> ConfigFlowResult:
36  """Handle the bluetooth discovery step."""
37  await self.async_set_unique_idasync_set_unique_id(discovery_info.address)
38  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
39  device = DeviceData()
40  if not device.supported(discovery_info):
41  return self.async_abortasync_abortasync_abort(reason="not_supported")
42  self._discovery_info_discovery_info = discovery_info
43  self._discovered_device_discovered_device = device
44  return await self.async_step_bluetooth_confirmasync_step_bluetooth_confirm()
45 
47  self, user_input: dict[str, Any] | None = None
48  ) -> ConfigFlowResult:
49  """Confirm discovery."""
50  assert self._discovered_device_discovered_device is not None
51  device = self._discovered_device_discovered_device
52  assert self._discovery_info_discovery_info is not None
53  discovery_info = self._discovery_info_discovery_info
54  title = device.title or device.get_device_name() or discovery_info.name
55  if user_input is not None:
56  return self.async_create_entryasync_create_entryasync_create_entry(
57  title=title, data={CONF_DEVICE_TYPE: device.device_type}
58  )
59 
60  self._set_confirm_only_set_confirm_only()
61  placeholders = {"name": title}
62  self.context["title_placeholders"] = placeholders
63  return self.async_show_formasync_show_formasync_show_form(
64  step_id="bluetooth_confirm", description_placeholders=placeholders
65  )
66 
67  async def async_step_user(
68  self, user_input: dict[str, Any] | None = None
69  ) -> ConfigFlowResult:
70  """Handle the user step to pick discovered device."""
71  if user_input is not None:
72  address = user_input[CONF_ADDRESS]
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  device, service_info = self._discovered_devices[address]
76  title = device.title or device.get_device_name() or service_info.name
77  return self.async_create_entryasync_create_entryasync_create_entry(
78  title=title, data={CONF_DEVICE_TYPE: device.device_type}
79  )
80 
81  current_addresses = self._async_current_ids_async_current_ids()
82  for discovery_info in async_discovered_service_info(self.hass, False):
83  address = discovery_info.address
84  if address in current_addresses or address in self._discovered_devices:
85  continue
86  device = DeviceData()
87  if device.supported(discovery_info):
88  self._discovered_devices[address] = (device, discovery_info)
89 
90  if not self._discovered_devices:
91  return self.async_abortasync_abortasync_abort(reason="no_devices_found")
92 
93  return self.async_show_formasync_show_formasync_show_form(
94  step_id="user",
95  data_schema=vol.Schema(
96  {
97  vol.Required(CONF_ADDRESS): vol.In(
98  {
99  address: f"{device.get_device_name(None) or discovery_info.name} ({address})"
100  for address, (
101  device,
102  discovery_info,
103  ) in self._discovered_devices.items()
104  }
105  )
106  }
107  ),
108  )
ConfigFlowResult async_step_bluetooth(self, BluetoothServiceInfoBleak discovery_info)
Definition: config_flow.py:35
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:69
ConfigFlowResult async_step_bluetooth_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:48
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