Add storage for cacheable homekit entity maps. (#23191)
This commit is contained in:
1 parent
f57191e8dd
commit
4ac9a2e9de
9 files changed
+373
-29
No files matched your search
@@ -8,9 +8,10 @@ from homeassistant.helpers.entity import Entity
|
||||
from .config_flow import load_old_pairings
|
||||
from .connection import get_accessory_information, HKDevice
|
||||
from .const import (
|
||||
CONTROLLER, KNOWN_DEVICES
|
||||
CONTROLLER, ENTITY_MAP, KNOWN_DEVICES
|
||||
)
|
||||
from .const import DOMAIN # noqa: pylint: disable=unused-import
|
||||
from .storage import EntityMapStorage
|
||||
|
||||
HOMEKIT_IGNORE = [
|
||||
'BSB002',
|
||||
@@ -44,7 +45,7 @@ class HomeKitEntity(Entity):
|
||||
# pylint: disable=import-error
|
||||
from homekit.model.characteristics import CharacteristicsTypes
|
||||
|
||||
pairing_data = self._accessory.pairing.pairing_data
|
||||
accessories = self._accessory.accessories
|
||||
|
||||
get_uuid = CharacteristicsTypes.get_uuid
|
||||
characteristic_types = [
|
||||
@@ -55,7 +56,7 @@ class HomeKitEntity(Entity):
|
||||
self._chars = {}
|
||||
self._char_names = {}
|
||||
|
||||
for accessory in pairing_data.get('accessories', []):
|
||||
for accessory in accessories:
|
||||
if accessory['aid'] != self._aid:
|
||||
continue
|
||||
self._accessory_info = get_accessory_information(accessory)
|
||||
@@ -149,12 +150,15 @@ class HomeKitEntity(Entity):
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
def setup(hass, config):
|
||||
async def async_setup(hass, config):
|
||||
"""Set up for Homekit devices."""
|
||||
# pylint: disable=import-error
|
||||
import homekit
|
||||
from homekit.controller.ip_implementation import IpPairing
|
||||
|
||||
map_storage = hass.data[ENTITY_MAP] = EntityMapStorage(hass)
|
||||
await map_storage.async_initialize()
|
||||
|
||||
hass.data[CONTROLLER] = controller = homekit.Controller()
|
||||
|
||||
for hkid, pairing_data in load_old_pairings(hass).items():
|
||||
@@ -185,12 +189,22 @@ def setup(hass, config):
|
||||
device = hass.data[KNOWN_DEVICES][hkid]
|
||||
if config_num > device.config_num and \
|
||||
device.pairing is not None:
|
||||
device.accessory_setup()
|
||||
device.refresh_entity_map(config_num)
|
||||
return
|
||||
|
||||
_LOGGER.debug('Discovered unique device %s', hkid)
|
||||
HKDevice(hass, host, port, model, hkid, config_num, config)
|
||||
device = HKDevice(hass, host, port, model, hkid, config_num, config)
|
||||
device.setup()
|
||||
|
||||
hass.data[KNOWN_DEVICES] = {}
|
||||
discovery.listen(hass, SERVICE_HOMEKIT, discovery_dispatch)
|
||||
|
||||
await hass.async_add_executor_job(
|
||||
discovery.listen, hass, SERVICE_HOMEKIT, discovery_dispatch)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def async_remove_entry(hass, entry):
|
||||
"""Cleanup caches before removing config entry."""
|
||||
hkid = entry.data['AccessoryPairingID']
|
||||
hass.data[ENTITY_MAP].async_delete_map(hkid)
|
||||
@@ -152,7 +152,7 @@ class HomekitControllerFlowHandler(config_entries.ConfigFlow):
|
||||
"HomeKit info %s: c# incremented, refreshing entities",
|
||||
hkid)
|
||||
self.hass.async_create_task(
|
||||
conn.async_config_num_changed(config_num))
|
||||
conn.async_refresh_entity_map(config_num))
|
||||
return self.async_abort(reason='already_configured')
|
||||
|
||||
old_pairings = await self.hass.async_add_executor_job(
|
||||
|
||||
@@ -4,11 +4,10 @@ import logging
|
||||
import os
|
||||
|
||||
from homeassistant.helpers import discovery
|
||||
from homeassistant.helpers.event import call_later
|
||||
|
||||
from .const import (
|
||||
CONTROLLER, DOMAIN, HOMEKIT_ACCESSORY_DISPATCH, KNOWN_DEVICES,
|
||||
PAIRING_FILE, HOMEKIT_DIR
|
||||
PAIRING_FILE, HOMEKIT_DIR, ENTITY_MAP
|
||||
)
|
||||
|
||||
|
||||
@@ -67,7 +66,7 @@ class HKDevice():
|
||||
self.config_num = config_num
|
||||
self.config = config
|
||||
self.configurator = hass.components.configurator
|
||||
self._connection_warning_logged = False
|
||||
self.accessories = {}
|
||||
|
||||
# This just tracks aid/iid pairs so we know if a HK service has been
|
||||
# mapped to a HA entity.
|
||||
@@ -79,27 +78,77 @@ class HKDevice():
|
||||
|
||||
hass.data[KNOWN_DEVICES][hkid] = self
|
||||
|
||||
if self.pairing is not None:
|
||||
self.accessory_setup()
|
||||
else:
|
||||
def setup(self):
|
||||
"""Prepare to use a paired HomeKit device in homeassistant."""
|
||||
if self.pairing is None:
|
||||
self.configure()
|
||||
|
||||
def accessory_setup(self):
|
||||
"""Handle setup of a HomeKit accessory."""
|
||||
# pylint: disable=import-error
|
||||
from homekit.model.services import ServicesTypes
|
||||
from homekit.exceptions import AccessoryDisconnectedError
|
||||
return
|
||||
|
||||
self.pairing.pairing_data['AccessoryIP'] = self.host
|
||||
self.pairing.pairing_data['AccessoryPort'] = self.port
|
||||
|
||||
cache = self.hass.data[ENTITY_MAP].get_map(self.unique_id)
|
||||
if not cache or cache['config_num'] < self.config_num:
|
||||
return self.refresh_entity_map(self.config_num)
|
||||
|
||||
self.accessories = cache['accessories']
|
||||
|
||||
# Ensure the Pairing object has access to the latest version of the
|
||||
# entity map.
|
||||
self.pairing.pairing_data['accessories'] = self.accessories
|
||||
|
||||
self.add_entities()
|
||||
|
||||
return True
|
||||
|
||||
async def async_refresh_entity_map(self, config_num):
|
||||
"""
|
||||
Handle setup of a HomeKit accessory.
|
||||
|
||||
The sync version will be removed when homekit_controller migrates to
|
||||
config flow.
|
||||
"""
|
||||
return await self.hass.async_add_executor_job(
|
||||
self.refresh_entity_map,
|
||||
config_num,
|
||||
)
|
||||
|
||||
def refresh_entity_map(self, config_num):
|
||||
"""Handle setup of a HomeKit accessory."""
|
||||
# pylint: disable=import-error
|
||||
from homekit.exceptions import AccessoryDisconnectedError
|
||||
|
||||
try:
|
||||
data = self.pairing.list_accessories_and_characteristics()
|
||||
accessories = self.pairing.list_accessories_and_characteristics()
|
||||
except AccessoryDisconnectedError:
|
||||
call_later(
|
||||
self.hass, RETRY_INTERVAL, lambda _: self.accessory_setup())
|
||||
# If we fail to refresh this data then we will naturally retry
|
||||
# later when Bonjour spots c# is still not up to date.
|
||||
return
|
||||
for accessory in data:
|
||||
|
||||
self.hass.data[ENTITY_MAP].async_create_or_update_map(
|
||||
self.unique_id,
|
||||
config_num,
|
||||
accessories,
|
||||
)
|
||||
|
||||
self.accessories = accessories
|
||||
self.config_num = config_num
|
||||
|
||||
# For BLE, the Pairing instance relies on the entity map to map
|
||||
# aid/iid to GATT characteristics. So push it to there as well.
|
||||
self.pairing.pairing_data['accessories'] = accessories
|
||||
|
||||
# Register add new entities that are available
|
||||
self.add_entities()
|
||||
|
||||
return True
|
||||
|
||||
def add_entities(self):
|
||||
"""Process the entity map and create HA entities."""
|
||||
# pylint: disable=import-error
|
||||
from homekit.model.services import ServicesTypes
|
||||
|
||||
for accessory in self.accessories:
|
||||
aid = accessory['aid']
|
||||
for service in accessory['services']:
|
||||
iid = service['iid']
|
||||
@@ -118,6 +167,7 @@ class HKDevice():
|
||||
if component is not None:
|
||||
discovery.load_platform(self.hass, component, DOMAIN,
|
||||
service_info, self.config)
|
||||
self.entities.append((aid, iid))
|
||||
|
||||
def device_config_callback(self, callback_data):
|
||||
"""Handle initial pairing."""
|
||||
@@ -145,15 +195,20 @@ class HKDevice():
|
||||
|
||||
self.pairing = self.controller.pairings.get(self.hkid)
|
||||
if self.pairing is not None:
|
||||
pairing_file = os.path.join(
|
||||
pairing_dir = os.path.join(
|
||||
self.hass.config.path(),
|
||||
HOMEKIT_DIR,
|
||||
)
|
||||
if not os.path.exists(pairing_dir):
|
||||
os.makedirs(pairing_dir)
|
||||
pairing_file = os.path.join(
|
||||
pairing_dir,
|
||||
PAIRING_FILE,
|
||||
)
|
||||
self.controller.save_data(pairing_file)
|
||||
_configurator = self.hass.data[DOMAIN+self.hkid]
|
||||
self.configurator.request_done(_configurator)
|
||||
self.accessory_setup()
|
||||
self.setup()
|
||||
else:
|
||||
error_msg = "Unable to pair, please try again"
|
||||
_configurator = self.hass.data[DOMAIN+self.hkid]
|
||||
@@ -197,3 +252,12 @@ class HKDevice():
|
||||
self.pairing.put_characteristics,
|
||||
chars
|
||||
)
|
||||
|
||||
@property
|
||||
def unique_id(self):
|
||||
"""
|
||||
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.hkid
|
||||
@@ -3,6 +3,7 @@ DOMAIN = 'homekit_controller'
|
||||
|
||||
KNOWN_DEVICES = "{}-devices".format(DOMAIN)
|
||||
CONTROLLER = "{}-controller".format(DOMAIN)
|
||||
ENTITY_MAP = '{}-entity-map'.format(DOMAIN)
|
||||
|
||||
HOMEKIT_DIR = '.homekit'
|
||||
PAIRING_FILE = 'pairing.json'
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
"""Helpers for HomeKit data stored in HA storage."""
|
||||
|
||||
from homeassistant.helpers.storage import Store
|
||||
from homeassistant.core import callback
|
||||
|
||||
from .const import DOMAIN
|
||||
|
||||
ENTITY_MAP_STORAGE_KEY = '{}-entity-map'.format(DOMAIN)
|
||||
ENTITY_MAP_STORAGE_VERSION = 1
|
||||
ENTITY_MAP_SAVE_DELAY = 10
|
||||
|
||||
|
||||
class EntityMapStorage:
|
||||
"""
|
||||
Holds a cache of entity structure data from a paired HomeKit device.
|
||||
|
||||
HomeKit has a cacheable entity map that describes how an IP or BLE
|
||||
endpoint is structured. This object holds the latest copy of that data.
|
||||
|
||||
An endpoint is made of accessories, services and characteristics. It is
|
||||
safe to cache this data until the c# discovery data changes.
|
||||
|
||||
Caching this data means we can add HomeKit devices to HA immediately at
|
||||
start even if discovery hasn't seen them yet or they are out of range. It
|
||||
is also important for BLE devices - accessing the entity structure is
|
||||
very slow for these devices.
|
||||
"""
|
||||
|
||||
def __init__(self, hass):
|
||||
"""Create a new entity map store."""
|
||||
self.hass = hass
|
||||
self.store = Store(
|
||||
hass,
|
||||
ENTITY_MAP_STORAGE_VERSION,
|
||||
ENTITY_MAP_STORAGE_KEY
|
||||
)
|
||||
self.storage_data = {}
|
||||
|
||||
async def async_initialize(self):
|
||||
"""Get the pairing cache data."""
|
||||
raw_storage = await self.store.async_load()
|
||||
if not raw_storage:
|
||||
# There is no cached data about HomeKit devices yet
|
||||
return
|
||||
|
||||
self.storage_data = raw_storage.get('pairings', {})
|
||||
|
||||
def get_map(self, homekit_id):
|
||||
"""Get a pairing cache item."""
|
||||
return self.storage_data.get(homekit_id)
|
||||
|
||||
def async_create_or_update_map(self, homekit_id, config_num, accessories):
|
||||
"""Create a new pairing cache."""
|
||||
data = {
|
||||
'config_num': config_num,
|
||||
'accessories': accessories,
|
||||
}
|
||||
self.storage_data[homekit_id] = data
|
||||
self._async_schedule_save()
|
||||
return data
|
||||
|
||||
def async_delete_map(self, homekit_id):
|
||||
"""Delete pairing cache."""
|
||||
if homekit_id not in self.storage_data:
|
||||
return
|
||||
|
||||
self.storage_data.pop(homekit_id)
|
||||
self._async_schedule_save()
|
||||
|
||||
@callback
|
||||
def _async_schedule_save(self):
|
||||
"""Schedule saving the entity map cache."""
|
||||
self.store.async_delay_save(self._data_to_save, ENTITY_MAP_SAVE_DELAY)
|
||||
|
||||
@callback
|
||||
def _data_to_save(self):
|
||||
"""Return data of entity map to store in a file."""
|
||||
return {
|
||||
'pairings': self.storage_data,
|
||||
}
|
||||
Reference in new issue
Block a user