mirror of https://github.com/home-assistant/core
765 lines
28 KiB
Python
765 lines
28 KiB
Python
"""Helpers for managing a pairing with a HomeKit accessory or bridge."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from collections.abc import Callable, Iterable
|
|
from datetime import datetime, timedelta
|
|
import logging
|
|
from types import MappingProxyType
|
|
from typing import Any
|
|
|
|
from aiohomekit import Controller
|
|
from aiohomekit.exceptions import (
|
|
AccessoryDisconnectedError,
|
|
AccessoryNotFoundError,
|
|
EncryptionError,
|
|
)
|
|
from aiohomekit.model import Accessories, Accessory, Transport
|
|
from aiohomekit.model.characteristics import Characteristic
|
|
from aiohomekit.model.services import Service
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import ATTR_VIA_DEVICE, EVENT_HOMEASSISTANT_STARTED
|
|
from homeassistant.core import CoreState, Event, HomeAssistant, callback
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
from homeassistant.helpers.debounce import Debouncer
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.event import async_track_time_interval
|
|
|
|
from .const import (
|
|
CHARACTERISTIC_PLATFORMS,
|
|
CONTROLLER,
|
|
DEBOUNCE_COOLDOWN,
|
|
DOMAIN,
|
|
HOMEKIT_ACCESSORY_DISPATCH,
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
IDENTIFIER_LEGACY_ACCESSORY_ID,
|
|
IDENTIFIER_LEGACY_SERIAL_NUMBER,
|
|
IDENTIFIER_SERIAL_NUMBER,
|
|
STARTUP_EXCEPTIONS,
|
|
)
|
|
from .device_trigger import async_fire_triggers, async_setup_triggers_for_entry
|
|
|
|
RETRY_INTERVAL = 60 # seconds
|
|
MAX_POLL_FAILURES_TO_DECLARE_UNAVAILABLE = 3
|
|
|
|
|
|
BLE_AVAILABILITY_CHECK_INTERVAL = 1800 # seconds
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
AddAccessoryCb = Callable[[Accessory], bool]
|
|
AddServiceCb = Callable[[Service], bool]
|
|
AddCharacteristicCb = Callable[[Characteristic], bool]
|
|
|
|
|
|
def valid_serial_number(serial: str) -> bool:
|
|
"""Return if the serial number appears to be valid."""
|
|
if not serial:
|
|
return False
|
|
try:
|
|
return float("".join(serial.rsplit(".", 1))) > 1
|
|
except ValueError:
|
|
return True
|
|
|
|
|
|
class HKDevice:
|
|
"""HomeKit device."""
|
|
|
|
def __init__(
|
|
self,
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
pairing_data: MappingProxyType[str, Any],
|
|
) -> None:
|
|
"""Initialise a generic HomeKit device."""
|
|
|
|
self.hass = hass
|
|
self.config_entry = config_entry
|
|
|
|
# We copy pairing_data because homekit_python may mutate it, but we
|
|
# don't want to mutate a dict owned by a config entry.
|
|
self.pairing_data = pairing_data.copy()
|
|
|
|
connection: Controller = hass.data[CONTROLLER]
|
|
|
|
self.pairing = connection.load_pairing(self.unique_id, self.pairing_data)
|
|
|
|
# A list of callbacks that turn HK accessories into entities
|
|
self.accessory_factories: list[AddAccessoryCb] = []
|
|
|
|
# A list of callbacks that turn HK service metadata into entities
|
|
self.listeners: list[AddServiceCb] = []
|
|
|
|
# A list of callbacks that turn HK characteristics into entities
|
|
self.char_factories: list[AddCharacteristicCb] = []
|
|
|
|
# The platorms we have forwarded the config entry so far. If a new
|
|
# accessory is added to a bridge we may have to load additional
|
|
# platforms. We don't want to load all platforms up front if its just
|
|
# a lightbulb. And we don't want to forward a config entry twice
|
|
# (triggers a Config entry already set up error)
|
|
self.platforms: set[str] = set()
|
|
|
|
# This just tracks aid/iid pairs so we know if a HK service has been
|
|
# mapped to a HA entity.
|
|
self.entities: list[tuple[int, int | None, int | None]] = []
|
|
|
|
# A map of aid -> device_id
|
|
# Useful when routing events to triggers
|
|
self.devices: dict[int, str] = {}
|
|
|
|
self.available = False
|
|
|
|
self.signal_state_updated = "_".join((DOMAIN, self.unique_id, "state_updated"))
|
|
|
|
self.pollable_characteristics: list[tuple[int, int]] = []
|
|
|
|
# Never allow concurrent polling of the same accessory or bridge
|
|
self._polling_lock = asyncio.Lock()
|
|
self._polling_lock_warned = False
|
|
self._poll_failures = 0
|
|
|
|
# This is set to True if we can't rely on serial numbers to be unique
|
|
self.unreliable_serial_numbers = False
|
|
|
|
self.watchable_characteristics: list[tuple[int, int]] = []
|
|
|
|
self._debounced_update = Debouncer(
|
|
hass,
|
|
_LOGGER,
|
|
cooldown=DEBOUNCE_COOLDOWN,
|
|
immediate=False,
|
|
function=self.async_update,
|
|
)
|
|
|
|
@property
|
|
def entity_map(self) -> Accessories:
|
|
"""Return the accessories from the pairing."""
|
|
return self.pairing.accessories_state.accessories
|
|
|
|
@property
|
|
def config_num(self) -> int:
|
|
"""Return the config num from the pairing."""
|
|
return self.pairing.accessories_state.config_num
|
|
|
|
def add_pollable_characteristics(
|
|
self, characteristics: list[tuple[int, int]]
|
|
) -> None:
|
|
"""Add (aid, iid) pairs that we need to poll."""
|
|
self.pollable_characteristics.extend(characteristics)
|
|
|
|
def remove_pollable_characteristics(self, accessory_id: int) -> None:
|
|
"""Remove all pollable characteristics by accessory id."""
|
|
self.pollable_characteristics = [
|
|
char for char in self.pollable_characteristics if char[0] != accessory_id
|
|
]
|
|
|
|
async def add_watchable_characteristics(
|
|
self, characteristics: list[tuple[int, int]]
|
|
) -> None:
|
|
"""Add (aid, iid) pairs that we need to poll."""
|
|
self.watchable_characteristics.extend(characteristics)
|
|
await self.pairing.subscribe(characteristics)
|
|
|
|
def remove_watchable_characteristics(self, accessory_id: int) -> None:
|
|
"""Remove all pollable characteristics by accessory id."""
|
|
self.watchable_characteristics = [
|
|
char for char in self.watchable_characteristics if char[0] != accessory_id
|
|
]
|
|
|
|
@callback
|
|
def async_set_available_state(self, available: bool) -> None:
|
|
"""Mark state of all entities on this connection when it becomes available or unavailable."""
|
|
_LOGGER.debug(
|
|
"Called async_set_available_state with %s for %s", available, self.unique_id
|
|
)
|
|
if self.available == available:
|
|
return
|
|
self.available = available
|
|
async_dispatcher_send(self.hass, self.signal_state_updated)
|
|
|
|
async def _async_populate_ble_accessory_state(self, event: Event) -> None:
|
|
"""Populate the BLE accessory state without blocking startup.
|
|
|
|
If the accessory was asleep at startup we need to retry
|
|
since we continued on to allow startup to proceed.
|
|
|
|
If this fails the state may be inconsistent, but will
|
|
get corrected as soon as the accessory advertises again.
|
|
"""
|
|
self._async_start_polling()
|
|
try:
|
|
await self.pairing.async_populate_accessories_state(force_update=True)
|
|
except STARTUP_EXCEPTIONS as ex:
|
|
_LOGGER.debug(
|
|
(
|
|
"Failed to populate BLE accessory state for %s, accessory may be"
|
|
" sleeping and will be retried the next time it advertises: %s"
|
|
),
|
|
self.config_entry.title,
|
|
ex,
|
|
)
|
|
|
|
async def async_setup(self) -> None:
|
|
"""Prepare to use a paired HomeKit device in Home Assistant."""
|
|
pairing = self.pairing
|
|
transport = pairing.transport
|
|
entry = self.config_entry
|
|
|
|
# We need to force an update here to make sure we have
|
|
# the latest values since the async_update we do in
|
|
# async_process_entity_map will no values to poll yet
|
|
# since entities are added via dispatching and then
|
|
# they add the chars they are concerned about in
|
|
# async_added_to_hass which is too late.
|
|
#
|
|
# Ideally we would know which entities we are about to add
|
|
# so we only poll those chars but that is not possible
|
|
# yet.
|
|
attempts = None if self.hass.state == CoreState.running else 1
|
|
if (
|
|
transport == Transport.BLE
|
|
and pairing.accessories
|
|
and pairing.accessories.has_aid(1)
|
|
):
|
|
# The GSN gets restored and a catch up poll will be
|
|
# triggered via disconnected events automatically
|
|
# if we are out of sync. To be sure we are in sync;
|
|
# If for some reason the BLE connection failed
|
|
# previously we force an update after startup
|
|
# is complete.
|
|
entry.async_on_unload(
|
|
self.hass.bus.async_listen(
|
|
EVENT_HOMEASSISTANT_STARTED,
|
|
self._async_populate_ble_accessory_state,
|
|
)
|
|
)
|
|
else:
|
|
await self.pairing.async_populate_accessories_state(
|
|
force_update=True, attempts=attempts
|
|
)
|
|
self._async_start_polling()
|
|
|
|
entry.async_on_unload(pairing.dispatcher_connect(self.process_new_events))
|
|
entry.async_on_unload(
|
|
pairing.dispatcher_connect_config_changed(self.process_config_changed)
|
|
)
|
|
entry.async_on_unload(
|
|
pairing.dispatcher_availability_changed(self.async_set_available_state)
|
|
)
|
|
|
|
await self.async_process_entity_map()
|
|
|
|
# If everything is up to date, we can create the entities
|
|
# since we know the data is not stale.
|
|
await self.async_add_new_entities()
|
|
|
|
self.async_set_available_state(self.pairing.is_available)
|
|
|
|
if transport == Transport.BLE:
|
|
# If we are using BLE, we need to periodically check of the
|
|
# BLE device is available since we won't get callbacks
|
|
# when it goes away since we HomeKit supports disconnected
|
|
# notifications and we cannot treat a disconnect as unavailability.
|
|
entry.async_on_unload(
|
|
async_track_time_interval(
|
|
self.hass,
|
|
self.async_update_available_state,
|
|
timedelta(seconds=BLE_AVAILABILITY_CHECK_INTERVAL),
|
|
)
|
|
)
|
|
# BLE devices always get an RSSI sensor as well
|
|
if "sensor" not in self.platforms:
|
|
await self.async_load_platform("sensor")
|
|
|
|
@callback
|
|
def _async_start_polling(self) -> None:
|
|
"""Start polling for updates."""
|
|
# We use async_request_update to avoid multiple updates
|
|
# at the same time which would generate a spurious warning
|
|
# in the log about concurrent polling.
|
|
self.config_entry.async_on_unload(
|
|
async_track_time_interval(
|
|
self.hass, self.async_request_update, self.pairing.poll_interval
|
|
)
|
|
)
|
|
|
|
async def async_add_new_entities(self) -> None:
|
|
"""Add new entities to Home Assistant."""
|
|
await self.async_load_platforms()
|
|
self.add_entities()
|
|
|
|
def device_info_for_accessory(self, accessory: Accessory) -> DeviceInfo:
|
|
"""Build a DeviceInfo for a given accessory."""
|
|
identifiers = {
|
|
(
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
f"{self.unique_id}:aid:{accessory.aid}",
|
|
)
|
|
}
|
|
|
|
if not self.unreliable_serial_numbers:
|
|
identifiers.add((IDENTIFIER_SERIAL_NUMBER, accessory.serial_number))
|
|
|
|
device_info = DeviceInfo(
|
|
identifiers={
|
|
(
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
f"{self.unique_id}:aid:{accessory.aid}",
|
|
)
|
|
},
|
|
name=accessory.name,
|
|
manufacturer=accessory.manufacturer,
|
|
model=accessory.model,
|
|
sw_version=accessory.firmware_revision,
|
|
hw_version=accessory.hardware_revision,
|
|
)
|
|
|
|
if accessory.aid != 1:
|
|
# Every pairing has an accessory 1
|
|
# It *doesn't* have a via_device, as it is the device we are connecting to
|
|
# Every other accessory should use it as its via device.
|
|
device_info[ATTR_VIA_DEVICE] = (
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
f"{self.unique_id}:aid:1",
|
|
)
|
|
|
|
return device_info
|
|
|
|
@callback
|
|
def async_migrate_devices(self) -> None:
|
|
"""Migrate legacy device entries from 3-tuples to 2-tuples."""
|
|
_LOGGER.debug(
|
|
"Migrating device registry entries for pairing %s", self.unique_id
|
|
)
|
|
|
|
device_registry = dr.async_get(self.hass)
|
|
|
|
for accessory in self.entity_map.accessories:
|
|
identifiers = {
|
|
(
|
|
DOMAIN,
|
|
IDENTIFIER_LEGACY_ACCESSORY_ID,
|
|
f"{self.unique_id}_{accessory.aid}",
|
|
),
|
|
}
|
|
|
|
if accessory.aid == 1:
|
|
identifiers.add(
|
|
(DOMAIN, IDENTIFIER_LEGACY_ACCESSORY_ID, self.unique_id)
|
|
)
|
|
|
|
if valid_serial_number(accessory.serial_number):
|
|
identifiers.add(
|
|
(DOMAIN, IDENTIFIER_LEGACY_SERIAL_NUMBER, accessory.serial_number)
|
|
)
|
|
|
|
device = device_registry.async_get_device(identifiers=identifiers) # type: ignore[arg-type]
|
|
if not device:
|
|
continue
|
|
|
|
if self.config_entry.entry_id not in device.config_entries:
|
|
_LOGGER.info(
|
|
(
|
|
"Found candidate device for %s:aid:%s, but owned by a different"
|
|
" config entry, skipping"
|
|
),
|
|
self.unique_id,
|
|
accessory.aid,
|
|
)
|
|
continue
|
|
|
|
_LOGGER.info(
|
|
"Migrating device identifiers for %s:aid:%s",
|
|
self.unique_id,
|
|
accessory.aid,
|
|
)
|
|
device_registry.async_update_device(
|
|
device.id,
|
|
new_identifiers={
|
|
(
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
f"{self.unique_id}:aid:{accessory.aid}",
|
|
)
|
|
},
|
|
)
|
|
|
|
@callback
|
|
def async_migrate_unique_id(
|
|
self, old_unique_id: str, new_unique_id: str, platform: str
|
|
) -> None:
|
|
"""Migrate legacy unique IDs to new format."""
|
|
_LOGGER.debug(
|
|
"Checking if unique ID %s on %s needs to be migrated",
|
|
old_unique_id,
|
|
platform,
|
|
)
|
|
entity_registry = er.async_get(self.hass)
|
|
# async_get_entity_id wants the "homekit_controller" domain
|
|
# in the platform field and the actual platform in the domain
|
|
# field for historical reasons since everything used to be
|
|
# PLATFORM.INTEGRATION instead of INTEGRATION.PLATFORM
|
|
if (
|
|
entity_id := entity_registry.async_get_entity_id(
|
|
platform, DOMAIN, old_unique_id
|
|
)
|
|
) is None:
|
|
_LOGGER.debug("Unique ID %s does not need to be migrated", old_unique_id)
|
|
return
|
|
if new_entity_id := entity_registry.async_get_entity_id(
|
|
platform, DOMAIN, new_unique_id
|
|
):
|
|
_LOGGER.debug(
|
|
(
|
|
"Unique ID %s is already in use by %s (system may have been"
|
|
" downgraded)"
|
|
),
|
|
new_unique_id,
|
|
new_entity_id,
|
|
)
|
|
return
|
|
_LOGGER.debug(
|
|
"Migrating unique ID for entity %s (%s -> %s)",
|
|
entity_id,
|
|
old_unique_id,
|
|
new_unique_id,
|
|
)
|
|
entity_registry.async_update_entity(entity_id, new_unique_id=new_unique_id)
|
|
|
|
@callback
|
|
def async_remove_legacy_device_serial_numbers(self) -> None:
|
|
"""Migrate remove legacy serial numbers from devices.
|
|
|
|
We no longer use serial numbers as device identifiers
|
|
since they are not reliable, and the HomeKit spec
|
|
does not require them to be stable.
|
|
"""
|
|
_LOGGER.debug(
|
|
(
|
|
"Removing legacy serial numbers from device registry entries for"
|
|
" pairing %s"
|
|
),
|
|
self.unique_id,
|
|
)
|
|
|
|
device_registry = dr.async_get(self.hass)
|
|
for accessory in self.entity_map.accessories:
|
|
identifiers = {
|
|
(
|
|
IDENTIFIER_ACCESSORY_ID,
|
|
f"{self.unique_id}:aid:{accessory.aid}",
|
|
)
|
|
}
|
|
legacy_serial_identifier = (
|
|
IDENTIFIER_SERIAL_NUMBER,
|
|
accessory.serial_number,
|
|
)
|
|
|
|
device = device_registry.async_get_device(identifiers=identifiers)
|
|
if not device or legacy_serial_identifier not in device.identifiers:
|
|
continue
|
|
|
|
device_registry.async_update_device(device.id, new_identifiers=identifiers)
|
|
|
|
@callback
|
|
def async_create_devices(self) -> None:
|
|
"""Build device registry entries for all accessories paired with the bridge.
|
|
|
|
This is done as well as by the entities for 2 reasons. First, the bridge
|
|
might not have any entities attached to it. Secondly there are stateless
|
|
entities like doorbells and remote controls.
|
|
"""
|
|
device_registry = dr.async_get(self.hass)
|
|
|
|
devices = {}
|
|
|
|
# Accessories need to be created in the correct order or setting up
|
|
# relationships with ATTR_VIA_DEVICE may fail.
|
|
for accessory in sorted(
|
|
self.entity_map.accessories, key=lambda accessory: accessory.aid
|
|
):
|
|
device_info = self.device_info_for_accessory(accessory)
|
|
|
|
device = device_registry.async_get_or_create(
|
|
config_entry_id=self.config_entry.entry_id,
|
|
**device_info,
|
|
)
|
|
|
|
devices[accessory.aid] = device.id
|
|
|
|
self.devices = devices
|
|
|
|
@callback
|
|
def async_detect_workarounds(self) -> None:
|
|
"""Detect any workarounds that are needed for this pairing."""
|
|
unreliable_serial_numbers = False
|
|
|
|
devices = set()
|
|
|
|
for accessory in self.entity_map.accessories:
|
|
if not valid_serial_number(accessory.serial_number):
|
|
_LOGGER.debug(
|
|
(
|
|
"Serial number %r is not valid, it cannot be used as a unique"
|
|
" identifier"
|
|
),
|
|
accessory.serial_number,
|
|
)
|
|
unreliable_serial_numbers = True
|
|
|
|
elif accessory.serial_number in devices:
|
|
_LOGGER.debug(
|
|
(
|
|
"Serial number %r is duplicated within this pairing, it cannot"
|
|
" be used as a unique identifier"
|
|
),
|
|
accessory.serial_number,
|
|
)
|
|
unreliable_serial_numbers = True
|
|
|
|
elif accessory.serial_number == accessory.hardware_revision:
|
|
# This is a known bug with some devices (e.g. RYSE SmartShades)
|
|
_LOGGER.debug(
|
|
(
|
|
"Serial number %r is actually the hardware revision, it cannot"
|
|
" be used as a unique identifier"
|
|
),
|
|
accessory.serial_number,
|
|
)
|
|
unreliable_serial_numbers = True
|
|
|
|
devices.add(accessory.serial_number)
|
|
|
|
self.unreliable_serial_numbers = unreliable_serial_numbers
|
|
|
|
async def async_process_entity_map(self) -> None:
|
|
"""Process the entity map and load any platforms or entities that need adding.
|
|
|
|
This is idempotent and will be called at startup and when we detect metadata changes
|
|
via the c# counter on the zeroconf record.
|
|
"""
|
|
# Ensure the Pairing object has access to the latest version of the entity map. This
|
|
# is especially important for BLE, as the Pairing instance relies on the entity map
|
|
# to map aid/iid to GATT characteristics. So push it to there as well.
|
|
self.async_detect_workarounds()
|
|
|
|
# Migrate to new device ids
|
|
self.async_migrate_devices()
|
|
|
|
# Remove any of the legacy serial numbers from the device registry
|
|
self.async_remove_legacy_device_serial_numbers()
|
|
|
|
self.async_create_devices()
|
|
|
|
# Load any triggers for this config entry
|
|
await async_setup_triggers_for_entry(self.hass, self.config_entry)
|
|
|
|
async def async_unload(self) -> None:
|
|
"""Stop interacting with device and prepare for removal from hass."""
|
|
await self.pairing.shutdown()
|
|
|
|
await self.hass.config_entries.async_unload_platforms(
|
|
self.config_entry, self.platforms
|
|
)
|
|
|
|
def process_config_changed(self, config_num: int) -> None:
|
|
"""Handle a config change notification from the pairing."""
|
|
self.hass.async_create_task(self.async_update_new_accessories_state())
|
|
|
|
async def async_update_new_accessories_state(self) -> None:
|
|
"""Process a change in the pairings accessories state."""
|
|
await self.async_process_entity_map()
|
|
if self.watchable_characteristics:
|
|
await self.pairing.subscribe(self.watchable_characteristics)
|
|
await self.async_update()
|
|
await self.async_add_new_entities()
|
|
|
|
def add_accessory_factory(self, add_entities_cb) -> None:
|
|
"""Add a callback to run when discovering new entities for accessories."""
|
|
self.accessory_factories.append(add_entities_cb)
|
|
self._add_new_entities_for_accessory([add_entities_cb])
|
|
|
|
def _add_new_entities_for_accessory(self, handlers) -> None:
|
|
for accessory in self.entity_map.accessories:
|
|
for handler in handlers:
|
|
if (accessory.aid, None, None) in self.entities:
|
|
continue
|
|
if handler(accessory):
|
|
self.entities.append((accessory.aid, None, None))
|
|
break
|
|
|
|
def add_char_factory(self, add_entities_cb: AddCharacteristicCb) -> None:
|
|
"""Add a callback to run when discovering new entities for accessories."""
|
|
self.char_factories.append(add_entities_cb)
|
|
self._add_new_entities_for_char([add_entities_cb])
|
|
|
|
def _add_new_entities_for_char(self, handlers) -> None:
|
|
for accessory in self.entity_map.accessories:
|
|
for service in accessory.services:
|
|
for char in service.characteristics:
|
|
for handler in handlers:
|
|
if (accessory.aid, service.iid, char.iid) in self.entities:
|
|
continue
|
|
if handler(char):
|
|
self.entities.append((accessory.aid, service.iid, char.iid))
|
|
break
|
|
|
|
def add_listener(self, add_entities_cb: AddServiceCb) -> None:
|
|
"""Add a callback to run when discovering new entities for services."""
|
|
self.listeners.append(add_entities_cb)
|
|
self._add_new_entities([add_entities_cb])
|
|
|
|
def add_entities(self) -> None:
|
|
"""Process the entity map and create HA entities."""
|
|
self._add_new_entities(self.listeners)
|
|
self._add_new_entities_for_accessory(self.accessory_factories)
|
|
self._add_new_entities_for_char(self.char_factories)
|
|
|
|
def _add_new_entities(self, callbacks) -> None:
|
|
for accessory in self.entity_map.accessories:
|
|
aid = accessory.aid
|
|
for service in accessory.services:
|
|
iid = service.iid
|
|
|
|
if (aid, None, iid) in self.entities:
|
|
# Don't add the same entity again
|
|
continue
|
|
|
|
for listener in callbacks:
|
|
if listener(service):
|
|
self.entities.append((aid, None, iid))
|
|
break
|
|
|
|
async def async_load_platform(self, platform: str) -> None:
|
|
"""Load a single platform idempotently."""
|
|
if platform in self.platforms:
|
|
return
|
|
|
|
self.platforms.add(platform)
|
|
try:
|
|
await self.hass.config_entries.async_forward_entry_setup(
|
|
self.config_entry, platform
|
|
)
|
|
except Exception:
|
|
self.platforms.remove(platform)
|
|
raise
|
|
|
|
async def async_load_platforms(self) -> None:
|
|
"""Load any platforms needed by this HomeKit device."""
|
|
to_load: set[str] = set()
|
|
for accessory in self.entity_map.accessories:
|
|
for service in accessory.services:
|
|
if service.type in HOMEKIT_ACCESSORY_DISPATCH:
|
|
platform = HOMEKIT_ACCESSORY_DISPATCH[service.type]
|
|
if platform not in self.platforms:
|
|
to_load.add(platform)
|
|
|
|
for char in service.characteristics:
|
|
if char.type in CHARACTERISTIC_PLATFORMS:
|
|
platform = CHARACTERISTIC_PLATFORMS[char.type]
|
|
if platform not in self.platforms:
|
|
to_load.add(platform)
|
|
|
|
if to_load:
|
|
await asyncio.gather(
|
|
*[self.async_load_platform(platform) for platform in to_load]
|
|
)
|
|
|
|
@callback
|
|
def async_update_available_state(self, *_: Any) -> None:
|
|
"""Update the available state of the device."""
|
|
self.async_set_available_state(self.pairing.is_available)
|
|
|
|
async def async_request_update(self, now: datetime | None = None) -> None:
|
|
"""Request an debounced update from the accessory."""
|
|
await self._debounced_update.async_call()
|
|
|
|
async def async_update(self, now=None):
|
|
"""Poll state of all entities attached to this bridge/accessory."""
|
|
if not self.pollable_characteristics:
|
|
self.async_update_available_state()
|
|
_LOGGER.debug(
|
|
"HomeKit connection not polling any characteristics: %s", self.unique_id
|
|
)
|
|
return
|
|
|
|
if self._polling_lock.locked():
|
|
if not self._polling_lock_warned:
|
|
_LOGGER.warning(
|
|
(
|
|
"HomeKit controller update skipped as previous poll still in"
|
|
" flight: %s"
|
|
),
|
|
self.unique_id,
|
|
)
|
|
self._polling_lock_warned = True
|
|
return
|
|
|
|
if self._polling_lock_warned:
|
|
_LOGGER.info(
|
|
(
|
|
"HomeKit controller no longer detecting back pressure - not"
|
|
" skipping poll: %s"
|
|
),
|
|
self.unique_id,
|
|
)
|
|
self._polling_lock_warned = False
|
|
|
|
async with self._polling_lock:
|
|
_LOGGER.debug("Starting HomeKit controller update: %s", self.unique_id)
|
|
|
|
try:
|
|
new_values_dict = await self.get_characteristics(
|
|
self.pollable_characteristics
|
|
)
|
|
except AccessoryNotFoundError:
|
|
# Not only did the connection fail, but also the accessory is not
|
|
# visible on the network.
|
|
self.async_set_available_state(False)
|
|
return
|
|
except (AccessoryDisconnectedError, EncryptionError):
|
|
# Temporary connection failure. Device may still available but our
|
|
# connection was dropped or we are reconnecting
|
|
self._poll_failures += 1
|
|
if self._poll_failures >= MAX_POLL_FAILURES_TO_DECLARE_UNAVAILABLE:
|
|
self.async_set_available_state(False)
|
|
return
|
|
|
|
self._poll_failures = 0
|
|
self.process_new_events(new_values_dict)
|
|
|
|
_LOGGER.debug("Finished HomeKit controller update: %s", self.unique_id)
|
|
|
|
def process_new_events(
|
|
self, new_values_dict: dict[tuple[int, int], dict[str, Any]]
|
|
) -> None:
|
|
"""Process events from accessory into HA state."""
|
|
self.async_set_available_state(True)
|
|
|
|
# Process any stateless events (via device_triggers)
|
|
async_fire_triggers(self, new_values_dict)
|
|
|
|
self.entity_map.process_changes(new_values_dict)
|
|
|
|
async_dispatcher_send(self.hass, self.signal_state_updated)
|
|
|
|
async def get_characteristics(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
|
|
"""Read latest state from homekit accessory."""
|
|
return await self.pairing.get_characteristics(*args, **kwargs)
|
|
|
|
async def put_characteristics(
|
|
self, characteristics: Iterable[tuple[int, int, Any]]
|
|
) -> None:
|
|
"""Control a HomeKit device state from Home Assistant."""
|
|
await self.pairing.put_characteristics(characteristics)
|
|
|
|
@property
|
|
def unique_id(self) -> str:
|
|
"""Return a unique id for this accessory or bridge.
|
|
|
|
This id is random and will change if a device undergoes a hard reset.
|
|
"""
|
|
return self.pairing_data["AccessoryPairingID"]
|