1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
from __future__ import annotations
import asyncio
from collections.abc import AsyncIterable
import logging
from bleak import BleakScanner
from bleak.backends.device import BLEDevice
from bleak.backends.scanner import AdvertisementData
from bleak.exc import BleakDBusError, BleakError
from aiohomekit.characteristic_cache import CharacteristicCacheType
from aiohomekit.controller.abstract import (
AbstractController,
AbstractPairingData,
TransportType,
)
from aiohomekit.controller.ble.manufacturer_data import (
APPLE_MANUFACTURER_ID,
HOMEKIT_ADVERTISEMENT_TYPE,
HOMEKIT_ENCRYPTED_NOTIFICATION_TYPE,
HomeKitAdvertisement,
HomeKitEncryptedNotification,
)
from aiohomekit.controller.ble.pairing import BlePairing
from aiohomekit.exceptions import AccessoryNotFoundError
from aiohomekit.utils import asyncio_timeout
from .discovery import BleDiscovery
logger = logging.getLogger(__name__)
class BleController(AbstractController):
discoveries: dict[str, BleDiscovery]
pairings: dict[str, BlePairing]
aliases: dict[str, BlePairing]
transport_type = TransportType.BLE
_scanner: BleakScanner | None
def __init__(
self,
char_cache: CharacteristicCacheType,
bleak_scanner_instance: BleakScanner | None = None,
) -> None:
super().__init__(char_cache=char_cache)
self._scanner = bleak_scanner_instance
self._ble_futures: dict[str, list[asyncio.Future[BLEDevice]]] = {}
def _device_detected(
self, device: BLEDevice, advertisement_data: AdvertisementData
) -> None:
manufacturer_data = advertisement_data.manufacturer_data
if not (mfr_data := manufacturer_data.get(APPLE_MANUFACTURER_ID)):
return
elif mfr_data[0] == HOMEKIT_ENCRYPTED_NOTIFICATION_TYPE:
try:
data = HomeKitEncryptedNotification.from_manufacturer_data(
device.name, device.address, manufacturer_data
)
except ValueError:
return
if pairing := self.pairings.get(data.id):
pairing._async_notification(data)
return
if mfr_data[0] != HOMEKIT_ADVERTISEMENT_TYPE:
return
try:
data = HomeKitAdvertisement.from_manufacturer_data(
device.name, device.address, manufacturer_data
)
except ValueError:
return
if old_discovery := self.discoveries.get(data.id):
if (old_name := old_discovery.description.name) and (
not (name := data.name)
or (
old_name != old_discovery.device.address
and len(old_name) > len(name)
)
):
#
# If we have a pairing and the name is longer than the one we
# just received, we assume the name is more accurate and
# update it.
#
# SHORTENED LOCAL NAME
# The Shortened Local Name data type defines a shortened version
# of the Local Name data type. The Shortened Local Name data type
# shall not be used to advertise a name that is longer than the
# Local Name data type.
#
data.name = old_name
if pairing := self.pairings.get(data.id):
pairing._async_description_update(data)
pairing._async_ble_update(device, advertisement_data)
if futures := self._ble_futures.get(data.id):
discovery = BleDiscovery(self, device, data, advertisement_data)
logger.debug("BLE device for %s found, fulfilling futures", data.id)
for future in futures:
future.set_result(discovery)
futures.clear()
if old_discovery:
# We need to make sure we update the device details
# in case they changed
old_discovery._async_process_advertisement(device, data, advertisement_data)
return
self.discoveries[data.id] = BleDiscovery(self, device, data, advertisement_data)
async def async_start(self) -> None:
logger.debug("Starting BLE controller with instance: %s", self._scanner)
if not self._scanner:
try:
self._scanner = BleakScanner()
except (FileNotFoundError, BleakDBusError, BleakError) as e:
logger.debug(
"Failed to init scanner, HAP-BLE not available: %s", str(e)
)
self._scanner = None
return
try:
self._scanner.register_detection_callback(self._device_detected)
await self._scanner.start()
except (FileNotFoundError, BleakDBusError, BleakError) as e:
logger.debug("Failed to start scanner, HAP-BLE not available: %s", str(e))
self._scanner = None
async def async_stop(self, *args):
if self._scanner:
await self._scanner.stop()
self._scanner.register_detection_callback(None)
self._scanner = None
async def async_reachable(self, device_id: str, timeout: float = 10) -> bool:
"""Check if a device is reachable on the network."""
return bool(
(discovery := self.discoveries.get(device_id))
and discovery.device.address
in self._scanner.discovered_devices_and_advertisement_data
)
async def async_find(self, device_id: str, timeout: float = 10) -> BleDiscovery:
if discovery := self.discoveries.get(device_id):
logger.debug("Discovery for %s already found", device_id)
return discovery
logger.debug(
"Discovery for hkid %s not found, waiting for advertisement with timeout: %s",
device_id,
timeout,
)
future = asyncio.get_running_loop().create_future()
try:
async with asyncio_timeout(timeout):
return await future
except asyncio.TimeoutError:
logger.debug(
"Timed out after %s waiting for discovery with hkid %s",
timeout,
device_id,
)
raise AccessoryNotFoundError(
f"Accessory with device id {device_id} not found"
)
finally:
if device_id not in self._ble_futures:
return
if future in self._ble_futures[device_id]:
self._ble_futures[device_id].remove(future)
if not self._ble_futures[device_id]:
del self._ble_futures[device_id]
async def async_discover(self) -> AsyncIterable[BleDiscovery]:
for device in self.discoveries.values():
yield device
def load_pairing(
self, alias: str, pairing_data: AbstractPairingData
) -> BlePairing | None:
if pairing_data["Connection"] != "BLE":
return None
if not (hkid := pairing_data.get("AccessoryPairingID")):
return None
id_ = hkid.lower()
device: BLEDevice | None = None
description: HomeKitAdvertisement | None = None
if discovery := self.discoveries.get(id_):
device = discovery.device
description = discovery.description
pairing = self.pairings[id_] = BlePairing(
self, pairing_data, device=device, description=description
)
self.aliases[alias] = pairing
return pairing
|
