427 lines
14 KiB
Python
427 lines
14 KiB
Python
import base64
|
|
from asyncio import Event, ensure_future
|
|
from contextlib import asynccontextmanager
|
|
from threading import RLock, Timer
|
|
from typing import AsyncGenerator, Collection, List, Optional, Dict, Type, Union
|
|
from uuid import UUID
|
|
|
|
from bleak import BleakClient, BleakScanner
|
|
from bleak.backends.device import BLEDevice
|
|
from typing_extensions import override
|
|
|
|
from platypush.context import get_bus, get_or_create_event_loop
|
|
from platypush.entities import Entity, EntityManager
|
|
from platypush.entities.bluetooth import BluetoothDevice
|
|
from platypush.message.event.bluetooth.ble import (
|
|
BluetoothDeviceBlockedEvent,
|
|
BluetoothDeviceConnectedEvent,
|
|
BluetoothDeviceDisconnectedEvent,
|
|
BluetoothDeviceFoundEvent,
|
|
BluetoothDeviceLostEvent,
|
|
BluetoothDevicePairedEvent,
|
|
BluetoothDeviceTrustedEvent,
|
|
BluetoothDeviceUnblockedEvent,
|
|
BluetoothDeviceUnpairedEvent,
|
|
BluetoothDeviceUntrustedEvent,
|
|
BluetoothDeviceEvent,
|
|
BluetoothScanPausedEvent,
|
|
BluetoothScanResumedEvent,
|
|
)
|
|
from platypush.plugins import AsyncRunnablePlugin, action
|
|
|
|
UUIDType = Union[str, UUID]
|
|
|
|
|
|
class BluetoothBlePlugin(AsyncRunnablePlugin, EntityManager):
|
|
"""
|
|
Plugin to interact with BLE (Bluetooth Low-Energy) devices.
|
|
|
|
Note that the support for Bluetooth low-energy devices requires a Bluetooth
|
|
adapter compatible with the Bluetooth 5.0 specification or higher.
|
|
|
|
Requires:
|
|
|
|
* **bleak** (``pip install bleak``)
|
|
|
|
TODO: Write supported events.
|
|
|
|
"""
|
|
|
|
# Default connection timeout (in seconds)
|
|
_default_connect_timeout = 5
|
|
|
|
def __init__(
|
|
self,
|
|
interface: Optional[str] = None,
|
|
connect_timeout: float = _default_connect_timeout,
|
|
device_names: Optional[Dict[str, str]] = None,
|
|
characteristics: Optional[Collection[UUIDType]] = None,
|
|
scan_paused_on_start: bool = False,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
:param interface: Name of the Bluetooth interface to use (e.g. ``hci0``
|
|
on Linux). Default: first available interface.
|
|
:param connect_timeout: Timeout in seconds for the connection to a
|
|
Bluetooth device. Default: 5 seconds.
|
|
:param characteristics: List of service/characteristic UUIDs to
|
|
discover. Default: all.
|
|
:param device_names: Bluetooth address -> device name mapping. If not
|
|
specified, the device's advertised name will be used, or its
|
|
Bluetooth address. Example:
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"00:11:22:33:44:55": "Switchbot",
|
|
"00:11:22:33:44:56": "Headphones",
|
|
"00:11:22:33:44:57": "Button"
|
|
}
|
|
|
|
:param scan_paused_on_start: If ``True``, the plugin will not the
|
|
scanning thread until :meth:`.scan_resume` is called (default:
|
|
``False``).
|
|
|
|
"""
|
|
super().__init__(**kwargs)
|
|
|
|
self._interface = interface
|
|
self._connect_timeout = connect_timeout
|
|
self._characteristics = characteristics
|
|
self._scan_lock = RLock()
|
|
self._scan_enabled = Event()
|
|
self._scan_controller_timer: Optional[Timer] = None
|
|
self._connections: Dict[str, BleakClient] = {}
|
|
self._devices: Dict[str, BLEDevice] = {}
|
|
self._device_name_by_addr = device_names or {}
|
|
self._device_addr_by_name = {
|
|
name: addr for addr, name in self._device_name_by_addr.items()
|
|
}
|
|
|
|
if not scan_paused_on_start:
|
|
self._scan_enabled.set()
|
|
|
|
async def _get_device(self, device: str) -> BLEDevice:
|
|
"""
|
|
Utility method to get a device by name or address.
|
|
"""
|
|
addr = (
|
|
self._device_addr_by_name[device]
|
|
if device in self._device_addr_by_name
|
|
else device
|
|
)
|
|
|
|
if addr not in self._devices:
|
|
self.logger.info('Scanning for unknown device "%s"', device)
|
|
await self._scan()
|
|
|
|
dev = self._devices.get(addr)
|
|
assert dev is not None, f'Unknown device: "{device}"'
|
|
return dev
|
|
|
|
def _get_device_name(self, device: BLEDevice) -> str:
|
|
return (
|
|
self._device_name_by_addr.get(device.address)
|
|
or device.name
|
|
or device.address
|
|
)
|
|
|
|
def _post_event(
|
|
self, event_type: Type[BluetoothDeviceEvent], device: BLEDevice, **kwargs
|
|
):
|
|
props = device.details.get('props', {})
|
|
get_bus().post(
|
|
event_type(
|
|
address=device.address,
|
|
name=self._get_device_name(device),
|
|
connected=props.get('Connected', False),
|
|
paired=props.get('Paired', False),
|
|
blocked=props.get('Blocked', False),
|
|
trusted=props.get('Trusted', False),
|
|
characteristics=device.metadata.get('uuids', []),
|
|
**kwargs,
|
|
)
|
|
)
|
|
|
|
def _on_device_event(self, device: BLEDevice, _):
|
|
event_types: List[Type[BluetoothDeviceEvent]] = []
|
|
existing_device = self._devices.get(device.address)
|
|
|
|
if existing_device:
|
|
old_props = existing_device.details.get('props', {})
|
|
new_props = device.details.get('props', {})
|
|
|
|
if old_props.get('Paired') != new_props.get('Paired'):
|
|
event_types.append(
|
|
BluetoothDevicePairedEvent
|
|
if new_props.get('Paired')
|
|
else BluetoothDeviceUnpairedEvent
|
|
)
|
|
|
|
if old_props.get('Connected') != new_props.get('Connected'):
|
|
event_types.append(
|
|
BluetoothDeviceConnectedEvent
|
|
if new_props.get('Connected')
|
|
else BluetoothDeviceDisconnectedEvent
|
|
)
|
|
|
|
if old_props.get('Blocked') != new_props.get('Blocked'):
|
|
event_types.append(
|
|
BluetoothDeviceBlockedEvent
|
|
if new_props.get('Blocked')
|
|
else BluetoothDeviceUnblockedEvent
|
|
)
|
|
|
|
if old_props.get('Trusted') != new_props.get('Trusted'):
|
|
event_types.append(
|
|
BluetoothDeviceTrustedEvent
|
|
if new_props.get('Trusted')
|
|
else BluetoothDeviceUntrustedEvent
|
|
)
|
|
else:
|
|
event_types.append(BluetoothDeviceFoundEvent)
|
|
|
|
self._devices[device.address] = device
|
|
if device.name:
|
|
self._device_name_by_addr[device.address] = device.name
|
|
self._device_addr_by_name[device.name] = device.address
|
|
|
|
if event_types:
|
|
for event_type in event_types:
|
|
self._post_event(event_type, device)
|
|
self.publish_entities([device])
|
|
|
|
@asynccontextmanager
|
|
async def _connect(
|
|
self,
|
|
device: str,
|
|
interface: Optional[str] = None,
|
|
timeout: Optional[float] = None,
|
|
) -> AsyncGenerator[BleakClient, None]:
|
|
dev = await self._get_device(device)
|
|
async with BleakClient(
|
|
dev.address,
|
|
adapter=interface or self._interface,
|
|
timeout=timeout or self._connect_timeout,
|
|
) as client:
|
|
self._connections[dev.address] = client
|
|
yield client
|
|
self._connections.pop(dev.address)
|
|
|
|
async def _read(
|
|
self,
|
|
device: str,
|
|
service_uuid: UUIDType,
|
|
interface: Optional[str] = None,
|
|
connect_timeout: Optional[float] = None,
|
|
) -> bytearray:
|
|
async with self._connect(device, interface, connect_timeout) as client:
|
|
data = await client.read_gatt_char(service_uuid)
|
|
|
|
return data
|
|
|
|
async def _write(
|
|
self,
|
|
device: str,
|
|
data: bytes,
|
|
service_uuid: UUIDType,
|
|
interface: Optional[str] = None,
|
|
connect_timeout: Optional[float] = None,
|
|
):
|
|
async with self._connect(device, interface, connect_timeout) as client:
|
|
await client.write_gatt_char(service_uuid, data)
|
|
|
|
async def _scan(
|
|
self,
|
|
duration: Optional[float] = None,
|
|
characteristics: Optional[Collection[UUIDType]] = None,
|
|
publish_entities: bool = False,
|
|
) -> Collection[Entity]:
|
|
with self._scan_lock:
|
|
timeout = duration or self.poll_interval or 5
|
|
devices = await BleakScanner.discover(
|
|
adapter=self._interface,
|
|
timeout=timeout,
|
|
service_uuids=list(
|
|
map(str, characteristics or self._characteristics or [])
|
|
),
|
|
detection_callback=self._on_device_event,
|
|
)
|
|
|
|
# TODO Infer type from device.metadata['manufacturer_data']
|
|
|
|
self._devices.update({dev.address: dev for dev in devices})
|
|
return (
|
|
self.publish_entities(devices)
|
|
if publish_entities
|
|
else self.transform_entities(devices)
|
|
)
|
|
|
|
async def _scan_state_set(self, state: bool, duration: Optional[float] = None):
|
|
def timer_callback():
|
|
if state:
|
|
self.scan_pause()
|
|
else:
|
|
self.scan_resume()
|
|
|
|
self._scan_controller_timer = None
|
|
|
|
with self._scan_lock:
|
|
if not state and self._scan_enabled.is_set():
|
|
get_bus().post(BluetoothScanPausedEvent(duration=duration))
|
|
elif state and not self._scan_enabled.is_set():
|
|
get_bus().post(BluetoothScanResumedEvent(duration=duration))
|
|
|
|
if state:
|
|
self._scan_enabled.set()
|
|
else:
|
|
self._scan_enabled.clear()
|
|
|
|
if duration and not self._scan_controller_timer:
|
|
self._scan_controller_timer = Timer(duration, timer_callback)
|
|
self._scan_controller_timer.start()
|
|
|
|
@action
|
|
def scan_pause(self, duration: Optional[float] = None):
|
|
"""
|
|
Pause the scanning thread.
|
|
|
|
:param duration: For how long the scanning thread should be paused
|
|
(default: null = indefinitely).
|
|
"""
|
|
if self._loop:
|
|
ensure_future(self._scan_state_set(False, duration), loop=self._loop)
|
|
|
|
@action
|
|
def scan_resume(self, duration: Optional[float] = None):
|
|
"""
|
|
Resume the scanning thread, if inactive.
|
|
|
|
:param duration: For how long the scanning thread should be running
|
|
(default: null = indefinitely).
|
|
"""
|
|
if self._loop:
|
|
ensure_future(self._scan_state_set(True, duration), loop=self._loop)
|
|
|
|
@action
|
|
def scan(
|
|
self,
|
|
duration: Optional[float] = None,
|
|
characteristics: Optional[Collection[UUIDType]] = None,
|
|
):
|
|
"""
|
|
Scan for Bluetooth devices nearby and return the results as a list of
|
|
entities.
|
|
|
|
:param duration: Scan duration in seconds (default: same as the plugin's
|
|
`poll_interval` configuration parameter)
|
|
:param characteristics: List of characteristic UUIDs to discover. Default: all.
|
|
"""
|
|
loop = get_or_create_event_loop()
|
|
return loop.run_until_complete(
|
|
self._scan(duration, characteristics, publish_entities=True)
|
|
)
|
|
|
|
@action
|
|
def read(
|
|
self,
|
|
device: str,
|
|
service_uuid: UUIDType,
|
|
interface: Optional[str] = None,
|
|
connect_timeout: Optional[float] = None,
|
|
) -> str:
|
|
"""
|
|
Read a message from a device.
|
|
|
|
:param device: Name or address of the device to read from.
|
|
:param service_uuid: Service UUID.
|
|
:param interface: Bluetooth adapter name to use (default configured if None).
|
|
:param connect_timeout: Connection timeout in seconds (default: same as the
|
|
configured `connect_timeout`).
|
|
:return: The base64-encoded response received from the device.
|
|
"""
|
|
loop = get_or_create_event_loop()
|
|
data = loop.run_until_complete(
|
|
self._read(device, service_uuid, interface, connect_timeout)
|
|
)
|
|
return base64.b64encode(data).decode()
|
|
|
|
@action
|
|
def write(
|
|
self,
|
|
device: str,
|
|
data: Union[str, bytes],
|
|
service_uuid: UUIDType,
|
|
interface: Optional[str] = None,
|
|
connect_timeout: Optional[float] = None,
|
|
):
|
|
"""
|
|
Writes data to a device
|
|
|
|
:param device: Name or address of the device to read from.
|
|
:param data: Data to be written, either as bytes or as a base64-encoded string.
|
|
:param service_uuid: Service UUID.
|
|
:param interface: Bluetooth adapter name to use (default configured if None)
|
|
:param connect_timeout: Connection timeout in seconds (default: same as the
|
|
configured `connect_timeout`).
|
|
"""
|
|
loop = get_or_create_event_loop()
|
|
if isinstance(data, str):
|
|
data = base64.b64decode(data.encode())
|
|
|
|
loop.run_until_complete(
|
|
self._write(device, data, service_uuid, interface, connect_timeout)
|
|
)
|
|
|
|
@override
|
|
@action
|
|
def status(self, *_, **__) -> Collection[Entity]:
|
|
"""
|
|
Alias for :meth:`.scan`.
|
|
"""
|
|
return self.scan().output
|
|
|
|
@override
|
|
def transform_entities(
|
|
self, entities: Collection[BLEDevice]
|
|
) -> Collection[BluetoothDevice]:
|
|
return [
|
|
BluetoothDevice(
|
|
id=dev.address,
|
|
name=self._get_device_name(dev),
|
|
)
|
|
for dev in entities
|
|
]
|
|
|
|
@override
|
|
async def listen(self):
|
|
device_addresses = set()
|
|
|
|
while True:
|
|
await self._scan_enabled.wait()
|
|
entities = await self._scan()
|
|
|
|
new_device_addresses = {e.id for e in entities}
|
|
missing_device_addresses = device_addresses - new_device_addresses
|
|
missing_devices = [
|
|
dev
|
|
for addr, dev in self._devices.items()
|
|
if addr in missing_device_addresses
|
|
]
|
|
|
|
for dev in missing_devices:
|
|
self._post_event(BluetoothDeviceLostEvent, dev)
|
|
self._devices.pop(dev.address, None)
|
|
|
|
device_addresses = new_device_addresses
|
|
|
|
@override
|
|
def stop(self):
|
|
if self._scan_controller_timer:
|
|
self._scan_controller_timer.cancel()
|
|
|
|
super().stop()
|
|
|
|
|
|
# vim:sw=4:ts=4:et:
|