config_flow.py

Go to the documentation of this file.

"""Config flow for BTHome Bluetooth integration."""
 
from __future__ import annotations
 
from collections.abc import Mapping
import dataclasses
from typing import Any
 
from bthome_ble import BTHomeBluetoothDeviceData as DeviceData
from bthome_ble.parser import EncryptionScheme
import voluptuous as vol
 
from homeassistant.components import onboarding
from homeassistant.components.bluetooth import (
    BluetoothServiceInfoBleak,
    async_discovered_service_info,
)
from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_ADDRESS
 
from .const import DOMAIN
 
 
@dataclasses.dataclass
class Discovery:
    """A discovered bluetooth device."""
 
    title: str
    discovery_info: BluetoothServiceInfoBleak
    device: DeviceData
 
 
def _title(discovery_info: BluetoothServiceInfoBleak, device: DeviceData) -> str:
    return device.title or device.get_device_name() or discovery_info.name
 
 
class BTHomeConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for BTHome Bluetooth."""
 
    VERSION = 1
 
    def __init__(self) -> None:
        """Initialize the config flow."""
        self._discovery_info_discovery_info: BluetoothServiceInfoBleak | None = None
        self._discovered_device_discovered_device: DeviceData | None = None
        self._discovered_devices: dict[str, Discovery] = {}
 
    async def async_step_bluetooth(
        self, discovery_info: BluetoothServiceInfoBleak
    ) -> ConfigFlowResult:
        """Handle the bluetooth discovery step."""
        await self.async_set_unique_idasync_set_unique_id(discovery_info.address)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured()
        device = DeviceData()
 
        if not device.supported(discovery_info):
            return self.async_abortasync_abortasync_abort(reason="not_supported")
 
        title = _title(discovery_info, device)
        self.context["title_placeholders"] = {"name": title}
        self._discovery_info_discovery_info = discovery_info
        self._discovered_device_discovered_device = device
 
        if device.encryption_scheme == EncryptionScheme.BTHOME_BINDKEY:
            return await self.async_step_get_encryption_keyasync_step_get_encryption_key()
        return await self.async_step_bluetooth_confirmasync_step_bluetooth_confirm()
 
    async def async_step_get_encryption_key(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Enter a bindkey for an encrypted BTHome device."""
        assert self._discovery_info_discovery_info
        assert self._discovered_device_discovered_device
 
        errors = {}
 
        if user_input is not None:
            bindkey: str = user_input["bindkey"]
 
            if len(bindkey) != 32:
                errors["bindkey"] = "expected_32_characters"
            else:
                self._discovered_device_discovered_device.set_bindkey(bytes.fromhex(bindkey))
 
                # If we got this far we already know supported will
                # return true so we don't bother checking that again
                # We just want to retry the decryption
                self._discovered_device_discovered_device.supported(self._discovery_info_discovery_info)
 
                if self._discovered_device_discovered_device.bindkey_verified:
                    return self._async_get_or_create_entry_async_get_or_create_entry(bindkey)
 
                errors["bindkey"] = "decryption_failed"
 
        return self.async_show_formasync_show_formasync_show_form(
            step_id="get_encryption_key",
            description_placeholders=self.context["title_placeholders"],
            data_schema=vol.Schema({vol.Required("bindkey"): vol.All(str, vol.Strip)}),
            errors=errors,
        )
 
    async def async_step_bluetooth_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Confirm discovery."""
        if user_input is not None or not onboarding.async_is_onboarded(self.hass):
            return self._async_get_or_create_entry_async_get_or_create_entry()
 
        self._set_confirm_only_set_confirm_only()
        return self.async_show_formasync_show_formasync_show_form(
            step_id="bluetooth_confirm",
            description_placeholders=self.context["title_placeholders"],
        )
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the user step to pick discovered device."""
        if user_input is not None:
            address = user_input[CONF_ADDRESS]
            await self.async_set_unique_idasync_set_unique_id(address, raise_on_progress=False)
            self._abort_if_unique_id_configured_abort_if_unique_id_configured()
            discovery = self._discovered_devices[address]
 
            self.context["title_placeholders"] = {"name": discovery.title}
 
            self._discovery_info_discovery_info = discovery.discovery_info
            self._discovered_device_discovered_device = discovery.device
 
            if discovery.device.encryption_scheme == EncryptionScheme.BTHOME_BINDKEY:
                return await self.async_step_get_encryption_keyasync_step_get_encryption_key()
 
            return self._async_get_or_create_entry_async_get_or_create_entry()
 
        current_addresses = self._async_current_ids_async_current_ids()
        for discovery_info in async_discovered_service_info(self.hass, False):
            address = discovery_info.address
            if address in current_addresses or address in self._discovered_devices:
                continue
            device = DeviceData()
            if device.supported(discovery_info):
                self._discovered_devices[address] = Discovery(
                    title=_title(discovery_info, device),
                    discovery_info=discovery_info,
                    device=device,
                )
 
        if not self._discovered_devices:
            return self.async_abortasync_abortasync_abort(reason="no_devices_found")
 
        titles = {
            address: discovery.title
            for (address, discovery) in self._discovered_devices.items()
        }
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user",
            data_schema=vol.Schema({vol.Required(CONF_ADDRESS): vol.In(titles)}),
        )
 
    async def async_step_reauth(
        self, entry_data: Mapping[str, Any]
    ) -> ConfigFlowResult:
        """Handle a flow initialized by a reauth event."""
        device: DeviceData = entry_data["device"]
        self._discovered_device_discovered_device = device
 
        self._discovery_info_discovery_info = device.last_service_info
 
        if device.encryption_scheme == EncryptionScheme.BTHOME_BINDKEY:
            return await self.async_step_get_encryption_keyasync_step_get_encryption_key()
 
        # Otherwise there wasn't actually encryption so abort
        return self.async_abortasync_abortasync_abort(reason="reauth_successful")
 
    def _async_get_or_create_entry(
        self, bindkey: str | None = None
    ) -> ConfigFlowResult:
        data: dict[str, Any] = {}
        if bindkey:
            data["bindkey"] = bindkey
 
        if self.sourcesourcesourcesource == SOURCE_REAUTH:
            return self.async_update_reload_and_abortasync_update_reload_and_abort(
                self._get_reauth_entry_get_reauth_entry(), data=data
            )
 
        return self.async_create_entryasync_create_entryasync_create_entry(
            title=self.context["title_placeholders"]["name"],
            data=data,
        )