config_flow.py

Go to the documentation of this file.

"""Config flow for Xiaomi Bluetooth integration."""
 
from __future__ import annotations
 
from collections.abc import Mapping
import dataclasses
import logging
from typing import Any
 
import voluptuous as vol
from xiaomi_ble import (
    XiaomiBluetoothDeviceData as DeviceData,
    XiaomiCloudException,
    XiaomiCloudInvalidAuthenticationException,
    XiaomiCloudTokenFetch,
)
from xiaomi_ble.parser import EncryptionScheme
 
from homeassistant.components import onboarding
from homeassistant.components.bluetooth import (
    BluetoothScanningMode,
    BluetoothServiceInfo,
    async_discovered_service_info,
    async_process_advertisements,
)
from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_ADDRESS, CONF_PASSWORD, CONF_USERNAME
from homeassistant.data_entry_flow import AbortFlow
from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
from .const import DOMAIN
 
# How long to wait for additional advertisement packets if we don't have the right ones
ADDITIONAL_DISCOVERY_TIMEOUT = 60
 
_LOGGER = logging.getLogger(__name__)
 
 
@dataclasses.dataclass
class Discovery:
    """A discovered bluetooth device."""
 
    title: str
    discovery_info: BluetoothServiceInfo
    device: DeviceData
 
 
def _title(discovery_info: BluetoothServiceInfo, device: DeviceData) -> str:
    return device.title or device.get_device_name() or discovery_info.name
 
 
class XiaomiConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Xiaomi Bluetooth."""
 
    VERSION = 1
 
    def __init__(self) -> None:
        """Initialize the config flow."""
        self._discovery_info_discovery_info: BluetoothServiceInfo | None = None
        self._discovered_device_discovered_device: DeviceData | None = None
        self._discovered_devices: dict[str, Discovery] = {}
 
    async def _async_wait_for_full_advertisement(
        self, discovery_info: BluetoothServiceInfo, device: DeviceData
    ) -> BluetoothServiceInfo:
        """Sometimes first advertisement we receive is blank or incomplete.
 
        Wait until we get a useful one.
        """
        if not device.pending:
            return discovery_info
 
        def _process_more_advertisements(
            service_info: BluetoothServiceInfo,
        ) -> bool:
            device.update(service_info)
            return not device.pending
 
        return await async_process_advertisements(
            self.hass,
            _process_more_advertisements,
            {"address": discovery_info.address},
            BluetoothScanningMode.ACTIVE,
            ADDITIONAL_DISCOVERY_TIMEOUT,
        )
 
    async def async_step_bluetooth(
        self, discovery_info: BluetoothServiceInfo
    ) -> 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._discovered_device_discovered_device = device
 
        # Wait until we have received enough information about
        # this device to detect its encryption type
        try:
            self._discovery_info_discovery_info = await self._async_wait_for_full_advertisement_async_wait_for_full_advertisement(
                discovery_info, device
            )
        except TimeoutError:
            # This device might have a really long advertising interval
            # So create a config entry for it, and if we discover it has
            # encryption later, we can do a reauth
            return await self.async_step_confirm_slowasync_step_confirm_slow()
 
        if device.encryption_scheme == EncryptionScheme.MIBEACON_LEGACY:
            return await self.async_step_get_encryption_key_legacyasync_step_get_encryption_key_legacy()
        if device.encryption_scheme == EncryptionScheme.MIBEACON_4_5:
            return await self.async_step_get_encryption_key_4_5_choose_methodasync_step_get_encryption_key_4_5_choose_method()
        return await self.async_step_bluetooth_confirmasync_step_bluetooth_confirm()
 
    async def async_step_get_encryption_key_legacy(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Enter a legacy bindkey for a v2/v3 MiBeacon device."""
        assert self._discovery_info_discovery_info
        assert self._discovered_device_discovered_device
 
        errors = {}
 
        if user_input is not None:
            bindkey = user_input["bindkey"]
 
            if len(bindkey) != 24:
                errors["bindkey"] = "expected_24_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_legacy",
            description_placeholders=self.context["title_placeholders"],
            data_schema=vol.Schema({vol.Required("bindkey"): vol.All(str, vol.Strip)}),
            errors=errors,
        )
 
    async def async_step_get_encryption_key_4_5(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Enter a bindkey for a v4/v5 MiBeacon device."""
        assert self._discovery_info_discovery_info
        assert self._discovered_device_discovered_device
 
        errors = {}
 
        if user_input is not None:
            bindkey = 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_4_5",
            description_placeholders=self.context["title_placeholders"],
            data_schema=vol.Schema({vol.Required("bindkey"): vol.All(str, vol.Strip)}),
            errors=errors,
        )
 
    async def async_step_cloud_auth(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the cloud auth step."""
        assert self._discovery_info_discovery_info
 
        errors: dict[str, str] = {}
        description_placeholders: dict[str, str] = {}
        if user_input is not None:
            session = async_get_clientsession(self.hass)
            fetcher = XiaomiCloudTokenFetch(
                user_input[CONF_USERNAME], user_input[CONF_PASSWORD], session
            )
            try:
                device_details = await fetcher.get_device_info(
                    self._discovery_info_discovery_info.address
                )
            except XiaomiCloudInvalidAuthenticationException as ex:
                _LOGGER.debug("Authentication failed: %s", ex, exc_info=True)
                errors = {"base": "auth_failed"}
                description_placeholders = {"error_detail": str(ex)}
            except XiaomiCloudException as ex:
                _LOGGER.debug("Failed to connect to MI API: %s", ex, exc_info=True)
                raise AbortFlow(
                    "api_error", description_placeholders={"error_detail": str(ex)}
                ) from ex
            else:
                if device_details:
                    return await self.async_step_get_encryption_key_4_5async_step_get_encryption_key_4_5(
                        {"bindkey": device_details.bindkey}
                    )
                errors = {"base": "api_device_not_found"}
 
        user_input = user_input or {}
        return self.async_show_formasync_show_formasync_show_form(
            step_id="cloud_auth",
            errors=errors,
            data_schema=vol.Schema(
                {
                    vol.Required(
                        CONF_USERNAME, default=user_input.get(CONF_USERNAME)
                    ): str,
                    vol.Required(CONF_PASSWORD): str,
                }
            ),
            description_placeholders={
                **self.context["title_placeholders"],
                **description_placeholders,
            },
        )
 
    async def async_step_get_encryption_key_4_5_choose_method(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Choose method to get the bind key for a version 4/5 device."""
        return self.async_show_menuasync_show_menu(
            step_id="get_encryption_key_4_5_choose_method",
            menu_options=["cloud_auth", "get_encryption_key_4_5"],
            description_placeholders=self.context["title_placeholders"],
        )
 
    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_confirm_slow(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Ack that device is slow."""
        if user_input is not None:
            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="confirm_slow",
            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}
 
            # Wait until we have received enough information about
            # this device to detect its encryption type
            try:
                self._discovery_info_discovery_info = await self._async_wait_for_full_advertisement_async_wait_for_full_advertisement(
                    discovery.discovery_info, discovery.device
                )
            except TimeoutError:
                # This device might have a really long advertising interval
                # So create a config entry for it, and if we discover
                # it has encryption later, we can do a reauth
                return await self.async_step_confirm_slowasync_step_confirm_slow()
 
            self._discovered_device_discovered_device = discovery.device
 
            if discovery.device.encryption_scheme == EncryptionScheme.MIBEACON_LEGACY:
                return await self.async_step_get_encryption_key_legacyasync_step_get_encryption_key_legacy()
 
            if discovery.device.encryption_scheme == EncryptionScheme.MIBEACON_4_5:
                return await self.async_step_get_encryption_key_4_5_choose_methodasync_step_get_encryption_key_4_5_choose_method()
 
            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.MIBEACON_LEGACY:
            return await self.async_step_get_encryption_key_legacyasync_step_get_encryption_key_legacy()
 
        if device.encryption_scheme == EncryptionScheme.MIBEACON_4_5:
            return await self.async_step_get_encryption_key_4_5_choose_methodasync_step_get_encryption_key_4_5_choose_method()
 
        # 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,
        )