mirror of
https://github.com/home-assistant/core.git
synced 2025-12-10 18:08:46 +00:00
147 lines
4.6 KiB
Python
147 lines
4.6 KiB
Python
"""Config flow for Hue BLE integration."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from enum import Enum
|
|
import logging
|
|
from typing import Any
|
|
|
|
from HueBLE import ConnectionError, HueBleError, HueBleLight, PairingError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components import bluetooth
|
|
from homeassistant.components.bluetooth.api import (
|
|
async_ble_device_from_address,
|
|
async_scanner_count,
|
|
)
|
|
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
|
from homeassistant.const import CONF_MAC, CONF_NAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers import device_registry as dr
|
|
|
|
from .const import DOMAIN, URL_FACTORY_RESET, URL_PAIRING_MODE
|
|
from .light import get_available_color_modes
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
async def validate_input(hass: HomeAssistant, address: str) -> Error | None:
|
|
"""Return error if cannot connect and validate."""
|
|
|
|
ble_device = async_ble_device_from_address(hass, address.upper(), connectable=True)
|
|
|
|
if ble_device is None:
|
|
count_scanners = async_scanner_count(hass, connectable=True)
|
|
_LOGGER.debug("Count of BLE scanners in HA bt: %i", count_scanners)
|
|
|
|
if count_scanners < 1:
|
|
return Error.NO_SCANNERS
|
|
return Error.NOT_FOUND
|
|
|
|
try:
|
|
light = HueBleLight(ble_device)
|
|
await light.connect()
|
|
get_available_color_modes(light)
|
|
await light.poll_state()
|
|
|
|
except ConnectionError as e:
|
|
_LOGGER.exception("Error connecting to light")
|
|
return (
|
|
Error.INVALID_AUTH
|
|
if type(e.__cause__) is PairingError
|
|
else Error.CANNOT_CONNECT
|
|
)
|
|
except HueBleError:
|
|
_LOGGER.exception("Unexpected error validating light connection")
|
|
return Error.UNKNOWN
|
|
except HomeAssistantError:
|
|
return Error.NOT_SUPPORTED
|
|
else:
|
|
return None
|
|
finally:
|
|
await light.disconnect()
|
|
|
|
|
|
class HueBleConfigFlow(ConfigFlow, domain=DOMAIN):
|
|
"""Handle a config flow for Hue BLE."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize the config flow."""
|
|
self._discovery_info: bluetooth.BluetoothServiceInfoBleak | None = None
|
|
|
|
async def async_step_bluetooth(
|
|
self, discovery_info: bluetooth.BluetoothServiceInfoBleak
|
|
) -> ConfigFlowResult:
|
|
"""Handle a flow initialized by the home assistant scanner."""
|
|
|
|
_LOGGER.debug(
|
|
"HA found light %s. Will show in UI but not auto connect",
|
|
discovery_info.name,
|
|
)
|
|
|
|
unique_id = dr.format_mac(discovery_info.address)
|
|
await self.async_set_unique_id(unique_id)
|
|
self._abort_if_unique_id_configured()
|
|
|
|
name = f"{discovery_info.name} ({discovery_info.address})"
|
|
self.context.update({"title_placeholders": {CONF_NAME: name}})
|
|
|
|
self._discovery_info = discovery_info
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_confirm(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> ConfigFlowResult:
|
|
"""Confirm a single device."""
|
|
|
|
assert self._discovery_info is not None
|
|
errors: dict[str, str] = {}
|
|
|
|
if user_input is not None:
|
|
unique_id = dr.format_mac(self._discovery_info.address)
|
|
await self.async_set_unique_id(unique_id)
|
|
self._abort_if_unique_id_configured()
|
|
error = await validate_input(self.hass, unique_id)
|
|
if error:
|
|
errors["base"] = error.value
|
|
else:
|
|
return self.async_create_entry(title=self._discovery_info.name, data={})
|
|
|
|
return self.async_show_form(
|
|
step_id="confirm",
|
|
data_schema=vol.Schema({}),
|
|
errors=errors,
|
|
description_placeholders={
|
|
CONF_NAME: self._discovery_info.name,
|
|
CONF_MAC: self._discovery_info.address,
|
|
"url_pairing_mode": URL_PAIRING_MODE,
|
|
"url_factory_reset": URL_FACTORY_RESET,
|
|
},
|
|
)
|
|
|
|
|
|
class Error(Enum):
|
|
"""Potential validation errors when attempting to connect."""
|
|
|
|
CANNOT_CONNECT = "cannot_connect"
|
|
"""Error to indicate we cannot connect."""
|
|
|
|
INVALID_AUTH = "invalid_auth"
|
|
"""Error to indicate there is invalid auth."""
|
|
|
|
NO_SCANNERS = "no_scanners"
|
|
"""Error to indicate no bluetooth scanners are available."""
|
|
|
|
NOT_FOUND = "not_found"
|
|
"""Error to indicate the light could not be found."""
|
|
|
|
NOT_SUPPORTED = "not_supported"
|
|
"""Error to indicate that the light is not a supported model."""
|
|
|
|
UNKNOWN = "unknown"
|
|
"""Error to indicate that the issue is unknown."""
|