config_flow.py

Go to the documentation of this file.

"""Config flow for Airthings BlE integration."""
 
from __future__ import annotations
 
import dataclasses
import logging
from typing import Any
 
from airthings_ble import AirthingsBluetoothDeviceData, AirthingsDevice
from bleak import BleakError
import voluptuous as vol
 
from homeassistant.components import bluetooth
from homeassistant.components.bluetooth import (
    BluetoothServiceInfo,
    async_discovered_service_info,
)
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_ADDRESS
 
from .const import DOMAIN, MFCT_ID
 
_LOGGER = logging.getLogger(__name__)
 
SERVICE_UUIDS = [
    "b42e1f6e-ade7-11e4-89d3-123b93f75cba",
    "b42e4a8e-ade7-11e4-89d3-123b93f75cba",
    "b42e1c08-ade7-11e4-89d3-123b93f75cba",
    "b42e3882-ade7-11e4-89d3-123b93f75cba",
]
 
 
@dataclasses.dataclass
class Discovery:
    """A discovered bluetooth device."""
 
    name: str
    discovery_info: BluetoothServiceInfo
    device: AirthingsDevice
 
 
def get_name(device: AirthingsDevice) -> str:
    """Generate name with model and identifier for device."""
 
    name = device.friendly_name()
    if identifier := device.identifier:
        name += f" ({identifier})"
    return name
 
 
class AirthingsDeviceUpdateError(Exception):
    """Custom error class for device updates."""
 
 
class AirthingsConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Airthings BLE."""
 
    VERSION = 1
 
    def __init__(self) -> None:
        """Initialize the config flow."""
        self._discovered_device_discovered_device: Discovery | None = None
        self._discovered_devices: dict[str, Discovery] = {}
 
    async def _get_device_data(
        self, discovery_info: BluetoothServiceInfo
    ) -> AirthingsDevice:
        ble_device = bluetooth.async_ble_device_from_address(
            self.hass, discovery_info.address
        )
        if ble_device is None:
            _LOGGER.debug("no ble_device in _get_device_data")
            raise AirthingsDeviceUpdateError("No ble_device")
 
        airthings = AirthingsBluetoothDeviceData(_LOGGER)
 
        try:
            data = await airthings.update_device(ble_device)
        except BleakError as err:
            _LOGGER.error(
                "Error connecting to and getting data from %s: %s",
                discovery_info.address,
                err,
            )
            raise AirthingsDeviceUpdateError("Failed getting device data") from err
        except Exception as err:
            _LOGGER.error(
                "Unknown error occurred from %s: %s", discovery_info.address, err
            )
            raise
        return data
 
    async def async_step_bluetooth(
        self, discovery_info: BluetoothServiceInfo
    ) -> ConfigFlowResult:
        """Handle the bluetooth discovery step."""
        _LOGGER.debug("Discovered BT device: %s", discovery_info)
        await self.async_set_unique_idasync_set_unique_id(discovery_info.address)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured()
 
        try:
            device = await self._get_device_data_get_device_data(discovery_info)
        except AirthingsDeviceUpdateError:
            return self.async_abortasync_abortasync_abort(reason="cannot_connect")
        except Exception:  # noqa: BLE001
            return self.async_abortasync_abortasync_abort(reason="unknown")
 
        name = get_name(device)
        self.context["title_placeholders"] = {"name": name}
        self._discovered_device_discovered_device = Discovery(name, discovery_info, device)
 
        return await self.async_step_bluetooth_confirmasync_step_bluetooth_confirm()
 
    async def async_step_bluetooth_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Confirm discovery."""
        if user_input is not None:
            return self.async_create_entryasync_create_entryasync_create_entry(
                title=self.context["title_placeholders"]["name"], data={}
            )
 
        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.name,
            }
 
            self._discovered_device_discovered_device = discovery
 
            return self.async_create_entryasync_create_entryasync_create_entry(title=discovery.name, data={})
 
        current_addresses = self._async_current_ids_async_current_ids()
        for discovery_info in async_discovered_service_info(self.hass):
            address = discovery_info.address
            if address in current_addresses or address in self._discovered_devices:
                continue
 
            if MFCT_ID not in discovery_info.manufacturer_data:
                continue
 
            if not any(uuid in SERVICE_UUIDS for uuid in discovery_info.service_uuids):
                continue
 
            try:
                device = await self._get_device_data_get_device_data(discovery_info)
            except AirthingsDeviceUpdateError:
                return self.async_abortasync_abortasync_abort(reason="cannot_connect")
            except Exception:  # noqa: BLE001
                return self.async_abortasync_abortasync_abort(reason="unknown")
            name = get_name(device)
            self._discovered_devices[address] = Discovery(name, discovery_info, device)
 
        if not self._discovered_devices:
            return self.async_abortasync_abortasync_abort(reason="no_devices_found")
 
        titles = {
            address: discovery.device.name
            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),
                },
            ),
        )