Compare commits

..

1 Commits

Author SHA1 Message Date
Charlie Boutier 7237619d3b A2DP example: Codec selection based on file type
Currently support SBC and AAC
2025-05-08 14:24:42 -07:00
232 changed files with 9868 additions and 14189 deletions
+1 -3
View File
@@ -6,8 +6,6 @@ on:
branches: [ main ] branches: [ main ]
pull_request: pull_request:
branches: [ main ] branches: [ main ]
workflow_dispatch:
branches: [main]
permissions: permissions:
contents: read contents: read
@@ -35,7 +33,7 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: | run: |
python -m pip install --upgrade pip python -m pip install --upgrade pip
python -m pip install ".[build,test,development]" python -m pip install ".[build,examples,test,development]"
- name: Check - name: Check
run: | run: |
invoke project.pre-commit invoke project.pre-commit
-2
View File
@@ -17,8 +17,6 @@ on:
pull_request: pull_request:
# The branches below must be a subset of the branches above # The branches below must be a subset of the branches above
branches: [ main ] branches: [ main ]
workflow_dispatch:
branches: [main]
schedule: schedule:
- cron: '39 21 * * 4' - cron: '39 21 * * 4'
-4
View File
@@ -7,10 +7,6 @@ on:
branches: [ main ] branches: [ main ]
paths: paths:
- 'extras/android/BtBench/**' - 'extras/android/BtBench/**'
workflow_dispatch:
branches: [main]
paths:
- 'extras/android/BtBench/**'
permissions: permissions:
contents: read contents: read
-2
View File
@@ -5,8 +5,6 @@ on:
branches: [ main ] branches: [ main ]
pull_request: pull_request:
branches: [ main ] branches: [ main ]
workflow_dispatch:
branches: [main]
permissions: permissions:
contents: read contents: read
+2 -4
View File
@@ -6,8 +6,6 @@ on:
branches: [ main ] branches: [ main ]
pull_request: pull_request:
branches: [ main ] branches: [ main ]
workflow_dispatch:
branches: [main]
permissions: permissions:
contents: read contents: read
@@ -49,7 +47,7 @@ jobs:
strategy: strategy:
matrix: matrix:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
rust-version: [ "1.80.0", "stable" ] rust-version: [ "1.76.0", "stable" ]
fail-fast: false fail-fast: false
steps: steps:
- name: Check out from Git - name: Check out from Git
@@ -72,7 +70,7 @@ jobs:
- name: Check License Headers - name: Check License Headers
run: cd rust && cargo run --features dev-tools --bin file-header check-all run: cd rust && cargo run --features dev-tools --bin file-header check-all
- name: Rust Build - name: Rust Build
run: cd rust && cargo build --all-targets && cargo build-all-features run: cd rust && cargo build --all-targets && cargo build-all-features --all-targets
# Lints after build so what clippy needs is already built # Lints after build so what clippy needs is already built
- name: Rust Lints - name: Rust Lints
run: cd rust && cargo fmt --check && cargo clippy --all-targets -- --deny warnings && cargo clippy --all-features --all-targets -- --deny warnings run: cd rust && cargo fmt --check && cargo clippy --all-targets -- --deny warnings && cargo clippy --all-features --all-targets -- --deny warnings
+1 -6
View File
@@ -102,10 +102,5 @@
"." "."
], ],
"python.testing.unittestEnabled": false, "python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true, "python.testing.pytestEnabled": true
"python-envs.defaultEnvManager": "ms-python.python:system",
"python-envs.pythonProjects": [],
"nrf-connect.applications": [
"${workspaceFolder}/extras/zephyr/hci_usb"
]
} }
+1 -1
View File
@@ -50,7 +50,7 @@ Bumble is easiest to use with a dedicated USB dongle.
This is because internal Bluetooth interfaces tend to be locked down by the operating system. This is because internal Bluetooth interfaces tend to be locked down by the operating system.
You can use the [usb_probe](/docs/mkdocs/src/apps_and_tools/usb_probe.md) tool (all platforms) or `lsusb` (Linux or macOS) to list the available USB devices on your system. You can use the [usb_probe](/docs/mkdocs/src/apps_and_tools/usb_probe.md) tool (all platforms) or `lsusb` (Linux or macOS) to list the available USB devices on your system.
See the [USB Transport](/docs/mkdocs/src/transports/usb.md) page for details on how to refer to USB devices. Also, if you are on a mac, see [these instructions](docs/mkdocs/src/platforms/macos.md). See the [USB Transport](/docs/mkdocs/src/transports/usb.md) page for details on how to refer to USB devices. Also, if your are on a mac, see [these instructions](docs/mkdocs/src/platforms/macos.md).
## License ## License
+3
View File
@@ -12,6 +12,9 @@ Apps
## `show.py` ## `show.py`
Parse a file with HCI packets and print the details of each packet in a human readable form Parse a file with HCI packets and print the details of each packet in a human readable form
## `link_relay.py`
Simple WebSocket relay for virtual RemoteLink instances to communicate with each other through.
## `hci_bridge.py` ## `hci_bridge.py`
This app acts as a simple bridge between two HCI transports, with a host on one side and This app acts as a simple bridge between two HCI transports, with a host on one side and
a controller on the other. All the HCI packets bridged between the two are printed on the console a controller on the other. All the HCI packets bridged between the two are printed on the console
+48 -26
View File
@@ -23,8 +23,16 @@ import contextlib
import dataclasses import dataclasses
import functools import functools
import logging import logging
import os
import struct import struct
from typing import Any, AsyncGenerator, Coroutine, Optional from typing import (
Any,
AsyncGenerator,
Coroutine,
Deque,
Optional,
Tuple,
)
import click import click
@@ -35,14 +43,19 @@ except ImportError as e:
"Try `python -m pip install \"git+https://github.com/google/liblc3.git\"`." "Try `python -m pip install \"git+https://github.com/google/liblc3.git\"`."
) from e ) from e
import bumble.device
import bumble.logging
import bumble.transport
import bumble.utils
from bumble import company_ids, core, data_types, gatt, hci
from bumble.audio import io as audio_io from bumble.audio import io as audio_io
from bumble.colors import color from bumble.colors import color
from bumble.profiles import bap, bass, le_audio, pbp from bumble import company_ids
from bumble import core
from bumble import gatt
from bumble import hci
from bumble.profiles import bap
from bumble.profiles import le_audio
from bumble.profiles import pbp
from bumble.profiles import bass
import bumble.device
import bumble.transport
import bumble.utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -117,8 +130,8 @@ class BroadcastScanner(bumble.utils.EventEmitter):
broadcast_audio_announcement: Optional[bap.BroadcastAudioAnnouncement] = None broadcast_audio_announcement: Optional[bap.BroadcastAudioAnnouncement] = None
basic_audio_announcement: Optional[bap.BasicAudioAnnouncement] = None basic_audio_announcement: Optional[bap.BasicAudioAnnouncement] = None
appearance: Optional[core.Appearance] = None appearance: Optional[core.Appearance] = None
biginfo: Optional[bumble.device.BigInfoAdvertisement] = None biginfo: Optional[bumble.device.BIGInfoAdvertisement] = None
manufacturer_data: Optional[tuple[str, bytes]] = None manufacturer_data: Optional[Tuple[str, bytes]] = None
def __post_init__(self) -> None: def __post_init__(self) -> None:
super().__init__() super().__init__()
@@ -244,10 +257,8 @@ class BroadcastScanner(bumble.utils.EventEmitter):
print(color(' SDU Interval: ', 'magenta'), self.biginfo.sdu_interval) print(color(' SDU Interval: ', 'magenta'), self.biginfo.sdu_interval)
print(color(' Max SDU: ', 'magenta'), self.biginfo.max_sdu) print(color(' Max SDU: ', 'magenta'), self.biginfo.max_sdu)
print(color(' PHY: ', 'magenta'), self.biginfo.phy.name) print(color(' PHY: ', 'magenta'), self.biginfo.phy.name)
print(color(' Framing: ', 'magenta'), self.biginfo.framing.name) print(color(' Framed: ', 'magenta'), self.biginfo.framed)
print( print(color(' Encrypted: ', 'magenta'), self.biginfo.encrypted)
color(' Encryption: ', 'magenta'), self.biginfo.encryption.name
)
def on_sync_establishment(self) -> None: def on_sync_establishment(self) -> None:
self.emit('sync_establishment') self.emit('sync_establishment')
@@ -277,7 +288,7 @@ class BroadcastScanner(bumble.utils.EventEmitter):
self.emit('change') self.emit('change')
def on_biginfo_advertisement( def on_biginfo_advertisement(
self, advertisement: bumble.device.BigInfoAdvertisement self, advertisement: bumble.device.BIGInfoAdvertisement
) -> None: ) -> None:
self.biginfo = advertisement self.biginfo = advertisement
self.emit('change') self.emit('change')
@@ -737,9 +748,7 @@ async def run_receive(
sample_rate_hz=sampling_frequency.hz, sample_rate_hz=sampling_frequency.hz,
num_channels=num_bis, num_channels=num_bis,
) )
lc3_queues: list[collections.deque[bytes]] = [ lc3_queues: list[Deque[bytes]] = [collections.deque() for i in range(num_bis)]
collections.deque() for i in range(num_bis)
]
packet_stats = [0, 0] packet_stats = [0, 0]
audio_output = await audio_io.create_audio_output(output) audio_output = await audio_io.create_audio_output(output)
@@ -755,7 +764,7 @@ async def run_receive(
) )
) )
def sink(queue: collections.deque[bytes], packet: hci.HCI_IsoDataPacket): def sink(queue: Deque[bytes], packet: hci.HCI_IsoDataPacket):
# TODO: re-assemble fragments and detect errors # TODO: re-assemble fragments and detect errors
queue.append(packet.iso_sdu_fragment) queue.append(packet.iso_sdu_fragment)
@@ -859,13 +868,21 @@ async def run_transmit(
) )
broadcast_audio_announcement = bap.BroadcastAudioAnnouncement(broadcast_id) broadcast_audio_announcement = bap.BroadcastAudioAnnouncement(broadcast_id)
advertising_data_types: list[core.DataType] = [ advertising_manufacturer_data = (
data_types.BroadcastName(broadcast_name) b''
] if manufacturer_data is None
if manufacturer_data is not None: else bytes(
advertising_data_types.append( core.AdvertisingData(
data_types.ManufacturerSpecificData(*manufacturer_data) [
(
core.AdvertisingData.MANUFACTURER_SPECIFIC_DATA,
struct.pack('<H', manufacturer_data[0])
+ manufacturer_data[1],
)
]
)
) )
)
advertising_set = await device.create_advertising_set( advertising_set = await device.create_advertising_set(
advertising_parameters=bumble.device.AdvertisingParameters( advertising_parameters=bumble.device.AdvertisingParameters(
@@ -877,7 +894,12 @@ async def run_transmit(
), ),
advertising_data=( advertising_data=(
broadcast_audio_announcement.get_advertising_data() broadcast_audio_announcement.get_advertising_data()
+ bytes(core.AdvertisingData(advertising_data_types)) + bytes(
core.AdvertisingData(
[(core.AdvertisingData.BROADCAST_NAME, broadcast_name.encode())]
)
)
+ advertising_manufacturer_data
), ),
periodic_advertising_parameters=bumble.device.PeriodicAdvertisingParameters( periodic_advertising_parameters=bumble.device.PeriodicAdvertisingParameters(
periodic_advertising_interval_min=80, periodic_advertising_interval_min=80,
@@ -1211,7 +1233,7 @@ def transmit(
def main(): def main():
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
auracast() auracast()
+44 -488
View File
@@ -19,46 +19,33 @@ import asyncio
import dataclasses import dataclasses
import enum import enum
import logging import logging
import os
import statistics import statistics
import struct import struct
import time import time
from typing import Optional
import click import click
import bumble.core
import bumble.logging
import bumble.rfcomm
from bumble import l2cap from bumble import l2cap
from bumble.colors import color
from bumble.core import ( from bumble.core import (
PhysicalTransport,
BT_L2CAP_PROTOCOL_ID, BT_L2CAP_PROTOCOL_ID,
BT_RFCOMM_PROTOCOL_ID, BT_RFCOMM_PROTOCOL_ID,
UUID, UUID,
CommandTimeoutError, CommandTimeoutError,
ConnectionPHY,
PhysicalTransport,
)
from bumble.device import (
CigParameters,
CisLink,
Connection,
ConnectionParametersPreferences,
Device,
Peer,
) )
from bumble.colors import color
from bumble.device import Connection, ConnectionParametersPreferences, Device, Peer
from bumble.gatt import Characteristic, CharacteristicValue, Service from bumble.gatt import Characteristic, CharacteristicValue, Service
from bumble.hci import ( from bumble.hci import (
HCI_LE_1M_PHY, HCI_LE_1M_PHY,
HCI_LE_2M_PHY, HCI_LE_2M_PHY,
HCI_LE_CODED_PHY, HCI_LE_CODED_PHY,
Role,
HCI_Constant, HCI_Constant,
HCI_Error, HCI_Error,
HCI_IsoDataPacket,
HCI_StatusError, HCI_StatusError,
Role,
) )
from bumble.pairing import PairingConfig
from bumble.sdp import ( from bumble.sdp import (
SDP_BROWSE_GROUP_LIST_ATTRIBUTE_ID, SDP_BROWSE_GROUP_LIST_ATTRIBUTE_ID,
SDP_PROTOCOL_DESCRIPTOR_LIST_ATTRIBUTE_ID, SDP_PROTOCOL_DESCRIPTOR_LIST_ATTRIBUTE_ID,
@@ -68,8 +55,12 @@ from bumble.sdp import (
DataElement, DataElement,
ServiceAttribute, ServiceAttribute,
) )
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
import bumble.rfcomm
import bumble.core
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
from bumble.pairing import PairingConfig
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -84,28 +75,17 @@ DEFAULT_CENTRAL_ADDRESS = 'F0:F0:F0:F0:F0:F0'
DEFAULT_CENTRAL_NAME = 'Speed Central' DEFAULT_CENTRAL_NAME = 'Speed Central'
DEFAULT_PERIPHERAL_ADDRESS = 'F1:F1:F1:F1:F1:F1' DEFAULT_PERIPHERAL_ADDRESS = 'F1:F1:F1:F1:F1:F1'
DEFAULT_PERIPHERAL_NAME = 'Speed Peripheral' DEFAULT_PERIPHERAL_NAME = 'Speed Peripheral'
DEFAULT_ADVERTISING_INTERVAL = 100
SPEED_SERVICE_UUID = '50DB505C-8AC4-4738-8448-3B1D9CC09CC5' SPEED_SERVICE_UUID = '50DB505C-8AC4-4738-8448-3B1D9CC09CC5'
SPEED_TX_UUID = 'E789C754-41A1-45F4-A948-A0A1A90DBA53' SPEED_TX_UUID = 'E789C754-41A1-45F4-A948-A0A1A90DBA53'
SPEED_RX_UUID = '016A2CC7-E14B-4819-935F-1F56EAE4098D' SPEED_RX_UUID = '016A2CC7-E14B-4819-935F-1F56EAE4098D'
DEFAULT_RFCOMM_UUID = 'E6D55659-C8B4-4B85-96BB-B1143AF6D3AE' DEFAULT_RFCOMM_UUID = 'E6D55659-C8B4-4B85-96BB-B1143AF6D3AE'
DEFAULT_L2CAP_PSM = 128 DEFAULT_L2CAP_PSM = 128
DEFAULT_L2CAP_MAX_CREDITS = 128 DEFAULT_L2CAP_MAX_CREDITS = 128
DEFAULT_L2CAP_MTU = 1024 DEFAULT_L2CAP_MTU = 1024
DEFAULT_L2CAP_MPS = 1024 DEFAULT_L2CAP_MPS = 1024
DEFAULT_ISO_MAX_SDU_C_TO_P = 251
DEFAULT_ISO_MAX_SDU_P_TO_C = 251
DEFAULT_ISO_SDU_INTERVAL_C_TO_P = 10000
DEFAULT_ISO_SDU_INTERVAL_P_TO_C = 10000
DEFAULT_ISO_MAX_TRANSPORT_LATENCY_C_TO_P = 35
DEFAULT_ISO_MAX_TRANSPORT_LATENCY_P_TO_C = 35
DEFAULT_ISO_RTN_C_TO_P = 3
DEFAULT_ISO_RTN_P_TO_C = 3
DEFAULT_LINGER_TIME = 1.0 DEFAULT_LINGER_TIME = 1.0
DEFAULT_POST_CONNECTION_WAIT_TIME = 1.0 DEFAULT_POST_CONNECTION_WAIT_TIME = 1.0
@@ -122,14 +102,14 @@ def le_phy_name(phy_id):
) )
def print_connection_phy(phy: ConnectionPHY) -> None: def print_connection_phy(phy):
logging.info( logging.info(
color('@@@ PHY: ', 'yellow') + f'TX:{le_phy_name(phy.tx_phy)}/' color('@@@ PHY: ', 'yellow') + f'TX:{le_phy_name(phy.tx_phy)}/'
f'RX:{le_phy_name(phy.rx_phy)}' f'RX:{le_phy_name(phy.rx_phy)}'
) )
def print_connection(connection: Connection) -> None: def print_connection(connection):
params = [] params = []
if connection.transport == PhysicalTransport.LE: if connection.transport == PhysicalTransport.LE:
params.append( params.append(
@@ -154,34 +134,6 @@ def print_connection(connection: Connection) -> None:
logging.info(color('@@@ Connection: ', 'yellow') + ' '.join(params)) logging.info(color('@@@ Connection: ', 'yellow') + ' '.join(params))
def print_cis_link(cis_link: CisLink) -> None:
logging.info(color("@@@ CIS established", "green"))
logging.info(color('@@@ ISO interval: ', 'green') + f"{cis_link.iso_interval}ms")
logging.info(color('@@@ NSE: ', 'green') + f"{cis_link.nse}")
logging.info(color('@@@ Central->Peripheral:', 'green'))
if cis_link.phy_c_to_p is not None:
logging.info(
color('@@@ PHY: ', 'green') + f"{cis_link.phy_c_to_p.name}"
)
logging.info(
color('@@@ Latency: ', 'green') + f"{cis_link.transport_latency_c_to_p}µs"
)
logging.info(color('@@@ BN: ', 'green') + f"{cis_link.bn_c_to_p}")
logging.info(color('@@@ FT: ', 'green') + f"{cis_link.ft_c_to_p}")
logging.info(color('@@@ Max PDU: ', 'green') + f"{cis_link.max_pdu_c_to_p}")
logging.info(color('@@@ Peripheral->Central:', 'green'))
if cis_link.phy_p_to_c is not None:
logging.info(
color('@@@ PHY: ', 'green') + f"{cis_link.phy_p_to_c.name}"
)
logging.info(
color('@@@ Latency: ', 'green') + f"{cis_link.transport_latency_p_to_c}µs"
)
logging.info(color('@@@ BN: ', 'green') + f"{cis_link.bn_p_to_c}")
logging.info(color('@@@ FT: ', 'green') + f"{cis_link.ft_p_to_c}")
logging.info(color('@@@ Max PDU: ', 'green') + f"{cis_link.max_pdu_p_to_c}")
def make_sdp_records(channel): def make_sdp_records(channel):
return { return {
0x00010001: [ 0x00010001: [
@@ -245,51 +197,6 @@ async def switch_roles(connection, role):
logging.info(f'{color("### Role switch failed:", "red")} {error}') logging.info(f'{color("### Role switch failed:", "red")} {error}')
async def pre_power_on(device: Device, classic: bool) -> None:
device.classic_enabled = classic
# Set up a pairing config factory with minimal requirements.
device.config.keystore = "JsonKeyStore"
device.pairing_config_factory = lambda _: PairingConfig(
sc=False, mitm=False, bonding=False
)
async def post_power_on(
device: Device,
le_scan: Optional[tuple[int, int]],
le_advertise: Optional[int],
classic_page_scan: bool,
classic_inquiry_scan: bool,
) -> None:
if classic_page_scan:
logging.info(color("*** Enabling page scan", "blue"))
await device.set_connectable(True)
if classic_inquiry_scan:
logging.info(color("*** Enabling inquiry scan", "blue"))
await device.set_discoverable(True)
if le_scan:
scan_window, scan_interval = le_scan
logging.info(
color(
f"*** Starting LE scanning [{scan_window}ms/{scan_interval}ms]",
"blue",
)
)
await device.start_scanning(
scan_interval=scan_interval, scan_window=scan_window
)
if le_advertise:
logging.info(color(f"*** Starting LE advertising [{le_advertise}ms]", "blue"))
await device.start_advertising(
advertising_interval_min=le_advertise,
advertising_interval_max=le_advertise,
auto_restart=True,
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Packet # Packet
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -507,8 +414,7 @@ class Sender:
self.bytes_sent += len(packet) self.bytes_sent += len(packet)
await self.packet_io.send_packet(packet) await self.packet_io.send_packet(packet)
if self.packet_io.can_receive(): await self.done.wait()
await self.done.wait()
run_counter = f'[{run + 1} of {self.repeat + 1}]' if self.repeat else '' run_counter = f'[{run + 1} of {self.repeat + 1}]' if self.repeat else ''
logging.info(color(f'=== {run_counter} Done!', 'magenta')) logging.info(color(f'=== {run_counter} Done!', 'magenta'))
@@ -538,9 +444,6 @@ class Sender:
) )
self.done.set() self.done.set()
def is_sender(self):
return True
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Receiver # Receiver
@@ -588,8 +491,7 @@ class Receiver:
logging.info( logging.info(
color( color(
f'!!! Unexpected packet, expected {self.expected_packet_index} ' f'!!! Unexpected packet, expected {self.expected_packet_index} '
f'but received {packet.sequence}', f'but received {packet.sequence}'
'red',
) )
) )
@@ -632,9 +534,6 @@ class Receiver:
await self.done.wait() await self.done.wait()
logging.info(color('=== Done!', 'magenta')) logging.info(color('=== Done!', 'magenta'))
def is_sender(self):
return False
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Ping # Ping
@@ -770,8 +669,7 @@ class Ping:
color( color(
f'!!! Unexpected packet, ' f'!!! Unexpected packet, '
f'expected {self.next_expected_packet_index} ' f'expected {self.next_expected_packet_index} '
f'but received {packet.sequence}', f'but received {packet.sequence}'
'red',
) )
) )
@@ -779,9 +677,6 @@ class Ping:
self.done.set() self.done.set()
return return
def is_sender(self):
return True
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Pong # Pong
@@ -826,8 +721,7 @@ class Pong:
logging.info( logging.info(
color( color(
f'!!! Unexpected packet, expected {self.expected_packet_index} ' f'!!! Unexpected packet, expected {self.expected_packet_index} '
f'but received {packet.sequence}', f'but received {packet.sequence}'
'red',
) )
) )
@@ -849,9 +743,6 @@ class Pong:
await self.done.wait() await self.done.wait()
logging.info(color('=== Done!', 'magenta')) logging.info(color('=== Done!', 'magenta'))
def is_sender(self):
return False
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# GattClient # GattClient
@@ -1015,9 +906,6 @@ class StreamedPacketIO:
# pylint: disable-next=not-callable # pylint: disable-next=not-callable
self.io_sink(struct.pack('>H', len(packet)) + packet) self.io_sink(struct.pack('>H', len(packet)) + packet)
def can_receive(self):
return True
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# L2capClient # L2capClient
@@ -1289,96 +1177,6 @@ class RfcommServer(StreamedPacketIO):
await self.dlc.drain() await self.dlc.drain()
# -----------------------------------------------------------------------------
# IsoClient
# -----------------------------------------------------------------------------
class IsoClient(StreamedPacketIO):
def __init__(
self,
device: Device,
) -> None:
super().__init__()
self.device = device
self.ready = asyncio.Event()
self.cis_link: Optional[CisLink] = None
async def on_connection(
self, connection: Connection, cis_link: CisLink, sender: bool
) -> None:
connection.on(connection.EVENT_DISCONNECTION, self.on_disconnection)
self.cis_link = cis_link
self.io_sink = cis_link.write
await cis_link.setup_data_path(
cis_link.Direction.HOST_TO_CONTROLLER
if sender
else cis_link.Direction.CONTROLLER_TO_HOST
)
cis_link.sink = self.on_iso_packet
self.ready.set()
def on_iso_packet(self, iso_packet: HCI_IsoDataPacket) -> None:
self.on_packet(iso_packet.iso_sdu_fragment)
def on_disconnection(self, _):
pass
async def drain(self):
if self.cis_link is None:
return
await self.cis_link.drain()
def can_receive(self):
return False
# -----------------------------------------------------------------------------
# IsoServer
# -----------------------------------------------------------------------------
class IsoServer(StreamedPacketIO):
def __init__(
self,
device: Device,
):
super().__init__()
self.device = device
self.cis_link: Optional[CisLink] = None
self.ready = asyncio.Event()
logging.info(
color(
'### Listening for ISO connection',
'yellow',
)
)
async def on_connection(
self, connection: Connection, cis_link: CisLink, sender: bool
) -> None:
connection.on(connection.EVENT_DISCONNECTION, self.on_disconnection)
self.io_sink = cis_link.write
await cis_link.setup_data_path(
cis_link.Direction.HOST_TO_CONTROLLER
if sender
else cis_link.Direction.CONTROLLER_TO_HOST
)
cis_link.sink = self.on_iso_packet
self.ready.set()
def on_iso_packet(self, iso_packet: HCI_IsoDataPacket) -> None:
self.on_packet(iso_packet.iso_sdu_fragment)
def on_disconnection(self, _):
pass
async def drain(self):
if self.cis_link is None:
return
await self.cis_link.drain()
def can_receive(self):
return False
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Central # Central
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -1387,52 +1185,26 @@ class Central(Connection.Listener):
self, self,
transport, transport,
peripheral_address, peripheral_address,
classic,
scenario_factory, scenario_factory,
mode_factory, mode_factory,
connection_interval, connection_interval,
phy, phy,
authenticate, authenticate,
encrypt, encrypt,
iso,
iso_sdu_interval_c_to_p,
iso_sdu_interval_p_to_c,
iso_max_sdu_c_to_p,
iso_max_sdu_p_to_c,
iso_max_transport_latency_c_to_p,
iso_max_transport_latency_p_to_c,
iso_rtn_c_to_p,
iso_rtn_p_to_c,
classic,
extended_data_length, extended_data_length,
role_switch, role_switch,
le_scan,
le_advertise,
classic_page_scan,
classic_inquiry_scan,
): ):
super().__init__() super().__init__()
self.transport = transport self.transport = transport
self.peripheral_address = peripheral_address self.peripheral_address = peripheral_address
self.classic = classic self.classic = classic
self.iso = iso
self.iso_sdu_interval_c_to_p = iso_sdu_interval_c_to_p
self.iso_sdu_interval_p_to_c = iso_sdu_interval_p_to_c
self.iso_max_sdu_c_to_p = iso_max_sdu_c_to_p
self.iso_max_sdu_p_to_c = iso_max_sdu_p_to_c
self.iso_max_transport_latency_c_to_p = iso_max_transport_latency_c_to_p
self.iso_max_transport_latency_p_to_c = iso_max_transport_latency_p_to_c
self.iso_rtn_c_to_p = iso_rtn_c_to_p
self.iso_rtn_p_to_c = iso_rtn_p_to_c
self.scenario_factory = scenario_factory self.scenario_factory = scenario_factory
self.mode_factory = mode_factory self.mode_factory = mode_factory
self.authenticate = authenticate self.authenticate = authenticate
self.encrypt = encrypt or authenticate self.encrypt = encrypt or authenticate
self.extended_data_length = extended_data_length self.extended_data_length = extended_data_length
self.role_switch = role_switch self.role_switch = role_switch
self.le_scan = le_scan
self.le_advertise = le_advertise
self.classic_page_scan = classic_page_scan
self.classic_inquiry_scan = classic_inquiry_scan
self.device = None self.device = None
self.connection = None self.connection = None
@@ -1469,7 +1241,7 @@ class Central(Connection.Listener):
async def run(self): async def run(self):
logging.info(color('>>> Connecting to HCI...', 'green')) logging.info(color('>>> Connecting to HCI...', 'green'))
async with await open_transport(self.transport) as ( async with await open_transport_or_link(self.transport) as (
hci_source, hci_source,
hci_sink, hci_sink,
): ):
@@ -1482,22 +1254,18 @@ class Central(Connection.Listener):
mode = self.mode_factory(self.device) mode = self.mode_factory(self.device)
scenario = self.scenario_factory(mode) scenario = self.scenario_factory(mode)
self.device.classic_enabled = self.classic self.device.classic_enabled = self.classic
self.device.cis_enabled = self.iso
# Set up a pairing config factory with minimal requirements. # Set up a pairing config factory with minimal requirements.
self.device.config.keystore = "JsonKeyStore"
self.device.pairing_config_factory = lambda _: PairingConfig( self.device.pairing_config_factory = lambda _: PairingConfig(
sc=False, mitm=False, bonding=False sc=False, mitm=False, bonding=False
) )
await pre_power_on(self.device, self.classic)
await self.device.power_on() await self.device.power_on()
await post_power_on(
self.device, if self.classic:
self.le_scan, await self.device.set_discoverable(False)
self.le_advertise, await self.device.set_connectable(False)
self.classic_page_scan,
self.classic_inquiry_scan,
)
logging.info( logging.info(
color(f'### Connecting to {self.peripheral_address}...', 'cyan') color(f'### Connecting to {self.peripheral_address}...', 'cyan')
@@ -1572,72 +1340,7 @@ class Central(Connection.Listener):
) )
) )
# Setup ISO streams. await mode.on_connection(self.connection)
if self.iso:
if scenario.is_sender():
sdu_interval_c_to_p = (
self.iso_sdu_interval_c_to_p or DEFAULT_ISO_SDU_INTERVAL_C_TO_P
)
sdu_interval_p_to_c = self.iso_sdu_interval_p_to_c or 0
max_transport_latency_c_to_p = (
self.iso_max_transport_latency_c_to_p
or DEFAULT_ISO_MAX_TRANSPORT_LATENCY_C_TO_P
)
max_transport_latency_p_to_c = (
self.iso_max_transport_latency_p_to_c or 0
)
max_sdu_c_to_p = (
self.iso_max_sdu_c_to_p or DEFAULT_ISO_MAX_SDU_C_TO_P
)
max_sdu_p_to_c = self.iso_max_sdu_p_to_c or 0
rtn_c_to_p = self.iso_rtn_c_to_p or DEFAULT_ISO_RTN_C_TO_P
rtn_p_to_c = self.iso_rtn_p_to_c or 0
else:
sdu_interval_p_to_c = (
self.iso_sdu_interval_p_to_c or DEFAULT_ISO_SDU_INTERVAL_P_TO_C
)
sdu_interval_c_to_p = self.iso_sdu_interval_c_to_p or 0
max_transport_latency_p_to_c = (
self.iso_max_transport_latency_p_to_c
or DEFAULT_ISO_MAX_TRANSPORT_LATENCY_P_TO_C
)
max_transport_latency_c_to_p = (
self.iso_max_transport_latency_c_to_p or 0
)
max_sdu_p_to_c = (
self.iso_max_sdu_p_to_c or DEFAULT_ISO_MAX_SDU_P_TO_C
)
max_sdu_c_to_p = self.iso_max_sdu_c_to_p or 0
rtn_p_to_c = self.iso_rtn_p_to_c or DEFAULT_ISO_RTN_P_TO_C
rtn_c_to_p = self.iso_rtn_c_to_p or 0
cis_handles = await self.device.setup_cig(
CigParameters(
cig_id=1,
sdu_interval_c_to_p=sdu_interval_c_to_p,
sdu_interval_p_to_c=sdu_interval_p_to_c,
max_transport_latency_c_to_p=max_transport_latency_c_to_p,
max_transport_latency_p_to_c=max_transport_latency_p_to_c,
cis_parameters=[
CigParameters.CisParameters(
cis_id=2,
max_sdu_c_to_p=max_sdu_c_to_p,
max_sdu_p_to_c=max_sdu_p_to_c,
rtn_c_to_p=rtn_c_to_p,
rtn_p_to_c=rtn_p_to_c,
)
],
)
)
cis_link = (
await self.device.create_cis([(cis_handles[0], self.connection)])
)[0]
print_cis_link(cis_link)
await mode.on_connection(
self.connection, cis_link, scenario.is_sender()
)
else:
await mode.on_connection(self.connection)
await scenario.run() await scenario.run()
await asyncio.sleep(DEFAULT_LINGER_TIME) await asyncio.sleep(DEFAULT_LINGER_TIME)
@@ -1673,38 +1376,24 @@ class Peripheral(Device.Listener, Connection.Listener):
scenario_factory, scenario_factory,
mode_factory, mode_factory,
classic, classic,
iso,
extended_data_length, extended_data_length,
role_switch, role_switch,
le_scan,
le_advertise,
classic_page_scan,
classic_inquiry_scan,
): ):
self.transport = transport self.transport = transport
self.classic = classic self.classic = classic
self.iso = iso
self.scenario_factory = scenario_factory self.scenario_factory = scenario_factory
self.mode_factory = mode_factory self.mode_factory = mode_factory
self.extended_data_length = extended_data_length self.extended_data_length = extended_data_length
self.role_switch = role_switch self.role_switch = role_switch
self.le_scan = le_scan
self.classic_page_scan = classic_page_scan
self.classic_inquiry_scan = classic_inquiry_scan
self.scenario = None self.scenario = None
self.mode = None self.mode = None
self.device = None self.device = None
self.connection = None self.connection = None
self.connected = asyncio.Event() self.connected = asyncio.Event()
if le_advertise:
self.le_advertise = le_advertise
else:
self.le_advertise = 0 if classic else DEFAULT_ADVERTISING_INTERVAL
async def run(self): async def run(self):
logging.info(color('>>> Connecting to HCI...', 'green')) logging.info(color('>>> Connecting to HCI...', 'green'))
async with await open_transport(self.transport) as ( async with await open_transport_or_link(self.transport) as (
hci_source, hci_source,
hci_sink, hci_sink,
): ):
@@ -1718,22 +1407,20 @@ class Peripheral(Device.Listener, Connection.Listener):
self.mode = self.mode_factory(self.device) self.mode = self.mode_factory(self.device)
self.scenario = self.scenario_factory(self.mode) self.scenario = self.scenario_factory(self.mode)
self.device.classic_enabled = self.classic self.device.classic_enabled = self.classic
self.device.cis_enabled = self.iso
# Set up a pairing config factory with minimal requirements. # Set up a pairing config factory with minimal requirements.
self.device.config.keystore = "JsonKeyStore"
self.device.pairing_config_factory = lambda _: PairingConfig( self.device.pairing_config_factory = lambda _: PairingConfig(
sc=False, mitm=False, bonding=False sc=False, mitm=False, bonding=False
) )
await pre_power_on(self.device, self.classic)
await self.device.power_on() await self.device.power_on()
await post_power_on(
self.device, if self.classic:
self.le_scan, await self.device.set_discoverable(True)
self.le_advertise, await self.device.set_connectable(True)
self.classic or self.classic_page_scan, else:
self.classic or self.classic_inquiry_scan, await self.device.start_advertising(auto_restart=True)
)
if self.classic: if self.classic:
logging.info( logging.info(
@@ -1755,21 +1442,7 @@ class Peripheral(Device.Listener, Connection.Listener):
logging.info(color('### Connected', 'cyan')) logging.info(color('### Connected', 'cyan'))
print_connection(self.connection) print_connection(self.connection)
if self.iso: await self.mode.on_connection(self.connection)
async def on_cis_request(cis_link: CisLink) -> None:
logging.info(color("@@@ Accepting CIS", "green"))
await self.device.accept_cis_request(cis_link)
print_cis_link(cis_link)
await self.mode.on_connection(
self.connection, cis_link, self.scenario.is_sender()
)
self.connection.on(self.connection.EVENT_CIS_REQUEST, on_cis_request)
else:
await self.mode.on_connection(self.connection)
await self.scenario.run() await self.scenario.run()
await asyncio.sleep(DEFAULT_LINGER_TIME) await asyncio.sleep(DEFAULT_LINGER_TIME)
@@ -1778,14 +1451,10 @@ class Peripheral(Device.Listener, Connection.Listener):
self.connection = connection self.connection = connection
self.connected.set() self.connected.set()
# Stop being discoverable and connectable if possible # Stop being discoverable and connectable
if self.classic: if self.classic:
if not self.classic_inquiry_scan: AsyncRunner.spawn(self.device.set_discoverable(False))
logging.info(color("*** Stopping inquiry scan", "blue")) AsyncRunner.spawn(self.device.set_connectable(False))
AsyncRunner.spawn(self.device.set_discoverable(False))
if not self.classic_page_scan:
logging.info(color("*** Stopping page scan", "blue"))
AsyncRunner.spawn(self.device.set_connectable(False))
# Request a new data length if needed # Request a new data length if needed
if not self.classic and self.extended_data_length: if not self.classic and self.extended_data_length:
@@ -1806,9 +1475,7 @@ class Peripheral(Device.Listener, Connection.Listener):
self.scenario.reset() self.scenario.reset()
if self.classic: if self.classic:
logging.info(color("*** Enabling inquiry scan", "blue"))
AsyncRunner.spawn(self.device.set_discoverable(True)) AsyncRunner.spawn(self.device.set_discoverable(True))
logging.info(color("*** Enabling page scan", "blue"))
AsyncRunner.spawn(self.device.set_connectable(True)) AsyncRunner.spawn(self.device.set_connectable(True))
def on_connection_parameters_update(self): def on_connection_parameters_update(self):
@@ -1881,12 +1548,6 @@ def create_mode_factory(ctx, default_mode):
credits_threshold=ctx.obj['rfcomm_credits_threshold'], credits_threshold=ctx.obj['rfcomm_credits_threshold'],
) )
if mode == 'iso-server':
return IsoServer(device)
if mode == 'iso-client':
return IsoClient(device)
raise ValueError('invalid mode') raise ValueError('invalid mode')
return create_mode return create_mode
@@ -1914,9 +1575,6 @@ def create_scenario_factory(ctx, default_scenario):
return Receiver(packet_io, ctx.obj['linger']) return Receiver(packet_io, ctx.obj['linger'])
if scenario == 'ping': if scenario == 'ping':
if isinstance(packet_io, (IsoClient, IsoServer)):
raise ValueError('ping not supported with ISO')
return Ping( return Ping(
packet_io, packet_io,
start_delay=ctx.obj['start_delay'], start_delay=ctx.obj['start_delay'],
@@ -1928,9 +1586,6 @@ def create_scenario_factory(ctx, default_scenario):
) )
if scenario == 'pong': if scenario == 'pong':
if isinstance(packet_io, (IsoClient, IsoServer)):
raise ValueError('pong not supported with ISO')
return Pong(packet_io, ctx.obj['linger']) return Pong(packet_io, ctx.obj['linger'])
raise ValueError('invalid scenario') raise ValueError('invalid scenario')
@@ -1954,8 +1609,6 @@ def create_scenario_factory(ctx, default_scenario):
'l2cap-server', 'l2cap-server',
'rfcomm-client', 'rfcomm-client',
'rfcomm-server', 'rfcomm-server',
'iso-client',
'iso-server',
] ]
), ),
) )
@@ -1968,7 +1621,6 @@ def create_scenario_factory(ctx, default_scenario):
) )
@click.option( @click.option(
'--extended-data-length', '--extended-data-length',
metavar='<TX-OCTETS>/<TX-TIME>',
help='Request a data length upon connection, specified as tx_octets/tx_time', help='Request a data length upon connection, specified as tx_octets/tx_time',
) )
@click.option( @click.option(
@@ -1976,26 +1628,6 @@ def create_scenario_factory(ctx, default_scenario):
type=click.Choice(['central', 'peripheral']), type=click.Choice(['central', 'peripheral']),
help='Request role switch upon connection (central or peripheral)', help='Request role switch upon connection (central or peripheral)',
) )
@click.option(
'--le-scan',
metavar='<WINDOW>/<INTERVAL>',
help='Perform an LE scan with a given window and interval (milliseconds)',
)
@click.option(
'--le-advertise',
metavar='<INTERVAL>',
help='Advertise with a given interval (milliseconds)',
)
@click.option(
'--classic-page-scan',
is_flag=True,
help='Enable Classic page scanning',
)
@click.option(
'--classic-inquiry-scan',
is_flag=True,
help='Enable Classic enquiry scanning',
)
@click.option( @click.option(
'--rfcomm-channel', '--rfcomm-channel',
type=int, type=int,
@@ -2121,10 +1753,6 @@ def bench(
att_mtu, att_mtu,
extended_data_length, extended_data_length,
role_switch, role_switch,
le_scan,
le_advertise,
classic_page_scan,
classic_inquiry_scan,
packet_size, packet_size,
packet_count, packet_count,
start_delay, start_delay,
@@ -2173,12 +1801,7 @@ def bench(
else None else None
) )
ctx.obj['role_switch'] = role_switch ctx.obj['role_switch'] = role_switch
ctx.obj['le_scan'] = [float(x) for x in le_scan.split('/')] if le_scan else None
ctx.obj['le_advertise'] = float(le_advertise) if le_advertise else None
ctx.obj['classic_page_scan'] = classic_page_scan
ctx.obj['classic_inquiry_scan'] = classic_inquiry_scan
ctx.obj['classic'] = mode in ('rfcomm-client', 'rfcomm-server') ctx.obj['classic'] = mode in ('rfcomm-client', 'rfcomm-server')
ctx.obj['iso'] = mode in ('iso-client', 'iso-server')
@bench.command() @bench.command()
@@ -2200,94 +1823,28 @@ def bench(
@click.option('--phy', type=click.Choice(['1m', '2m', 'coded']), help='PHY to use') @click.option('--phy', type=click.Choice(['1m', '2m', 'coded']), help='PHY to use')
@click.option('--authenticate', is_flag=True, help='Authenticate (RFComm only)') @click.option('--authenticate', is_flag=True, help='Authenticate (RFComm only)')
@click.option('--encrypt', is_flag=True, help='Encrypt the connection (RFComm only)') @click.option('--encrypt', is_flag=True, help='Encrypt the connection (RFComm only)')
@click.option(
'--iso-sdu-interval-c-to-p',
type=int,
help='ISO SDU central -> peripheral (microseconds)',
)
@click.option(
'--iso-sdu-interval-p-to-c',
type=int,
help='ISO SDU interval peripheral -> central (microseconds)',
)
@click.option(
'--iso-max-sdu-c-to-p',
type=int,
help='ISO max SDU central -> peripheral',
)
@click.option(
'--iso-max-sdu-p-to-c',
type=int,
help='ISO max SDU peripheral -> central',
)
@click.option(
'--iso-max-transport-latency-c-to-p',
type=int,
help='ISO max transport latency central -> peripheral (milliseconds)',
)
@click.option(
'--iso-max-transport-latency-p-to-c',
type=int,
help='ISO max transport latency peripheral -> central (milliseconds)',
)
@click.option(
'--iso-rtn-c-to-p',
type=int,
help='ISO RTN central -> peripheral (integer count)',
)
@click.option(
'--iso-rtn-p-to-c',
type=int,
help='ISO RTN peripheral -> central (integer count)',
)
@click.pass_context @click.pass_context
def central( def central(
ctx, ctx, transport, peripheral_address, connection_interval, phy, authenticate, encrypt
transport,
peripheral_address,
connection_interval,
phy,
authenticate,
encrypt,
iso_sdu_interval_c_to_p,
iso_sdu_interval_p_to_c,
iso_max_sdu_c_to_p,
iso_max_sdu_p_to_c,
iso_max_transport_latency_c_to_p,
iso_max_transport_latency_p_to_c,
iso_rtn_c_to_p,
iso_rtn_p_to_c,
): ):
"""Run as a central (initiates the connection)""" """Run as a central (initiates the connection)"""
scenario_factory = create_scenario_factory(ctx, 'send') scenario_factory = create_scenario_factory(ctx, 'send')
mode_factory = create_mode_factory(ctx, 'gatt-client') mode_factory = create_mode_factory(ctx, 'gatt-client')
classic = ctx.obj['classic']
async def run_central(): async def run_central():
await Central( await Central(
transport, transport,
peripheral_address, peripheral_address,
classic,
scenario_factory, scenario_factory,
mode_factory, mode_factory,
connection_interval, connection_interval,
phy, phy,
authenticate, authenticate,
encrypt or authenticate, encrypt or authenticate,
ctx.obj['iso'],
iso_sdu_interval_c_to_p,
iso_sdu_interval_p_to_c,
iso_max_sdu_c_to_p,
iso_max_sdu_p_to_c,
iso_max_transport_latency_c_to_p,
iso_max_transport_latency_p_to_c,
iso_rtn_c_to_p,
iso_rtn_p_to_c,
ctx.obj['classic'],
ctx.obj['extended_data_length'], ctx.obj['extended_data_length'],
ctx.obj['role_switch'], ctx.obj['role_switch'],
ctx.obj['le_scan'],
ctx.obj['le_advertise'],
ctx.obj['classic_page_scan'],
ctx.obj['classic_inquiry_scan'],
).run() ).run()
asyncio.run(run_central()) asyncio.run(run_central())
@@ -2307,20 +1864,19 @@ def peripheral(ctx, transport):
scenario_factory, scenario_factory,
mode_factory, mode_factory,
ctx.obj['classic'], ctx.obj['classic'],
ctx.obj['iso'],
ctx.obj['extended_data_length'], ctx.obj['extended_data_length'],
ctx.obj['role_switch'], ctx.obj['role_switch'],
ctx.obj['le_scan'],
ctx.obj['le_advertise'],
ctx.obj['classic_page_scan'],
ctx.obj['classic_inquiry_scan'],
).run() ).run()
asyncio.run(run_peripheral()) asyncio.run(run_peripheral())
def main(): def main():
bumble.logging.setup_basic_logging('INFO') logging.basicConfig(
level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper(),
format="[%(asctime)s.%(msecs)03d] %(levelname)s:%(name)s:%(message)s",
datefmt="%H:%M:%S",
)
bench() bench()
-1
View File
@@ -13,7 +13,6 @@
# limitations under the License. # limitations under the License.
import click import click
from bumble.colors import color from bumble.colors import color
from bumble.hci import Address from bumble.hci import Address
from bumble.helpers import generate_irk, verify_rpa_with_irk from bumble.helpers import generate_irk, verify_rpa_with_irk
+27 -24
View File
@@ -23,55 +23,58 @@ import asyncio
import logging import logging
import os import os
import re import re
from collections import OrderedDict import humanize
from typing import Optional, Union from typing import Optional, Union
from collections import OrderedDict
import click import click
import humanize
from prettytable import PrettyTable from prettytable import PrettyTable
from prompt_toolkit import Application from prompt_toolkit import Application
from prompt_toolkit.completion import Completer, Completion, NestedCompleter
from prompt_toolkit.data_structures import Point
from prompt_toolkit.filters import Condition
from prompt_toolkit.formatted_text import ANSI
from prompt_toolkit.history import FileHistory from prompt_toolkit.history import FileHistory
from prompt_toolkit.completion import Completer, Completion, NestedCompleter
from prompt_toolkit.key_binding import KeyBindings from prompt_toolkit.key_binding import KeyBindings
from prompt_toolkit.formatted_text import ANSI
from prompt_toolkit.styles import Style
from prompt_toolkit.filters import Condition
from prompt_toolkit.widgets import TextArea, Frame
from prompt_toolkit.widgets.toolbars import FormattedTextToolbar
from prompt_toolkit.data_structures import Point
from prompt_toolkit.layout import ( from prompt_toolkit.layout import (
Layout,
HSplit,
Window,
CompletionsMenu, CompletionsMenu,
Float,
FormattedTextControl,
FloatContainer,
ConditionalContainer, ConditionalContainer,
Dimension, Dimension,
Float,
FloatContainer,
FormattedTextControl,
HSplit,
Layout,
Window,
) )
from prompt_toolkit.styles import Style
from prompt_toolkit.widgets import Frame, TextArea
from prompt_toolkit.widgets.toolbars import FormattedTextToolbar
from bumble import __version__
import bumble.core import bumble.core
from bumble import __version__, colors from bumble import colors
from bumble.core import UUID, AdvertisingData from bumble.core import UUID, AdvertisingData, PhysicalTransport
from bumble.device import ( from bumble.device import (
Connection,
ConnectionParametersPreferences, ConnectionParametersPreferences,
ConnectionPHY, ConnectionPHY,
Device, Device,
Connection,
Peer, Peer,
) )
from bumble.gatt import Characteristic, CharacteristicDeclaration, Descriptor, Service from bumble.utils import AsyncRunner
from bumble.transport import open_transport_or_link
from bumble.gatt import Characteristic, Service, CharacteristicDeclaration, Descriptor
from bumble.gatt_client import CharacteristicProxy from bumble.gatt_client import CharacteristicProxy
from bumble.hci import ( from bumble.hci import (
Address,
HCI_Constant,
HCI_LE_1M_PHY, HCI_LE_1M_PHY,
HCI_LE_2M_PHY, HCI_LE_2M_PHY,
HCI_LE_CODED_PHY, HCI_LE_CODED_PHY,
Address,
HCI_Constant,
) )
from bumble.transport import open_transport
from bumble.utils import AsyncRunner
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -288,7 +291,7 @@ class ConsoleApp:
async def run_async(self, device_config, transport): async def run_async(self, device_config, transport):
rssi_monitoring_task = asyncio.create_task(self.rssi_monitor_loop()) rssi_monitoring_task = asyncio.create_task(self.rssi_monitor_loop())
async with await open_transport(transport) as (hci_source, hci_sink): async with await open_transport_or_link(transport) as (hci_source, hci_sink):
if device_config: if device_config:
self.device = Device.from_config_file_with_hci( self.device = Device.from_config_file_with_hci(
device_config, hci_source, hci_sink device_config, hci_source, hci_sink
+32 -64
View File
@@ -16,48 +16,49 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import logging
import time import time
import click import click
import bumble.logging
from bumble.colors import color
from bumble.company_ids import COMPANY_IDENTIFIERS from bumble.company_ids import COMPANY_IDENTIFIERS
from bumble.colors import color
from bumble.core import name_or_number from bumble.core import name_or_number
from bumble.hci import ( from bumble.hci import (
HCI_LE_READ_BUFFER_SIZE_COMMAND, map_null_terminated_utf8_string,
HCI_LE_READ_BUFFER_SIZE_V2_COMMAND, CodecID,
HCI_LE_READ_MAXIMUM_ADVERTISING_DATA_LENGTH_COMMAND, LeFeature,
HCI_LE_READ_MAXIMUM_DATA_LENGTH_COMMAND,
HCI_LE_READ_NUMBER_OF_SUPPORTED_ADVERTISING_SETS_COMMAND,
HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH_COMMAND,
HCI_READ_BD_ADDR_COMMAND,
HCI_READ_BUFFER_SIZE_COMMAND,
HCI_READ_LOCAL_NAME_COMMAND,
HCI_SUCCESS, HCI_SUCCESS,
HCI_VERSION_NAMES, HCI_VERSION_NAMES,
LMP_VERSION_NAMES, LMP_VERSION_NAMES,
CodecID,
HCI_Command, HCI_Command,
HCI_Command_Complete_Event, HCI_Command_Complete_Event,
HCI_Command_Status_Event, HCI_Command_Status_Event,
HCI_LE_Read_Buffer_Size_Command, HCI_READ_BUFFER_SIZE_COMMAND,
HCI_LE_Read_Buffer_Size_V2_Command,
HCI_LE_Read_Maximum_Advertising_Data_Length_Command,
HCI_LE_Read_Maximum_Data_Length_Command,
HCI_LE_Read_Number_Of_Supported_Advertising_Sets_Command,
HCI_LE_Read_Suggested_Default_Data_Length_Command,
HCI_Read_BD_ADDR_Command,
HCI_Read_Buffer_Size_Command, HCI_Read_Buffer_Size_Command,
HCI_LE_READ_BUFFER_SIZE_V2_COMMAND,
HCI_LE_Read_Buffer_Size_V2_Command,
HCI_READ_BD_ADDR_COMMAND,
HCI_Read_BD_ADDR_Command,
HCI_READ_LOCAL_NAME_COMMAND,
HCI_Read_Local_Name_Command, HCI_Read_Local_Name_Command,
HCI_LE_READ_BUFFER_SIZE_COMMAND,
HCI_LE_Read_Buffer_Size_Command,
HCI_LE_READ_MAXIMUM_DATA_LENGTH_COMMAND,
HCI_LE_Read_Maximum_Data_Length_Command,
HCI_LE_READ_NUMBER_OF_SUPPORTED_ADVERTISING_SETS_COMMAND,
HCI_LE_Read_Number_Of_Supported_Advertising_Sets_Command,
HCI_LE_READ_MAXIMUM_ADVERTISING_DATA_LENGTH_COMMAND,
HCI_LE_Read_Maximum_Advertising_Data_Length_Command,
HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH_COMMAND,
HCI_LE_Read_Suggested_Default_Data_Length_Command,
HCI_Read_Local_Supported_Codecs_Command, HCI_Read_Local_Supported_Codecs_Command,
HCI_Read_Local_Supported_Codecs_V2_Command, HCI_Read_Local_Supported_Codecs_V2_Command,
HCI_Read_Local_Version_Information_Command, HCI_Read_Local_Version_Information_Command,
LeFeature,
map_null_terminated_utf8_string,
) )
from bumble.host import Host from bumble.host import Host
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -241,43 +242,28 @@ async def get_codecs_info(host: Host) -> None:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def async_main( async def async_main(latency_probes, transport):
latency_probes, latency_probe_interval, latency_probe_command, transport
):
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport(transport) as (hci_source, hci_sink): async with await open_transport_or_link(transport) as (hci_source, hci_sink):
print('<<< connected') print('<<< connected')
host = Host(hci_source, hci_sink) host = Host(hci_source, hci_sink)
await host.reset() await host.reset()
# Measure the latency if requested # Measure the latency if requested
# (we add an extra probe at the start, that we ignore, just to ensure that
# the transport is primed)
latencies = [] latencies = []
if latency_probes: if latency_probes:
if latency_probe_command: for _ in range(latency_probes):
probe_hci_command = HCI_Command.from_bytes(
bytes.fromhex(latency_probe_command)
)
else:
probe_hci_command = HCI_Read_Local_Version_Information_Command()
for iteration in range(1 + latency_probes):
if latency_probe_interval:
await asyncio.sleep(latency_probe_interval / 1000)
start = time.time() start = time.time()
await host.send_command(probe_hci_command) await host.send_command(HCI_Read_Local_Version_Information_Command())
if iteration: latencies.append(1000 * (time.time() - start))
latencies.append(1000 * (time.time() - start))
print( print(
color('HCI Command Latency:', 'yellow'), color('HCI Command Latency:', 'yellow'),
( (
f'min={min(latencies):.2f}, ' f'min={min(latencies):.2f}, '
f'max={max(latencies):.2f}, ' f'max={max(latencies):.2f}, '
f'average={sum(latencies)/len(latencies):.2f},' f'average={sum(latencies)/len(latencies):.2f}'
), ),
[f'{latency:.4}' for latency in latencies],
'\n', '\n',
) )
@@ -325,28 +311,10 @@ async def async_main(
type=int, type=int,
help='Send N commands to measure HCI transport latency statistics', help='Send N commands to measure HCI transport latency statistics',
) )
@click.option(
'--latency-probe-interval',
metavar='INTERVAL',
type=int,
help='Interval between latency probes (milliseconds)',
)
@click.option(
'--latency-probe-command',
metavar='COMMAND_HEX',
help=(
'Probe command (HCI Command packet bytes, in hex. Use 0177FC00 for'
' a loopback test with the HCI remote proxy app)'
),
)
@click.argument('transport') @click.argument('transport')
def main(latency_probes, latency_probe_interval, latency_probe_command, transport): def main(latency_probes, transport):
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
asyncio.run( asyncio.run(async_main(latency_probes, transport))
async_main(
latency_probes, latency_probe_interval, latency_probe_command, transport
)
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
+8 -8
View File
@@ -16,22 +16,21 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import logging
import os
import time import time
from typing import Optional from typing import Optional
import click
import bumble.logging
from bumble.colors import color from bumble.colors import color
from bumble.hci import ( from bumble.hci import (
HCI_READ_LOOPBACK_MODE_COMMAND, HCI_READ_LOOPBACK_MODE_COMMAND,
HCI_WRITE_LOOPBACK_MODE_COMMAND,
HCI_Read_Loopback_Mode_Command, HCI_Read_Loopback_Mode_Command,
HCI_WRITE_LOOPBACK_MODE_COMMAND,
HCI_Write_Loopback_Mode_Command, HCI_Write_Loopback_Mode_Command,
LoopbackMode, LoopbackMode,
) )
from bumble.host import Host from bumble.host import Host
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
import click
class Loopback: class Loopback:
@@ -89,7 +88,7 @@ class Loopback:
async def run(self): async def run(self):
"""Run a loopback throughput test""" """Run a loopback throughput test"""
print(color('>>> Connecting to HCI...', 'green')) print(color('>>> Connecting to HCI...', 'green'))
async with await open_transport(self.transport) as ( async with await open_transport_or_link(self.transport) as (
hci_source, hci_source,
hci_sink, hci_sink,
): ):
@@ -195,7 +194,8 @@ class Loopback:
) )
@click.argument('transport') @click.argument('transport')
def main(packet_size, packet_count, transport): def main(packet_size, packet_count, transport):
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
loopback = Loopback(packet_size, packet_count, transport) loopback = Loopback(packet_size, packet_count, transport)
asyncio.run(loopback.run()) asyncio.run(loopback.run())
+5 -4
View File
@@ -15,13 +15,14 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import logging
import asyncio import asyncio
import sys import sys
import os
import bumble.logging
from bumble.controller import Controller from bumble.controller import Controller
from bumble.link import LocalLink from bumble.link import LocalLink
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -41,7 +42,7 @@ async def async_main():
transports = [] transports = []
controllers = [] controllers = []
for index, transport_name in enumerate(sys.argv[1:]): for index, transport_name in enumerate(sys.argv[1:]):
transport = await open_transport(transport_name) transport = await open_transport_or_link(transport_name)
transports.append(transport) transports.append(transport)
controller = Controller( controller = Controller(
f'C{index}', f'C{index}',
@@ -61,7 +62,7 @@ async def async_main():
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def main(): def main():
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
asyncio.run(async_main()) asyncio.run(async_main())
+7 -6
View File
@@ -16,22 +16,23 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import logging
from typing import Callable, Iterable, Optional from typing import Callable, Iterable, Optional
import click import click
import bumble.logging
from bumble.colors import color
from bumble.core import ProtocolError from bumble.core import ProtocolError
from bumble.colors import color
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.gatt import Service from bumble.gatt import Service
from bumble.profiles.battery_service import BatteryServiceProxy
from bumble.profiles.device_information_service import DeviceInformationServiceProxy from bumble.profiles.device_information_service import DeviceInformationServiceProxy
from bumble.profiles.battery_service import BatteryServiceProxy
from bumble.profiles.gap import GenericAccessServiceProxy from bumble.profiles.gap import GenericAccessServiceProxy
from bumble.profiles.pacs import PublishedAudioCapabilitiesServiceProxy from bumble.profiles.pacs import PublishedAudioCapabilitiesServiceProxy
from bumble.profiles.tmap import TelephonyAndMediaAudioServiceProxy from bumble.profiles.tmap import TelephonyAndMediaAudioServiceProxy
from bumble.profiles.vcs import VolumeControlServiceProxy from bumble.profiles.vcs import VolumeControlServiceProxy
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -214,7 +215,7 @@ async def show_device_info(peer, done: Optional[asyncio.Future]) -> None:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def async_main(device_config, encrypt, transport, address_or_name): async def async_main(device_config, encrypt, transport, address_or_name):
async with await open_transport(transport) as (hci_source, hci_sink): async with await open_transport_or_link(transport) as (hci_source, hci_sink):
# Create a device # Create a device
if device_config: if device_config:
@@ -266,7 +267,7 @@ def main(device_config, encrypt, transport, address_or_name):
Dump the GATT database on a remote device. If ADDRESS_OR_NAME is not specified, Dump the GATT database on a remote device. If ADDRESS_OR_NAME is not specified,
wait for an incoming connection. wait for an incoming connection.
""" """
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
asyncio.run(async_main(device_config, encrypt, transport, address_or_name)) asyncio.run(async_main(device_config, encrypt, transport, address_or_name))
+5 -5
View File
@@ -16,15 +16,15 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import logging
import click import click
import bumble.core import bumble.core
import bumble.logging
from bumble.colors import color from bumble.colors import color
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.gatt import show_services from bumble.gatt import show_services
from bumble.transport import open_transport from bumble.transport import open_transport_or_link
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -60,7 +60,7 @@ async def dump_gatt_db(peer, done):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def async_main(device_config, encrypt, transport, address_or_name): async def async_main(device_config, encrypt, transport, address_or_name):
async with await open_transport(transport) as (hci_source, hci_sink): async with await open_transport_or_link(transport) as (hci_source, hci_sink):
# Create a device # Create a device
if device_config: if device_config:
@@ -112,7 +112,7 @@ def main(device_config, encrypt, transport, address_or_name):
Dump the GATT database on a remote device. If ADDRESS_OR_NAME is not specified, Dump the GATT database on a remote device. If ADDRESS_OR_NAME is not specified,
wait for an incoming connection. wait for an incoming connection.
""" """
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
asyncio.run(async_main(device_config, encrypt, transport, address_or_name)) asyncio.run(async_main(device_config, encrypt, transport, address_or_name))
+9 -8
View File
@@ -16,19 +16,20 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import struct import struct
import logging
import click import click
import bumble.logging
from bumble import l2cap from bumble import l2cap
from bumble.colors import color from bumble.colors import color
from bumble.core import AdvertisingData
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.gatt import Characteristic, CharacteristicValue, Service from bumble.core import AdvertisingData
from bumble.hci import HCI_Constant from bumble.gatt import Service, Characteristic, CharacteristicValue
from bumble.transport import open_transport
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
from bumble.transport import open_transport_or_link
from bumble.hci import HCI_Constant
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -324,7 +325,7 @@ async def run(
receive_port, receive_port,
): ):
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport(hci_transport) as (hci_source, hci_sink): async with await open_transport_or_link(hci_transport) as (hci_source, hci_sink):
print('<<< connected') print('<<< connected')
# Instantiate a bridge object # Instantiate a bridge object
@@ -382,7 +383,6 @@ def main(
receive_host, receive_host,
receive_port, receive_port,
): ):
bumble.logging.setup_basic_logging('WARNING')
asyncio.run( asyncio.run(
run( run(
hci_transport, hci_transport,
@@ -397,5 +397,6 @@ def main(
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
if __name__ == '__main__': if __name__ == '__main__':
main() main()
+5 -6
View File
@@ -12,15 +12,14 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import asyncio
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import logging import logging
import asyncio
import os
import sys import sys
import bumble.logging
from bumble import hci, transport from bumble import hci, transport
from bumble.bridge import HCI_Bridge from bumble.bridge import HCI_Bridge
@@ -47,14 +46,14 @@ async def async_main():
return return
print('>>> connecting to HCI...') print('>>> connecting to HCI...')
async with await transport.open_transport(sys.argv[1]) as ( async with await transport.open_transport_or_link(sys.argv[1]) as (
hci_host_source, hci_host_source,
hci_host_sink, hci_host_sink,
): ):
print('>>> connected') print('>>> connected')
print('>>> connecting to HCI...') print('>>> connecting to HCI...')
async with await transport.open_transport(sys.argv[2]) as ( async with await transport.open_transport_or_link(sys.argv[2]) as (
hci_controller_source, hci_controller_source,
hci_controller_sink, hci_controller_sink,
): ):
@@ -101,7 +100,7 @@ async def async_main():
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def main(): def main():
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
asyncio.run(async_main()) asyncio.run(async_main())
+6 -6
View File
@@ -16,16 +16,16 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import logging
import os
import click import click
import bumble.logging
from bumble import l2cap from bumble import l2cap
from bumble.colors import color from bumble.colors import color
from bumble.transport import open_transport_or_link
from bumble.device import Device from bumble.device import Device
from bumble.hci import HCI_Constant
from bumble.transport import open_transport
from bumble.utils import FlowControlAsyncPipe from bumble.utils import FlowControlAsyncPipe
from bumble.hci import HCI_Constant
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -258,7 +258,7 @@ class ClientBridge:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def run(device_config, hci_transport, bridge): async def run(device_config, hci_transport, bridge):
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport(hci_transport) as (hci_source, hci_sink): async with await open_transport_or_link(hci_transport) as (hci_source, hci_sink):
print('<<< connected') print('<<< connected')
device = Device.from_config_file_with_hci(device_config, hci_source, hci_sink) device = Device.from_config_file_with_hci(device_config, hci_source, hci_sink)
@@ -356,6 +356,6 @@ def client(context, bluetooth_address, tcp_host, tcp_port):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
if __name__ == '__main__': if __name__ == '__main__':
bumble.logging.setup_basic_logging('WARNING')
cli(obj={}) # pylint: disable=no-value-for-parameter cli(obj={}) # pylint: disable=no-value-for-parameter
+21 -16
View File
@@ -20,30 +20,31 @@ from __future__ import annotations
import asyncio import asyncio
import datetime import datetime
import functools import functools
from importlib import resources
import json import json
import os
import logging import logging
import pathlib import pathlib
import wave
import weakref import weakref
from importlib import resources import wave
try: try:
import lc3 # type: ignore # pylint: disable=E0401 import lc3 # type: ignore # pylint: disable=E0401
except ImportError as e: except ImportError as e:
raise ImportError("Try `python -m pip install \".[lc3]\"`.") from e raise ImportError("Try `python -m pip install \".[lc3]\"`.") from e
import aiohttp.web
import click import click
import aiohttp.web
import bumble import bumble
import bumble.logging from bumble import utils
from bumble import data_types, utils
from bumble.colors import color
from bumble.core import AdvertisingData from bumble.core import AdvertisingData
from bumble.device import AdvertisingParameters, CisLink, Device, DeviceConfiguration from bumble.colors import color
from bumble.hci import Address, CodecID, CodingFormat, HCI_IsoDataPacket from bumble.device import Device, DeviceConfiguration, AdvertisingParameters, CisLink
from bumble.profiles import ascs, bap, pacs
from bumble.transport import open_transport from bumble.transport import open_transport
from bumble.profiles import ascs, bap, pacs
from bumble.hci import Address, CodecID, CodingFormat, HCI_IsoDataPacket
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -330,13 +331,17 @@ class Speaker:
advertising_data = bytes( advertising_data = bytes(
AdvertisingData( AdvertisingData(
[ [
data_types.CompleteLocalName(device_config.name), (
data_types.Flags( AdvertisingData.COMPLETE_LOCAL_NAME,
AdvertisingData.Flags.LE_GENERAL_DISCOVERABLE_MODE bytes(device_config.name, 'utf-8'),
| AdvertisingData.Flags.BR_EDR_NOT_SUPPORTED
), ),
data_types.IncompleteListOf16BitServiceUUIDs( (
[pacs.PublishedAudioCapabilitiesService.UUID] AdvertisingData.FLAGS,
bytes([AdvertisingData.LE_GENERAL_DISCOVERABLE_MODE_FLAG]),
),
(
AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS,
bytes(pacs.PublishedAudioCapabilitiesService.UUID),
), ),
] ]
) )
@@ -444,7 +449,7 @@ def speaker(ui_port: int, device_config: str, transport: str, lc3_file: str) ->
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def main(): def main():
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
speaker() speaker()
View File
+289
View File
@@ -0,0 +1,289 @@
# Copyright 2021-2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ----------------------------------------------------------------------------
# Imports
# ----------------------------------------------------------------------------
import sys
import logging
import json
import asyncio
import argparse
import uuid
import os
from urllib.parse import urlparse
import websockets
from bumble.colors import color
# -----------------------------------------------------------------------------
# Logging
# -----------------------------------------------------------------------------
logger = logging.getLogger(__name__)
# ----------------------------------------------------------------------------
# Constants
# ----------------------------------------------------------------------------
DEFAULT_RELAY_PORT = 10723
# ----------------------------------------------------------------------------
# Utils
# ----------------------------------------------------------------------------
def error_to_json(error):
return json.dumps({'error': error})
def error_to_result(error):
return f'result:{error_to_json(error)}'
async def broadcast_message(message, connections):
# Send to all the connections
tasks = [connection.send_message(message) for connection in connections]
if tasks:
await asyncio.gather(*tasks)
# ----------------------------------------------------------------------------
# Connection class
# ----------------------------------------------------------------------------
class Connection:
"""
A Connection represents a client connected to the relay over a websocket
"""
def __init__(self, room, websocket):
self.room = room
self.websocket = websocket
self.address = str(uuid.uuid4())
async def send_message(self, message):
try:
logger.debug(color(f'->{self.address}: {message}', 'yellow'))
return await self.websocket.send(message)
except websockets.exceptions.WebSocketException as error:
logger.info(f'! client "{self}" disconnected: {error}')
await self.cleanup()
async def send_error(self, error):
return await self.send_message(f'result:{error_to_json(error)}')
async def receive_message(self):
try:
message = await self.websocket.recv()
logger.debug(color(f'<-{self.address}: {message}', 'blue'))
return message
except websockets.exceptions.WebSocketException as error:
logger.info(color(f'! client "{self}" disconnected: {error}', 'red'))
await self.cleanup()
async def cleanup(self):
if self.room:
await self.room.remove_connection(self)
def set_address(self, address):
logger.info(f'Connection address changed: {self.address} -> {address}')
self.address = address
def __str__(self):
return (
f'Connection(address="{self.address}", '
f'client={self.websocket.remote_address[0]}:'
f'{self.websocket.remote_address[1]})'
)
# ----------------------------------------------------------------------------
# Room class
# ----------------------------------------------------------------------------
class Room:
"""
A Room is a collection of bridged connections
"""
def __init__(self, relay, name):
self.relay = relay
self.name = name
self.observers = []
self.connections = []
async def add_connection(self, connection):
logger.info(f'New participant in {self.name}: {connection}')
self.connections.append(connection)
await self.broadcast_message(connection, f'joined:{connection.address}')
async def remove_connection(self, connection):
if connection in self.connections:
self.connections.remove(connection)
await self.broadcast_message(connection, f'left:{connection.address}')
def find_connections_by_address(self, address):
return [c for c in self.connections if c.address == address]
async def bridge_connection(self, connection):
while True:
# Wait for a message
message = await connection.receive_message()
# Skip empty messages
if message is None:
return
# Parse the message to decide how to handle it
if message.startswith('@'):
# This is a targeted message
await self.on_targeted_message(connection, message)
elif message.startswith('/'):
# This is an RPC request
await self.on_rpc_request(connection, message)
else:
await connection.send_message(
f'result:{error_to_json("error: invalid message")}'
)
async def broadcast_message(self, sender, message):
'''
Send to all connections in the room except back to the sender
'''
await broadcast_message(message, [c for c in self.connections if c != sender])
async def on_rpc_request(self, connection, message):
command, *params = message.split(' ', 1)
if handler := getattr(
self, f'on_{command[1:].lower().replace("-","_")}_command', None
):
try:
result = await handler(connection, params)
except Exception as error:
result = error_to_result(error)
else:
result = error_to_result('unknown command')
await connection.send_message(result or 'result:{}')
async def on_targeted_message(self, connection, message):
target, *payload = message.split(' ', 1)
if not payload:
return error_to_json('missing arguments')
payload = payload[0]
target = target[1:]
# Determine what targets to send to
if target == '*':
# Send to all connections in the room except the connection from which the
# message was received
connections = [c for c in self.connections if c != connection]
else:
connections = self.find_connections_by_address(target)
if not connections:
# Unicast with no recipient, let the sender know
await connection.send_message(f'unreachable:{target}')
# Send to targets
await broadcast_message(f'message:{connection.address}/{payload}', connections)
async def on_set_address_command(self, connection, params):
if not params:
return error_to_result('missing address')
current_address = connection.address
new_address = params[0]
connection.set_address(new_address)
await self.broadcast_message(
connection, f'address-changed:from={current_address},to={new_address}'
)
# ----------------------------------------------------------------------------
class Relay:
"""
A relay accepts connections with the following url: ws://<hostname>/<room>.
Participants in a room can communicate with each other
"""
def __init__(self, port):
self.port = port
self.rooms = {}
self.observers = []
def start(self):
logger.info(f'Starting Relay on port {self.port}')
# pylint: disable-next=no-member
return websockets.serve(self.serve, '0.0.0.0', self.port, ping_interval=None)
async def serve_as_controller(self, connection):
pass
async def serve(self, websocket, path):
logger.debug(f'New connection with path {path}')
# Parse the path
parsed = urlparse(path)
# Check if this is a controller client
if parsed.path == '/':
return await self.serve_as_controller(Connection('', websocket))
# Find or create a room for this connection
room_name = parsed.path[1:].split('/')[0]
if room_name not in self.rooms:
self.rooms[room_name] = Room(self, room_name)
room = self.rooms[room_name]
# Add the connection to the room
connection = Connection(room, websocket)
await room.add_connection(connection)
# Bridge until the connection is closed
await room.bridge_connection(connection)
# ----------------------------------------------------------------------------
def main():
# Check the Python version
if sys.version_info < (3, 6, 1):
print('ERROR: Python 3.6.1 or higher is required')
sys.exit(1)
logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
# Parse arguments
arg_parser = argparse.ArgumentParser(description='Bumble Link Relay')
arg_parser.add_argument('--log-level', default='INFO', help='logger level')
arg_parser.add_argument('--log-config', help='logger config file (YAML)')
arg_parser.add_argument(
'--port', type=int, default=DEFAULT_RELAY_PORT, help='Port to listen on'
)
args = arg_parser.parse_args()
# Setup logger
if args.log_config:
from logging import config # pylint: disable=import-outside-toplevel
config.fileConfig(args.log_config)
else:
logging.basicConfig(level=getattr(logging, args.log_level.upper()))
# Start a relay
relay = Relay(args.port)
asyncio.get_event_loop().run_until_complete(relay.start())
asyncio.get_event_loop().run_forever()
# ----------------------------------------------------------------------------
if __name__ == '__main__':
main()
+21
View File
@@ -0,0 +1,21 @@
[loggers]
keys=root
[handlers]
keys=stream_handler
[formatters]
keys=formatter
[logger_root]
level=DEBUG
handlers=stream_handler
[handler_stream_handler]
class=StreamHandler
level=DEBUG
formatter=formatter
args=(sys.stderr,)
[formatter_formatter]
format=%(asctime)s %(name)-12s %(levelname)-8s %(message)s
+53 -48
View File
@@ -16,44 +16,42 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import logging
import os import os
import logging
import struct import struct
import click import click
from prompt_toolkit.shortcuts import PromptSession from prompt_toolkit.shortcuts import PromptSession
from bumble import data_types
from bumble.a2dp import make_audio_sink_service_sdp_records from bumble.a2dp import make_audio_sink_service_sdp_records
from bumble.att import (
ATT_INSUFFICIENT_AUTHENTICATION_ERROR,
ATT_INSUFFICIENT_ENCRYPTION_ERROR,
ATT_Error,
)
from bumble.colors import color from bumble.colors import color
from bumble.device import Device, Peer
from bumble.transport import open_transport_or_link
from bumble.pairing import OobData, PairingDelegate, PairingConfig
from bumble.smp import OobContext, OobLegacyContext
from bumble.smp import error_name as smp_error_name
from bumble.keys import JsonKeyStore
from bumble.core import ( from bumble.core import (
UUID,
AdvertisingData, AdvertisingData,
Appearance, Appearance,
DataType,
PhysicalTransport,
ProtocolError, ProtocolError,
PhysicalTransport,
UUID,
) )
from bumble.device import Device, Peer
from bumble.gatt import ( from bumble.gatt import (
GATT_DEVICE_NAME_CHARACTERISTIC, GATT_DEVICE_NAME_CHARACTERISTIC,
GATT_GENERIC_ACCESS_SERVICE, GATT_GENERIC_ACCESS_SERVICE,
GATT_HEART_RATE_MEASUREMENT_CHARACTERISTIC,
GATT_HEART_RATE_SERVICE, GATT_HEART_RATE_SERVICE,
Characteristic, GATT_HEART_RATE_MEASUREMENT_CHARACTERISTIC,
Service, Service,
Characteristic,
) )
from bumble.hci import OwnAddressType from bumble.hci import OwnAddressType
from bumble.keys import JsonKeyStore from bumble.att import (
from bumble.pairing import OobData, PairingConfig, PairingDelegate ATT_Error,
from bumble.smp import OobContext, OobLegacyContext ATT_INSUFFICIENT_AUTHENTICATION_ERROR,
from bumble.smp import error_name as smp_error_name ATT_INSUFFICIENT_ENCRYPTION_ERROR,
from bumble.transport import open_transport )
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -351,7 +349,7 @@ async def pair(
Waiter.instance = Waiter(linger=linger) Waiter.instance = Waiter(linger=linger)
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport(hci_transport) as (hci_source, hci_sink): async with await open_transport_or_link(hci_transport) as (hci_source, hci_sink):
print('<<< connected') print('<<< connected')
# Create a device to manage the host # Create a device to manage the host
@@ -404,19 +402,14 @@ async def pair(
# Create an OOB context if needed # Create an OOB context if needed
if oob: if oob:
our_oob_context = OobContext() our_oob_context = OobContext()
if oob == '-': shared_data = (
shared_data = None None
legacy_context = OobLegacyContext() if oob == '-'
else: else OobData.from_ad(
oob_data = OobData.from_ad(
AdvertisingData.from_bytes(bytes.fromhex(oob)) AdvertisingData.from_bytes(bytes.fromhex(oob))
) ).shared_data
shared_data = oob_data.shared_data )
legacy_context = oob_data.legacy_context legacy_context = OobLegacyContext()
if legacy_context is None and not sc:
print(color('OOB pairing in legacy mode requires TK', 'red'))
return
oob_contexts = PairingConfig.OobConfig( oob_contexts = PairingConfig.OobConfig(
our_context=our_oob_context, our_context=our_oob_context,
peer_data=shared_data, peer_data=shared_data,
@@ -426,9 +419,7 @@ async def pair(
print(color('@@@ OOB Data:', 'yellow')) print(color('@@@ OOB Data:', 'yellow'))
if shared_data is None: if shared_data is None:
oob_data = OobData( oob_data = OobData(
address=device.random_address, address=device.random_address, shared_data=our_oob_context.share()
shared_data=our_oob_context.share(),
legacy_context=(None if sc else legacy_context),
) )
print( print(
color( color(
@@ -436,8 +427,7 @@ async def pair(
'yellow', 'yellow',
) )
) )
if legacy_context: print(color(f'@@@ TK={legacy_context.tk.hex()}', 'yellow'))
print(color(f'@@@ TK={legacy_context.tk.hex()}', 'yellow'))
print(color('@@@-----------------------------------', 'yellow')) print(color('@@@-----------------------------------', 'yellow'))
else: else:
oob_contexts = None oob_contexts = None
@@ -508,21 +498,33 @@ async def pair(
if mode == 'dual': if mode == 'dual':
flags |= AdvertisingData.Flags.SIMULTANEOUS_LE_BR_EDR_CAPABLE flags |= AdvertisingData.Flags.SIMULTANEOUS_LE_BR_EDR_CAPABLE
advertising_data_types: list[DataType] = [ ad_structs = [
data_types.Flags(flags), (
data_types.CompleteLocalName('Bumble'), AdvertisingData.FLAGS,
bytes([flags]),
),
(AdvertisingData.COMPLETE_LOCAL_NAME, 'Bumble'.encode()),
] ]
if service_uuids_16: if service_uuids_16:
advertising_data_types.append( ad_structs.append(
data_types.IncompleteListOf16BitServiceUUIDs(service_uuids_16) (
AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS,
b"".join(bytes(uuid) for uuid in service_uuids_16),
)
) )
if service_uuids_32: if service_uuids_32:
advertising_data_types.append( ad_structs.append(
data_types.IncompleteListOf32BitServiceUUIDs(service_uuids_32) (
AdvertisingData.INCOMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS,
b"".join(bytes(uuid) for uuid in service_uuids_32),
)
) )
if service_uuids_128: if service_uuids_128:
advertising_data_types.append( ad_structs.append(
data_types.IncompleteListOf128BitServiceUUIDs(service_uuids_128) (
AdvertisingData.INCOMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS,
b"".join(bytes(uuid) for uuid in service_uuids_128),
)
) )
if advertise_appearance: if advertise_appearance:
@@ -549,10 +551,13 @@ async def pair(
advertise_appearance_int = int( advertise_appearance_int = int(
Appearance(category_enum, subcategory_enum) Appearance(category_enum, subcategory_enum)
) )
advertising_data_types.append( ad_structs.append(
data_types.Appearance(category_enum, subcategory_enum) (
AdvertisingData.APPEARANCE,
struct.pack('<H', advertise_appearance_int),
)
) )
device.advertising_data = bytes(AdvertisingData(advertising_data_types)) device.advertising_data = bytes(AdvertisingData(ad_structs))
await device.start_advertising( await device.start_advertising(
auto_restart=True, auto_restart=True,
own_address_type=( own_address_type=(
+5 -6
View File
@@ -1,11 +1,10 @@
import asyncio import asyncio
import json
import logging
from typing import Any
import click import click
import logging
import json
from bumble.pandora import Config, PandoraDevice, serve from bumble.pandora import PandoraDevice, Config, serve
from typing import Dict, Any
BUMBLE_SERVER_GRPC_PORT = 7999 BUMBLE_SERVER_GRPC_PORT = 7999
ROOTCANAL_PORT_CUTTLEFISH = 7300 ROOTCANAL_PORT_CUTTLEFISH = 7300
@@ -40,7 +39,7 @@ def main(grpc_port: int, rootcanal_port: int, transport: str, config: str) -> No
asyncio.run(serve(device, config=server_config, port=grpc_port)) asyncio.run(serve(device, config=server_config, port=grpc_port))
def retrieve_config(config: str) -> dict[str, Any]: def retrieve_config(config: str) -> Dict[str, Any]:
if not config: if not config:
return {} return {}
+24 -20
View File
@@ -16,51 +16,55 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import asyncio.subprocess
import os
import logging import logging
from typing import Optional, Union from typing import Optional, Union
import click import click
import bumble.logging
from bumble.a2dp import ( from bumble.a2dp import (
make_audio_source_service_sdp_records,
A2DP_SBC_CODEC_TYPE,
A2DP_MPEG_2_4_AAC_CODEC_TYPE, A2DP_MPEG_2_4_AAC_CODEC_TYPE,
A2DP_NON_A2DP_CODEC_TYPE, A2DP_NON_A2DP_CODEC_TYPE,
A2DP_SBC_CODEC_TYPE,
AacFrame, AacFrame,
AacMediaCodecInformation,
AacPacketSource,
AacParser, AacParser,
OpusMediaCodecInformation, AacPacketSource,
OpusPacket, AacMediaCodecInformation,
OpusPacketSource,
OpusParser,
SbcFrame, SbcFrame,
SbcMediaCodecInformation,
SbcPacketSource,
SbcParser, SbcParser,
make_audio_source_service_sdp_records, SbcPacketSource,
SbcMediaCodecInformation,
OpusPacket,
OpusParser,
OpusPacketSource,
OpusMediaCodecInformation,
) )
from bumble.avrcp import Protocol as AvrcpProtocol
from bumble.avdtp import ( from bumble.avdtp import (
find_avdtp_service_with_connection,
AVDTP_AUDIO_MEDIA_TYPE, AVDTP_AUDIO_MEDIA_TYPE,
AVDTP_DELAY_REPORTING_SERVICE_CATEGORY, AVDTP_DELAY_REPORTING_SERVICE_CATEGORY,
MediaCodecCapabilities, MediaCodecCapabilities,
MediaPacketPump, MediaPacketPump,
Protocol as AvdtpProtocol,
) )
from bumble.avdtp import Protocol as AvdtpProtocol
from bumble.avdtp import find_avdtp_service_with_connection
from bumble.avrcp import Protocol as AvrcpProtocol
from bumble.colors import color from bumble.colors import color
from bumble.core import AdvertisingData from bumble.core import (
from bumble.core import ConnectionError as BumbleConnectionError AdvertisingData,
from bumble.core import DeviceClass, PhysicalTransport ConnectionError as BumbleConnectionError,
DeviceClass,
PhysicalTransport,
)
from bumble.device import Connection, Device, DeviceConfiguration from bumble.device import Connection, Device, DeviceConfiguration
from bumble.hci import HCI_CONNECTION_ALREADY_EXISTS_ERROR, Address, HCI_Constant from bumble.hci import Address, HCI_CONNECTION_ALREADY_EXISTS_ERROR, HCI_Constant
from bumble.pairing import PairingConfig from bumble.pairing import PairingConfig
from bumble.transport import open_transport from bumble.transport import open_transport
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -595,7 +599,7 @@ def play(context, address, audio_format, audio_file):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def main(): def main():
bumble.logging.setup_basic_logging("WARNING") logging.basicConfig(level=os.environ.get("BUMBLE_LOGLEVEL", "WARNING").upper())
player_cli() player_cli()
+11 -5
View File
@@ -16,15 +16,21 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import logging
import os
import time import time
from typing import Optional from typing import Optional
import click import click
import bumble.logging
from bumble import core, hci, rfcomm, transport, utils
from bumble.colors import color from bumble.colors import color
from bumble.device import Connection, Device, DeviceConfiguration from bumble.device import Device, DeviceConfiguration, Connection
from bumble import core
from bumble import hci
from bumble import rfcomm
from bumble import transport
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -400,7 +406,7 @@ class ClientBridge:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def run(device_config, hci_transport, bridge): async def run(device_config, hci_transport, bridge):
print("<<< connecting to HCI...") print("<<< connecting to HCI...")
async with await transport.open_transport(hci_transport) as ( async with await transport.open_transport_or_link(hci_transport) as (
hci_source, hci_source,
hci_sink, hci_sink,
): ):
@@ -509,6 +515,6 @@ def client(context, bluetooth_address, tcp_host, tcp_port, authenticate, encrypt
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
logging.basicConfig(level=os.environ.get("BUMBLE_LOGLEVEL", "WARNING").upper())
if __name__ == "__main__": if __name__ == "__main__":
bumble.logging.setup_basic_logging("WARNING")
cli(obj={}) # pylint: disable=no-value-for-parameter cli(obj={}) # pylint: disable=no-value-for-parameter
+9 -18
View File
@@ -16,17 +16,17 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import logging
import click import click
import bumble.logging
from bumble import data_types
from bumble.colors import color from bumble.colors import color
from bumble.device import Advertisement, Device from bumble.device import Device
from bumble.hci import HCI_LE_1M_PHY, HCI_LE_CODED_PHY, Address, HCI_Constant from bumble.transport import open_transport_or_link
from bumble.keys import JsonKeyStore from bumble.keys import JsonKeyStore
from bumble.smp import AddressResolver from bumble.smp import AddressResolver
from bumble.transport import open_transport from bumble.device import Advertisement
from bumble.hci import Address, HCI_Constant, HCI_LE_1M_PHY, HCI_LE_CODED_PHY
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -95,22 +95,13 @@ class AdvertisementPrinter:
else: else:
phy_info = '' phy_info = ''
details = separator.join(
[
data_type.to_string(use_label=True)
for data_type in data_types.data_types_from_advertising_data(
advertisement.data
)
]
)
print( print(
f'>>> {color(address, address_color)} ' f'>>> {color(address, address_color)} '
f'[{color(address_type_string, type_color)}]{address_qualifier}' f'[{color(address_type_string, type_color)}]{address_qualifier}'
f'{resolution_qualifier}:{separator}' f'{resolution_qualifier}:{separator}'
f'{phy_info}' f'{phy_info}'
f'RSSI:{advertisement.rssi:4} {rssi_bar}{separator}' f'RSSI:{advertisement.rssi:4} {rssi_bar}{separator}'
f'{details}\n' f'{advertisement.data.to_string(separator)}\n'
) )
def on_advertisement(self, advertisement): def on_advertisement(self, advertisement):
@@ -136,7 +127,7 @@ async def scan(
transport, transport,
): ):
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport(transport) as (hci_source, hci_sink): async with await open_transport_or_link(transport) as (hci_source, hci_sink):
print('<<< connected') print('<<< connected')
if device_config: if device_config:
@@ -246,7 +237,7 @@ def main(
device_config, device_config,
transport, transport,
): ):
bumble.logging.setup_basic_logging('WARNING') logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
asyncio.run( asyncio.run(
scan( scan(
min_rssi, min_rssi,
+7 -8
View File
@@ -16,17 +16,17 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import datetime import datetime
import importlib
import logging import logging
import os
import struct import struct
import click import click
import bumble.logging
from bumble import hci
from bumble.colors import color from bumble.colors import color
from bumble.helpers import PacketTracer from bumble import hci
from bumble.transport.common import PacketReader from bumble.transport.common import PacketReader
from bumble.helpers import PacketTracer
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -154,10 +154,9 @@ class Printer:
def main(format, vendor, filename): def main(format, vendor, filename):
for vendor_name in vendor: for vendor_name in vendor:
if vendor_name == 'android': if vendor_name == 'android':
# Prevent being deleted by linter. import bumble.vendor.android.hci
importlib.import_module('bumble.vendor.android.hci')
elif vendor_name == 'zephyr': elif vendor_name == 'zephyr':
importlib.import_module('bumble.vendor.zephyr.hci') import bumble.vendor.zephyr.hci
input = open(filename, 'rb') input = open(filename, 'rb')
if format == 'h4': if format == 'h4':
@@ -187,5 +186,5 @@ def main(format, vendor, filename):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
if __name__ == '__main__': if __name__ == '__main__':
bumble.logging.setup_basic_logging('WARNING') logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
main() # pylint: disable=no-value-for-parameter main() # pylint: disable=no-value-for-parameter
-1
View File
@@ -15,7 +15,6 @@
<tr><td>Codec</td><td><span id="codecText"></span></td></tr> <tr><td>Codec</td><td><span id="codecText"></span></td></tr>
<tr><td>Packets</td><td><span id="packetsReceivedText"></span></td></tr> <tr><td>Packets</td><td><span id="packetsReceivedText"></span></td></tr>
<tr><td>Bytes</td><td><span id="bytesReceivedText"></span></td></tr> <tr><td>Bytes</td><td><span id="bytesReceivedText"></span></td></tr>
<tr><td>Bitrate</td><td><span id="bitrate"></span></td></tr>
</table> </table>
</td> </td>
<td> <td>
+62 -113
View File
@@ -7,19 +7,17 @@ let connectionText;
let codecText; let codecText;
let packetsReceivedText; let packetsReceivedText;
let bytesReceivedText; let bytesReceivedText;
let bitrateText;
let streamStateText; let streamStateText;
let connectionStateText; let connectionStateText;
let controlsDiv; let controlsDiv;
let audioOnButton; let audioOnButton;
let audioDecoder; let mediaSource;
let audioCodec; let sourceBuffer;
let audioElement;
let audioContext; let audioContext;
let audioAnalyzer; let audioAnalyzer;
let audioFrequencyBinCount; let audioFrequencyBinCount;
let audioFrequencyData; let audioFrequencyData;
let nextAudioStartPosition = 0;
let audioStartTime = 0;
let packetsReceived = 0; let packetsReceived = 0;
let bytesReceived = 0; let bytesReceived = 0;
let audioState = "stopped"; let audioState = "stopped";
@@ -31,17 +29,20 @@ let bandwidthCanvas;
let bandwidthCanvasContext; let bandwidthCanvasContext;
let bandwidthBinCount; let bandwidthBinCount;
let bandwidthBins = []; let bandwidthBins = [];
let bitrateSamples = [];
const FFT_WIDTH = 800; const FFT_WIDTH = 800;
const FFT_HEIGHT = 256; const FFT_HEIGHT = 256;
const BANDWIDTH_WIDTH = 500; const BANDWIDTH_WIDTH = 500;
const BANDWIDTH_HEIGHT = 100; const BANDWIDTH_HEIGHT = 100;
const BITRATE_WINDOW = 30;
function hexToBytes(hex) {
return Uint8Array.from(hex.match(/.{1,2}/g).map((byte) => parseInt(byte, 16)));
}
function init() { function init() {
initUI(); initUI();
initAudioContext(); initMediaSource();
initAudioElement();
initAnalyzer(); initAnalyzer();
connect(); connect();
@@ -55,7 +56,6 @@ function initUI() {
codecText = document.getElementById("codecText"); codecText = document.getElementById("codecText");
packetsReceivedText = document.getElementById("packetsReceivedText"); packetsReceivedText = document.getElementById("packetsReceivedText");
bytesReceivedText = document.getElementById("bytesReceivedText"); bytesReceivedText = document.getElementById("bytesReceivedText");
bitrateText = document.getElementById("bitrate");
streamStateText = document.getElementById("streamStateText"); streamStateText = document.getElementById("streamStateText");
connectionStateText = document.getElementById("connectionStateText"); connectionStateText = document.getElementById("connectionStateText");
audioSupportMessageText = document.getElementById("audioSupportMessageText"); audioSupportMessageText = document.getElementById("audioSupportMessageText");
@@ -67,9 +67,17 @@ function initUI() {
requestAnimationFrame(onAnimationFrame); requestAnimationFrame(onAnimationFrame);
} }
function initAudioContext() { function initMediaSource() {
audioContext = new AudioContext(); mediaSource = new MediaSource();
audioContext.onstatechange = () => console.log("AudioContext state:", audioContext.state); mediaSource.onsourceopen = onMediaSourceOpen;
mediaSource.onsourceclose = onMediaSourceClose;
mediaSource.onsourceended = onMediaSourceEnd;
}
function initAudioElement() {
audioElement = document.getElementById("audio");
audioElement.src = URL.createObjectURL(mediaSource);
// audioElement.controls = true;
} }
function initAnalyzer() { function initAnalyzer() {
@@ -86,16 +94,24 @@ function initAnalyzer() {
bandwidthCanvasContext = bandwidthCanvas.getContext('2d'); bandwidthCanvasContext = bandwidthCanvas.getContext('2d');
bandwidthCanvasContext.fillStyle = "rgb(255, 255, 255)"; bandwidthCanvasContext.fillStyle = "rgb(255, 255, 255)";
bandwidthCanvasContext.fillRect(0, 0, BANDWIDTH_WIDTH, BANDWIDTH_HEIGHT); bandwidthCanvasContext.fillRect(0, 0, BANDWIDTH_WIDTH, BANDWIDTH_HEIGHT);
}
function startAnalyzer() {
// FFT
if (audioElement.captureStream !== undefined) {
audioContext = new AudioContext();
audioAnalyzer = audioContext.createAnalyser();
audioAnalyzer.fftSize = 128;
audioFrequencyBinCount = audioAnalyzer.frequencyBinCount;
audioFrequencyData = new Uint8Array(audioFrequencyBinCount);
const stream = audioElement.captureStream();
const source = audioContext.createMediaStreamSource(stream);
source.connect(audioAnalyzer);
}
// Bandwidth
bandwidthBinCount = BANDWIDTH_WIDTH / 2; bandwidthBinCount = BANDWIDTH_WIDTH / 2;
bandwidthBins = []; bandwidthBins = [];
bitrateSamples = [];
audioAnalyzer = audioContext.createAnalyser();
audioAnalyzer.fftSize = 128;
audioFrequencyBinCount = audioAnalyzer.frequencyBinCount;
audioFrequencyData = new Uint8Array(audioFrequencyBinCount);
audioAnalyzer.connect(audioContext.destination)
} }
function setConnectionText(message) { function setConnectionText(message) {
@@ -132,8 +148,7 @@ function onAnimationFrame() {
bandwidthCanvasContext.fillRect(0, 0, BANDWIDTH_WIDTH, BANDWIDTH_HEIGHT); bandwidthCanvasContext.fillRect(0, 0, BANDWIDTH_WIDTH, BANDWIDTH_HEIGHT);
bandwidthCanvasContext.fillStyle = `rgb(100, 100, 100)`; bandwidthCanvasContext.fillStyle = `rgb(100, 100, 100)`;
for (let t = 0; t < bandwidthBins.length; t++) { for (let t = 0; t < bandwidthBins.length; t++) {
const bytesReceived = bandwidthBins[t] const lineHeight = (bandwidthBins[t] / 1000) * BANDWIDTH_HEIGHT;
const lineHeight = (bytesReceived / 1000) * BANDWIDTH_HEIGHT;
bandwidthCanvasContext.fillRect(t * 2, BANDWIDTH_HEIGHT - lineHeight, 2, lineHeight); bandwidthCanvasContext.fillRect(t * 2, BANDWIDTH_HEIGHT - lineHeight, 2, lineHeight);
} }
@@ -141,14 +156,28 @@ function onAnimationFrame() {
requestAnimationFrame(onAnimationFrame); requestAnimationFrame(onAnimationFrame);
} }
function onMediaSourceOpen() {
console.log(this.readyState);
sourceBuffer = mediaSource.addSourceBuffer("audio/aac");
}
function onMediaSourceClose() {
console.log(this.readyState);
}
function onMediaSourceEnd() {
console.log(this.readyState);
}
async function startAudio() { async function startAudio() {
try { try {
console.log("starting audio..."); console.log("starting audio...");
audioOnButton.disabled = true; audioOnButton.disabled = true;
audioState = "starting"; audioState = "starting";
audioContext.resume(); await audioElement.play();
console.log("audio started"); console.log("audio started");
audioState = "playing"; audioState = "playing";
startAnalyzer();
} catch(error) { } catch(error) {
console.error(`play failed: ${error}`); console.error(`play failed: ${error}`);
audioState = "stopped"; audioState = "stopped";
@@ -156,47 +185,12 @@ async function startAudio() {
} }
} }
function onDecodedAudio(audioData) { function onAudioPacket(packet) {
const bufferSource = audioContext.createBufferSource() if (audioState != "stopped") {
// Queue the audio packet.
const now = audioContext.currentTime; sourceBuffer.appendBuffer(packet);
let nextAudioStartTime = audioStartTime + (nextAudioStartPosition / audioData.sampleRate);
if (nextAudioStartTime < now) {
console.log("starting new audio time base")
audioStartTime = now;
nextAudioStartTime = now;
nextAudioStartPosition = 0;
} else {
console.log(`audio buffer scheduled in ${nextAudioStartTime - now}`)
} }
const audioBuffer = audioContext.createBuffer(
audioData.numberOfChannels,
audioData.numberOfFrames,
audioData.sampleRate
);
for (let channel = 0; channel < audioData.numberOfChannels; channel++) {
audioData.copyTo(
audioBuffer.getChannelData(channel),
{
planeIndex: channel,
format: "f32-planar"
}
)
}
bufferSource.buffer = audioBuffer;
bufferSource.connect(audioAnalyzer)
bufferSource.start(nextAudioStartTime);
nextAudioStartPosition += audioData.numberOfFrames;
}
function onCodecError(error) {
console.log("Codec error:", error)
}
async function onAudioPacket(packet) {
packetsReceived += 1; packetsReceived += 1;
packetsReceivedText.innerText = packetsReceived; packetsReceivedText.innerText = packetsReceived;
bytesReceived += packet.byteLength; bytesReceived += packet.byteLength;
@@ -206,48 +200,6 @@ async function onAudioPacket(packet) {
if (bandwidthBins.length > bandwidthBinCount) { if (bandwidthBins.length > bandwidthBinCount) {
bandwidthBins.shift(); bandwidthBins.shift();
} }
bitrateSamples[bitrateSamples.length] = {ts: Date.now(), bytes: packet.byteLength}
if (bitrateSamples.length > BITRATE_WINDOW) {
bitrateSamples.shift();
}
if (bitrateSamples.length >= 2) {
const windowBytes = bitrateSamples.reduce((accumulator, x) => accumulator + x.bytes, 0) - bitrateSamples[0].bytes;
const elapsed = bitrateSamples[bitrateSamples.length-1].ts - bitrateSamples[0].ts;
const bitrate = Math.floor(8 * windowBytes / elapsed)
bitrateText.innerText = `${bitrate} kb/s`
}
if (audioState == "stopped") {
return;
}
if (audioDecoder === undefined) {
let audioConfig;
if (audioCodec == 'aac') {
audioConfig = {
codec: 'mp4a.40.2',
sampleRate: 44100, // ignored
numberOfChannels: 2, // ignored
}
} else if (audioCodec == 'opus') {
audioConfig = {
codec: 'opus',
sampleRate: 48000, // ignored
numberOfChannels: 2, // ignored
}
}
audioDecoder = new AudioDecoder({ output: onDecodedAudio, error: onCodecError });
audioDecoder.configure(audioConfig)
}
const encodedAudio = new EncodedAudioChunk({
type: "key",
data: packet,
timestamp: 0,
transfer: [packet],
});
audioDecoder.decode(encodedAudio);
} }
function onChannelOpen() { function onChannelOpen() {
@@ -297,19 +249,16 @@ function onChannelMessage(message) {
} }
} }
async function onHelloMessage(params) { function onHelloMessage(params) {
codecText.innerText = params.codec; codecText.innerText = params.codec;
if (params.codec != "aac") {
if (params.codec == "aac" || params.codec == "opus") { audioOnButton.disabled = true;
audioCodec = params.codec audioSupportMessageText.innerText = "Only AAC can be played, audio will be disabled";
audioSupportMessageText.style.display = "inline-block";
} else {
audioSupportMessageText.innerText = ""; audioSupportMessageText.innerText = "";
audioSupportMessageText.style.display = "none"; audioSupportMessageText.style.display = "none";
} else {
audioOnButton.disabled = true;
audioSupportMessageText.innerText = "Only AAC and Opus can be played, audio will be disabled";
audioSupportMessageText.style.display = "inline-block";
} }
if (params.streamState) { if (params.streamState) {
setStreamState(params.streamState); setStreamState(params.streamState);
} }
+38 -142
View File
@@ -16,49 +16,47 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import asyncio.subprocess import asyncio.subprocess
from importlib import resources
import enum import enum
import json import json
import os
import logging import logging
import pathlib import pathlib
import subprocess import subprocess
from typing import Dict, List, Optional
import weakref import weakref
from importlib import resources
from typing import Optional
import aiohttp
import click import click
import aiohttp
from aiohttp import web from aiohttp import web
import bumble import bumble
import bumble.logging from bumble.colors import color
from bumble.a2dp import ( from bumble.core import PhysicalTransport, CommandTimeoutError
A2DP_MPEG_2_4_AAC_CODEC_TYPE, from bumble.device import Connection, Device, DeviceConfiguration
A2DP_NON_A2DP_CODEC_TYPE, from bumble.hci import HCI_StatusError
A2DP_SBC_CODEC_TYPE, from bumble.pairing import PairingConfig
AacMediaCodecInformation, from bumble.sdp import ServiceAttribute
OpusMediaCodecInformation, from bumble.transport import open_transport
SbcMediaCodecInformation,
make_audio_sink_service_sdp_records,
)
from bumble.avdtp import ( from bumble.avdtp import (
AVDTP_AUDIO_MEDIA_TYPE, AVDTP_AUDIO_MEDIA_TYPE,
Listener, Listener,
MediaCodecCapabilities, MediaCodecCapabilities,
Protocol, Protocol,
) )
from bumble.codecs import AacAudioRtpPacket from bumble.a2dp import (
from bumble.colors import color make_audio_sink_service_sdp_records,
from bumble.core import CommandTimeoutError, PhysicalTransport A2DP_SBC_CODEC_TYPE,
from bumble.device import Connection, Device, DeviceConfiguration A2DP_MPEG_2_4_AAC_CODEC_TYPE,
from bumble.hci import HCI_StatusError SbcMediaCodecInformation,
from bumble.pairing import PairingConfig AacMediaCodecInformation,
from bumble.rtp import MediaPacket )
from bumble.sdp import ServiceAttribute
from bumble.transport import open_transport
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
from bumble.codecs import AacAudioRtpPacket
from bumble.rtp import MediaPacket
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -80,8 +78,6 @@ class AudioExtractor:
return AacAudioExtractor() return AacAudioExtractor()
if codec == 'sbc': if codec == 'sbc':
return SbcAudioExtractor() return SbcAudioExtractor()
if codec == 'opus':
return OpusAudioExtractor()
def extract_audio(self, packet: MediaPacket) -> bytes: def extract_audio(self, packet: MediaPacket) -> bytes:
raise NotImplementedError() raise NotImplementedError()
@@ -106,13 +102,6 @@ class SbcAudioExtractor:
return packet.payload[1:] return packet.payload[1:]
# -----------------------------------------------------------------------------
class OpusAudioExtractor:
def extract_audio(self, packet: MediaPacket) -> bytes:
# TODO: parse fields
return packet.payload[1:]
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Output: class Output:
async def start(self) -> None: async def start(self) -> None:
@@ -246,7 +235,7 @@ class FfplayOutput(QueuedOutput):
await super().start() await super().start()
self.subprocess = await asyncio.create_subprocess_shell( self.subprocess = await asyncio.create_subprocess_shell(
f'ffplay -probesize 32 -f {self.codec} pipe:0', f'ffplay -f {self.codec} pipe:0',
stdin=asyncio.subprocess.PIPE, stdin=asyncio.subprocess.PIPE,
stdout=asyncio.subprocess.PIPE, stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE,
@@ -410,24 +399,10 @@ class Speaker:
STARTED = 2 STARTED = 2
SUSPENDED = 3 SUSPENDED = 3
def __init__( def __init__(self, device_config, transport, codec, discover, outputs, ui_port):
self,
device_config,
transport,
codec,
sampling_frequencies,
bitrate,
vbr,
discover,
outputs,
ui_port,
):
self.device_config = device_config self.device_config = device_config
self.transport = transport self.transport = transport
self.codec = codec self.codec = codec
self.sampling_frequencies = sampling_frequencies
self.bitrate = bitrate
self.vbr = vbr
self.discover = discover self.discover = discover
self.ui_port = ui_port self.ui_port = ui_port
self.device = None self.device = None
@@ -448,7 +423,7 @@ class Speaker:
# Create an HTTP server for the UI # Create an HTTP server for the UI
self.ui_server = UiServer(speaker=self, port=ui_port) self.ui_server = UiServer(speaker=self, port=ui_port)
def sdp_records(self) -> dict[int, list[ServiceAttribute]]: def sdp_records(self) -> Dict[int, List[ServiceAttribute]]:
service_record_handle = 0x00010001 service_record_handle = 0x00010001
return { return {
service_record_handle: make_audio_sink_service_sdp_records( service_record_handle: make_audio_sink_service_sdp_records(
@@ -463,56 +438,32 @@ class Speaker:
if self.codec == 'sbc': if self.codec == 'sbc':
return self.sbc_codec_capabilities() return self.sbc_codec_capabilities()
if self.codec == 'opus':
return self.opus_codec_capabilities()
raise RuntimeError('unsupported codec') raise RuntimeError('unsupported codec')
def aac_codec_capabilities(self) -> MediaCodecCapabilities: def aac_codec_capabilities(self) -> MediaCodecCapabilities:
supported_sampling_frequencies = AacMediaCodecInformation.SamplingFrequency(0)
for sampling_frequency in self.sampling_frequencies or [
8000,
11025,
12000,
16000,
22050,
24000,
32000,
44100,
48000,
]:
supported_sampling_frequencies |= (
AacMediaCodecInformation.SamplingFrequency.from_int(sampling_frequency)
)
return MediaCodecCapabilities( return MediaCodecCapabilities(
media_type=AVDTP_AUDIO_MEDIA_TYPE, media_type=AVDTP_AUDIO_MEDIA_TYPE,
media_codec_type=A2DP_MPEG_2_4_AAC_CODEC_TYPE, media_codec_type=A2DP_MPEG_2_4_AAC_CODEC_TYPE,
media_codec_information=AacMediaCodecInformation( media_codec_information=AacMediaCodecInformation(
object_type=AacMediaCodecInformation.ObjectType.MPEG_2_AAC_LC, object_type=AacMediaCodecInformation.ObjectType.MPEG_2_AAC_LC,
sampling_frequency=supported_sampling_frequencies, sampling_frequency=AacMediaCodecInformation.SamplingFrequency.SF_48000
| AacMediaCodecInformation.SamplingFrequency.SF_44100,
channels=AacMediaCodecInformation.Channels.MONO channels=AacMediaCodecInformation.Channels.MONO
| AacMediaCodecInformation.Channels.STEREO, | AacMediaCodecInformation.Channels.STEREO,
vbr=1 if self.vbr else 0, vbr=1,
bitrate=self.bitrate or 256000, bitrate=256000,
), ),
) )
def sbc_codec_capabilities(self) -> MediaCodecCapabilities: def sbc_codec_capabilities(self) -> MediaCodecCapabilities:
supported_sampling_frequencies = SbcMediaCodecInformation.SamplingFrequency(0)
for sampling_frequency in self.sampling_frequencies or [
16000,
32000,
44100,
48000,
]:
supported_sampling_frequencies |= (
SbcMediaCodecInformation.SamplingFrequency.from_int(sampling_frequency)
)
return MediaCodecCapabilities( return MediaCodecCapabilities(
media_type=AVDTP_AUDIO_MEDIA_TYPE, media_type=AVDTP_AUDIO_MEDIA_TYPE,
media_codec_type=A2DP_SBC_CODEC_TYPE, media_codec_type=A2DP_SBC_CODEC_TYPE,
media_codec_information=SbcMediaCodecInformation( media_codec_information=SbcMediaCodecInformation(
sampling_frequency=supported_sampling_frequencies, sampling_frequency=SbcMediaCodecInformation.SamplingFrequency.SF_48000
| SbcMediaCodecInformation.SamplingFrequency.SF_44100
| SbcMediaCodecInformation.SamplingFrequency.SF_32000
| SbcMediaCodecInformation.SamplingFrequency.SF_16000,
channel_mode=SbcMediaCodecInformation.ChannelMode.MONO channel_mode=SbcMediaCodecInformation.ChannelMode.MONO
| SbcMediaCodecInformation.ChannelMode.DUAL_CHANNEL | SbcMediaCodecInformation.ChannelMode.DUAL_CHANNEL
| SbcMediaCodecInformation.ChannelMode.STEREO | SbcMediaCodecInformation.ChannelMode.STEREO
@@ -530,25 +481,6 @@ class Speaker:
), ),
) )
def opus_codec_capabilities(self) -> MediaCodecCapabilities:
supported_sampling_frequencies = OpusMediaCodecInformation.SamplingFrequency(0)
for sampling_frequency in self.sampling_frequencies or [48000]:
supported_sampling_frequencies |= (
OpusMediaCodecInformation.SamplingFrequency.from_int(sampling_frequency)
)
return MediaCodecCapabilities(
media_type=AVDTP_AUDIO_MEDIA_TYPE,
media_codec_type=A2DP_NON_A2DP_CODEC_TYPE,
media_codec_information=OpusMediaCodecInformation(
frame_size=OpusMediaCodecInformation.FrameSize.FS_10MS
| OpusMediaCodecInformation.FrameSize.FS_20MS,
channel_mode=OpusMediaCodecInformation.ChannelMode.MONO
| OpusMediaCodecInformation.ChannelMode.STEREO
| OpusMediaCodecInformation.ChannelMode.DUAL_MONO,
sampling_frequency=supported_sampling_frequencies,
),
)
async def dispatch_to_outputs(self, function): async def dispatch_to_outputs(self, function):
for output in self.outputs: for output in self.outputs:
await function(output) await function(output)
@@ -743,26 +675,7 @@ def speaker_cli(ctx, device_config):
@click.command() @click.command()
@click.option( @click.option(
'--codec', '--codec', type=click.Choice(['sbc', 'aac']), default='aac', show_default=True
type=click.Choice(['sbc', 'aac', 'opus']),
default='aac',
show_default=True,
)
@click.option(
'--sampling-frequency',
metavar='SAMPLING-FREQUENCY',
type=int,
multiple=True,
help='Enable a sampling frequency (may be specified more than once)',
)
@click.option(
'--bitrate',
metavar='BITRATE',
type=int,
help='Supported bitrate (AAC only)',
)
@click.option(
'--vbr/--no-vbr', is_flag=True, default=True, help='Enable VBR (AAC only)'
) )
@click.option( @click.option(
'--discover', is_flag=True, help='Discover remote endpoints once connected' '--discover', is_flag=True, help='Discover remote endpoints once connected'
@@ -793,16 +706,7 @@ def speaker_cli(ctx, device_config):
@click.option('--device-config', metavar='FILENAME', help='Device configuration file') @click.option('--device-config', metavar='FILENAME', help='Device configuration file')
@click.argument('transport') @click.argument('transport')
def speaker( def speaker(
transport, transport, codec, connect_address, discover, output, ui_port, device_config
codec,
sampling_frequency,
bitrate,
vbr,
connect_address,
discover,
output,
ui_port,
device_config,
): ):
"""Run the speaker.""" """Run the speaker."""
@@ -817,23 +721,15 @@ def speaker(
output = list(filter(lambda x: x != '@ffplay', output)) output = list(filter(lambda x: x != '@ffplay', output))
asyncio.run( asyncio.run(
Speaker( Speaker(device_config, transport, codec, discover, output, ui_port).run(
device_config, connect_address
transport, )
codec,
sampling_frequency,
bitrate,
vbr,
discover,
output,
ui_port,
).run(connect_address)
) )
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def main(): def main():
bumble.logging.setup_basic_logging('WARNING') logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
speaker() speaker()
+3 -3
View File
@@ -16,10 +16,10 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import asyncio import asyncio
import os
import logging
import click import click
import bumble.logging
from bumble.device import Device from bumble.device import Device
from bumble.keys import JsonKeyStore from bumble.keys import JsonKeyStore
from bumble.transport import open_transport from bumble.transport import open_transport
@@ -68,7 +68,7 @@ def main(keystore_file, hci_transport, device_config, address):
instantiated. instantiated.
If no address is passed, the existing pairing keys for all addresses are printed. If no address is passed, the existing pairing keys for all addresses are printed.
""" """
bumble.logging.setup_basic_logging() logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
if not keystore_file and not hci_transport: if not keystore_file and not hci_transport:
print('either --keystore-file or --hci-transport must be specified.') print('either --keystore-file or --hci-transport must be specified.')
+4 -2
View File
@@ -26,13 +26,15 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import os
import logging
import click import click
import usb1 import usb1
import bumble.logging
from bumble.colors import color from bumble.colors import color
from bumble.transport.usb import load_libusb from bumble.transport.usb import load_libusb
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -167,7 +169,7 @@ def is_bluetooth_hci(device):
@click.command() @click.command()
@click.option('--verbose', is_flag=True, default=False, help='Print more details') @click.option('--verbose', is_flag=True, default=False, help='Print more details')
def main(verbose): def main(verbose):
bumble.logging.setup_basic_logging('WARNING') logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'WARNING').upper())
load_libusb() load_libusb()
with usb1.USBContext() as context: with usb1.USBContext() as context:
+17 -22
View File
@@ -17,36 +17,37 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
from collections.abc import AsyncGenerator
import dataclasses import dataclasses
import enum import enum
import logging import logging
import struct import struct
from collections.abc import AsyncGenerator
from typing import Awaitable, Callable from typing import Awaitable, Callable
from typing_extensions import ClassVar, Self from typing_extensions import ClassVar, Self
from bumble.codecs import AacAudioRtpPacket from bumble.codecs import AacAudioRtpPacket
from bumble.company_ids import COMPANY_IDENTIFIERS from bumble.company_ids import COMPANY_IDENTIFIERS
from bumble.sdp import (
DataElement,
ServiceAttribute,
SDP_PUBLIC_BROWSE_ROOT,
SDP_BROWSE_GROUP_LIST_ATTRIBUTE_ID,
SDP_SERVICE_RECORD_HANDLE_ATTRIBUTE_ID,
SDP_SERVICE_CLASS_ID_LIST_ATTRIBUTE_ID,
SDP_PROTOCOL_DESCRIPTOR_LIST_ATTRIBUTE_ID,
SDP_BLUETOOTH_PROFILE_DESCRIPTOR_LIST_ATTRIBUTE_ID,
)
from bumble.core import ( from bumble.core import (
BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE,
BT_AUDIO_SINK_SERVICE,
BT_AUDIO_SOURCE_SERVICE,
BT_AVDTP_PROTOCOL_ID,
BT_L2CAP_PROTOCOL_ID, BT_L2CAP_PROTOCOL_ID,
BT_AUDIO_SOURCE_SERVICE,
BT_AUDIO_SINK_SERVICE,
BT_AVDTP_PROTOCOL_ID,
BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE,
name_or_number, name_or_number,
) )
from bumble.rtp import MediaPacket from bumble.rtp import MediaPacket
from bumble.sdp import (
SDP_BLUETOOTH_PROFILE_DESCRIPTOR_LIST_ATTRIBUTE_ID,
SDP_BROWSE_GROUP_LIST_ATTRIBUTE_ID,
SDP_PROTOCOL_DESCRIPTOR_LIST_ATTRIBUTE_ID,
SDP_PUBLIC_BROWSE_ROOT,
SDP_SERVICE_CLASS_ID_LIST_ATTRIBUTE_ID,
SDP_SERVICE_RECORD_HANDLE_ATTRIBUTE_ID,
DataElement,
ServiceAttribute,
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -478,12 +479,6 @@ class OpusMediaCodecInformation(VendorSpecificMediaCodecInformation):
class SamplingFrequency(enum.IntFlag): class SamplingFrequency(enum.IntFlag):
SF_48000 = 1 << 0 SF_48000 = 1 << 0
@classmethod
def from_int(cls, sampling_frequency: int) -> Self:
if sampling_frequency != 48000:
raise ValueError("no such sampling frequency")
return cls(1)
VENDOR_ID: ClassVar[int] = 0x000000E0 VENDOR_ID: ClassVar[int] = 0x000000E0
CODEC_ID: ClassVar[int] = 0x0001 CODEC_ID: ClassVar[int] = 0x0001
+4 -4
View File
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from typing import Union from typing import List, Union
from bumble import core from bumble import core
@@ -21,7 +21,7 @@ class AtParsingError(core.InvalidPacketError):
"""Error raised when parsing AT commands fails.""" """Error raised when parsing AT commands fails."""
def tokenize_parameters(buffer: bytes) -> list[bytes]: def tokenize_parameters(buffer: bytes) -> List[bytes]:
"""Split input parameters into tokens. """Split input parameters into tokens.
Removes space characters outside of double quote blocks: Removes space characters outside of double quote blocks:
T-rec-V-25 - 5.2.1 Command line general format: "Space characters (IA5 2/0) T-rec-V-25 - 5.2.1 Command line general format: "Space characters (IA5 2/0)
@@ -63,12 +63,12 @@ def tokenize_parameters(buffer: bytes) -> list[bytes]:
return [bytes(token) for token in tokens if len(token) > 0] return [bytes(token) for token in tokens if len(token) > 0]
def parse_parameters(buffer: bytes) -> list[Union[bytes, list]]: def parse_parameters(buffer: bytes) -> List[Union[bytes, list]]:
"""Parse the parameters using the comma and parenthesis separators. """Parse the parameters using the comma and parenthesis separators.
Raises AtParsingError in case of invalid input string.""" Raises AtParsingError in case of invalid input string."""
tokens = tokenize_parameters(buffer) tokens = tokenize_parameters(buffer)
accumulator: list[list] = [[]] accumulator: List[list] = [[]]
current: Union[bytes, list] = bytes() current: Union[bytes, list] = bytes()
for token in tokens: for token in tokens:
+260 -249
View File
@@ -24,26 +24,28 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses
import enum import enum
import functools import functools
import inspect import inspect
import struct import struct
from typing import ( from typing import (
TYPE_CHECKING,
Awaitable, Awaitable,
Callable, Callable,
ClassVar,
Generic, Generic,
Dict,
List,
Optional, Optional,
Type,
TypeVar, TypeVar,
Union, Union,
TYPE_CHECKING,
) )
from bumble import hci, utils
from bumble import utils
from bumble.core import UUID, name_or_number, InvalidOperationError, ProtocolError
from bumble.hci import HCI_Object, key_with_value
from bumble.colors import color from bumble.colors import color
from bumble.core import UUID, InvalidOperationError, ProtocolError
from bumble.hci import HCI_Object
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Typing # Typing
@@ -62,66 +64,96 @@ _T = TypeVar('_T')
ATT_CID = 0x04 ATT_CID = 0x04
ATT_PSM = 0x001F ATT_PSM = 0x001F
class Opcode(hci.SpecableEnum): ATT_ERROR_RESPONSE = 0x01
ATT_ERROR_RESPONSE = 0x01 ATT_EXCHANGE_MTU_REQUEST = 0x02
ATT_EXCHANGE_MTU_REQUEST = 0x02 ATT_EXCHANGE_MTU_RESPONSE = 0x03
ATT_EXCHANGE_MTU_RESPONSE = 0x03 ATT_FIND_INFORMATION_REQUEST = 0x04
ATT_FIND_INFORMATION_REQUEST = 0x04 ATT_FIND_INFORMATION_RESPONSE = 0x05
ATT_FIND_INFORMATION_RESPONSE = 0x05 ATT_FIND_BY_TYPE_VALUE_REQUEST = 0x06
ATT_FIND_BY_TYPE_VALUE_REQUEST = 0x06 ATT_FIND_BY_TYPE_VALUE_RESPONSE = 0x07
ATT_FIND_BY_TYPE_VALUE_RESPONSE = 0x07 ATT_READ_BY_TYPE_REQUEST = 0x08
ATT_READ_BY_TYPE_REQUEST = 0x08 ATT_READ_BY_TYPE_RESPONSE = 0x09
ATT_READ_BY_TYPE_RESPONSE = 0x09 ATT_READ_REQUEST = 0x0A
ATT_READ_REQUEST = 0x0A ATT_READ_RESPONSE = 0x0B
ATT_READ_RESPONSE = 0x0B ATT_READ_BLOB_REQUEST = 0x0C
ATT_READ_BLOB_REQUEST = 0x0C ATT_READ_BLOB_RESPONSE = 0x0D
ATT_READ_BLOB_RESPONSE = 0x0D ATT_READ_MULTIPLE_REQUEST = 0x0E
ATT_READ_MULTIPLE_REQUEST = 0x0E ATT_READ_MULTIPLE_RESPONSE = 0x0F
ATT_READ_MULTIPLE_RESPONSE = 0x0F ATT_READ_BY_GROUP_TYPE_REQUEST = 0x10
ATT_READ_BY_GROUP_TYPE_REQUEST = 0x10 ATT_READ_BY_GROUP_TYPE_RESPONSE = 0x11
ATT_READ_BY_GROUP_TYPE_RESPONSE = 0x11 ATT_WRITE_REQUEST = 0x12
ATT_WRITE_REQUEST = 0x12 ATT_WRITE_RESPONSE = 0x13
ATT_WRITE_RESPONSE = 0x13 ATT_WRITE_COMMAND = 0x52
ATT_WRITE_COMMAND = 0x52 ATT_SIGNED_WRITE_COMMAND = 0xD2
ATT_SIGNED_WRITE_COMMAND = 0xD2 ATT_PREPARE_WRITE_REQUEST = 0x16
ATT_PREPARE_WRITE_REQUEST = 0x16 ATT_PREPARE_WRITE_RESPONSE = 0x17
ATT_PREPARE_WRITE_RESPONSE = 0x17 ATT_EXECUTE_WRITE_REQUEST = 0x18
ATT_EXECUTE_WRITE_REQUEST = 0x18 ATT_EXECUTE_WRITE_RESPONSE = 0x19
ATT_EXECUTE_WRITE_RESPONSE = 0x19 ATT_HANDLE_VALUE_NOTIFICATION = 0x1B
ATT_HANDLE_VALUE_NOTIFICATION = 0x1B ATT_HANDLE_VALUE_INDICATION = 0x1D
ATT_HANDLE_VALUE_INDICATION = 0x1D ATT_HANDLE_VALUE_CONFIRMATION = 0x1E
ATT_HANDLE_VALUE_CONFIRMATION = 0x1E
ATT_PDU_NAMES = {
ATT_ERROR_RESPONSE: 'ATT_ERROR_RESPONSE',
ATT_EXCHANGE_MTU_REQUEST: 'ATT_EXCHANGE_MTU_REQUEST',
ATT_EXCHANGE_MTU_RESPONSE: 'ATT_EXCHANGE_MTU_RESPONSE',
ATT_FIND_INFORMATION_REQUEST: 'ATT_FIND_INFORMATION_REQUEST',
ATT_FIND_INFORMATION_RESPONSE: 'ATT_FIND_INFORMATION_RESPONSE',
ATT_FIND_BY_TYPE_VALUE_REQUEST: 'ATT_FIND_BY_TYPE_VALUE_REQUEST',
ATT_FIND_BY_TYPE_VALUE_RESPONSE: 'ATT_FIND_BY_TYPE_VALUE_RESPONSE',
ATT_READ_BY_TYPE_REQUEST: 'ATT_READ_BY_TYPE_REQUEST',
ATT_READ_BY_TYPE_RESPONSE: 'ATT_READ_BY_TYPE_RESPONSE',
ATT_READ_REQUEST: 'ATT_READ_REQUEST',
ATT_READ_RESPONSE: 'ATT_READ_RESPONSE',
ATT_READ_BLOB_REQUEST: 'ATT_READ_BLOB_REQUEST',
ATT_READ_BLOB_RESPONSE: 'ATT_READ_BLOB_RESPONSE',
ATT_READ_MULTIPLE_REQUEST: 'ATT_READ_MULTIPLE_REQUEST',
ATT_READ_MULTIPLE_RESPONSE: 'ATT_READ_MULTIPLE_RESPONSE',
ATT_READ_BY_GROUP_TYPE_REQUEST: 'ATT_READ_BY_GROUP_TYPE_REQUEST',
ATT_READ_BY_GROUP_TYPE_RESPONSE: 'ATT_READ_BY_GROUP_TYPE_RESPONSE',
ATT_WRITE_REQUEST: 'ATT_WRITE_REQUEST',
ATT_WRITE_RESPONSE: 'ATT_WRITE_RESPONSE',
ATT_WRITE_COMMAND: 'ATT_WRITE_COMMAND',
ATT_SIGNED_WRITE_COMMAND: 'ATT_SIGNED_WRITE_COMMAND',
ATT_PREPARE_WRITE_REQUEST: 'ATT_PREPARE_WRITE_REQUEST',
ATT_PREPARE_WRITE_RESPONSE: 'ATT_PREPARE_WRITE_RESPONSE',
ATT_EXECUTE_WRITE_REQUEST: 'ATT_EXECUTE_WRITE_REQUEST',
ATT_EXECUTE_WRITE_RESPONSE: 'ATT_EXECUTE_WRITE_RESPONSE',
ATT_HANDLE_VALUE_NOTIFICATION: 'ATT_HANDLE_VALUE_NOTIFICATION',
ATT_HANDLE_VALUE_INDICATION: 'ATT_HANDLE_VALUE_INDICATION',
ATT_HANDLE_VALUE_CONFIRMATION: 'ATT_HANDLE_VALUE_CONFIRMATION'
}
ATT_REQUESTS = [ ATT_REQUESTS = [
Opcode.ATT_EXCHANGE_MTU_REQUEST, ATT_EXCHANGE_MTU_REQUEST,
Opcode.ATT_FIND_INFORMATION_REQUEST, ATT_FIND_INFORMATION_REQUEST,
Opcode.ATT_FIND_BY_TYPE_VALUE_REQUEST, ATT_FIND_BY_TYPE_VALUE_REQUEST,
Opcode.ATT_READ_BY_TYPE_REQUEST, ATT_READ_BY_TYPE_REQUEST,
Opcode.ATT_READ_REQUEST, ATT_READ_REQUEST,
Opcode.ATT_READ_BLOB_REQUEST, ATT_READ_BLOB_REQUEST,
Opcode.ATT_READ_MULTIPLE_REQUEST, ATT_READ_MULTIPLE_REQUEST,
Opcode.ATT_READ_BY_GROUP_TYPE_REQUEST, ATT_READ_BY_GROUP_TYPE_REQUEST,
Opcode.ATT_WRITE_REQUEST, ATT_WRITE_REQUEST,
Opcode.ATT_PREPARE_WRITE_REQUEST, ATT_PREPARE_WRITE_REQUEST,
Opcode.ATT_EXECUTE_WRITE_REQUEST ATT_EXECUTE_WRITE_REQUEST
] ]
ATT_RESPONSES = [ ATT_RESPONSES = [
Opcode.ATT_ERROR_RESPONSE, ATT_ERROR_RESPONSE,
Opcode.ATT_EXCHANGE_MTU_RESPONSE, ATT_EXCHANGE_MTU_RESPONSE,
Opcode.ATT_FIND_INFORMATION_RESPONSE, ATT_FIND_INFORMATION_RESPONSE,
Opcode.ATT_FIND_BY_TYPE_VALUE_RESPONSE, ATT_FIND_BY_TYPE_VALUE_RESPONSE,
Opcode.ATT_READ_BY_TYPE_RESPONSE, ATT_READ_BY_TYPE_RESPONSE,
Opcode.ATT_READ_RESPONSE, ATT_READ_RESPONSE,
Opcode.ATT_READ_BLOB_RESPONSE, ATT_READ_BLOB_RESPONSE,
Opcode.ATT_READ_MULTIPLE_RESPONSE, ATT_READ_MULTIPLE_RESPONSE,
Opcode.ATT_READ_BY_GROUP_TYPE_RESPONSE, ATT_READ_BY_GROUP_TYPE_RESPONSE,
Opcode.ATT_WRITE_RESPONSE, ATT_WRITE_RESPONSE,
Opcode.ATT_PREPARE_WRITE_RESPONSE, ATT_PREPARE_WRITE_RESPONSE,
Opcode.ATT_EXECUTE_WRITE_RESPONSE ATT_EXECUTE_WRITE_RESPONSE
] ]
class ErrorCode(hci.SpecableEnum): class ErrorCode(utils.OpenIntEnum):
''' '''
See See
@@ -176,6 +208,10 @@ ATT_INSUFFICIENT_RESOURCES_ERROR = ErrorCode.INSUFFICIENT_RESOURCES
ATT_DEFAULT_MTU = 23 ATT_DEFAULT_MTU = 23
HANDLE_FIELD_SPEC = {'size': 2, 'mapper': lambda x: f'0x{x:04X}'} HANDLE_FIELD_SPEC = {'size': 2, 'mapper': lambda x: f'0x{x:04X}'}
# pylint: disable-next=unnecessary-lambda-assignment,unnecessary-lambda
UUID_2_16_FIELD_SPEC = lambda x, y: UUID.parse_uuid(x, y)
# pylint: disable-next=unnecessary-lambda-assignment,unnecessary-lambda
UUID_2_FIELD_SPEC = lambda x, y: UUID.parse_uuid_2(x, y) # noqa: E731
# fmt: on # fmt: on
# pylint: enable=line-too-long # pylint: enable=line-too-long
@@ -195,7 +231,7 @@ class ATT_Error(ProtocolError):
super().__init__( super().__init__(
error_code, error_code,
error_namespace='att', error_namespace='att',
error_name=ErrorCode(error_code).name, error_name=ATT_PDU.error_name(error_code),
) )
self.att_handle = att_handle self.att_handle = att_handle
self.message = message self.message = message
@@ -210,45 +246,61 @@ class ATT_Error(ProtocolError):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Attribute Protocol # Attribute Protocol
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@dataclasses.dataclass
class ATT_PDU: class ATT_PDU:
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.3 ATTRIBUTE PDU See Bluetooth spec @ Vol 3, Part F - 3.3 ATTRIBUTE PDU
''' '''
pdu_classes: ClassVar[dict[int, type[ATT_PDU]]] = {} pdu_classes: Dict[int, Type[ATT_PDU]] = {}
fields: ClassVar[hci.Fields] = () op_code = 0
op_code: int = dataclasses.field(init=False) name: str
name: str = dataclasses.field(init=False)
_payload: Optional[bytes] = dataclasses.field(default=None, init=False)
@classmethod @staticmethod
def from_bytes(cls, pdu: bytes) -> ATT_PDU: def from_bytes(pdu):
op_code = pdu[0] op_code = pdu[0]
subclass = ATT_PDU.pdu_classes.get(op_code) cls = ATT_PDU.pdu_classes.get(op_code)
if subclass is None: if cls is None:
instance = ATT_PDU() instance = ATT_PDU(pdu)
instance.name = ATT_PDU.pdu_name(op_code)
instance.op_code = op_code instance.op_code = op_code
instance.payload = pdu[1:]
instance.name = Opcode(op_code).name
return instance return instance
instance = subclass(**HCI_Object.dict_from_bytes(pdu, 1, subclass.fields)) self = cls.__new__(cls)
instance.payload = pdu[1:] ATT_PDU.__init__(self, pdu)
return instance if hasattr(self, 'fields'):
self.init_from_bytes(pdu, 1)
return self
_PDU = TypeVar("_PDU", bound="ATT_PDU") @staticmethod
def pdu_name(op_code):
return name_or_number(ATT_PDU_NAMES, op_code, 2)
@classmethod @classmethod
def subclass(cls, subclass: type[_PDU]) -> type[_PDU]: def error_name(cls, error_code: int) -> str:
subclass.name = subclass.__name__.upper() return ErrorCode(error_code).name
subclass.op_code = Opcode[subclass.name]
subclass.fields = HCI_Object.fields_from_dataclass(subclass)
# Register a factory for this class @staticmethod
ATT_PDU.pdu_classes[subclass.op_code] = subclass def subclass(fields):
def inner(cls):
cls.name = cls.__name__.upper()
cls.op_code = key_with_value(ATT_PDU_NAMES, cls.name)
if cls.op_code is None:
raise KeyError(f'PDU name {cls.name} not found in ATT_PDU_NAMES')
cls.fields = fields
return subclass # Register a factory for this class
ATT_PDU.pdu_classes[cls.op_code] = cls
return cls
return inner
def __init__(self, pdu=None, **kwargs):
if hasattr(self, 'fields') and kwargs:
HCI_Object.init_from_fields(self, self.fields, kwargs)
if pdu is None:
pdu = bytes([self.op_code]) + HCI_Object.dict_to_bytes(kwargs, self.fields)
self.pdu = pdu
def init_from_bytes(self, pdu, offset): def init_from_bytes(self, pdu, offset):
return HCI_Object.init_from_bytes(self, pdu, offset, self.fields) return HCI_Object.init_from_bytes(self, pdu, offset, self.fields)
@@ -261,91 +313,67 @@ class ATT_PDU:
def has_authentication_signature(self): def has_authentication_signature(self):
return ((self.op_code >> 7) & 1) == 1 return ((self.op_code >> 7) & 1) == 1
@property def __bytes__(self):
def payload(self) -> bytes: return self.pdu
if self._payload is None:
self._payload = HCI_Object.dict_to_bytes(self.__dict__, self.fields)
return self._payload
@payload.setter
def payload(self, value: bytes):
self._payload = value
def __bytes__(self) -> bytes:
return bytes([self.op_code]) + self.payload
def __str__(self): def __str__(self):
result = color(self.name, 'yellow') result = color(self.name, 'yellow')
if fields := getattr(self, 'fields', None): if fields := getattr(self, 'fields', None):
result += ':\n' + HCI_Object.format_fields(self.__dict__, fields, ' ') result += ':\n' + HCI_Object.format_fields(self.__dict__, fields, ' ')
else: else:
if self.payload: if len(self.pdu) > 1:
result += f': {self.payload.hex()}' result += f': {self.pdu.hex()}'
return result return result
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('request_opcode_in_error', {'size': 1, 'mapper': ATT_PDU.pdu_name}),
('attribute_handle_in_error', HANDLE_FIELD_SPEC),
('error_code', {'size': 1, 'mapper': ATT_PDU.error_name}),
]
)
class ATT_Error_Response(ATT_PDU): class ATT_Error_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.1.1 Error Response See Bluetooth spec @ Vol 3, Part F - 3.4.1.1 Error Response
''' '''
request_opcode_in_error: int = dataclasses.field(metadata=Opcode.type_metadata(1))
attribute_handle_in_error: int = dataclasses.field(
metadata=hci.metadata(HANDLE_FIELD_SPEC)
)
error_code: int = dataclasses.field(metadata=ErrorCode.type_metadata(1))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('client_rx_mtu', 2)])
@dataclasses.dataclass
class ATT_Exchange_MTU_Request(ATT_PDU): class ATT_Exchange_MTU_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.2.1 Exchange MTU Request See Bluetooth spec @ Vol 3, Part F - 3.4.2.1 Exchange MTU Request
''' '''
client_rx_mtu: int = dataclasses.field(metadata=hci.metadata(2))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('server_rx_mtu', 2)])
@dataclasses.dataclass
class ATT_Exchange_MTU_Response(ATT_PDU): class ATT_Exchange_MTU_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.2.2 Exchange MTU Response See Bluetooth spec @ Vol 3, Part F - 3.4.2.2 Exchange MTU Response
''' '''
server_rx_mtu: int = dataclasses.field(metadata=hci.metadata(2))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [('starting_handle', HANDLE_FIELD_SPEC), ('ending_handle', HANDLE_FIELD_SPEC)]
)
class ATT_Find_Information_Request(ATT_PDU): class ATT_Find_Information_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.3.1 Find Information Request See Bluetooth spec @ Vol 3, Part F - 3.4.3.1 Find Information Request
''' '''
starting_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
ending_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('format', 1), ('information_data', '*')])
@dataclasses.dataclass
class ATT_Find_Information_Response(ATT_PDU): class ATT_Find_Information_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.3.2 Find Information Response See Bluetooth spec @ Vol 3, Part F - 3.4.3.2 Find Information Response
''' '''
format: int = dataclasses.field(metadata=hci.metadata(1)) def parse_information_data(self):
information_data: bytes = dataclasses.field(metadata=hci.metadata("*"))
information: list[tuple[int, bytes]] = dataclasses.field(init=False)
def __post_init__(self) -> None:
self.information = [] self.information = []
offset = 0 offset = 0
uuid_size = 2 if self.format == 1 else 16 uuid_size = 2 if self.format == 1 else 16
@@ -355,6 +383,14 @@ class ATT_Find_Information_Response(ATT_PDU):
self.information.append((handle, uuid)) self.information.append((handle, uuid))
offset += 2 + uuid_size offset += 2 + uuid_size
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.parse_information_data()
def init_from_bytes(self, pdu, offset):
super().init_from_bytes(pdu, offset)
self.parse_information_data()
def __str__(self): def __str__(self):
result = color(self.name, 'yellow') result = color(self.name, 'yellow')
result += ':\n' + HCI_Object.format_fields( result += ':\n' + HCI_Object.format_fields(
@@ -376,31 +412,28 @@ class ATT_Find_Information_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('starting_handle', HANDLE_FIELD_SPEC),
('ending_handle', HANDLE_FIELD_SPEC),
('attribute_type', UUID_2_FIELD_SPEC),
('attribute_value', '*'),
]
)
class ATT_Find_By_Type_Value_Request(ATT_PDU): class ATT_Find_By_Type_Value_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.3.3 Find By Type Value Request See Bluetooth spec @ Vol 3, Part F - 3.4.3.3 Find By Type Value Request
''' '''
starting_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
ending_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_type: UUID = dataclasses.field(metadata=hci.metadata(UUID.parse_uuid_2))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('handles_information_list', '*')])
@dataclasses.dataclass
class ATT_Find_By_Type_Value_Response(ATT_PDU): class ATT_Find_By_Type_Value_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.3.4 Find By Type Value Response See Bluetooth spec @ Vol 3, Part F - 3.4.3.4 Find By Type Value Response
''' '''
handles_information_list: bytes = dataclasses.field(metadata=hci.metadata("*")) def parse_handles_information_list(self):
handles_information: list[tuple[int, int]] = dataclasses.field(init=False)
def __post_init__(self) -> None:
self.handles_information = [] self.handles_information = []
offset = 0 offset = 0
while offset + 4 <= len(self.handles_information_list): while offset + 4 <= len(self.handles_information_list):
@@ -410,6 +443,14 @@ class ATT_Find_By_Type_Value_Response(ATT_PDU):
self.handles_information.append((found_attribute_handle, group_end_handle)) self.handles_information.append((found_attribute_handle, group_end_handle))
offset += 4 offset += 4
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.parse_handles_information_list()
def init_from_bytes(self, pdu, offset):
super().init_from_bytes(pdu, offset)
self.parse_handles_information_list()
def __str__(self): def __str__(self):
result = color(self.name, 'yellow') result = color(self.name, 'yellow')
result += ':\n' + HCI_Object.format_fields( result += ':\n' + HCI_Object.format_fields(
@@ -433,31 +474,27 @@ class ATT_Find_By_Type_Value_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('starting_handle', HANDLE_FIELD_SPEC),
('ending_handle', HANDLE_FIELD_SPEC),
('attribute_type', UUID_2_16_FIELD_SPEC),
]
)
class ATT_Read_By_Type_Request(ATT_PDU): class ATT_Read_By_Type_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.1 Read By Type Request See Bluetooth spec @ Vol 3, Part F - 3.4.4.1 Read By Type Request
''' '''
starting_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
ending_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_type: UUID = dataclasses.field(metadata=hci.metadata(UUID.parse_uuid))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('length', 1), ('attribute_data_list', '*')])
@dataclasses.dataclass
class ATT_Read_By_Type_Response(ATT_PDU): class ATT_Read_By_Type_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.2 Read By Type Response See Bluetooth spec @ Vol 3, Part F - 3.4.4.2 Read By Type Response
''' '''
length: int = dataclasses.field(metadata=hci.metadata(1)) def parse_attribute_data_list(self):
attribute_data_list: bytes = dataclasses.field(metadata=hci.metadata("*"))
attributes: list[tuple[int, bytes]] = dataclasses.field(init=False)
def __post_init__(self) -> None:
self.attributes = [] self.attributes = []
offset = 0 offset = 0
while self.length != 0 and offset + self.length <= len( while self.length != 0 and offset + self.length <= len(
@@ -472,6 +509,14 @@ class ATT_Read_By_Type_Response(ATT_PDU):
self.attributes.append((attribute_handle, attribute_value)) self.attributes.append((attribute_handle, attribute_value))
offset += self.length offset += self.length
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.parse_attribute_data_list()
def init_from_bytes(self, pdu, offset):
super().init_from_bytes(pdu, offset)
self.parse_attribute_data_list()
def __str__(self): def __str__(self):
result = color(self.name, 'yellow') result = color(self.name, 'yellow')
result += ':\n' + HCI_Object.format_fields( result += ':\n' + HCI_Object.format_fields(
@@ -493,100 +538,75 @@ class ATT_Read_By_Type_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC)])
@dataclasses.dataclass
class ATT_Read_Request(ATT_PDU): class ATT_Read_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.3 Read Request See Bluetooth spec @ Vol 3, Part F - 3.4.4.3 Read Request
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_value', '*')])
@dataclasses.dataclass
class ATT_Read_Response(ATT_PDU): class ATT_Read_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.4 Read Response See Bluetooth spec @ Vol 3, Part F - 3.4.4.4 Read Response
''' '''
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC), ('value_offset', 2)])
@dataclasses.dataclass
class ATT_Read_Blob_Request(ATT_PDU): class ATT_Read_Blob_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.5 Read Blob Request See Bluetooth spec @ Vol 3, Part F - 3.4.4.5 Read Blob Request
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
value_offset: int = dataclasses.field(metadata=hci.metadata(2))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('part_attribute_value', '*')])
@dataclasses.dataclass
class ATT_Read_Blob_Response(ATT_PDU): class ATT_Read_Blob_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.6 Read Blob Response See Bluetooth spec @ Vol 3, Part F - 3.4.4.6 Read Blob Response
''' '''
part_attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('set_of_handles', '*')])
@dataclasses.dataclass
class ATT_Read_Multiple_Request(ATT_PDU): class ATT_Read_Multiple_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.7 Read Multiple Request See Bluetooth spec @ Vol 3, Part F - 3.4.4.7 Read Multiple Request
''' '''
set_of_handles: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('set_of_values', '*')])
@dataclasses.dataclass
class ATT_Read_Multiple_Response(ATT_PDU): class ATT_Read_Multiple_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.8 Read Multiple Response See Bluetooth spec @ Vol 3, Part F - 3.4.4.8 Read Multiple Response
''' '''
set_of_values: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('starting_handle', HANDLE_FIELD_SPEC),
('ending_handle', HANDLE_FIELD_SPEC),
('attribute_group_type', UUID_2_16_FIELD_SPEC),
]
)
class ATT_Read_By_Group_Type_Request(ATT_PDU): class ATT_Read_By_Group_Type_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.9 Read by Group Type Request See Bluetooth spec @ Vol 3, Part F - 3.4.4.9 Read by Group Type Request
''' '''
starting_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
ending_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_group_type: UUID = dataclasses.field(
metadata=hci.metadata(UUID.parse_uuid)
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('length', 1), ('attribute_data_list', '*')])
@dataclasses.dataclass
class ATT_Read_By_Group_Type_Response(ATT_PDU): class ATT_Read_By_Group_Type_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.4.10 Read by Group Type Response See Bluetooth spec @ Vol 3, Part F - 3.4.4.10 Read by Group Type Response
''' '''
length: int = dataclasses.field(metadata=hci.metadata(1)) def parse_attribute_data_list(self):
attribute_data_list: bytes = dataclasses.field(metadata=hci.metadata("*"))
attributes: list[tuple[int, int, bytes]] = dataclasses.field(init=False)
def __post_init__(self) -> None:
self.attributes = [] self.attributes = []
offset = 0 offset = 0
while self.length != 0 and offset + self.length <= len( while self.length != 0 and offset + self.length <= len(
@@ -603,6 +623,14 @@ class ATT_Read_By_Group_Type_Response(ATT_PDU):
) )
offset += self.length offset += self.length
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.parse_attribute_data_list()
def init_from_bytes(self, pdu, offset):
super().init_from_bytes(pdu, offset)
self.parse_attribute_data_list()
def __str__(self): def __str__(self):
result = color(self.name, 'yellow') result = color(self.name, 'yellow')
result += ':\n' + HCI_Object.format_fields( result += ':\n' + HCI_Object.format_fields(
@@ -627,20 +655,15 @@ class ATT_Read_By_Group_Type_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC), ('attribute_value', '*')])
@dataclasses.dataclass
class ATT_Write_Request(ATT_PDU): class ATT_Write_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.5.1 Write Request See Bluetooth spec @ Vol 3, Part F - 3.4.5.1 Write Request
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([])
@dataclasses.dataclass
class ATT_Write_Response(ATT_PDU): class ATT_Write_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.5.2 Write Response See Bluetooth spec @ Vol 3, Part F - 3.4.5.2 Write Response
@@ -648,70 +671,65 @@ class ATT_Write_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC), ('attribute_value', '*')])
@dataclasses.dataclass
class ATT_Write_Command(ATT_PDU): class ATT_Write_Command(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.5.3 Write Command See Bluetooth spec @ Vol 3, Part F - 3.4.5.3 Write Command
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('attribute_handle', HANDLE_FIELD_SPEC),
('attribute_value', '*'),
# ('authentication_signature', 'TODO')
]
)
class ATT_Signed_Write_Command(ATT_PDU): class ATT_Signed_Write_Command(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.5.4 Signed Write Command See Bluetooth spec @ Vol 3, Part F - 3.4.5.4 Signed Write Command
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# TODO: authentication_signature
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('attribute_handle', HANDLE_FIELD_SPEC),
('value_offset', 2),
('part_attribute_value', '*'),
]
)
class ATT_Prepare_Write_Request(ATT_PDU): class ATT_Prepare_Write_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.6.1 Prepare Write Request See Bluetooth spec @ Vol 3, Part F - 3.4.6.1 Prepare Write Request
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
value_offset: int = dataclasses.field(metadata=hci.metadata(2))
part_attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass(
@dataclasses.dataclass [
('attribute_handle', HANDLE_FIELD_SPEC),
('value_offset', 2),
('part_attribute_value', '*'),
]
)
class ATT_Prepare_Write_Response(ATT_PDU): class ATT_Prepare_Write_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.6.2 Prepare Write Response See Bluetooth spec @ Vol 3, Part F - 3.4.6.2 Prepare Write Response
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
value_offset: int = dataclasses.field(metadata=hci.metadata(2))
part_attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([("flags", 1)])
@dataclasses.dataclass
class ATT_Execute_Write_Request(ATT_PDU): class ATT_Execute_Write_Request(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.6.3 Execute Write Request See Bluetooth spec @ Vol 3, Part F - 3.4.6.3 Execute Write Request
''' '''
flags: int = dataclasses.field(metadata=hci.metadata(1))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([])
@dataclasses.dataclass
class ATT_Execute_Write_Response(ATT_PDU): class ATT_Execute_Write_Response(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.6.4 Execute Write Response See Bluetooth spec @ Vol 3, Part F - 3.4.6.4 Execute Write Response
@@ -719,32 +737,23 @@ class ATT_Execute_Write_Response(ATT_PDU):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC), ('attribute_value', '*')])
@dataclasses.dataclass
class ATT_Handle_Value_Notification(ATT_PDU): class ATT_Handle_Value_Notification(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.7.1 Handle Value Notification See Bluetooth spec @ Vol 3, Part F - 3.4.7.1 Handle Value Notification
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([('attribute_handle', HANDLE_FIELD_SPEC), ('attribute_value', '*')])
@dataclasses.dataclass
class ATT_Handle_Value_Indication(ATT_PDU): class ATT_Handle_Value_Indication(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.7.2 Handle Value Indication See Bluetooth spec @ Vol 3, Part F - 3.4.7.2 Handle Value Indication
''' '''
attribute_handle: int = dataclasses.field(metadata=hci.metadata(HANDLE_FIELD_SPEC))
attribute_value: bytes = dataclasses.field(metadata=hci.metadata("*"))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ATT_PDU.subclass @ATT_PDU.subclass([])
@dataclasses.dataclass
class ATT_Handle_Value_Confirmation(ATT_PDU): class ATT_Handle_Value_Confirmation(ATT_PDU):
''' '''
See Bluetooth spec @ Vol 3, Part F - 3.4.7.3 Handle Value Confirmation See Bluetooth spec @ Vol 3, Part F - 3.4.7.3 Handle Value Confirmation
@@ -761,25 +770,27 @@ class AttributeValue(Generic[_T]):
def __init__( def __init__(
self, self,
read: Union[ read: Union[
Callable[[Connection], _T], Callable[[Optional[Connection]], _T],
Callable[[Connection], Awaitable[_T]], Callable[[Optional[Connection]], Awaitable[_T]],
None, None,
] = None, ] = None,
write: Union[ write: Union[
Callable[[Connection, _T], None], Callable[[Optional[Connection], _T], None],
Callable[[Connection, _T], Awaitable[None]], Callable[[Optional[Connection], _T], Awaitable[None]],
None, None,
] = None, ] = None,
): ):
self._read = read self._read = read
self._write = write self._write = write
def read(self, connection: Connection) -> Union[_T, Awaitable[_T]]: def read(self, connection: Optional[Connection]) -> Union[_T, Awaitable[_T]]:
if self._read is None: if self._read is None:
raise InvalidOperationError('AttributeValue has no read function') raise InvalidOperationError('AttributeValue has no read function')
return self._read(connection) return self._read(connection)
def write(self, connection: Connection, value: _T) -> Union[Awaitable[None], None]: def write(
self, connection: Optional[Connection], value: _T
) -> Union[Awaitable[None], None]:
if self._write is None: if self._write is None:
raise InvalidOperationError('AttributeValue has no write function') raise InvalidOperationError('AttributeValue has no write function')
return self._write(connection, value) return self._write(connection, value)
@@ -809,7 +820,7 @@ class Attribute(utils.EventEmitter, Generic[_T]):
# The check for `p.name is not None` here is needed because for InFlag # The check for `p.name is not None` here is needed because for InFlag
# enums, the .name property can be None, when the enum value is 0, # enums, the .name property can be None, when the enum value is 0,
# so the type hint for .name is Optional[str]. # so the type hint for .name is Optional[str].
enum_list: list[str] = [p.name for p in cls if p.name is not None] enum_list: List[str] = [p.name for p in cls if p.name is not None]
enum_list_str = ",".join(enum_list) enum_list_str = ",".join(enum_list)
raise TypeError( raise TypeError(
f"Attribute::permissions error:\nExpected a string containing any of the keys, separated by commas: {enum_list_str}\nGot: {permissions_str}" f"Attribute::permissions error:\nExpected a string containing any of the keys, separated by commas: {enum_list_str}\nGot: {permissions_str}"
@@ -860,7 +871,7 @@ class Attribute(utils.EventEmitter, Generic[_T]):
def decode_value(self, value: bytes) -> _T: def decode_value(self, value: bytes) -> _T:
return value # type: ignore return value # type: ignore
async def read_value(self, connection: Connection) -> bytes: async def read_value(self, connection: Optional[Connection]) -> bytes:
if ( if (
(self.permissions & self.READ_REQUIRES_ENCRYPTION) (self.permissions & self.READ_REQUIRES_ENCRYPTION)
and connection is not None and connection is not None
@@ -902,7 +913,7 @@ class Attribute(utils.EventEmitter, Generic[_T]):
return b'' if value is None else self.encode_value(value) return b'' if value is None else self.encode_value(value)
async def write_value(self, connection: Connection, value: bytes) -> None: async def write_value(self, connection: Optional[Connection], value: bytes) -> None:
if ( if (
(self.permissions & self.WRITE_REQUIRES_ENCRYPTION) (self.permissions & self.WRITE_REQUIRES_ENCRYPTION)
and connection is not None and connection is not None
+9 -5
View File
@@ -17,16 +17,20 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import abc
import asyncio import asyncio
import abc
from concurrent.futures import ThreadPoolExecutor
import dataclasses import dataclasses
import enum import enum
import logging import logging
import pathlib import pathlib
from typing import (
AsyncGenerator,
BinaryIO,
TYPE_CHECKING,
)
import sys import sys
import wave import wave
from concurrent.futures import ThreadPoolExecutor
from typing import TYPE_CHECKING, AsyncGenerator, BinaryIO
from bumble.colors import color from bumble.colors import color
@@ -226,8 +230,8 @@ class SoundDeviceAudioOutput(ThreadedAudioOutput):
try: try:
self._stream.write(pcm_samples) self._stream.write(pcm_samples)
except Exception: except Exception as error:
logger.exception('Sound device error') print(f'Sound device error: {error}')
raise raise
def _close(self): def _close(self):
+9 -9
View File
@@ -16,12 +16,12 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import enum import enum
import struct import struct
from typing import Union from typing import Dict, Type, Union, Tuple
from bumble import core, utils from bumble import core
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -213,11 +213,11 @@ class CommandFrame(Frame):
NOTIFY = 0x03 NOTIFY = 0x03
GENERAL_INQUIRY = 0x04 GENERAL_INQUIRY = 0x04
subclasses: dict[Frame.OperationCode, type[CommandFrame]] = {} subclasses: Dict[Frame.OperationCode, Type[CommandFrame]] = {}
ctype: CommandType ctype: CommandType
@staticmethod @staticmethod
def parse_operands(operands: bytes) -> tuple: def parse_operands(operands: bytes) -> Tuple:
raise NotImplementedError raise NotImplementedError
def __init__( def __init__(
@@ -251,11 +251,11 @@ class ResponseFrame(Frame):
CHANGED = 0x0D CHANGED = 0x0D
INTERIM = 0x0F INTERIM = 0x0F
subclasses: dict[Frame.OperationCode, type[ResponseFrame]] = {} subclasses: Dict[Frame.OperationCode, Type[ResponseFrame]] = {}
response: ResponseCode response: ResponseCode
@staticmethod @staticmethod
def parse_operands(operands: bytes) -> tuple: def parse_operands(operands: bytes) -> Tuple:
raise NotImplementedError raise NotImplementedError
def __init__( def __init__(
@@ -282,7 +282,7 @@ class VendorDependentFrame:
vendor_dependent_data: bytes vendor_dependent_data: bytes
@staticmethod @staticmethod
def parse_operands(operands: bytes) -> tuple: def parse_operands(operands: bytes) -> Tuple:
return ( return (
struct.unpack(">I", b"\x00" + operands[:3])[0], struct.unpack(">I", b"\x00" + operands[:3])[0],
operands[3:], operands[3:],
@@ -432,7 +432,7 @@ class PassThroughFrame:
operation_data: bytes operation_data: bytes
@staticmethod @staticmethod
def parse_operands(operands: bytes) -> tuple: def parse_operands(operands: bytes) -> Tuple:
return ( return (
PassThroughFrame.StateFlag(operands[0] >> 7), PassThroughFrame.StateFlag(operands[0] >> 7),
PassThroughFrame.OperationId(operands[0] & 0x7F), PassThroughFrame.OperationId(operands[0] & 0x7F),
+9 -8
View File
@@ -16,14 +16,15 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
from enum import IntEnum
import logging import logging
import struct import struct
from enum import IntEnum from typing import Callable, cast, Dict, Optional
from typing import Callable, Optional, cast
from bumble import avc, core, l2cap
from bumble.colors import color from bumble.colors import color
from bumble import avc
from bumble import core
from bumble import l2cap
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -136,8 +137,8 @@ class MessageAssembler:
self.pid, self.pid,
self.payload, self.payload,
) )
except Exception: except Exception as error:
logger.exception(color("!!! exception in callback", "red")) logger.exception(color(f"!!! exception in callback: {error}", "red"))
self.reset() self.reset()
@@ -145,9 +146,9 @@ class MessageAssembler:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Protocol: class Protocol:
CommandHandler = Callable[[int, avc.CommandFrame], None] CommandHandler = Callable[[int, avc.CommandFrame], None]
command_handlers: dict[int, CommandHandler] # Command handlers, by PID command_handlers: Dict[int, CommandHandler] # Command handlers, by PID
ResponseHandler = Callable[[int, Optional[avc.ResponseFrame]], None] ResponseHandler = Callable[[int, Optional[avc.ResponseFrame]], None]
response_handlers: dict[int, ResponseHandler] # Response handlers, by PID response_handlers: Dict[int, ResponseHandler] # Response handlers, by PID
next_transaction_label: int next_transaction_label: int
message_assembler: MessageAssembler message_assembler: MessageAssembler
+43 -36
View File
@@ -16,25 +16,35 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import enum
import logging
import time import time
import logging
import enum
import warnings import warnings
from typing import ( from typing import (
Any, Any,
AsyncGenerator,
Awaitable, Awaitable,
Callable, Dict,
Iterable, Type,
Tuple,
Optional, Optional,
SupportsBytes, Callable,
List,
AsyncGenerator,
Iterable,
Union, Union,
SupportsBytes,
cast, cast,
) )
from bumble import device, l2cap, sdp, utils
from bumble.core import (
BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE,
InvalidStateError,
ProtocolError,
InvalidArgumentError,
name_or_number,
)
from bumble.a2dp import ( from bumble.a2dp import (
A2DP_CODEC_TYPE_NAMES, A2DP_CODEC_TYPE_NAMES,
A2DP_MPEG_2_4_AAC_CODEC_TYPE, A2DP_MPEG_2_4_AAC_CODEC_TYPE,
@@ -45,15 +55,10 @@ from bumble.a2dp import (
SbcMediaCodecInformation, SbcMediaCodecInformation,
VendorSpecificMediaCodecInformation, VendorSpecificMediaCodecInformation,
) )
from bumble.colors import color
from bumble.core import (
BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE,
InvalidArgumentError,
InvalidStateError,
ProtocolError,
name_or_number,
)
from bumble.rtp import MediaPacket from bumble.rtp import MediaPacket
from bumble import sdp, device, l2cap, utils
from bumble.colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -222,7 +227,7 @@ AVDTP_STATE_NAMES = {
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def find_avdtp_service_with_sdp_client( async def find_avdtp_service_with_sdp_client(
sdp_client: sdp.Client, sdp_client: sdp.Client,
) -> Optional[tuple[int, int]]: ) -> Optional[Tuple[int, int]]:
''' '''
Find an AVDTP service, using a connected SDP client, and return its version, Find an AVDTP service, using a connected SDP client, and return its version,
or None if none is found or None if none is found
@@ -252,7 +257,7 @@ async def find_avdtp_service_with_sdp_client(
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def find_avdtp_service_with_connection( async def find_avdtp_service_with_connection(
connection: device.Connection, connection: device.Connection,
) -> Optional[tuple[int, int]]: ) -> Optional[Tuple[int, int]]:
''' '''
Find an AVDTP service, for a connection, and return its version, Find an AVDTP service, for a connection, and return its version,
or None if none is found or None if none is found
@@ -433,8 +438,8 @@ class MessageAssembler:
) )
try: try:
self.callback(self.transaction_label, message) self.callback(self.transaction_label, message)
except Exception: except Exception as error:
logger.exception(color('!!! exception in callback', 'red')) logger.exception(color(f'!!! exception in callback: {error}', 'red'))
self.reset() self.reset()
@@ -446,7 +451,7 @@ class ServiceCapabilities:
service_category: int, service_capabilities_bytes: bytes service_category: int, service_capabilities_bytes: bytes
) -> ServiceCapabilities: ) -> ServiceCapabilities:
# Select the appropriate subclass # Select the appropriate subclass
cls: type[ServiceCapabilities] cls: Type[ServiceCapabilities]
if service_category == AVDTP_MEDIA_CODEC_SERVICE_CATEGORY: if service_category == AVDTP_MEDIA_CODEC_SERVICE_CATEGORY:
cls = MediaCodecCapabilities cls = MediaCodecCapabilities
else: else:
@@ -461,7 +466,7 @@ class ServiceCapabilities:
return instance return instance
@staticmethod @staticmethod
def parse_capabilities(payload: bytes) -> list[ServiceCapabilities]: def parse_capabilities(payload: bytes) -> List[ServiceCapabilities]:
capabilities = [] capabilities = []
while payload: while payload:
service_category = payload[0] service_category = payload[0]
@@ -494,7 +499,7 @@ class ServiceCapabilities:
self.service_category = service_category self.service_category = service_category
self.service_capabilities_bytes = service_capabilities_bytes self.service_capabilities_bytes = service_capabilities_bytes
def to_string(self, details: Optional[list[str]] = None) -> str: def to_string(self, details: Optional[List[str]] = None) -> str:
attributes = ','.join( attributes = ','.join(
[name_or_number(AVDTP_SERVICE_CATEGORY_NAMES, self.service_category)] [name_or_number(AVDTP_SERVICE_CATEGORY_NAMES, self.service_category)]
+ (details or []) + (details or [])
@@ -607,7 +612,7 @@ class Message: # pylint:disable=attribute-defined-outside-init
RESPONSE_REJECT = 3 RESPONSE_REJECT = 3
# Subclasses, by signal identifier and message type # Subclasses, by signal identifier and message type
subclasses: dict[int, dict[int, type[Message]]] = {} subclasses: Dict[int, Dict[int, Type[Message]]] = {}
message_type: MessageType message_type: MessageType
signal_identifier: int signal_identifier: int
@@ -752,7 +757,7 @@ class Discover_Response(Message):
See Bluetooth AVDTP spec - 8.6.2 Stream End Point Discovery Response See Bluetooth AVDTP spec - 8.6.2 Stream End Point Discovery Response
''' '''
endpoints: list[EndPointInfo] endpoints: List[EndPointInfo]
def init_from_payload(self): def init_from_payload(self):
self.endpoints = [] self.endpoints = []
@@ -1197,10 +1202,10 @@ class DelayReport_Reject(Simple_Reject):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Protocol(utils.EventEmitter): class Protocol(utils.EventEmitter):
local_endpoints: list[LocalStreamEndPoint] local_endpoints: List[LocalStreamEndPoint]
remote_endpoints: dict[int, DiscoveredStreamEndPoint] remote_endpoints: Dict[int, DiscoveredStreamEndPoint]
streams: dict[int, Stream] streams: Dict[int, Stream]
transaction_results: list[Optional[asyncio.Future[Message]]] transaction_results: List[Optional[asyncio.Future[Message]]]
channel_connector: Callable[[], Awaitable[l2cap.ClassicChannel]] channel_connector: Callable[[], Awaitable[l2cap.ClassicChannel]]
EVENT_OPEN = "open" EVENT_OPEN = "open"
@@ -1218,7 +1223,7 @@ class Protocol(utils.EventEmitter):
@staticmethod @staticmethod
async def connect( async def connect(
connection: device.Connection, version: tuple[int, int] = (1, 3) connection: device.Connection, version: Tuple[int, int] = (1, 3)
) -> Protocol: ) -> Protocol:
channel = await connection.create_l2cap_channel( channel = await connection.create_l2cap_channel(
spec=l2cap.ClassicChannelSpec(psm=AVDTP_PSM) spec=l2cap.ClassicChannelSpec(psm=AVDTP_PSM)
@@ -1228,7 +1233,7 @@ class Protocol(utils.EventEmitter):
return protocol return protocol
def __init__( def __init__(
self, l2cap_channel: l2cap.ClassicChannel, version: tuple[int, int] = (1, 3) self, l2cap_channel: l2cap.ClassicChannel, version: Tuple[int, int] = (1, 3)
) -> None: ) -> None:
super().__init__() super().__init__()
self.l2cap_channel = l2cap_channel self.l2cap_channel = l2cap_channel
@@ -1399,8 +1404,10 @@ class Protocol(utils.EventEmitter):
try: try:
response = handler(message) response = handler(message)
self.send_message(transaction_label, response) self.send_message(transaction_label, response)
except Exception: except Exception as error:
logger.exception(color("!!! Exception in handler:", "red")) logger.warning(
f'{color("!!! Exception in handler:", "red")} {error}'
)
else: else:
logger.warning('unhandled command') logger.warning('unhandled command')
else: else:
@@ -1495,7 +1502,7 @@ class Protocol(utils.EventEmitter):
return response return response
async def start_transaction(self) -> tuple[int, asyncio.Future[Message]]: async def start_transaction(self) -> Tuple[int, asyncio.Future[Message]]:
# Wait until we can start a new transaction # Wait until we can start a new transaction
await self.transaction_semaphore.acquire() await self.transaction_semaphore.acquire()
@@ -1696,7 +1703,7 @@ class Protocol(utils.EventEmitter):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Listener(utils.EventEmitter): class Listener(utils.EventEmitter):
servers: dict[int, Protocol] servers: Dict[int, Protocol]
EVENT_CONNECTION = "connection" EVENT_CONNECTION = "connection"
@@ -1728,7 +1735,7 @@ class Listener(utils.EventEmitter):
@classmethod @classmethod
def for_device( def for_device(
cls, device: device.Device, version: tuple[int, int] = (1, 3) cls, device: device.Device, version: Tuple[int, int] = (1, 3)
) -> Listener: ) -> Listener:
listener = Listener(registrar=None, version=version) listener = Listener(registrar=None, version=version)
l2cap_server = device.create_l2cap_server( l2cap_server = device.create_l2cap_server(
+674 -1170
View File
File diff suppressed because it is too large Load Diff
-2
View File
@@ -16,9 +16,7 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
from dataclasses import dataclass from dataclasses import dataclass
from typing_extensions import Self from typing_extensions import Self
from bumble import core from bumble import core
+2 -2
View File
@@ -13,7 +13,7 @@
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
from functools import partial from functools import partial
from typing import Optional, Union from typing import List, Optional, Union
class ColorError(ValueError): class ColorError(ValueError):
@@ -65,7 +65,7 @@ def color(
bg: Optional[ColorSpec] = None, bg: Optional[ColorSpec] = None,
style: Optional[str] = None, style: Optional[str] = None,
) -> str: ) -> str:
codes: list[ColorSpec] = [] codes: List[ColorSpec] = []
if fg: if fg:
codes.append(_color_code(fg, 30)) codes.append(_color_code(fg, 30))
+56 -224
View File
@@ -17,32 +17,34 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import logging
import asyncio import asyncio
import dataclasses import dataclasses
import itertools import itertools
import logging
import random import random
import struct import struct
from typing import TYPE_CHECKING, Any, Optional, Union
from bumble import hci
from bumble.colors import color from bumble.colors import color
from bumble.core import PhysicalTransport from bumble.core import (
PhysicalTransport,
)
from bumble.hci import ( from bumble.hci import (
HCI_ACL_DATA_PACKET, HCI_ACL_DATA_PACKET,
HCI_COMMAND_DISALLOWED_ERROR, HCI_COMMAND_DISALLOWED_ERROR,
HCI_COMMAND_PACKET, HCI_COMMAND_PACKET,
HCI_COMMAND_STATUS_PENDING, HCI_COMMAND_STATUS_PENDING,
HCI_CONNECTION_TIMEOUT_ERROR,
HCI_CONTROLLER_BUSY_ERROR, HCI_CONTROLLER_BUSY_ERROR,
HCI_EVENT_PACKET, HCI_EVENT_PACKET,
HCI_INVALID_HCI_COMMAND_PARAMETERS_ERROR, HCI_INVALID_HCI_COMMAND_PARAMETERS_ERROR,
HCI_LE_1M_PHY, HCI_LE_1M_PHY,
HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR,
HCI_SUCCESS, HCI_SUCCESS,
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
HCI_UNKNOWN_HCI_COMMAND_ERROR, HCI_UNKNOWN_HCI_COMMAND_ERROR,
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR,
HCI_VERSION_BLUETOOTH_CORE_5_0, HCI_VERSION_BLUETOOTH_CORE_5_0,
Address, Address,
Role,
HCI_AclDataPacket, HCI_AclDataPacket,
HCI_AclDataPacketAssembler, HCI_AclDataPacketAssembler,
HCI_Command_Complete_Event, HCI_Command_Complete_Event,
@@ -51,6 +53,7 @@ from bumble.hci import (
HCI_Connection_Request_Event, HCI_Connection_Request_Event,
HCI_Disconnection_Complete_Event, HCI_Disconnection_Complete_Event,
HCI_Encryption_Change_Event, HCI_Encryption_Change_Event,
HCI_Synchronous_Connection_Complete_Event,
HCI_LE_Advertising_Report_Event, HCI_LE_Advertising_Report_Event,
HCI_LE_CIS_Established_Event, HCI_LE_CIS_Established_Event,
HCI_LE_CIS_Request_Event, HCI_LE_CIS_Request_Event,
@@ -59,9 +62,8 @@ from bumble.hci import (
HCI_Number_Of_Completed_Packets_Event, HCI_Number_Of_Completed_Packets_Event,
HCI_Packet, HCI_Packet,
HCI_Role_Change_Event, HCI_Role_Change_Event,
HCI_Synchronous_Connection_Complete_Event,
Role,
) )
from typing import Optional, Union, Dict, Any, TYPE_CHECKING
if TYPE_CHECKING: if TYPE_CHECKING:
from bumble.link import LocalLink from bumble.link import LocalLink
@@ -87,7 +89,6 @@ class CisLink:
cis_id: int cis_id: int
cig_id: int cig_id: int
acl_connection: Optional[Connection] = None acl_connection: Optional[Connection] = None
data_paths: set[int] = dataclasses.field(default_factory=set)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -107,9 +108,7 @@ class Connection:
def on_hci_acl_data_packet(self, packet): def on_hci_acl_data_packet(self, packet):
self.assembler.feed_packet(packet) self.assembler.feed_packet(packet)
self.controller.send_hci_packet( self.controller.send_hci_packet(
HCI_Number_Of_Completed_Packets_Event( HCI_Number_Of_Completed_Packets_Event([(self.handle, 1)])
connection_handles=[self.handle], num_completed_packets=[1]
)
) )
def on_acl_pdu(self, data): def on_acl_pdu(self, data):
@@ -133,17 +132,17 @@ class Controller:
self.hci_sink = None self.hci_sink = None
self.link = link self.link = link
self.central_connections: dict[Address, Connection] = ( self.central_connections: Dict[Address, Connection] = (
{} {}
) # Connections where this controller is the central ) # Connections where this controller is the central
self.peripheral_connections: dict[Address, Connection] = ( self.peripheral_connections: Dict[Address, Connection] = (
{} {}
) # Connections where this controller is the peripheral ) # Connections where this controller is the peripheral
self.classic_connections: dict[Address, Connection] = ( self.classic_connections: Dict[Address, Connection] = (
{} {}
) # Connections in BR/EDR ) # Connections in BR/EDR
self.central_cis_links: dict[int, CisLink] = {} # CIS links by handle self.central_cis_links: Dict[int, CisLink] = {} # CIS links by handle
self.peripheral_cis_links: dict[int, CisLink] = {} # CIS links by handle self.peripheral_cis_links: Dict[int, CisLink] = {} # CIS links by handle
self.hci_version = HCI_VERSION_BLUETOOTH_CORE_5_0 self.hci_version = HCI_VERSION_BLUETOOTH_CORE_5_0
self.hci_revision = 0 self.hci_revision = 0
@@ -369,23 +368,12 @@ class Controller:
return connection return connection
return None return None
def find_peripheral_connection_by_handle(self, handle):
for connection in self.peripheral_connections.values():
if connection.handle == handle:
return connection
return None
def find_classic_connection_by_handle(self, handle): def find_classic_connection_by_handle(self, handle):
for connection in self.classic_connections.values(): for connection in self.classic_connections.values():
if connection.handle == handle: if connection.handle == handle:
return connection return connection
return None return None
def find_iso_link_by_handle(self, handle: int) -> Optional[CisLink]:
return self.central_cis_links.get(handle) or self.peripheral_cis_links.get(
handle
)
def on_link_central_connected(self, central_address): def on_link_central_connected(self, central_address):
''' '''
Called when an incoming connection occurs from a central on the link Called when an incoming connection occurs from a central on the link
@@ -404,7 +392,7 @@ class Controller:
peer_address=peer_address, peer_address=peer_address,
link=self.link, link=self.link,
transport=PhysicalTransport.LE, transport=PhysicalTransport.LE,
link_type=HCI_Connection_Complete_Event.LinkType.ACL, link_type=HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
self.peripheral_connections[peer_address] = connection self.peripheral_connections[peer_address] = connection
logger.debug(f'New PERIPHERAL connection handle: 0x{connection_handle:04X}') logger.debug(f'New PERIPHERAL connection handle: 0x{connection_handle:04X}')
@@ -424,7 +412,7 @@ class Controller:
) )
) )
def on_link_disconnected(self, peer_address, reason): def on_link_central_disconnected(self, peer_address, reason):
''' '''
Called when an active disconnection occurs from a peer Called when an active disconnection occurs from a peer
''' '''
@@ -441,17 +429,6 @@ class Controller:
# Remove the connection # Remove the connection
del self.peripheral_connections[peer_address] del self.peripheral_connections[peer_address]
elif connection := self.central_connections.get(peer_address):
self.send_hci_packet(
HCI_Disconnection_Complete_Event(
status=HCI_SUCCESS,
connection_handle=connection.handle,
reason=reason,
)
)
# Remove the connection
del self.central_connections[peer_address]
else: else:
logger.warning(f'!!! No peripheral connection found for {peer_address}') logger.warning(f'!!! No peripheral connection found for {peer_address}')
@@ -475,7 +452,7 @@ class Controller:
peer_address=peer_address, peer_address=peer_address,
link=self.link, link=self.link,
transport=PhysicalTransport.LE, transport=PhysicalTransport.LE,
link_type=HCI_Connection_Complete_Event.LinkType.ACL, link_type=HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
self.central_connections[peer_address] = connection self.central_connections[peer_address] = connection
logger.debug( logger.debug(
@@ -500,7 +477,7 @@ class Controller:
) )
) )
def on_link_disconnection_complete(self, disconnection_command, status): def on_link_peripheral_disconnection_complete(self, disconnection_command, status):
''' '''
Called when a disconnection has been completed Called when a disconnection has been completed
''' '''
@@ -520,11 +497,26 @@ class Controller:
): ):
logger.debug(f'CENTRAL Connection removed: {connection}') logger.debug(f'CENTRAL Connection removed: {connection}')
del self.central_connections[connection.peer_address] del self.central_connections[connection.peer_address]
elif connection := self.find_peripheral_connection_by_handle(
disconnection_command.connection_handle def on_link_peripheral_disconnected(self, peer_address):
): '''
logger.debug(f'PERIPHERAL Connection removed: {connection}') Called when a connection to a peripheral is broken
del self.peripheral_connections[connection.peer_address] '''
# Send a disconnection complete event
if connection := self.central_connections.get(peer_address):
self.send_hci_packet(
HCI_Disconnection_Complete_Event(
status=HCI_SUCCESS,
connection_handle=connection.handle,
reason=HCI_CONNECTION_TIMEOUT_ERROR,
)
)
# Remove the connection
del self.central_connections[peer_address]
else:
logger.warning(f'!!! No central connection found for {peer_address}')
def on_link_encrypted(self, peer_address, _rand, _ediv, _ltk): def on_link_encrypted(self, peer_address, _rand, _ediv, _ltk):
# For now, just setup the encryption without asking the host # For now, just setup the encryption without asking the host
@@ -550,14 +542,15 @@ class Controller:
acl_packet = HCI_AclDataPacket(connection.handle, 2, 0, len(data), data) acl_packet = HCI_AclDataPacket(connection.handle, 2, 0, len(data), data)
self.send_hci_packet(acl_packet) self.send_hci_packet(acl_packet)
def on_link_advertising_data(self, sender_address: Address, data: bytes): def on_link_advertising_data(self, sender_address, data):
# Ignore if we're not scanning # Ignore if we're not scanning
if self.le_scan_enable == 0: if self.le_scan_enable == 0:
return return
# Send a scan report # Send a scan report
report = HCI_LE_Advertising_Report_Event.Report( report = HCI_LE_Advertising_Report_Event.Report(
event_type=HCI_LE_Advertising_Report_Event.EventType.ADV_IND, HCI_LE_Advertising_Report_Event.Report.FIELDS,
event_type=HCI_LE_Advertising_Report_Event.ADV_IND,
address_type=sender_address.address_type, address_type=sender_address.address_type,
address=sender_address, address=sender_address,
data=data, data=data,
@@ -567,7 +560,8 @@ class Controller:
# Simulate a scan response # Simulate a scan response
report = HCI_LE_Advertising_Report_Event.Report( report = HCI_LE_Advertising_Report_Event.Report(
event_type=HCI_LE_Advertising_Report_Event.EventType.SCAN_RSP, HCI_LE_Advertising_Report_Event.Report.FIELDS,
event_type=HCI_LE_Advertising_Report_Event.SCAN_RSP,
address_type=sender_address.address_type, address_type=sender_address.address_type,
address=sender_address, address=sender_address,
data=data, data=data,
@@ -624,8 +618,8 @@ class Controller:
cis_sync_delay=0, cis_sync_delay=0,
transport_latency_c_to_p=0, transport_latency_c_to_p=0,
transport_latency_p_to_c=0, transport_latency_p_to_c=0,
phy_c_to_p=1, phy_c_to_p=0,
phy_p_to_c=1, phy_p_to_c=0,
nse=0, nse=0,
bn_c_to_p=0, bn_c_to_p=0,
bn_p_to_c=0, bn_p_to_c=0,
@@ -701,7 +695,7 @@ class Controller:
peer_address=peer_address, peer_address=peer_address,
link=self.link, link=self.link,
transport=PhysicalTransport.BR_EDR, transport=PhysicalTransport.BR_EDR,
link_type=HCI_Connection_Complete_Event.LinkType.ACL, link_type=HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
self.classic_connections[peer_address] = connection self.classic_connections[peer_address] = connection
logger.debug( logger.debug(
@@ -715,7 +709,7 @@ class Controller:
connection_handle=connection_handle, connection_handle=connection_handle,
bd_addr=peer_address, bd_addr=peer_address,
encryption_enabled=False, encryption_enabled=False,
link_type=HCI_Connection_Complete_Event.LinkType.ACL, link_type=HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
) )
else: else:
@@ -726,7 +720,7 @@ class Controller:
connection_handle=0, connection_handle=0,
bd_addr=peer_address, bd_addr=peer_address,
encryption_enabled=False, encryption_enabled=False,
link_type=HCI_Connection_Complete_Event.LinkType.ACL, link_type=HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
) )
@@ -883,14 +877,6 @@ class Controller:
else: else:
# Remove the connection # Remove the connection
del self.central_connections[connection.peer_address] del self.central_connections[connection.peer_address]
elif connection := self.find_peripheral_connection_by_handle(handle):
if self.link:
self.link.disconnect(
self.random_address, connection.peer_address, command
)
else:
# Remove the connection
del self.peripheral_connections[connection.peer_address]
elif connection := self.find_classic_connection_by_handle(handle): elif connection := self.find_classic_connection_by_handle(handle):
if self.link: if self.link:
self.link.classic_disconnect( self.link.classic_disconnect(
@@ -959,7 +945,7 @@ class Controller:
) )
) )
self.link.classic_sco_connect( self.link.classic_sco_connect(
self, connection.peer_address, HCI_Connection_Complete_Event.LinkType.ESCO self, connection.peer_address, HCI_Connection_Complete_Event.ESCO_LINK_TYPE
) )
def on_hci_enhanced_accept_synchronous_connection_request_command(self, command): def on_hci_enhanced_accept_synchronous_connection_request_command(self, command):
@@ -988,71 +974,10 @@ class Controller:
) )
) )
self.link.classic_accept_sco_connection( self.link.classic_accept_sco_connection(
self, connection.peer_address, HCI_Connection_Complete_Event.LinkType.ESCO self, connection.peer_address, HCI_Connection_Complete_Event.ESCO_LINK_TYPE
) )
def on_hci_sniff_mode_command(self, command: hci.HCI_Sniff_Mode_Command): def on_hci_switch_role_command(self, command):
'''
See Bluetooth spec Vol 4, Part E - 7.2.2 Sniff Mode command
'''
if self.link is None:
self.send_hci_packet(
hci.HCI_Command_Status_Event(
status=hci.HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
num_hci_command_packets=1,
command_opcode=command.op_code,
)
)
return
self.send_hci_packet(
hci.HCI_Command_Status_Event(
status=HCI_SUCCESS,
num_hci_command_packets=1,
command_opcode=command.op_code,
)
)
self.send_hci_packet(
hci.HCI_Mode_Change_Event(
status=HCI_SUCCESS,
connection_handle=command.connection_handle,
current_mode=hci.HCI_Mode_Change_Event.Mode.SNIFF,
interval=2,
)
)
def on_hci_exit_sniff_mode_command(self, command: hci.HCI_Exit_Sniff_Mode_Command):
'''
See Bluetooth spec Vol 4, Part E - 7.2.3 Exit Sniff Mode command
'''
if self.link is None:
self.send_hci_packet(
hci.HCI_Command_Status_Event(
status=hci.HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
num_hci_command_packets=1,
command_opcode=command.op_code,
)
)
return
self.send_hci_packet(
hci.HCI_Command_Status_Event(
status=HCI_SUCCESS,
num_hci_command_packets=1,
command_opcode=command.op_code,
)
)
self.send_hci_packet(
hci.HCI_Mode_Change_Event(
status=HCI_SUCCESS,
connection_handle=command.connection_handle,
current_mode=hci.HCI_Mode_Change_Event.Mode.ACTIVE,
interval=2,
)
)
def on_hci_switch_role_command(self, command: hci.HCI_Switch_Role_Command):
''' '''
See Bluetooth spec Vol 4, Part E - 7.2.8 Switch Role command See Bluetooth spec Vol 4, Part E - 7.2.8 Switch Role command
''' '''
@@ -1273,56 +1198,6 @@ class Controller:
) )
return bytes([HCI_SUCCESS]) + bd_addr return bytes([HCI_SUCCESS]) + bd_addr
def on_hci_le_set_default_subrate_command(
self, command: hci.HCI_LE_Set_Default_Subrate_Command
):
'''
See Bluetooth spec Vol 6, Part E - 7.8.123 LE Set Event Mask Command
'''
if (
command.subrate_max * (command.max_latency) > 500
or command.subrate_max < command.subrate_min
or command.continuation_number >= command.subrate_max
):
return bytes([HCI_INVALID_HCI_COMMAND_PARAMETERS_ERROR])
return bytes([HCI_SUCCESS])
def on_hci_le_subrate_request_command(
self, command: hci.HCI_LE_Subrate_Request_Command
):
'''
See Bluetooth spec Vol 6, Part E - 7.8.124 LE Subrate Request command
'''
if (
command.subrate_max * (command.max_latency) > 500
or command.continuation_number < command.continuation_number
or command.subrate_max < command.subrate_min
or command.continuation_number >= command.subrate_max
):
return bytes([HCI_INVALID_HCI_COMMAND_PARAMETERS_ERROR])
self.send_hci_packet(
hci.HCI_Command_Status_Event(
status=hci.HCI_SUCCESS,
num_hci_command_packets=1,
command_opcode=command.op_code,
)
)
self.send_hci_packet(
hci.HCI_LE_Subrate_Change_Event(
status=hci.HCI_SUCCESS,
connection_handle=command.connection_handle,
subrate_factor=2,
peripheral_latency=2,
continuation_number=command.continuation_number,
supervision_timeout=command.supervision_timeout,
)
)
return None
def on_hci_le_set_event_mask_command(self, command): def on_hci_le_set_event_mask_command(self, command):
''' '''
See Bluetooth spec Vol 4, Part E - 7.8.1 LE Set Event Mask Command See Bluetooth spec Vol 4, Part E - 7.8.1 LE Set Event Mask Command
@@ -1858,57 +1733,14 @@ class Controller:
) )
) )
def on_hci_le_setup_iso_data_path_command( def on_hci_le_setup_iso_data_path_command(self, command):
self, command: hci.HCI_LE_Setup_ISO_Data_Path_Command
) -> bytes:
''' '''
See Bluetooth spec Vol 4, Part E - 7.8.109 LE Setup ISO Data Path Command See Bluetooth spec Vol 4, Part E - 7.8.109 LE Setup ISO Data Path Command
''' '''
if not (iso_link := self.find_iso_link_by_handle(command.connection_handle)):
return struct.pack(
'<BH',
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
command.connection_handle,
)
if command.data_path_direction in iso_link.data_paths:
return struct.pack(
'<BH',
HCI_COMMAND_DISALLOWED_ERROR,
command.connection_handle,
)
iso_link.data_paths.add(command.data_path_direction)
return struct.pack('<BH', HCI_SUCCESS, command.connection_handle) return struct.pack('<BH', HCI_SUCCESS, command.connection_handle)
def on_hci_le_remove_iso_data_path_command( def on_hci_le_remove_iso_data_path_command(self, command):
self, command: hci.HCI_LE_Remove_ISO_Data_Path_Command
) -> bytes:
''' '''
See Bluetooth spec Vol 4, Part E - 7.8.110 LE Remove ISO Data Path Command See Bluetooth spec Vol 4, Part E - 7.8.110 LE Remove ISO Data Path Command
''' '''
if not (iso_link := self.find_iso_link_by_handle(command.connection_handle)):
return struct.pack(
'<BH',
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
command.connection_handle,
)
data_paths: set[int] = set(
direction
for direction in hci.HCI_LE_Setup_ISO_Data_Path_Command.Direction
if (1 << direction) & command.data_path_direction
)
if not data_paths.issubset(iso_link.data_paths):
return struct.pack(
'<BH',
HCI_COMMAND_DISALLOWED_ERROR,
command.connection_handle,
)
iso_link.data_paths.difference_update(data_paths)
return struct.pack('<BH', HCI_SUCCESS, command.connection_handle) return struct.pack('<BH', HCI_SUCCESS, command.connection_handle)
def on_hci_le_set_host_feature_command(
self, _command: hci.HCI_LE_Set_Host_Feature_Command
):
'''
See Bluetooth spec Vol 4, Part E - 7.8.115 LE Set Host Feature command
'''
return bytes([HCI_SUCCESS])
+256 -575
View File
File diff suppressed because it is too large Load Diff
+95 -11
View File
@@ -1,6 +1,6 @@
# Copyright 2021-2025 Google LLC # Copyright 2021-2022 Google LLC
# #
# Licensed under the Apache License, Version 2.0 (the "License") # Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. # you may not use this file except in compliance with the License.
# You may obtain a copy of the License at # You may obtain a copy of the License at
# #
@@ -12,6 +12,12 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# -----------------------------------------------------------------------------
# Crypto support
#
# See Bluetooth spec Vol 3, Part H - 2.2 CRYPTOGRAPHIC TOOLBOX
# -----------------------------------------------------------------------------
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -19,15 +25,19 @@ from __future__ import annotations
import logging import logging
import operator import operator
import secrets
try: import secrets
from bumble.crypto.cryptography import EccKey, aes_cmac, e from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
except ImportError: from cryptography.hazmat.primitives.asymmetric.ec import (
logging.getLogger(__name__).debug( generate_private_key,
"Unable to import cryptography, use built-in primitives." ECDH,
) EllipticCurvePrivateKey,
from bumble.crypto.builtin import EccKey, aes_cmac, e # type: ignore[assignment] EllipticCurvePublicNumbers,
EllipticCurvePrivateNumbers,
SECP256R1,
)
from cryptography.hazmat.primitives import cmac
from typing import Tuple
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -36,6 +46,55 @@ except ImportError:
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
# -----------------------------------------------------------------------------
# Classes
# -----------------------------------------------------------------------------
class EccKey:
def __init__(self, private_key: EllipticCurvePrivateKey) -> None:
self.private_key = private_key
@classmethod
def generate(cls) -> EccKey:
private_key = generate_private_key(SECP256R1())
return cls(private_key)
@classmethod
def from_private_key_bytes(
cls, d_bytes: bytes, x_bytes: bytes, y_bytes: bytes
) -> EccKey:
d = int.from_bytes(d_bytes, byteorder='big', signed=False)
x = int.from_bytes(x_bytes, byteorder='big', signed=False)
y = int.from_bytes(y_bytes, byteorder='big', signed=False)
private_key = EllipticCurvePrivateNumbers(
d, EllipticCurvePublicNumbers(x, y, SECP256R1())
).private_key()
return cls(private_key)
@property
def x(self) -> bytes:
return (
self.private_key.public_key()
.public_numbers()
.x.to_bytes(32, byteorder='big')
)
@property
def y(self) -> bytes:
return (
self.private_key.public_key()
.public_numbers()
.y.to_bytes(32, byteorder='big')
)
def dh(self, public_key_x: bytes, public_key_y: bytes) -> bytes:
x = int.from_bytes(public_key_x, byteorder='big', signed=False)
y = int.from_bytes(public_key_y, byteorder='big', signed=False)
public_key = EllipticCurvePublicNumbers(x, y, SECP256R1()).public_key()
shared_key = self.private_key.exchange(ECDH(), public_key)
return shared_key
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Functions # Functions
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -73,6 +132,19 @@ def r() -> bytes:
return secrets.token_bytes(16) return secrets.token_bytes(16)
# -----------------------------------------------------------------------------
def e(key: bytes, data: bytes) -> bytes:
'''
AES-128 ECB, expecting byte-swapped inputs and producing a byte-swapped output.
See Bluetooth spec Vol 3, Part H - 2.2.1 Security function e
'''
cipher = Cipher(algorithms.AES(reverse(key)), modes.ECB())
encryptor = cipher.encryptor()
return reverse(encryptor.update(reverse(data)))
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def ah(k: bytes, r: bytes) -> bytes: # pylint: disable=redefined-outer-name def ah(k: bytes, r: bytes) -> bytes: # pylint: disable=redefined-outer-name
''' '''
@@ -115,6 +187,18 @@ def s1(k: bytes, r1: bytes, r2: bytes) -> bytes:
return e(k, r2[0:8] + r1[0:8]) return e(k, r2[0:8] + r1[0:8])
# -----------------------------------------------------------------------------
def aes_cmac(m: bytes, k: bytes) -> bytes:
'''
See Bluetooth spec, Vol 3, Part H - 2.2.5 FunctionAES-CMAC
NOTE: the input and output of this internal function are in big-endian byte order
'''
mac = cmac.CMAC(algorithms.AES(k))
mac.update(m)
return mac.finalize()
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def f4(u: bytes, v: bytes, x: bytes, z: bytes) -> bytes: def f4(u: bytes, v: bytes, x: bytes, z: bytes) -> bytes:
''' '''
@@ -125,7 +209,7 @@ def f4(u: bytes, v: bytes, x: bytes, z: bytes) -> bytes:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def f5(w: bytes, n1: bytes, n2: bytes, a1: bytes, a2: bytes) -> tuple[bytes, bytes]: def f5(w: bytes, n1: bytes, n2: bytes, a1: bytes, a2: bytes) -> Tuple[bytes, bytes]:
''' '''
See Bluetooth spec, Vol 3, Part H - 2.2.7 LE Secure Connections Key Generation See Bluetooth spec, Vol 3, Part H - 2.2.7 LE Secure Connections Key Generation
Function f5 Function f5
-652
View File
@@ -1,652 +0,0 @@
# Copyright 2021-2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License")
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# The implementation is modified from:
# * AES - https://github.com/ricmoo/pyaes by Richard Moore under MIT License
# * CMAC - https://github.com/pycrypto/pycrypto by contributors under pycrypto License.
# -----------------------------------------------------------------------------
# Built-in implementation of cryptography primitives.
#
# Note: It's very dangerous to use this library in the real world.
# -----------------------------------------------------------------------------
from __future__ import annotations
import copy
import dataclasses
import functools
import secrets
import struct
from typing import Optional
from bumble import core
def _compact_word(word: bytes) -> int:
return int.from_bytes(word, "big")
def _shift_bytes(bs: bytes, xor_lsb: int = 0) -> bytes:
return ((int.from_bytes(bs, "big") << 1) ^ xor_lsb).to_bytes(len(bs) + 1, "big")[1:]
def _xor(a: bytes, b: bytes) -> bytes:
return bytes(x ^ y for x, y in zip(a, b))
# Based *largely* on the Rijndael implementation
# See: http://csrc.nist.gov/publications/FIPS/FIPS197/FIPS-197.pdf
class _AES:
'''Encapsulates the AES block cipher.
You generally should not need this. Use the AESModeOfOperation classes
below instead.'''
# fmt: off
# Number of rounds by key size
_NUMBER_OF_ROUNDS = {16: 10, 24: 12, 32: 14}
# Round constant words
_RCON = [ 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91 ]
# S-box and Inverse S-box (S is for Substitution)
_S = [ 0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5, 0x30, 0x01, 0x67, 0x2b, 0xfe, 0xd7, 0xab, 0x76, 0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0, 0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0, 0xb7, 0xfd, 0x93, 0x26, 0x36, 0x3f, 0xf7, 0xcc, 0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15, 0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a, 0x07, 0x12, 0x80, 0xe2, 0xeb, 0x27, 0xb2, 0x75, 0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0, 0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84, 0x53, 0xd1, 0x00, 0xed, 0x20, 0xfc, 0xb1, 0x5b, 0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf, 0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85, 0x45, 0xf9, 0x02, 0x7f, 0x50, 0x3c, 0x9f, 0xa8, 0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5, 0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2, 0xcd, 0x0c, 0x13, 0xec, 0x5f, 0x97, 0x44, 0x17, 0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73, 0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88, 0x46, 0xee, 0xb8, 0x14, 0xde, 0x5e, 0x0b, 0xdb, 0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c, 0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79, 0xe7, 0xc8, 0x37, 0x6d, 0x8d, 0xd5, 0x4e, 0xa9, 0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08, 0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6, 0xe8, 0xdd, 0x74, 0x1f, 0x4b, 0xbd, 0x8b, 0x8a, 0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e, 0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e, 0xe1, 0xf8, 0x98, 0x11, 0x69, 0xd9, 0x8e, 0x94, 0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf, 0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68, 0x41, 0x99, 0x2d, 0x0f, 0xb0, 0x54, 0xbb, 0x16 ]
_S_INV =[ 0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38, 0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb, 0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87, 0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb, 0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d, 0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e, 0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2, 0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25, 0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92, 0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda, 0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84, 0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a, 0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06, 0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02, 0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b, 0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea, 0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73, 0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85, 0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e, 0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89, 0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b, 0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20, 0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4, 0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31, 0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f, 0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d, 0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef, 0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0, 0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61, 0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26, 0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d ]
# Transformations for encryption
_T1 = [ 0xc66363a5, 0xf87c7c84, 0xee777799, 0xf67b7b8d, 0xfff2f20d, 0xd66b6bbd, 0xde6f6fb1, 0x91c5c554, 0x60303050, 0x02010103, 0xce6767a9, 0x562b2b7d, 0xe7fefe19, 0xb5d7d762, 0x4dababe6, 0xec76769a, 0x8fcaca45, 0x1f82829d, 0x89c9c940, 0xfa7d7d87, 0xeffafa15, 0xb25959eb, 0x8e4747c9, 0xfbf0f00b, 0x41adadec, 0xb3d4d467, 0x5fa2a2fd, 0x45afafea, 0x239c9cbf, 0x53a4a4f7, 0xe4727296, 0x9bc0c05b, 0x75b7b7c2, 0xe1fdfd1c, 0x3d9393ae, 0x4c26266a, 0x6c36365a, 0x7e3f3f41, 0xf5f7f702, 0x83cccc4f, 0x6834345c, 0x51a5a5f4, 0xd1e5e534, 0xf9f1f108, 0xe2717193, 0xabd8d873, 0x62313153, 0x2a15153f, 0x0804040c, 0x95c7c752, 0x46232365, 0x9dc3c35e, 0x30181828, 0x379696a1, 0x0a05050f, 0x2f9a9ab5, 0x0e070709, 0x24121236, 0x1b80809b, 0xdfe2e23d, 0xcdebeb26, 0x4e272769, 0x7fb2b2cd, 0xea75759f, 0x1209091b, 0x1d83839e, 0x582c2c74, 0x341a1a2e, 0x361b1b2d, 0xdc6e6eb2, 0xb45a5aee, 0x5ba0a0fb, 0xa45252f6, 0x763b3b4d, 0xb7d6d661, 0x7db3b3ce, 0x5229297b, 0xdde3e33e, 0x5e2f2f71, 0x13848497, 0xa65353f5, 0xb9d1d168, 0x00000000, 0xc1eded2c, 0x40202060, 0xe3fcfc1f, 0x79b1b1c8, 0xb65b5bed, 0xd46a6abe, 0x8dcbcb46, 0x67bebed9, 0x7239394b, 0x944a4ade, 0x984c4cd4, 0xb05858e8, 0x85cfcf4a, 0xbbd0d06b, 0xc5efef2a, 0x4faaaae5, 0xedfbfb16, 0x864343c5, 0x9a4d4dd7, 0x66333355, 0x11858594, 0x8a4545cf, 0xe9f9f910, 0x04020206, 0xfe7f7f81, 0xa05050f0, 0x783c3c44, 0x259f9fba, 0x4ba8a8e3, 0xa25151f3, 0x5da3a3fe, 0x804040c0, 0x058f8f8a, 0x3f9292ad, 0x219d9dbc, 0x70383848, 0xf1f5f504, 0x63bcbcdf, 0x77b6b6c1, 0xafdada75, 0x42212163, 0x20101030, 0xe5ffff1a, 0xfdf3f30e, 0xbfd2d26d, 0x81cdcd4c, 0x180c0c14, 0x26131335, 0xc3ecec2f, 0xbe5f5fe1, 0x359797a2, 0x884444cc, 0x2e171739, 0x93c4c457, 0x55a7a7f2, 0xfc7e7e82, 0x7a3d3d47, 0xc86464ac, 0xba5d5de7, 0x3219192b, 0xe6737395, 0xc06060a0, 0x19818198, 0x9e4f4fd1, 0xa3dcdc7f, 0x44222266, 0x542a2a7e, 0x3b9090ab, 0x0b888883, 0x8c4646ca, 0xc7eeee29, 0x6bb8b8d3, 0x2814143c, 0xa7dede79, 0xbc5e5ee2, 0x160b0b1d, 0xaddbdb76, 0xdbe0e03b, 0x64323256, 0x743a3a4e, 0x140a0a1e, 0x924949db, 0x0c06060a, 0x4824246c, 0xb85c5ce4, 0x9fc2c25d, 0xbdd3d36e, 0x43acacef, 0xc46262a6, 0x399191a8, 0x319595a4, 0xd3e4e437, 0xf279798b, 0xd5e7e732, 0x8bc8c843, 0x6e373759, 0xda6d6db7, 0x018d8d8c, 0xb1d5d564, 0x9c4e4ed2, 0x49a9a9e0, 0xd86c6cb4, 0xac5656fa, 0xf3f4f407, 0xcfeaea25, 0xca6565af, 0xf47a7a8e, 0x47aeaee9, 0x10080818, 0x6fbabad5, 0xf0787888, 0x4a25256f, 0x5c2e2e72, 0x381c1c24, 0x57a6a6f1, 0x73b4b4c7, 0x97c6c651, 0xcbe8e823, 0xa1dddd7c, 0xe874749c, 0x3e1f1f21, 0x964b4bdd, 0x61bdbddc, 0x0d8b8b86, 0x0f8a8a85, 0xe0707090, 0x7c3e3e42, 0x71b5b5c4, 0xcc6666aa, 0x904848d8, 0x06030305, 0xf7f6f601, 0x1c0e0e12, 0xc26161a3, 0x6a35355f, 0xae5757f9, 0x69b9b9d0, 0x17868691, 0x99c1c158, 0x3a1d1d27, 0x279e9eb9, 0xd9e1e138, 0xebf8f813, 0x2b9898b3, 0x22111133, 0xd26969bb, 0xa9d9d970, 0x078e8e89, 0x339494a7, 0x2d9b9bb6, 0x3c1e1e22, 0x15878792, 0xc9e9e920, 0x87cece49, 0xaa5555ff, 0x50282878, 0xa5dfdf7a, 0x038c8c8f, 0x59a1a1f8, 0x09898980, 0x1a0d0d17, 0x65bfbfda, 0xd7e6e631, 0x844242c6, 0xd06868b8, 0x824141c3, 0x299999b0, 0x5a2d2d77, 0x1e0f0f11, 0x7bb0b0cb, 0xa85454fc, 0x6dbbbbd6, 0x2c16163a ]
_T2 = [ 0xa5c66363, 0x84f87c7c, 0x99ee7777, 0x8df67b7b, 0x0dfff2f2, 0xbdd66b6b, 0xb1de6f6f, 0x5491c5c5, 0x50603030, 0x03020101, 0xa9ce6767, 0x7d562b2b, 0x19e7fefe, 0x62b5d7d7, 0xe64dabab, 0x9aec7676, 0x458fcaca, 0x9d1f8282, 0x4089c9c9, 0x87fa7d7d, 0x15effafa, 0xebb25959, 0xc98e4747, 0x0bfbf0f0, 0xec41adad, 0x67b3d4d4, 0xfd5fa2a2, 0xea45afaf, 0xbf239c9c, 0xf753a4a4, 0x96e47272, 0x5b9bc0c0, 0xc275b7b7, 0x1ce1fdfd, 0xae3d9393, 0x6a4c2626, 0x5a6c3636, 0x417e3f3f, 0x02f5f7f7, 0x4f83cccc, 0x5c683434, 0xf451a5a5, 0x34d1e5e5, 0x08f9f1f1, 0x93e27171, 0x73abd8d8, 0x53623131, 0x3f2a1515, 0x0c080404, 0x5295c7c7, 0x65462323, 0x5e9dc3c3, 0x28301818, 0xa1379696, 0x0f0a0505, 0xb52f9a9a, 0x090e0707, 0x36241212, 0x9b1b8080, 0x3ddfe2e2, 0x26cdebeb, 0x694e2727, 0xcd7fb2b2, 0x9fea7575, 0x1b120909, 0x9e1d8383, 0x74582c2c, 0x2e341a1a, 0x2d361b1b, 0xb2dc6e6e, 0xeeb45a5a, 0xfb5ba0a0, 0xf6a45252, 0x4d763b3b, 0x61b7d6d6, 0xce7db3b3, 0x7b522929, 0x3edde3e3, 0x715e2f2f, 0x97138484, 0xf5a65353, 0x68b9d1d1, 0x00000000, 0x2cc1eded, 0x60402020, 0x1fe3fcfc, 0xc879b1b1, 0xedb65b5b, 0xbed46a6a, 0x468dcbcb, 0xd967bebe, 0x4b723939, 0xde944a4a, 0xd4984c4c, 0xe8b05858, 0x4a85cfcf, 0x6bbbd0d0, 0x2ac5efef, 0xe54faaaa, 0x16edfbfb, 0xc5864343, 0xd79a4d4d, 0x55663333, 0x94118585, 0xcf8a4545, 0x10e9f9f9, 0x06040202, 0x81fe7f7f, 0xf0a05050, 0x44783c3c, 0xba259f9f, 0xe34ba8a8, 0xf3a25151, 0xfe5da3a3, 0xc0804040, 0x8a058f8f, 0xad3f9292, 0xbc219d9d, 0x48703838, 0x04f1f5f5, 0xdf63bcbc, 0xc177b6b6, 0x75afdada, 0x63422121, 0x30201010, 0x1ae5ffff, 0x0efdf3f3, 0x6dbfd2d2, 0x4c81cdcd, 0x14180c0c, 0x35261313, 0x2fc3ecec, 0xe1be5f5f, 0xa2359797, 0xcc884444, 0x392e1717, 0x5793c4c4, 0xf255a7a7, 0x82fc7e7e, 0x477a3d3d, 0xacc86464, 0xe7ba5d5d, 0x2b321919, 0x95e67373, 0xa0c06060, 0x98198181, 0xd19e4f4f, 0x7fa3dcdc, 0x66442222, 0x7e542a2a, 0xab3b9090, 0x830b8888, 0xca8c4646, 0x29c7eeee, 0xd36bb8b8, 0x3c281414, 0x79a7dede, 0xe2bc5e5e, 0x1d160b0b, 0x76addbdb, 0x3bdbe0e0, 0x56643232, 0x4e743a3a, 0x1e140a0a, 0xdb924949, 0x0a0c0606, 0x6c482424, 0xe4b85c5c, 0x5d9fc2c2, 0x6ebdd3d3, 0xef43acac, 0xa6c46262, 0xa8399191, 0xa4319595, 0x37d3e4e4, 0x8bf27979, 0x32d5e7e7, 0x438bc8c8, 0x596e3737, 0xb7da6d6d, 0x8c018d8d, 0x64b1d5d5, 0xd29c4e4e, 0xe049a9a9, 0xb4d86c6c, 0xfaac5656, 0x07f3f4f4, 0x25cfeaea, 0xafca6565, 0x8ef47a7a, 0xe947aeae, 0x18100808, 0xd56fbaba, 0x88f07878, 0x6f4a2525, 0x725c2e2e, 0x24381c1c, 0xf157a6a6, 0xc773b4b4, 0x5197c6c6, 0x23cbe8e8, 0x7ca1dddd, 0x9ce87474, 0x213e1f1f, 0xdd964b4b, 0xdc61bdbd, 0x860d8b8b, 0x850f8a8a, 0x90e07070, 0x427c3e3e, 0xc471b5b5, 0xaacc6666, 0xd8904848, 0x05060303, 0x01f7f6f6, 0x121c0e0e, 0xa3c26161, 0x5f6a3535, 0xf9ae5757, 0xd069b9b9, 0x91178686, 0x5899c1c1, 0x273a1d1d, 0xb9279e9e, 0x38d9e1e1, 0x13ebf8f8, 0xb32b9898, 0x33221111, 0xbbd26969, 0x70a9d9d9, 0x89078e8e, 0xa7339494, 0xb62d9b9b, 0x223c1e1e, 0x92158787, 0x20c9e9e9, 0x4987cece, 0xffaa5555, 0x78502828, 0x7aa5dfdf, 0x8f038c8c, 0xf859a1a1, 0x80098989, 0x171a0d0d, 0xda65bfbf, 0x31d7e6e6, 0xc6844242, 0xb8d06868, 0xc3824141, 0xb0299999, 0x775a2d2d, 0x111e0f0f, 0xcb7bb0b0, 0xfca85454, 0xd66dbbbb, 0x3a2c1616 ]
_T3 = [ 0x63a5c663, 0x7c84f87c, 0x7799ee77, 0x7b8df67b, 0xf20dfff2, 0x6bbdd66b, 0x6fb1de6f, 0xc55491c5, 0x30506030, 0x01030201, 0x67a9ce67, 0x2b7d562b, 0xfe19e7fe, 0xd762b5d7, 0xabe64dab, 0x769aec76, 0xca458fca, 0x829d1f82, 0xc94089c9, 0x7d87fa7d, 0xfa15effa, 0x59ebb259, 0x47c98e47, 0xf00bfbf0, 0xadec41ad, 0xd467b3d4, 0xa2fd5fa2, 0xafea45af, 0x9cbf239c, 0xa4f753a4, 0x7296e472, 0xc05b9bc0, 0xb7c275b7, 0xfd1ce1fd, 0x93ae3d93, 0x266a4c26, 0x365a6c36, 0x3f417e3f, 0xf702f5f7, 0xcc4f83cc, 0x345c6834, 0xa5f451a5, 0xe534d1e5, 0xf108f9f1, 0x7193e271, 0xd873abd8, 0x31536231, 0x153f2a15, 0x040c0804, 0xc75295c7, 0x23654623, 0xc35e9dc3, 0x18283018, 0x96a13796, 0x050f0a05, 0x9ab52f9a, 0x07090e07, 0x12362412, 0x809b1b80, 0xe23ddfe2, 0xeb26cdeb, 0x27694e27, 0xb2cd7fb2, 0x759fea75, 0x091b1209, 0x839e1d83, 0x2c74582c, 0x1a2e341a, 0x1b2d361b, 0x6eb2dc6e, 0x5aeeb45a, 0xa0fb5ba0, 0x52f6a452, 0x3b4d763b, 0xd661b7d6, 0xb3ce7db3, 0x297b5229, 0xe33edde3, 0x2f715e2f, 0x84971384, 0x53f5a653, 0xd168b9d1, 0x00000000, 0xed2cc1ed, 0x20604020, 0xfc1fe3fc, 0xb1c879b1, 0x5bedb65b, 0x6abed46a, 0xcb468dcb, 0xbed967be, 0x394b7239, 0x4ade944a, 0x4cd4984c, 0x58e8b058, 0xcf4a85cf, 0xd06bbbd0, 0xef2ac5ef, 0xaae54faa, 0xfb16edfb, 0x43c58643, 0x4dd79a4d, 0x33556633, 0x85941185, 0x45cf8a45, 0xf910e9f9, 0x02060402, 0x7f81fe7f, 0x50f0a050, 0x3c44783c, 0x9fba259f, 0xa8e34ba8, 0x51f3a251, 0xa3fe5da3, 0x40c08040, 0x8f8a058f, 0x92ad3f92, 0x9dbc219d, 0x38487038, 0xf504f1f5, 0xbcdf63bc, 0xb6c177b6, 0xda75afda, 0x21634221, 0x10302010, 0xff1ae5ff, 0xf30efdf3, 0xd26dbfd2, 0xcd4c81cd, 0x0c14180c, 0x13352613, 0xec2fc3ec, 0x5fe1be5f, 0x97a23597, 0x44cc8844, 0x17392e17, 0xc45793c4, 0xa7f255a7, 0x7e82fc7e, 0x3d477a3d, 0x64acc864, 0x5de7ba5d, 0x192b3219, 0x7395e673, 0x60a0c060, 0x81981981, 0x4fd19e4f, 0xdc7fa3dc, 0x22664422, 0x2a7e542a, 0x90ab3b90, 0x88830b88, 0x46ca8c46, 0xee29c7ee, 0xb8d36bb8, 0x143c2814, 0xde79a7de, 0x5ee2bc5e, 0x0b1d160b, 0xdb76addb, 0xe03bdbe0, 0x32566432, 0x3a4e743a, 0x0a1e140a, 0x49db9249, 0x060a0c06, 0x246c4824, 0x5ce4b85c, 0xc25d9fc2, 0xd36ebdd3, 0xacef43ac, 0x62a6c462, 0x91a83991, 0x95a43195, 0xe437d3e4, 0x798bf279, 0xe732d5e7, 0xc8438bc8, 0x37596e37, 0x6db7da6d, 0x8d8c018d, 0xd564b1d5, 0x4ed29c4e, 0xa9e049a9, 0x6cb4d86c, 0x56faac56, 0xf407f3f4, 0xea25cfea, 0x65afca65, 0x7a8ef47a, 0xaee947ae, 0x08181008, 0xbad56fba, 0x7888f078, 0x256f4a25, 0x2e725c2e, 0x1c24381c, 0xa6f157a6, 0xb4c773b4, 0xc65197c6, 0xe823cbe8, 0xdd7ca1dd, 0x749ce874, 0x1f213e1f, 0x4bdd964b, 0xbddc61bd, 0x8b860d8b, 0x8a850f8a, 0x7090e070, 0x3e427c3e, 0xb5c471b5, 0x66aacc66, 0x48d89048, 0x03050603, 0xf601f7f6, 0x0e121c0e, 0x61a3c261, 0x355f6a35, 0x57f9ae57, 0xb9d069b9, 0x86911786, 0xc15899c1, 0x1d273a1d, 0x9eb9279e, 0xe138d9e1, 0xf813ebf8, 0x98b32b98, 0x11332211, 0x69bbd269, 0xd970a9d9, 0x8e89078e, 0x94a73394, 0x9bb62d9b, 0x1e223c1e, 0x87921587, 0xe920c9e9, 0xce4987ce, 0x55ffaa55, 0x28785028, 0xdf7aa5df, 0x8c8f038c, 0xa1f859a1, 0x89800989, 0x0d171a0d, 0xbfda65bf, 0xe631d7e6, 0x42c68442, 0x68b8d068, 0x41c38241, 0x99b02999, 0x2d775a2d, 0x0f111e0f, 0xb0cb7bb0, 0x54fca854, 0xbbd66dbb, 0x163a2c16 ]
_T4 = [ 0x6363a5c6, 0x7c7c84f8, 0x777799ee, 0x7b7b8df6, 0xf2f20dff, 0x6b6bbdd6, 0x6f6fb1de, 0xc5c55491, 0x30305060, 0x01010302, 0x6767a9ce, 0x2b2b7d56, 0xfefe19e7, 0xd7d762b5, 0xababe64d, 0x76769aec, 0xcaca458f, 0x82829d1f, 0xc9c94089, 0x7d7d87fa, 0xfafa15ef, 0x5959ebb2, 0x4747c98e, 0xf0f00bfb, 0xadadec41, 0xd4d467b3, 0xa2a2fd5f, 0xafafea45, 0x9c9cbf23, 0xa4a4f753, 0x727296e4, 0xc0c05b9b, 0xb7b7c275, 0xfdfd1ce1, 0x9393ae3d, 0x26266a4c, 0x36365a6c, 0x3f3f417e, 0xf7f702f5, 0xcccc4f83, 0x34345c68, 0xa5a5f451, 0xe5e534d1, 0xf1f108f9, 0x717193e2, 0xd8d873ab, 0x31315362, 0x15153f2a, 0x04040c08, 0xc7c75295, 0x23236546, 0xc3c35e9d, 0x18182830, 0x9696a137, 0x05050f0a, 0x9a9ab52f, 0x0707090e, 0x12123624, 0x80809b1b, 0xe2e23ddf, 0xebeb26cd, 0x2727694e, 0xb2b2cd7f, 0x75759fea, 0x09091b12, 0x83839e1d, 0x2c2c7458, 0x1a1a2e34, 0x1b1b2d36, 0x6e6eb2dc, 0x5a5aeeb4, 0xa0a0fb5b, 0x5252f6a4, 0x3b3b4d76, 0xd6d661b7, 0xb3b3ce7d, 0x29297b52, 0xe3e33edd, 0x2f2f715e, 0x84849713, 0x5353f5a6, 0xd1d168b9, 0x00000000, 0xeded2cc1, 0x20206040, 0xfcfc1fe3, 0xb1b1c879, 0x5b5bedb6, 0x6a6abed4, 0xcbcb468d, 0xbebed967, 0x39394b72, 0x4a4ade94, 0x4c4cd498, 0x5858e8b0, 0xcfcf4a85, 0xd0d06bbb, 0xefef2ac5, 0xaaaae54f, 0xfbfb16ed, 0x4343c586, 0x4d4dd79a, 0x33335566, 0x85859411, 0x4545cf8a, 0xf9f910e9, 0x02020604, 0x7f7f81fe, 0x5050f0a0, 0x3c3c4478, 0x9f9fba25, 0xa8a8e34b, 0x5151f3a2, 0xa3a3fe5d, 0x4040c080, 0x8f8f8a05, 0x9292ad3f, 0x9d9dbc21, 0x38384870, 0xf5f504f1, 0xbcbcdf63, 0xb6b6c177, 0xdada75af, 0x21216342, 0x10103020, 0xffff1ae5, 0xf3f30efd, 0xd2d26dbf, 0xcdcd4c81, 0x0c0c1418, 0x13133526, 0xecec2fc3, 0x5f5fe1be, 0x9797a235, 0x4444cc88, 0x1717392e, 0xc4c45793, 0xa7a7f255, 0x7e7e82fc, 0x3d3d477a, 0x6464acc8, 0x5d5de7ba, 0x19192b32, 0x737395e6, 0x6060a0c0, 0x81819819, 0x4f4fd19e, 0xdcdc7fa3, 0x22226644, 0x2a2a7e54, 0x9090ab3b, 0x8888830b, 0x4646ca8c, 0xeeee29c7, 0xb8b8d36b, 0x14143c28, 0xdede79a7, 0x5e5ee2bc, 0x0b0b1d16, 0xdbdb76ad, 0xe0e03bdb, 0x32325664, 0x3a3a4e74, 0x0a0a1e14, 0x4949db92, 0x06060a0c, 0x24246c48, 0x5c5ce4b8, 0xc2c25d9f, 0xd3d36ebd, 0xacacef43, 0x6262a6c4, 0x9191a839, 0x9595a431, 0xe4e437d3, 0x79798bf2, 0xe7e732d5, 0xc8c8438b, 0x3737596e, 0x6d6db7da, 0x8d8d8c01, 0xd5d564b1, 0x4e4ed29c, 0xa9a9e049, 0x6c6cb4d8, 0x5656faac, 0xf4f407f3, 0xeaea25cf, 0x6565afca, 0x7a7a8ef4, 0xaeaee947, 0x08081810, 0xbabad56f, 0x787888f0, 0x25256f4a, 0x2e2e725c, 0x1c1c2438, 0xa6a6f157, 0xb4b4c773, 0xc6c65197, 0xe8e823cb, 0xdddd7ca1, 0x74749ce8, 0x1f1f213e, 0x4b4bdd96, 0xbdbddc61, 0x8b8b860d, 0x8a8a850f, 0x707090e0, 0x3e3e427c, 0xb5b5c471, 0x6666aacc, 0x4848d890, 0x03030506, 0xf6f601f7, 0x0e0e121c, 0x6161a3c2, 0x35355f6a, 0x5757f9ae, 0xb9b9d069, 0x86869117, 0xc1c15899, 0x1d1d273a, 0x9e9eb927, 0xe1e138d9, 0xf8f813eb, 0x9898b32b, 0x11113322, 0x6969bbd2, 0xd9d970a9, 0x8e8e8907, 0x9494a733, 0x9b9bb62d, 0x1e1e223c, 0x87879215, 0xe9e920c9, 0xcece4987, 0x5555ffaa, 0x28287850, 0xdfdf7aa5, 0x8c8c8f03, 0xa1a1f859, 0x89898009, 0x0d0d171a, 0xbfbfda65, 0xe6e631d7, 0x4242c684, 0x6868b8d0, 0x4141c382, 0x9999b029, 0x2d2d775a, 0x0f0f111e, 0xb0b0cb7b, 0x5454fca8, 0xbbbbd66d, 0x16163a2c ]
# Transformations for decryption
_T5 = [ 0x51f4a750, 0x7e416553, 0x1a17a4c3, 0x3a275e96, 0x3bab6bcb, 0x1f9d45f1, 0xacfa58ab, 0x4be30393, 0x2030fa55, 0xad766df6, 0x88cc7691, 0xf5024c25, 0x4fe5d7fc, 0xc52acbd7, 0x26354480, 0xb562a38f, 0xdeb15a49, 0x25ba1b67, 0x45ea0e98, 0x5dfec0e1, 0xc32f7502, 0x814cf012, 0x8d4697a3, 0x6bd3f9c6, 0x038f5fe7, 0x15929c95, 0xbf6d7aeb, 0x955259da, 0xd4be832d, 0x587421d3, 0x49e06929, 0x8ec9c844, 0x75c2896a, 0xf48e7978, 0x99583e6b, 0x27b971dd, 0xbee14fb6, 0xf088ad17, 0xc920ac66, 0x7dce3ab4, 0x63df4a18, 0xe51a3182, 0x97513360, 0x62537f45, 0xb16477e0, 0xbb6bae84, 0xfe81a01c, 0xf9082b94, 0x70486858, 0x8f45fd19, 0x94de6c87, 0x527bf8b7, 0xab73d323, 0x724b02e2, 0xe31f8f57, 0x6655ab2a, 0xb2eb2807, 0x2fb5c203, 0x86c57b9a, 0xd33708a5, 0x302887f2, 0x23bfa5b2, 0x02036aba, 0xed16825c, 0x8acf1c2b, 0xa779b492, 0xf307f2f0, 0x4e69e2a1, 0x65daf4cd, 0x0605bed5, 0xd134621f, 0xc4a6fe8a, 0x342e539d, 0xa2f355a0, 0x058ae132, 0xa4f6eb75, 0x0b83ec39, 0x4060efaa, 0x5e719f06, 0xbd6e1051, 0x3e218af9, 0x96dd063d, 0xdd3e05ae, 0x4de6bd46, 0x91548db5, 0x71c45d05, 0x0406d46f, 0x605015ff, 0x1998fb24, 0xd6bde997, 0x894043cc, 0x67d99e77, 0xb0e842bd, 0x07898b88, 0xe7195b38, 0x79c8eedb, 0xa17c0a47, 0x7c420fe9, 0xf8841ec9, 0x00000000, 0x09808683, 0x322bed48, 0x1e1170ac, 0x6c5a724e, 0xfd0efffb, 0x0f853856, 0x3daed51e, 0x362d3927, 0x0a0fd964, 0x685ca621, 0x9b5b54d1, 0x24362e3a, 0x0c0a67b1, 0x9357e70f, 0xb4ee96d2, 0x1b9b919e, 0x80c0c54f, 0x61dc20a2, 0x5a774b69, 0x1c121a16, 0xe293ba0a, 0xc0a02ae5, 0x3c22e043, 0x121b171d, 0x0e090d0b, 0xf28bc7ad, 0x2db6a8b9, 0x141ea9c8, 0x57f11985, 0xaf75074c, 0xee99ddbb, 0xa37f60fd, 0xf701269f, 0x5c72f5bc, 0x44663bc5, 0x5bfb7e34, 0x8b432976, 0xcb23c6dc, 0xb6edfc68, 0xb8e4f163, 0xd731dcca, 0x42638510, 0x13972240, 0x84c61120, 0x854a247d, 0xd2bb3df8, 0xaef93211, 0xc729a16d, 0x1d9e2f4b, 0xdcb230f3, 0x0d8652ec, 0x77c1e3d0, 0x2bb3166c, 0xa970b999, 0x119448fa, 0x47e96422, 0xa8fc8cc4, 0xa0f03f1a, 0x567d2cd8, 0x223390ef, 0x87494ec7, 0xd938d1c1, 0x8ccaa2fe, 0x98d40b36, 0xa6f581cf, 0xa57ade28, 0xdab78e26, 0x3fadbfa4, 0x2c3a9de4, 0x5078920d, 0x6a5fcc9b, 0x547e4662, 0xf68d13c2, 0x90d8b8e8, 0x2e39f75e, 0x82c3aff5, 0x9f5d80be, 0x69d0937c, 0x6fd52da9, 0xcf2512b3, 0xc8ac993b, 0x10187da7, 0xe89c636e, 0xdb3bbb7b, 0xcd267809, 0x6e5918f4, 0xec9ab701, 0x834f9aa8, 0xe6956e65, 0xaaffe67e, 0x21bccf08, 0xef15e8e6, 0xbae79bd9, 0x4a6f36ce, 0xea9f09d4, 0x29b07cd6, 0x31a4b2af, 0x2a3f2331, 0xc6a59430, 0x35a266c0, 0x744ebc37, 0xfc82caa6, 0xe090d0b0, 0x33a7d815, 0xf104984a, 0x41ecdaf7, 0x7fcd500e, 0x1791f62f, 0x764dd68d, 0x43efb04d, 0xccaa4d54, 0xe49604df, 0x9ed1b5e3, 0x4c6a881b, 0xc12c1fb8, 0x4665517f, 0x9d5eea04, 0x018c355d, 0xfa877473, 0xfb0b412e, 0xb3671d5a, 0x92dbd252, 0xe9105633, 0x6dd64713, 0x9ad7618c, 0x37a10c7a, 0x59f8148e, 0xeb133c89, 0xcea927ee, 0xb761c935, 0xe11ce5ed, 0x7a47b13c, 0x9cd2df59, 0x55f2733f, 0x1814ce79, 0x73c737bf, 0x53f7cdea, 0x5ffdaa5b, 0xdf3d6f14, 0x7844db86, 0xcaaff381, 0xb968c43e, 0x3824342c, 0xc2a3405f, 0x161dc372, 0xbce2250c, 0x283c498b, 0xff0d9541, 0x39a80171, 0x080cb3de, 0xd8b4e49c, 0x6456c190, 0x7bcb8461, 0xd532b670, 0x486c5c74, 0xd0b85742 ]
_T6 = [ 0x5051f4a7, 0x537e4165, 0xc31a17a4, 0x963a275e, 0xcb3bab6b, 0xf11f9d45, 0xabacfa58, 0x934be303, 0x552030fa, 0xf6ad766d, 0x9188cc76, 0x25f5024c, 0xfc4fe5d7, 0xd7c52acb, 0x80263544, 0x8fb562a3, 0x49deb15a, 0x6725ba1b, 0x9845ea0e, 0xe15dfec0, 0x02c32f75, 0x12814cf0, 0xa38d4697, 0xc66bd3f9, 0xe7038f5f, 0x9515929c, 0xebbf6d7a, 0xda955259, 0x2dd4be83, 0xd3587421, 0x2949e069, 0x448ec9c8, 0x6a75c289, 0x78f48e79, 0x6b99583e, 0xdd27b971, 0xb6bee14f, 0x17f088ad, 0x66c920ac, 0xb47dce3a, 0x1863df4a, 0x82e51a31, 0x60975133, 0x4562537f, 0xe0b16477, 0x84bb6bae, 0x1cfe81a0, 0x94f9082b, 0x58704868, 0x198f45fd, 0x8794de6c, 0xb7527bf8, 0x23ab73d3, 0xe2724b02, 0x57e31f8f, 0x2a6655ab, 0x07b2eb28, 0x032fb5c2, 0x9a86c57b, 0xa5d33708, 0xf2302887, 0xb223bfa5, 0xba02036a, 0x5ced1682, 0x2b8acf1c, 0x92a779b4, 0xf0f307f2, 0xa14e69e2, 0xcd65daf4, 0xd50605be, 0x1fd13462, 0x8ac4a6fe, 0x9d342e53, 0xa0a2f355, 0x32058ae1, 0x75a4f6eb, 0x390b83ec, 0xaa4060ef, 0x065e719f, 0x51bd6e10, 0xf93e218a, 0x3d96dd06, 0xaedd3e05, 0x464de6bd, 0xb591548d, 0x0571c45d, 0x6f0406d4, 0xff605015, 0x241998fb, 0x97d6bde9, 0xcc894043, 0x7767d99e, 0xbdb0e842, 0x8807898b, 0x38e7195b, 0xdb79c8ee, 0x47a17c0a, 0xe97c420f, 0xc9f8841e, 0x00000000, 0x83098086, 0x48322bed, 0xac1e1170, 0x4e6c5a72, 0xfbfd0eff, 0x560f8538, 0x1e3daed5, 0x27362d39, 0x640a0fd9, 0x21685ca6, 0xd19b5b54, 0x3a24362e, 0xb10c0a67, 0x0f9357e7, 0xd2b4ee96, 0x9e1b9b91, 0x4f80c0c5, 0xa261dc20, 0x695a774b, 0x161c121a, 0x0ae293ba, 0xe5c0a02a, 0x433c22e0, 0x1d121b17, 0x0b0e090d, 0xadf28bc7, 0xb92db6a8, 0xc8141ea9, 0x8557f119, 0x4caf7507, 0xbbee99dd, 0xfda37f60, 0x9ff70126, 0xbc5c72f5, 0xc544663b, 0x345bfb7e, 0x768b4329, 0xdccb23c6, 0x68b6edfc, 0x63b8e4f1, 0xcad731dc, 0x10426385, 0x40139722, 0x2084c611, 0x7d854a24, 0xf8d2bb3d, 0x11aef932, 0x6dc729a1, 0x4b1d9e2f, 0xf3dcb230, 0xec0d8652, 0xd077c1e3, 0x6c2bb316, 0x99a970b9, 0xfa119448, 0x2247e964, 0xc4a8fc8c, 0x1aa0f03f, 0xd8567d2c, 0xef223390, 0xc787494e, 0xc1d938d1, 0xfe8ccaa2, 0x3698d40b, 0xcfa6f581, 0x28a57ade, 0x26dab78e, 0xa43fadbf, 0xe42c3a9d, 0x0d507892, 0x9b6a5fcc, 0x62547e46, 0xc2f68d13, 0xe890d8b8, 0x5e2e39f7, 0xf582c3af, 0xbe9f5d80, 0x7c69d093, 0xa96fd52d, 0xb3cf2512, 0x3bc8ac99, 0xa710187d, 0x6ee89c63, 0x7bdb3bbb, 0x09cd2678, 0xf46e5918, 0x01ec9ab7, 0xa8834f9a, 0x65e6956e, 0x7eaaffe6, 0x0821bccf, 0xe6ef15e8, 0xd9bae79b, 0xce4a6f36, 0xd4ea9f09, 0xd629b07c, 0xaf31a4b2, 0x312a3f23, 0x30c6a594, 0xc035a266, 0x37744ebc, 0xa6fc82ca, 0xb0e090d0, 0x1533a7d8, 0x4af10498, 0xf741ecda, 0x0e7fcd50, 0x2f1791f6, 0x8d764dd6, 0x4d43efb0, 0x54ccaa4d, 0xdfe49604, 0xe39ed1b5, 0x1b4c6a88, 0xb8c12c1f, 0x7f466551, 0x049d5eea, 0x5d018c35, 0x73fa8774, 0x2efb0b41, 0x5ab3671d, 0x5292dbd2, 0x33e91056, 0x136dd647, 0x8c9ad761, 0x7a37a10c, 0x8e59f814, 0x89eb133c, 0xeecea927, 0x35b761c9, 0xede11ce5, 0x3c7a47b1, 0x599cd2df, 0x3f55f273, 0x791814ce, 0xbf73c737, 0xea53f7cd, 0x5b5ffdaa, 0x14df3d6f, 0x867844db, 0x81caaff3, 0x3eb968c4, 0x2c382434, 0x5fc2a340, 0x72161dc3, 0x0cbce225, 0x8b283c49, 0x41ff0d95, 0x7139a801, 0xde080cb3, 0x9cd8b4e4, 0x906456c1, 0x617bcb84, 0x70d532b6, 0x74486c5c, 0x42d0b857 ]
_T7 = [ 0xa75051f4, 0x65537e41, 0xa4c31a17, 0x5e963a27, 0x6bcb3bab, 0x45f11f9d, 0x58abacfa, 0x03934be3, 0xfa552030, 0x6df6ad76, 0x769188cc, 0x4c25f502, 0xd7fc4fe5, 0xcbd7c52a, 0x44802635, 0xa38fb562, 0x5a49deb1, 0x1b6725ba, 0x0e9845ea, 0xc0e15dfe, 0x7502c32f, 0xf012814c, 0x97a38d46, 0xf9c66bd3, 0x5fe7038f, 0x9c951592, 0x7aebbf6d, 0x59da9552, 0x832dd4be, 0x21d35874, 0x692949e0, 0xc8448ec9, 0x896a75c2, 0x7978f48e, 0x3e6b9958, 0x71dd27b9, 0x4fb6bee1, 0xad17f088, 0xac66c920, 0x3ab47dce, 0x4a1863df, 0x3182e51a, 0x33609751, 0x7f456253, 0x77e0b164, 0xae84bb6b, 0xa01cfe81, 0x2b94f908, 0x68587048, 0xfd198f45, 0x6c8794de, 0xf8b7527b, 0xd323ab73, 0x02e2724b, 0x8f57e31f, 0xab2a6655, 0x2807b2eb, 0xc2032fb5, 0x7b9a86c5, 0x08a5d337, 0x87f23028, 0xa5b223bf, 0x6aba0203, 0x825ced16, 0x1c2b8acf, 0xb492a779, 0xf2f0f307, 0xe2a14e69, 0xf4cd65da, 0xbed50605, 0x621fd134, 0xfe8ac4a6, 0x539d342e, 0x55a0a2f3, 0xe132058a, 0xeb75a4f6, 0xec390b83, 0xefaa4060, 0x9f065e71, 0x1051bd6e, 0x8af93e21, 0x063d96dd, 0x05aedd3e, 0xbd464de6, 0x8db59154, 0x5d0571c4, 0xd46f0406, 0x15ff6050, 0xfb241998, 0xe997d6bd, 0x43cc8940, 0x9e7767d9, 0x42bdb0e8, 0x8b880789, 0x5b38e719, 0xeedb79c8, 0x0a47a17c, 0x0fe97c42, 0x1ec9f884, 0x00000000, 0x86830980, 0xed48322b, 0x70ac1e11, 0x724e6c5a, 0xfffbfd0e, 0x38560f85, 0xd51e3dae, 0x3927362d, 0xd9640a0f, 0xa621685c, 0x54d19b5b, 0x2e3a2436, 0x67b10c0a, 0xe70f9357, 0x96d2b4ee, 0x919e1b9b, 0xc54f80c0, 0x20a261dc, 0x4b695a77, 0x1a161c12, 0xba0ae293, 0x2ae5c0a0, 0xe0433c22, 0x171d121b, 0x0d0b0e09, 0xc7adf28b, 0xa8b92db6, 0xa9c8141e, 0x198557f1, 0x074caf75, 0xddbbee99, 0x60fda37f, 0x269ff701, 0xf5bc5c72, 0x3bc54466, 0x7e345bfb, 0x29768b43, 0xc6dccb23, 0xfc68b6ed, 0xf163b8e4, 0xdccad731, 0x85104263, 0x22401397, 0x112084c6, 0x247d854a, 0x3df8d2bb, 0x3211aef9, 0xa16dc729, 0x2f4b1d9e, 0x30f3dcb2, 0x52ec0d86, 0xe3d077c1, 0x166c2bb3, 0xb999a970, 0x48fa1194, 0x642247e9, 0x8cc4a8fc, 0x3f1aa0f0, 0x2cd8567d, 0x90ef2233, 0x4ec78749, 0xd1c1d938, 0xa2fe8cca, 0x0b3698d4, 0x81cfa6f5, 0xde28a57a, 0x8e26dab7, 0xbfa43fad, 0x9de42c3a, 0x920d5078, 0xcc9b6a5f, 0x4662547e, 0x13c2f68d, 0xb8e890d8, 0xf75e2e39, 0xaff582c3, 0x80be9f5d, 0x937c69d0, 0x2da96fd5, 0x12b3cf25, 0x993bc8ac, 0x7da71018, 0x636ee89c, 0xbb7bdb3b, 0x7809cd26, 0x18f46e59, 0xb701ec9a, 0x9aa8834f, 0x6e65e695, 0xe67eaaff, 0xcf0821bc, 0xe8e6ef15, 0x9bd9bae7, 0x36ce4a6f, 0x09d4ea9f, 0x7cd629b0, 0xb2af31a4, 0x23312a3f, 0x9430c6a5, 0x66c035a2, 0xbc37744e, 0xcaa6fc82, 0xd0b0e090, 0xd81533a7, 0x984af104, 0xdaf741ec, 0x500e7fcd, 0xf62f1791, 0xd68d764d, 0xb04d43ef, 0x4d54ccaa, 0x04dfe496, 0xb5e39ed1, 0x881b4c6a, 0x1fb8c12c, 0x517f4665, 0xea049d5e, 0x355d018c, 0x7473fa87, 0x412efb0b, 0x1d5ab367, 0xd25292db, 0x5633e910, 0x47136dd6, 0x618c9ad7, 0x0c7a37a1, 0x148e59f8, 0x3c89eb13, 0x27eecea9, 0xc935b761, 0xe5ede11c, 0xb13c7a47, 0xdf599cd2, 0x733f55f2, 0xce791814, 0x37bf73c7, 0xcdea53f7, 0xaa5b5ffd, 0x6f14df3d, 0xdb867844, 0xf381caaf, 0xc43eb968, 0x342c3824, 0x405fc2a3, 0xc372161d, 0x250cbce2, 0x498b283c, 0x9541ff0d, 0x017139a8, 0xb3de080c, 0xe49cd8b4, 0xc1906456, 0x84617bcb, 0xb670d532, 0x5c74486c, 0x5742d0b8 ]
_T8 = [ 0xf4a75051, 0x4165537e, 0x17a4c31a, 0x275e963a, 0xab6bcb3b, 0x9d45f11f, 0xfa58abac, 0xe303934b, 0x30fa5520, 0x766df6ad, 0xcc769188, 0x024c25f5, 0xe5d7fc4f, 0x2acbd7c5, 0x35448026, 0x62a38fb5, 0xb15a49de, 0xba1b6725, 0xea0e9845, 0xfec0e15d, 0x2f7502c3, 0x4cf01281, 0x4697a38d, 0xd3f9c66b, 0x8f5fe703, 0x929c9515, 0x6d7aebbf, 0x5259da95, 0xbe832dd4, 0x7421d358, 0xe0692949, 0xc9c8448e, 0xc2896a75, 0x8e7978f4, 0x583e6b99, 0xb971dd27, 0xe14fb6be, 0x88ad17f0, 0x20ac66c9, 0xce3ab47d, 0xdf4a1863, 0x1a3182e5, 0x51336097, 0x537f4562, 0x6477e0b1, 0x6bae84bb, 0x81a01cfe, 0x082b94f9, 0x48685870, 0x45fd198f, 0xde6c8794, 0x7bf8b752, 0x73d323ab, 0x4b02e272, 0x1f8f57e3, 0x55ab2a66, 0xeb2807b2, 0xb5c2032f, 0xc57b9a86, 0x3708a5d3, 0x2887f230, 0xbfa5b223, 0x036aba02, 0x16825ced, 0xcf1c2b8a, 0x79b492a7, 0x07f2f0f3, 0x69e2a14e, 0xdaf4cd65, 0x05bed506, 0x34621fd1, 0xa6fe8ac4, 0x2e539d34, 0xf355a0a2, 0x8ae13205, 0xf6eb75a4, 0x83ec390b, 0x60efaa40, 0x719f065e, 0x6e1051bd, 0x218af93e, 0xdd063d96, 0x3e05aedd, 0xe6bd464d, 0x548db591, 0xc45d0571, 0x06d46f04, 0x5015ff60, 0x98fb2419, 0xbde997d6, 0x4043cc89, 0xd99e7767, 0xe842bdb0, 0x898b8807, 0x195b38e7, 0xc8eedb79, 0x7c0a47a1, 0x420fe97c, 0x841ec9f8, 0x00000000, 0x80868309, 0x2bed4832, 0x1170ac1e, 0x5a724e6c, 0x0efffbfd, 0x8538560f, 0xaed51e3d, 0x2d392736, 0x0fd9640a, 0x5ca62168, 0x5b54d19b, 0x362e3a24, 0x0a67b10c, 0x57e70f93, 0xee96d2b4, 0x9b919e1b, 0xc0c54f80, 0xdc20a261, 0x774b695a, 0x121a161c, 0x93ba0ae2, 0xa02ae5c0, 0x22e0433c, 0x1b171d12, 0x090d0b0e, 0x8bc7adf2, 0xb6a8b92d, 0x1ea9c814, 0xf1198557, 0x75074caf, 0x99ddbbee, 0x7f60fda3, 0x01269ff7, 0x72f5bc5c, 0x663bc544, 0xfb7e345b, 0x4329768b, 0x23c6dccb, 0xedfc68b6, 0xe4f163b8, 0x31dccad7, 0x63851042, 0x97224013, 0xc6112084, 0x4a247d85, 0xbb3df8d2, 0xf93211ae, 0x29a16dc7, 0x9e2f4b1d, 0xb230f3dc, 0x8652ec0d, 0xc1e3d077, 0xb3166c2b, 0x70b999a9, 0x9448fa11, 0xe9642247, 0xfc8cc4a8, 0xf03f1aa0, 0x7d2cd856, 0x3390ef22, 0x494ec787, 0x38d1c1d9, 0xcaa2fe8c, 0xd40b3698, 0xf581cfa6, 0x7ade28a5, 0xb78e26da, 0xadbfa43f, 0x3a9de42c, 0x78920d50, 0x5fcc9b6a, 0x7e466254, 0x8d13c2f6, 0xd8b8e890, 0x39f75e2e, 0xc3aff582, 0x5d80be9f, 0xd0937c69, 0xd52da96f, 0x2512b3cf, 0xac993bc8, 0x187da710, 0x9c636ee8, 0x3bbb7bdb, 0x267809cd, 0x5918f46e, 0x9ab701ec, 0x4f9aa883, 0x956e65e6, 0xffe67eaa, 0xbccf0821, 0x15e8e6ef, 0xe79bd9ba, 0x6f36ce4a, 0x9f09d4ea, 0xb07cd629, 0xa4b2af31, 0x3f23312a, 0xa59430c6, 0xa266c035, 0x4ebc3774, 0x82caa6fc, 0x90d0b0e0, 0xa7d81533, 0x04984af1, 0xecdaf741, 0xcd500e7f, 0x91f62f17, 0x4dd68d76, 0xefb04d43, 0xaa4d54cc, 0x9604dfe4, 0xd1b5e39e, 0x6a881b4c, 0x2c1fb8c1, 0x65517f46, 0x5eea049d, 0x8c355d01, 0x877473fa, 0x0b412efb, 0x671d5ab3, 0xdbd25292, 0x105633e9, 0xd647136d, 0xd7618c9a, 0xa10c7a37, 0xf8148e59, 0x133c89eb, 0xa927eece, 0x61c935b7, 0x1ce5ede1, 0x47b13c7a, 0xd2df599c, 0xf2733f55, 0x14ce7918, 0xc737bf73, 0xf7cdea53, 0xfdaa5b5f, 0x3d6f14df, 0x44db8678, 0xaff381ca, 0x68c43eb9, 0x24342c38, 0xa3405fc2, 0x1dc37216, 0xe2250cbc, 0x3c498b28, 0x0d9541ff, 0xa8017139, 0x0cb3de08, 0xb4e49cd8, 0x56c19064, 0xcb84617b, 0x32b670d5, 0x6c5c7448, 0xb85742d0 ]
# Transformations for decryption key expansion
_U1 = [ 0x00000000, 0x0e090d0b, 0x1c121a16, 0x121b171d, 0x3824342c, 0x362d3927, 0x24362e3a, 0x2a3f2331, 0x70486858, 0x7e416553, 0x6c5a724e, 0x62537f45, 0x486c5c74, 0x4665517f, 0x547e4662, 0x5a774b69, 0xe090d0b0, 0xee99ddbb, 0xfc82caa6, 0xf28bc7ad, 0xd8b4e49c, 0xd6bde997, 0xc4a6fe8a, 0xcaaff381, 0x90d8b8e8, 0x9ed1b5e3, 0x8ccaa2fe, 0x82c3aff5, 0xa8fc8cc4, 0xa6f581cf, 0xb4ee96d2, 0xbae79bd9, 0xdb3bbb7b, 0xd532b670, 0xc729a16d, 0xc920ac66, 0xe31f8f57, 0xed16825c, 0xff0d9541, 0xf104984a, 0xab73d323, 0xa57ade28, 0xb761c935, 0xb968c43e, 0x9357e70f, 0x9d5eea04, 0x8f45fd19, 0x814cf012, 0x3bab6bcb, 0x35a266c0, 0x27b971dd, 0x29b07cd6, 0x038f5fe7, 0x0d8652ec, 0x1f9d45f1, 0x119448fa, 0x4be30393, 0x45ea0e98, 0x57f11985, 0x59f8148e, 0x73c737bf, 0x7dce3ab4, 0x6fd52da9, 0x61dc20a2, 0xad766df6, 0xa37f60fd, 0xb16477e0, 0xbf6d7aeb, 0x955259da, 0x9b5b54d1, 0x894043cc, 0x87494ec7, 0xdd3e05ae, 0xd33708a5, 0xc12c1fb8, 0xcf2512b3, 0xe51a3182, 0xeb133c89, 0xf9082b94, 0xf701269f, 0x4de6bd46, 0x43efb04d, 0x51f4a750, 0x5ffdaa5b, 0x75c2896a, 0x7bcb8461, 0x69d0937c, 0x67d99e77, 0x3daed51e, 0x33a7d815, 0x21bccf08, 0x2fb5c203, 0x058ae132, 0x0b83ec39, 0x1998fb24, 0x1791f62f, 0x764dd68d, 0x7844db86, 0x6a5fcc9b, 0x6456c190, 0x4e69e2a1, 0x4060efaa, 0x527bf8b7, 0x5c72f5bc, 0x0605bed5, 0x080cb3de, 0x1a17a4c3, 0x141ea9c8, 0x3e218af9, 0x302887f2, 0x223390ef, 0x2c3a9de4, 0x96dd063d, 0x98d40b36, 0x8acf1c2b, 0x84c61120, 0xaef93211, 0xa0f03f1a, 0xb2eb2807, 0xbce2250c, 0xe6956e65, 0xe89c636e, 0xfa877473, 0xf48e7978, 0xdeb15a49, 0xd0b85742, 0xc2a3405f, 0xccaa4d54, 0x41ecdaf7, 0x4fe5d7fc, 0x5dfec0e1, 0x53f7cdea, 0x79c8eedb, 0x77c1e3d0, 0x65daf4cd, 0x6bd3f9c6, 0x31a4b2af, 0x3fadbfa4, 0x2db6a8b9, 0x23bfa5b2, 0x09808683, 0x07898b88, 0x15929c95, 0x1b9b919e, 0xa17c0a47, 0xaf75074c, 0xbd6e1051, 0xb3671d5a, 0x99583e6b, 0x97513360, 0x854a247d, 0x8b432976, 0xd134621f, 0xdf3d6f14, 0xcd267809, 0xc32f7502, 0xe9105633, 0xe7195b38, 0xf5024c25, 0xfb0b412e, 0x9ad7618c, 0x94de6c87, 0x86c57b9a, 0x88cc7691, 0xa2f355a0, 0xacfa58ab, 0xbee14fb6, 0xb0e842bd, 0xea9f09d4, 0xe49604df, 0xf68d13c2, 0xf8841ec9, 0xd2bb3df8, 0xdcb230f3, 0xcea927ee, 0xc0a02ae5, 0x7a47b13c, 0x744ebc37, 0x6655ab2a, 0x685ca621, 0x42638510, 0x4c6a881b, 0x5e719f06, 0x5078920d, 0x0a0fd964, 0x0406d46f, 0x161dc372, 0x1814ce79, 0x322bed48, 0x3c22e043, 0x2e39f75e, 0x2030fa55, 0xec9ab701, 0xe293ba0a, 0xf088ad17, 0xfe81a01c, 0xd4be832d, 0xdab78e26, 0xc8ac993b, 0xc6a59430, 0x9cd2df59, 0x92dbd252, 0x80c0c54f, 0x8ec9c844, 0xa4f6eb75, 0xaaffe67e, 0xb8e4f163, 0xb6edfc68, 0x0c0a67b1, 0x02036aba, 0x10187da7, 0x1e1170ac, 0x342e539d, 0x3a275e96, 0x283c498b, 0x26354480, 0x7c420fe9, 0x724b02e2, 0x605015ff, 0x6e5918f4, 0x44663bc5, 0x4a6f36ce, 0x587421d3, 0x567d2cd8, 0x37a10c7a, 0x39a80171, 0x2bb3166c, 0x25ba1b67, 0x0f853856, 0x018c355d, 0x13972240, 0x1d9e2f4b, 0x47e96422, 0x49e06929, 0x5bfb7e34, 0x55f2733f, 0x7fcd500e, 0x71c45d05, 0x63df4a18, 0x6dd64713, 0xd731dcca, 0xd938d1c1, 0xcb23c6dc, 0xc52acbd7, 0xef15e8e6, 0xe11ce5ed, 0xf307f2f0, 0xfd0efffb, 0xa779b492, 0xa970b999, 0xbb6bae84, 0xb562a38f, 0x9f5d80be, 0x91548db5, 0x834f9aa8, 0x8d4697a3 ]
_U2 = [ 0x00000000, 0x0b0e090d, 0x161c121a, 0x1d121b17, 0x2c382434, 0x27362d39, 0x3a24362e, 0x312a3f23, 0x58704868, 0x537e4165, 0x4e6c5a72, 0x4562537f, 0x74486c5c, 0x7f466551, 0x62547e46, 0x695a774b, 0xb0e090d0, 0xbbee99dd, 0xa6fc82ca, 0xadf28bc7, 0x9cd8b4e4, 0x97d6bde9, 0x8ac4a6fe, 0x81caaff3, 0xe890d8b8, 0xe39ed1b5, 0xfe8ccaa2, 0xf582c3af, 0xc4a8fc8c, 0xcfa6f581, 0xd2b4ee96, 0xd9bae79b, 0x7bdb3bbb, 0x70d532b6, 0x6dc729a1, 0x66c920ac, 0x57e31f8f, 0x5ced1682, 0x41ff0d95, 0x4af10498, 0x23ab73d3, 0x28a57ade, 0x35b761c9, 0x3eb968c4, 0x0f9357e7, 0x049d5eea, 0x198f45fd, 0x12814cf0, 0xcb3bab6b, 0xc035a266, 0xdd27b971, 0xd629b07c, 0xe7038f5f, 0xec0d8652, 0xf11f9d45, 0xfa119448, 0x934be303, 0x9845ea0e, 0x8557f119, 0x8e59f814, 0xbf73c737, 0xb47dce3a, 0xa96fd52d, 0xa261dc20, 0xf6ad766d, 0xfda37f60, 0xe0b16477, 0xebbf6d7a, 0xda955259, 0xd19b5b54, 0xcc894043, 0xc787494e, 0xaedd3e05, 0xa5d33708, 0xb8c12c1f, 0xb3cf2512, 0x82e51a31, 0x89eb133c, 0x94f9082b, 0x9ff70126, 0x464de6bd, 0x4d43efb0, 0x5051f4a7, 0x5b5ffdaa, 0x6a75c289, 0x617bcb84, 0x7c69d093, 0x7767d99e, 0x1e3daed5, 0x1533a7d8, 0x0821bccf, 0x032fb5c2, 0x32058ae1, 0x390b83ec, 0x241998fb, 0x2f1791f6, 0x8d764dd6, 0x867844db, 0x9b6a5fcc, 0x906456c1, 0xa14e69e2, 0xaa4060ef, 0xb7527bf8, 0xbc5c72f5, 0xd50605be, 0xde080cb3, 0xc31a17a4, 0xc8141ea9, 0xf93e218a, 0xf2302887, 0xef223390, 0xe42c3a9d, 0x3d96dd06, 0x3698d40b, 0x2b8acf1c, 0x2084c611, 0x11aef932, 0x1aa0f03f, 0x07b2eb28, 0x0cbce225, 0x65e6956e, 0x6ee89c63, 0x73fa8774, 0x78f48e79, 0x49deb15a, 0x42d0b857, 0x5fc2a340, 0x54ccaa4d, 0xf741ecda, 0xfc4fe5d7, 0xe15dfec0, 0xea53f7cd, 0xdb79c8ee, 0xd077c1e3, 0xcd65daf4, 0xc66bd3f9, 0xaf31a4b2, 0xa43fadbf, 0xb92db6a8, 0xb223bfa5, 0x83098086, 0x8807898b, 0x9515929c, 0x9e1b9b91, 0x47a17c0a, 0x4caf7507, 0x51bd6e10, 0x5ab3671d, 0x6b99583e, 0x60975133, 0x7d854a24, 0x768b4329, 0x1fd13462, 0x14df3d6f, 0x09cd2678, 0x02c32f75, 0x33e91056, 0x38e7195b, 0x25f5024c, 0x2efb0b41, 0x8c9ad761, 0x8794de6c, 0x9a86c57b, 0x9188cc76, 0xa0a2f355, 0xabacfa58, 0xb6bee14f, 0xbdb0e842, 0xd4ea9f09, 0xdfe49604, 0xc2f68d13, 0xc9f8841e, 0xf8d2bb3d, 0xf3dcb230, 0xeecea927, 0xe5c0a02a, 0x3c7a47b1, 0x37744ebc, 0x2a6655ab, 0x21685ca6, 0x10426385, 0x1b4c6a88, 0x065e719f, 0x0d507892, 0x640a0fd9, 0x6f0406d4, 0x72161dc3, 0x791814ce, 0x48322bed, 0x433c22e0, 0x5e2e39f7, 0x552030fa, 0x01ec9ab7, 0x0ae293ba, 0x17f088ad, 0x1cfe81a0, 0x2dd4be83, 0x26dab78e, 0x3bc8ac99, 0x30c6a594, 0x599cd2df, 0x5292dbd2, 0x4f80c0c5, 0x448ec9c8, 0x75a4f6eb, 0x7eaaffe6, 0x63b8e4f1, 0x68b6edfc, 0xb10c0a67, 0xba02036a, 0xa710187d, 0xac1e1170, 0x9d342e53, 0x963a275e, 0x8b283c49, 0x80263544, 0xe97c420f, 0xe2724b02, 0xff605015, 0xf46e5918, 0xc544663b, 0xce4a6f36, 0xd3587421, 0xd8567d2c, 0x7a37a10c, 0x7139a801, 0x6c2bb316, 0x6725ba1b, 0x560f8538, 0x5d018c35, 0x40139722, 0x4b1d9e2f, 0x2247e964, 0x2949e069, 0x345bfb7e, 0x3f55f273, 0x0e7fcd50, 0x0571c45d, 0x1863df4a, 0x136dd647, 0xcad731dc, 0xc1d938d1, 0xdccb23c6, 0xd7c52acb, 0xe6ef15e8, 0xede11ce5, 0xf0f307f2, 0xfbfd0eff, 0x92a779b4, 0x99a970b9, 0x84bb6bae, 0x8fb562a3, 0xbe9f5d80, 0xb591548d, 0xa8834f9a, 0xa38d4697 ]
_U3 = [ 0x00000000, 0x0d0b0e09, 0x1a161c12, 0x171d121b, 0x342c3824, 0x3927362d, 0x2e3a2436, 0x23312a3f, 0x68587048, 0x65537e41, 0x724e6c5a, 0x7f456253, 0x5c74486c, 0x517f4665, 0x4662547e, 0x4b695a77, 0xd0b0e090, 0xddbbee99, 0xcaa6fc82, 0xc7adf28b, 0xe49cd8b4, 0xe997d6bd, 0xfe8ac4a6, 0xf381caaf, 0xb8e890d8, 0xb5e39ed1, 0xa2fe8cca, 0xaff582c3, 0x8cc4a8fc, 0x81cfa6f5, 0x96d2b4ee, 0x9bd9bae7, 0xbb7bdb3b, 0xb670d532, 0xa16dc729, 0xac66c920, 0x8f57e31f, 0x825ced16, 0x9541ff0d, 0x984af104, 0xd323ab73, 0xde28a57a, 0xc935b761, 0xc43eb968, 0xe70f9357, 0xea049d5e, 0xfd198f45, 0xf012814c, 0x6bcb3bab, 0x66c035a2, 0x71dd27b9, 0x7cd629b0, 0x5fe7038f, 0x52ec0d86, 0x45f11f9d, 0x48fa1194, 0x03934be3, 0x0e9845ea, 0x198557f1, 0x148e59f8, 0x37bf73c7, 0x3ab47dce, 0x2da96fd5, 0x20a261dc, 0x6df6ad76, 0x60fda37f, 0x77e0b164, 0x7aebbf6d, 0x59da9552, 0x54d19b5b, 0x43cc8940, 0x4ec78749, 0x05aedd3e, 0x08a5d337, 0x1fb8c12c, 0x12b3cf25, 0x3182e51a, 0x3c89eb13, 0x2b94f908, 0x269ff701, 0xbd464de6, 0xb04d43ef, 0xa75051f4, 0xaa5b5ffd, 0x896a75c2, 0x84617bcb, 0x937c69d0, 0x9e7767d9, 0xd51e3dae, 0xd81533a7, 0xcf0821bc, 0xc2032fb5, 0xe132058a, 0xec390b83, 0xfb241998, 0xf62f1791, 0xd68d764d, 0xdb867844, 0xcc9b6a5f, 0xc1906456, 0xe2a14e69, 0xefaa4060, 0xf8b7527b, 0xf5bc5c72, 0xbed50605, 0xb3de080c, 0xa4c31a17, 0xa9c8141e, 0x8af93e21, 0x87f23028, 0x90ef2233, 0x9de42c3a, 0x063d96dd, 0x0b3698d4, 0x1c2b8acf, 0x112084c6, 0x3211aef9, 0x3f1aa0f0, 0x2807b2eb, 0x250cbce2, 0x6e65e695, 0x636ee89c, 0x7473fa87, 0x7978f48e, 0x5a49deb1, 0x5742d0b8, 0x405fc2a3, 0x4d54ccaa, 0xdaf741ec, 0xd7fc4fe5, 0xc0e15dfe, 0xcdea53f7, 0xeedb79c8, 0xe3d077c1, 0xf4cd65da, 0xf9c66bd3, 0xb2af31a4, 0xbfa43fad, 0xa8b92db6, 0xa5b223bf, 0x86830980, 0x8b880789, 0x9c951592, 0x919e1b9b, 0x0a47a17c, 0x074caf75, 0x1051bd6e, 0x1d5ab367, 0x3e6b9958, 0x33609751, 0x247d854a, 0x29768b43, 0x621fd134, 0x6f14df3d, 0x7809cd26, 0x7502c32f, 0x5633e910, 0x5b38e719, 0x4c25f502, 0x412efb0b, 0x618c9ad7, 0x6c8794de, 0x7b9a86c5, 0x769188cc, 0x55a0a2f3, 0x58abacfa, 0x4fb6bee1, 0x42bdb0e8, 0x09d4ea9f, 0x04dfe496, 0x13c2f68d, 0x1ec9f884, 0x3df8d2bb, 0x30f3dcb2, 0x27eecea9, 0x2ae5c0a0, 0xb13c7a47, 0xbc37744e, 0xab2a6655, 0xa621685c, 0x85104263, 0x881b4c6a, 0x9f065e71, 0x920d5078, 0xd9640a0f, 0xd46f0406, 0xc372161d, 0xce791814, 0xed48322b, 0xe0433c22, 0xf75e2e39, 0xfa552030, 0xb701ec9a, 0xba0ae293, 0xad17f088, 0xa01cfe81, 0x832dd4be, 0x8e26dab7, 0x993bc8ac, 0x9430c6a5, 0xdf599cd2, 0xd25292db, 0xc54f80c0, 0xc8448ec9, 0xeb75a4f6, 0xe67eaaff, 0xf163b8e4, 0xfc68b6ed, 0x67b10c0a, 0x6aba0203, 0x7da71018, 0x70ac1e11, 0x539d342e, 0x5e963a27, 0x498b283c, 0x44802635, 0x0fe97c42, 0x02e2724b, 0x15ff6050, 0x18f46e59, 0x3bc54466, 0x36ce4a6f, 0x21d35874, 0x2cd8567d, 0x0c7a37a1, 0x017139a8, 0x166c2bb3, 0x1b6725ba, 0x38560f85, 0x355d018c, 0x22401397, 0x2f4b1d9e, 0x642247e9, 0x692949e0, 0x7e345bfb, 0x733f55f2, 0x500e7fcd, 0x5d0571c4, 0x4a1863df, 0x47136dd6, 0xdccad731, 0xd1c1d938, 0xc6dccb23, 0xcbd7c52a, 0xe8e6ef15, 0xe5ede11c, 0xf2f0f307, 0xfffbfd0e, 0xb492a779, 0xb999a970, 0xae84bb6b, 0xa38fb562, 0x80be9f5d, 0x8db59154, 0x9aa8834f, 0x97a38d46 ]
_U4 = [ 0x00000000, 0x090d0b0e, 0x121a161c, 0x1b171d12, 0x24342c38, 0x2d392736, 0x362e3a24, 0x3f23312a, 0x48685870, 0x4165537e, 0x5a724e6c, 0x537f4562, 0x6c5c7448, 0x65517f46, 0x7e466254, 0x774b695a, 0x90d0b0e0, 0x99ddbbee, 0x82caa6fc, 0x8bc7adf2, 0xb4e49cd8, 0xbde997d6, 0xa6fe8ac4, 0xaff381ca, 0xd8b8e890, 0xd1b5e39e, 0xcaa2fe8c, 0xc3aff582, 0xfc8cc4a8, 0xf581cfa6, 0xee96d2b4, 0xe79bd9ba, 0x3bbb7bdb, 0x32b670d5, 0x29a16dc7, 0x20ac66c9, 0x1f8f57e3, 0x16825ced, 0x0d9541ff, 0x04984af1, 0x73d323ab, 0x7ade28a5, 0x61c935b7, 0x68c43eb9, 0x57e70f93, 0x5eea049d, 0x45fd198f, 0x4cf01281, 0xab6bcb3b, 0xa266c035, 0xb971dd27, 0xb07cd629, 0x8f5fe703, 0x8652ec0d, 0x9d45f11f, 0x9448fa11, 0xe303934b, 0xea0e9845, 0xf1198557, 0xf8148e59, 0xc737bf73, 0xce3ab47d, 0xd52da96f, 0xdc20a261, 0x766df6ad, 0x7f60fda3, 0x6477e0b1, 0x6d7aebbf, 0x5259da95, 0x5b54d19b, 0x4043cc89, 0x494ec787, 0x3e05aedd, 0x3708a5d3, 0x2c1fb8c1, 0x2512b3cf, 0x1a3182e5, 0x133c89eb, 0x082b94f9, 0x01269ff7, 0xe6bd464d, 0xefb04d43, 0xf4a75051, 0xfdaa5b5f, 0xc2896a75, 0xcb84617b, 0xd0937c69, 0xd99e7767, 0xaed51e3d, 0xa7d81533, 0xbccf0821, 0xb5c2032f, 0x8ae13205, 0x83ec390b, 0x98fb2419, 0x91f62f17, 0x4dd68d76, 0x44db8678, 0x5fcc9b6a, 0x56c19064, 0x69e2a14e, 0x60efaa40, 0x7bf8b752, 0x72f5bc5c, 0x05bed506, 0x0cb3de08, 0x17a4c31a, 0x1ea9c814, 0x218af93e, 0x2887f230, 0x3390ef22, 0x3a9de42c, 0xdd063d96, 0xd40b3698, 0xcf1c2b8a, 0xc6112084, 0xf93211ae, 0xf03f1aa0, 0xeb2807b2, 0xe2250cbc, 0x956e65e6, 0x9c636ee8, 0x877473fa, 0x8e7978f4, 0xb15a49de, 0xb85742d0, 0xa3405fc2, 0xaa4d54cc, 0xecdaf741, 0xe5d7fc4f, 0xfec0e15d, 0xf7cdea53, 0xc8eedb79, 0xc1e3d077, 0xdaf4cd65, 0xd3f9c66b, 0xa4b2af31, 0xadbfa43f, 0xb6a8b92d, 0xbfa5b223, 0x80868309, 0x898b8807, 0x929c9515, 0x9b919e1b, 0x7c0a47a1, 0x75074caf, 0x6e1051bd, 0x671d5ab3, 0x583e6b99, 0x51336097, 0x4a247d85, 0x4329768b, 0x34621fd1, 0x3d6f14df, 0x267809cd, 0x2f7502c3, 0x105633e9, 0x195b38e7, 0x024c25f5, 0x0b412efb, 0xd7618c9a, 0xde6c8794, 0xc57b9a86, 0xcc769188, 0xf355a0a2, 0xfa58abac, 0xe14fb6be, 0xe842bdb0, 0x9f09d4ea, 0x9604dfe4, 0x8d13c2f6, 0x841ec9f8, 0xbb3df8d2, 0xb230f3dc, 0xa927eece, 0xa02ae5c0, 0x47b13c7a, 0x4ebc3774, 0x55ab2a66, 0x5ca62168, 0x63851042, 0x6a881b4c, 0x719f065e, 0x78920d50, 0x0fd9640a, 0x06d46f04, 0x1dc37216, 0x14ce7918, 0x2bed4832, 0x22e0433c, 0x39f75e2e, 0x30fa5520, 0x9ab701ec, 0x93ba0ae2, 0x88ad17f0, 0x81a01cfe, 0xbe832dd4, 0xb78e26da, 0xac993bc8, 0xa59430c6, 0xd2df599c, 0xdbd25292, 0xc0c54f80, 0xc9c8448e, 0xf6eb75a4, 0xffe67eaa, 0xe4f163b8, 0xedfc68b6, 0x0a67b10c, 0x036aba02, 0x187da710, 0x1170ac1e, 0x2e539d34, 0x275e963a, 0x3c498b28, 0x35448026, 0x420fe97c, 0x4b02e272, 0x5015ff60, 0x5918f46e, 0x663bc544, 0x6f36ce4a, 0x7421d358, 0x7d2cd856, 0xa10c7a37, 0xa8017139, 0xb3166c2b, 0xba1b6725, 0x8538560f, 0x8c355d01, 0x97224013, 0x9e2f4b1d, 0xe9642247, 0xe0692949, 0xfb7e345b, 0xf2733f55, 0xcd500e7f, 0xc45d0571, 0xdf4a1863, 0xd647136d, 0x31dccad7, 0x38d1c1d9, 0x23c6dccb, 0x2acbd7c5, 0x15e8e6ef, 0x1ce5ede1, 0x07f2f0f3, 0x0efffbfd, 0x79b492a7, 0x70b999a9, 0x6bae84bb, 0x62a38fb5, 0x5d80be9f, 0x548db591, 0x4f9aa883, 0x4697a38d ]
# fmt: on
def __init__(self, key: bytes) -> None:
if len(key) not in (16, 24, 32):
raise core.InvalidArgumentError(f'Invalid key size {len(key)}')
rounds = self._NUMBER_OF_ROUNDS[len(key)]
# Encryption round keys
self._ke = [[0] * 4 for i in range(rounds + 1)]
# Decryption round keys
self._kd = [[0] * 4 for i in range(rounds + 1)]
round_key_count = (rounds + 1) * 4
kc = len(key) // 4
# Convert the key into ints
tk = [struct.unpack('>i', key[i : i + 4])[0] for i in range(0, len(key), 4)]
# Copy values into round key arrays
for i in range(0, kc):
self._ke[i // 4][i % 4] = tk[i]
self._kd[rounds - (i // 4)][i % 4] = tk[i]
# Key expansion (FIPS-197 section 5.2)
r_con_pointer = 0
t = kc
while t < round_key_count:
tt = tk[kc - 1]
tk[0] ^= (
(self._S[(tt >> 16) & 0xFF] << 24)
^ (self._S[(tt >> 8) & 0xFF] << 16)
^ (self._S[tt & 0xFF] << 8)
^ self._S[(tt >> 24) & 0xFF]
^ (self._RCON[r_con_pointer] << 24)
)
r_con_pointer += 1
if kc != 8:
for i in range(1, kc):
tk[i] ^= tk[i - 1]
# Key expansion for 256-bit keys is "slightly different" (FIPS-197)
else:
for i in range(1, kc // 2):
tk[i] ^= tk[i - 1]
tt = tk[kc // 2 - 1]
tk[kc // 2] ^= (
self._S[tt & 0xFF]
^ (self._S[(tt >> 8) & 0xFF] << 8)
^ (self._S[(tt >> 16) & 0xFF] << 16)
^ (self._S[(tt >> 24) & 0xFF] << 24)
)
for i in range(kc // 2 + 1, kc):
tk[i] ^= tk[i - 1]
# Copy values into round key arrays
j = 0
while j < kc and t < round_key_count:
self._ke[t // 4][t % 4] = tk[j]
self._kd[rounds - (t // 4)][t % 4] = tk[j]
j += 1
t += 1
# Inverse-Cipher-ify the decryption round key (FIPS-197 section 5.3)
for r in range(1, rounds):
for j in range(0, 4):
tt = self._kd[r][j]
self._kd[r][j] = (
self._U1[(tt >> 24) & 0xFF]
^ self._U2[(tt >> 16) & 0xFF]
^ self._U3[(tt >> 8) & 0xFF]
^ self._U4[tt & 0xFF]
)
def encrypt(self, plaintext: bytes) -> bytes:
"""Encrypt a block of plain text using the AES block cipher."""
if len(plaintext) != 16:
raise core.InvalidArgumentError(f'wrong block length {len(plaintext)}')
rounds = len(self._ke) - 1
(s1, s2, s3) = [1, 2, 3]
a = [0, 0, 0, 0]
# Convert plaintext to (ints ^ key)
t = [
(_compact_word(plaintext[4 * i : 4 * i + 4]) ^ self._ke[0][i])
for i in range(0, 4)
]
# Apply round transforms
for r in range(1, rounds):
for i in range(0, 4):
a[i] = (
self._T1[(t[i] >> 24) & 0xFF]
^ self._T2[(t[(i + s1) % 4] >> 16) & 0xFF]
^ self._T3[(t[(i + s2) % 4] >> 8) & 0xFF]
^ self._T4[t[(i + s3) % 4] & 0xFF]
^ self._ke[r][i]
)
t = copy.copy(a)
# The last round is special
result = []
for i in range(0, 4):
tt = self._ke[rounds][i]
result.append((self._S[(t[i] >> 24) & 0xFF] ^ (tt >> 24)) & 0xFF)
result.append((self._S[(t[(i + s1) % 4] >> 16) & 0xFF] ^ (tt >> 16)) & 0xFF)
result.append((self._S[(t[(i + s2) % 4] >> 8) & 0xFF] ^ (tt >> 8)) & 0xFF)
result.append((self._S[t[(i + s3) % 4] & 0xFF] ^ tt) & 0xFF)
return bytes(result)
def decrypt(self, cipher_text: bytes) -> bytes:
"""Decrypt a block of cipher text using the AES block cipher."""
if len(cipher_text) != 16:
raise core.InvalidArgumentError(f'wrong block length {len(cipher_text)}')
rounds = len(self._kd) - 1
(s1, s2, s3) = [3, 2, 1]
a = [0, 0, 0, 0]
# Convert ciphertext to (ints ^ key)
t = [
(_compact_word(cipher_text[4 * i : 4 * i + 4]) ^ self._kd[0][i])
for i in range(0, 4)
]
# Apply round transforms
for r in range(1, rounds):
for i in range(0, 4):
a[i] = (
self._T5[(t[i] >> 24) & 0xFF]
^ self._T6[(t[(i + s1) % 4] >> 16) & 0xFF]
^ self._T7[(t[(i + s2) % 4] >> 8) & 0xFF]
^ self._T8[t[(i + s3) % 4] & 0xFF]
^ self._kd[r][i]
)
t = copy.copy(a)
# The last round is special
result = []
for i in range(0, 4):
tt = self._kd[rounds][i]
result.append((self._S_INV[(t[i] >> 24) & 0xFF] ^ (tt >> 24)) & 0xFF)
result.append(
(self._S_INV[(t[(i + s1) % 4] >> 16) & 0xFF] ^ (tt >> 16)) & 0xFF
)
result.append(
(self._S_INV[(t[(i + s2) % 4] >> 8) & 0xFF] ^ (tt >> 8)) & 0xFF
)
result.append((self._S_INV[t[(i + s3) % 4] & 0xFF] ^ tt) & 0xFF)
return bytes(result)
class _ECB:
def __init__(self, key: bytes):
self._aes = _AES(key)
def encrypt(self, plaintext: bytes) -> bytes:
return b"".join(
[
self._aes.encrypt(
plaintext[offset : offset + 16].ljust(16, b"\x00") # Pad 0.
)
for offset in range(0, len(plaintext), 16)
]
)
def decrypt(self, cipher_text: bytes) -> bytes:
return b"".join(
[
self._aes.encrypt(cipher_text[offset : offset + 16])
for offset in range(0, len(cipher_text), 16)
]
)
class _CBC:
def __init__(self, key: bytes, iv: bytes = bytes(16)) -> None:
if len(iv) != 16:
raise core.InvalidArgumentError(
f'initialization vector must be 16 bytes, get {len(iv)}'
)
else:
self._last_cipher_block = iv
self._aes = _AES(key)
def encrypt(self, plaintext: bytes) -> bytes:
cipher_text = b""
for offset in range(0, len(plaintext), 16):
pre_cipher_block = _xor(
plaintext[offset : offset + 16], self._last_cipher_block
)
self._last_cipher_block = self._aes.encrypt(pre_cipher_block)
cipher_text += self._last_cipher_block
return cipher_text
def decrypt(self, cipher_text: bytes) -> bytes:
plaintext = b""
for offset in range(0, len(cipher_text), 16):
plaintext += _xor(
self._aes.decrypt(cipher_text[offset : offset + 16]),
self._last_cipher_block,
)
self._last_cipher_block = cipher_text[offset : offset + 16]
return plaintext
class _CMAC:
def __init__(
self,
key: bytes,
msg: bytes = bytes(16),
mac_len: int = 16,
update_after_digest: bool = False,
) -> None:
self.digest_size = mac_len
self._key = key
self._block_size = bs = 16
self._mac_tag: Optional[bytes] = None
self._update_after_digest = update_after_digest
# Section 5.3 of NIST SP 800 38B and Appendix B
if bs == 8:
const_Rb = 0x1B
self._max_size = 8 * (2**21)
elif bs == 16:
const_Rb = 0x87
self._max_size = 16 * (2**48)
else:
raise core.InvalidArgumentError(
f"CMAC requires a cipher with a block size of 8 or 16 bytes, not {bs}"
)
# Compute sub-keys
zero_block = bytes(bs)
self._ecb = _ECB(key)
L = self._ecb.encrypt(zero_block)
if L[0] & 0x80:
self._k1 = _shift_bytes(L, const_Rb)
else:
self._k1 = _shift_bytes(L)
if self._k1[0] & 0x80:
self._k2 = _shift_bytes(self._k1, const_Rb)
else:
self._k2 = _shift_bytes(self._k1)
# Initialize CBC cipher with zero IV
self._cbc = _CBC(key, zero_block)
# Cache for outstanding data to authenticate
self._cache = bytearray(bs)
self._cache_n = 0
# Last piece of cipher text produced
self._last_ct = zero_block
# Last block that was encrypted with AES
self._last_pt: Optional[bytes] = None
# Counter for total message size
self._data_size = 0
if msg:
self.update(msg)
def update(self, msg: bytes) -> _CMAC:
"""Authenticate the next chunk of message.
Args:
data (byte string/byte array/memoryview): The next chunk of data
"""
if self._mac_tag is not None and not self._update_after_digest:
raise core.InvalidStateError(
"update() cannot be called after digest() or verify()"
)
self._data_size += len(msg)
bs = self._block_size
if self._cache_n > 0:
filler = min(bs - self._cache_n, len(msg))
self._cache[self._cache_n : self._cache_n + filler] = msg[:filler]
self._cache_n += filler
if self._cache_n < bs:
return self
msg = msg[filler:]
self._update(self._cache)
self._cache_n = 0
remain = len(msg) % bs
if remain > 0:
self._update(msg[:-remain])
self._cache[:remain] = msg[-remain:]
else:
self._update(msg)
self._cache_n = remain
return self
def _update(self, data_block: bytes) -> None:
"""Update a block aligned to the block boundary"""
bs = self._block_size
assert len(data_block) % bs == 0
if len(data_block) == 0:
return
ct = self._cbc.encrypt(data_block)
if len(data_block) == bs:
second_last = self._last_ct
else:
second_last = ct[-bs * 2 : -bs]
self._last_ct = ct[-bs:]
self._last_pt = _xor(second_last, data_block[-bs:])
def digest(self) -> bytes:
bs = self._block_size
if self._mac_tag is not None and not self._update_after_digest:
return self._mac_tag
if self._data_size > self._max_size:
raise core.InvalidArgumentError("MAC is unsafe for this message")
if self._cache_n == 0 and self._data_size > 0 and self._last_pt:
# Last block was full
pt = _xor(self._last_pt, self._k1)
else:
# Last block is partial (or message length is zero)
partial = self._cache[:]
partial[self._cache_n :] = b'\x80' + b'\x00' * (bs - self._cache_n - 1)
pt = _xor(_xor(self._last_ct, partial), self._k2)
self._mac_tag = self._ecb.encrypt(pt)[: self.digest_size]
return self._mac_tag
# Define the original Point class for clarity and conversion purposes
@dataclasses.dataclass
class _Point:
"""Represents a point on the elliptic curve in affine coordinates."""
curve: _EllipticCurve
x: int = 0
y: int = 0
infinite: bool = False
@dataclasses.dataclass(frozen=True)
class _JacobianPoint:
"""Represents a point on the elliptic curve in Jacobian coordinates."""
curve: _EllipticCurve
x: int = 1 # For point at infinity (1:1:0)
y: int = 1
z: int = 0 # z = 0 indicates point at infinity
@classmethod
def point_at_infinity(cls, curve: _EllipticCurve) -> _JacobianPoint:
return _JacobianPoint(curve=curve, x=1, y=1, z=0)
@classmethod
def from_affine(cls, affine_point: _Point) -> _JacobianPoint:
if affine_point.infinite:
return _JacobianPoint.point_at_infinity(affine_point.curve)
# A simple conversion is (x, y, 1)
return _JacobianPoint(
curve=affine_point.curve, x=affine_point.x, y=affine_point.y, z=1
)
def to_affine(self) -> _Point:
if self.z == 0:
return _Point(infinite=True, curve=self.curve)
p = self.curve.p
inv_z = pow(self.z, -1, p)
affine_x = (self.x * inv_z**2) % p
affine_y = (self.y * inv_z**3) % p
return _Point(curve=self.curve, x=affine_x, y=affine_y, infinite=False)
def double(self) -> _JacobianPoint:
if self.z == 0 or self.y == 0:
return _JacobianPoint.point_at_infinity(self.curve)
s = 4 * self.x * self.y**2
m = 3 * self.x**2 + self.curve.a * self.z**4
x2 = m**2 - 2 * s
y2 = m * (s - x2) - 8 * self.y**4
z2 = 2 * self.y * self.z
p = self.curve.p
return _JacobianPoint(curve=self.curve, x=x2 % p, y=y2 % p, z=z2 % p)
def __add__(self, other: _JacobianPoint) -> _JacobianPoint:
if self.z == 0 and other.z == 0:
return _JacobianPoint.point_at_infinity(self.curve)
elif self.z == 0:
return other
elif other.z == 0:
return self
x1 = self.x
y1 = self.y
z1 = self.z
x2 = other.x
y2 = other.y
z2 = other.z
p = self.curve.p
u1 = (x1 * z2**2) % p
u2 = (x2 * z1**2) % p
s1 = (y1 * z2**3) % p
s2 = (y2 * z1**3) % p
if u1 == u2:
if s1 != s2:
return _JacobianPoint.point_at_infinity(self.curve)
else:
return self.double()
else:
h = u2 - u1
r = s2 - s1
h3 = h**3 % p
u1h2 = (u1 * h**2) % p
x3 = r**2 - h3 - 2 * u1h2
y3 = r * (u1h2 - x3) - s1 * h3
z3 = h * z1 * z2
return _JacobianPoint(self.curve, x3 % p, y3 % p, z3 % p)
def __mul__(self, k: int) -> _JacobianPoint:
addend = self
result = _JacobianPoint.point_at_infinity(self.curve)
while k > 0:
if k % 2 != 0:
result = result + addend
addend = addend.double()
k = k >> 1
return result
def __rmul__(self, k: int) -> _JacobianPoint:
return self * k
@dataclasses.dataclass
class _EllipticCurve:
p: int
a: int
b: int
n: int
g_x: int
g_y: int
_generator_jacobian: _JacobianPoint = dataclasses.field(init=False)
def __post_init__(self):
self._generator_jacobian = _JacobianPoint(
curve=self, x=self.g_x, y=self.g_y, z=1
)
@dataclasses.dataclass
class PrivateKey:
key: int
curve: _EllipticCurve
def generate_private_key(self) -> PrivateKey:
"""Generates a random private key."""
return self.PrivateKey(key=secrets.randbelow(self.n), curve=self)
def generate_public_key(self, private_key: int) -> _Point:
"""Generates a public key from a private key using Jacobian coordinates for scalar multiplication."""
public_key_jacobian = self._generator_jacobian * private_key
return public_key_jacobian.to_affine()
def ecdh_shared_secret(self, private_key: int, other_public_key: _Point) -> bytes:
"""Computes the shared secret using ECDH."""
other_public_key_jacobian = _JacobianPoint.from_affine(other_public_key)
shared_point_jacobian = other_public_key_jacobian * private_key
shared_point_affine = shared_point_jacobian.to_affine()
if shared_point_affine.infinite:
raise core.InvalidPacketError(
"Shared secret calculation resulted in the point at infinite"
)
return shared_point_affine.x.to_bytes(32, 'big')
@classmethod
def SECP256R1(cls) -> _EllipticCurve:
p = 0xFFFFFFFF00000001000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFF
a = 0xFFFFFFFF00000001000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFC
b = 0x5AC635D8AA3A93E7B3EBBD55769886BC651D06B0CC53B0F63BCE3C3E27D2604B
n = 0xFFFFFFFF00000000FFFFFFFFFFFFFFFFBCE6FAADA7179E84F3B9CAC2FC632551 # Curve order
g_x = 0x6B17D1F2E12C4247F8BCE6E563A440F277037D812DEB33A0F4A13945D898C296
g_y = 0x4FE342E2FE1A7F9B8EE7EB4A7C0F9E162BCE33576B315ECECBB6406837BF51F5
return _EllipticCurve(p=p, a=a, b=b, n=n, g_x=g_x, g_y=g_y)
class EccKey:
def __init__(self, private_key: _EllipticCurve.PrivateKey) -> None:
self.private_key = private_key
@functools.cached_property
def x(self) -> bytes:
return self.private_key.curve.generate_public_key(
self.private_key.key
).x.to_bytes(32, byteorder='big')
@functools.cached_property
def y(self) -> bytes:
return self.private_key.curve.generate_public_key(
self.private_key.key
).y.to_bytes(32, byteorder='big')
def dh(self, public_key_x: bytes, public_key_y: bytes) -> bytes:
x = int.from_bytes(public_key_x, byteorder='big', signed=False)
y = int.from_bytes(public_key_y, byteorder='big', signed=False)
return self.private_key.curve.ecdh_shared_secret(
self.private_key.key,
_Point(x=x, y=y, curve=self.private_key.curve),
)
@classmethod
def generate(cls) -> EccKey:
return EccKey(_EllipticCurve.SECP256R1().generate_private_key())
@classmethod
def from_private_key_bytes(cls, d_bytes: bytes) -> EccKey:
d = int.from_bytes(d_bytes, byteorder='big', signed=False)
return EccKey(_EllipticCurve.PrivateKey(d, _EllipticCurve.SECP256R1()))
def e(key: bytes, data: bytes) -> bytes:
'''
AES-128 ECB, expecting byte-swapped inputs and producing a byte-swapped output.
See Bluetooth spec Vol 3, Part H - 2.2.1 Security function e
'''
return _ECB(key[::-1]).encrypt(data[::-1])[::-1]
def aes_cmac(m: bytes, k: bytes) -> bytes:
'''
See Bluetooth spec, Vol 3, Part H - 2.2.5 FunctionAES-CMAC
NOTE: the input and output of this internal function are in big-endian byte order
'''
return _CMAC(key=k, msg=m).digest()
-82
View File
@@ -1,82 +0,0 @@
# Copyright 2021-2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License")
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import functools
from cryptography.hazmat.primitives import ciphers, cmac
from cryptography.hazmat.primitives.asymmetric import ec
from cryptography.hazmat.primitives.ciphers import algorithms, modes
def e(key: bytes, data: bytes) -> bytes:
'''
AES-128 ECB, expecting byte-swapped inputs and producing a byte-swapped output.
See Bluetooth spec Vol 3, Part H - 2.2.1 Security function e
'''
cipher = ciphers.Cipher(algorithms.AES(key[::-1]), modes.ECB())
encryptor = cipher.encryptor()
return encryptor.update(data[::-1])[::-1]
class EccKey:
def __init__(self, private_key: ec.EllipticCurvePrivateKey) -> None:
self.private_key = private_key
@classmethod
def generate(cls) -> EccKey:
return EccKey(ec.generate_private_key(ec.SECP256R1()))
@classmethod
def from_private_key_bytes(cls, d_bytes: bytes) -> EccKey:
d = int.from_bytes(d_bytes, byteorder='big', signed=False)
return EccKey(ec.derive_private_key(d, ec.SECP256R1()))
@functools.cached_property
def x(self) -> bytes:
return (
self.private_key.public_key()
.public_numbers()
.x.to_bytes(32, byteorder='big')
)
@functools.cached_property
def y(self) -> bytes:
return (
self.private_key.public_key()
.public_numbers()
.y.to_bytes(32, byteorder='big')
)
def dh(self, public_key_x: bytes, public_key_y: bytes) -> bytes:
x = int.from_bytes(public_key_x, byteorder='big', signed=False)
y = int.from_bytes(public_key_y, byteorder='big', signed=False)
return self.private_key.exchange(
ec.ECDH(),
ec.EllipticCurvePublicNumbers(x, y, ec.SECP256R1()).public_key(),
)
def aes_cmac(m: bytes, k: bytes) -> bytes:
'''
See Bluetooth spec, Vol 3, Part H - 2.2.5 FunctionAES-CMAC
NOTE: the input and output of this internal function are in big-endian byte order
'''
mac = cmac.CMAC(algorithms.AES(k))
mac.update(m)
return mac.finalize()
-1025
View File
File diff suppressed because it is too large Load Diff
+442 -693
View File
File diff suppressed because it is too large Load Diff
+3 -4
View File
@@ -20,13 +20,12 @@ like loading firmware after a cold start.
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import logging import logging
import pathlib import pathlib
import platform import platform
from typing import TYPE_CHECKING, Iterable, Optional from typing import Dict, Iterable, Optional, Type, TYPE_CHECKING
from bumble.drivers import intel, rtk from bumble.drivers import rtk, intel
from bumble.drivers.common import Driver from bumble.drivers.common import Driver
if TYPE_CHECKING: if TYPE_CHECKING:
@@ -46,7 +45,7 @@ async def get_driver_for_host(host: Host) -> Optional[Driver]:
found. found.
If a "driver" HCI metadata entry is present, only that driver class will be probed. If a "driver" HCI metadata entry is present, only that driver class will be probed.
""" """
driver_classes: dict[str, type[Driver]] = {"rtk": rtk.Driver, "intel": intel.Driver} driver_classes: Dict[str, Type[Driver]] = {"rtk": rtk.Driver, "intel": intel.Driver}
probe_list: Iterable[str] probe_list: Iterable[str]
if driver_name := host.hci_metadata.get("driver"): if driver_name := host.hci_metadata.get("driver"):
# Only probe a single driver # Only probe a single driver
+2
View File
@@ -20,6 +20,8 @@ Common types for drivers.
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import abc import abc
from bumble import core
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Classes # Classes
+41 -40
View File
@@ -20,7 +20,6 @@ Loosely based on the Fuchsia OS implementation.
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import collections import collections
import dataclasses import dataclasses
@@ -29,10 +28,12 @@ import os
import pathlib import pathlib
import platform import platform
import struct import struct
from typing import TYPE_CHECKING, Any, Optional from typing import Any, Deque, Optional, TYPE_CHECKING
from bumble import core, hci, utils from bumble import core
from bumble.drivers import common from bumble.drivers import common
from bumble import hci
from bumble import utils
if TYPE_CHECKING: if TYPE_CHECKING:
from bumble.host import Host from bumble.host import Host
@@ -49,7 +50,6 @@ logger = logging.getLogger(__name__)
INTEL_USB_PRODUCTS = { INTEL_USB_PRODUCTS = {
(0x8087, 0x0032), # AX210 (0x8087, 0x0032), # AX210
(0x8087, 0x0033), # AX211
(0x8087, 0x0036), # BE200 (0x8087, 0x0036), # BE200
} }
@@ -89,51 +89,54 @@ HCI_INTEL_WRITE_BOOT_PARAMS_COMMAND = hci.hci_vendor_command_op_code(0x000E)
hci.HCI_Command.register_commands(globals()) hci.HCI_Command.register_commands(globals())
@hci.HCI_Command.command @hci.HCI_Command.command(
@dataclasses.dataclass fields=[
class HCI_Intel_Read_Version_Command(hci.HCI_Command): ("param0", 1),
param0: int = dataclasses.field(metadata=hci.metadata(1)) ],
return_parameters_fields=[
return_parameters_fields = [
("status", hci.STATUS_SPEC), ("status", hci.STATUS_SPEC),
("tlv", "*"), ("tlv", "*"),
] ],
)
class HCI_Intel_Read_Version_Command(hci.HCI_Command):
pass
@hci.HCI_Command.command @hci.HCI_Command.command(
@dataclasses.dataclass fields=[("data_type", 1), ("data", "*")],
class Hci_Intel_Secure_Send_Command(hci.HCI_Command): return_parameters_fields=[
data_type: int = dataclasses.field(metadata=hci.metadata(1))
data: bytes = dataclasses.field(metadata=hci.metadata("*"))
return_parameters_fields = [
("status", 1), ("status", 1),
] ],
)
class Hci_Intel_Secure_Send_Command(hci.HCI_Command):
pass
@hci.HCI_Command.command @hci.HCI_Command.command(
@dataclasses.dataclass fields=[
class HCI_Intel_Reset_Command(hci.HCI_Command): ("reset_type", 1),
reset_type: int = dataclasses.field(metadata=hci.metadata(1)) ("patch_enable", 1),
patch_enable: int = dataclasses.field(metadata=hci.metadata(1)) ("ddc_reload", 1),
ddc_reload: int = dataclasses.field(metadata=hci.metadata(1)) ("boot_option", 1),
boot_option: int = dataclasses.field(metadata=hci.metadata(1)) ("boot_address", 4),
boot_address: int = dataclasses.field(metadata=hci.metadata(4)) ],
return_parameters_fields=[
return_parameters_fields = [
("data", "*"), ("data", "*"),
] ],
)
class HCI_Intel_Reset_Command(hci.HCI_Command):
pass
@hci.HCI_Command.command @hci.HCI_Command.command(
@dataclasses.dataclass fields=[("data", "*")],
class Hci_Intel_Write_Device_Config_Command(hci.HCI_Command): return_parameters_fields=[
data: bytes = dataclasses.field(metadata=hci.metadata("*"))
return_parameters_fields = [
("status", hci.STATUS_SPEC), ("status", hci.STATUS_SPEC),
("params", "*"), ("params", "*"),
] ],
)
class Hci_Intel_Write_Device_Config_Command(hci.HCI_Command):
pass
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -290,7 +293,6 @@ class HardwareVariant(utils.OpenIntEnum):
# This is a just a partial list. # This is a just a partial list.
# Add other constants here as new hardware is encountered and tested. # Add other constants here as new hardware is encountered and tested.
TYPHOON_PEAK = 0x17 TYPHOON_PEAK = 0x17
GARFIELD_PEAK = 0x19
GALE_PEAK = 0x1C GALE_PEAK = 0x1C
@@ -344,7 +346,7 @@ class Driver(common.Driver):
def __init__(self, host: Host) -> None: def __init__(self, host: Host) -> None:
self.host = host self.host = host
self.max_in_flight_firmware_load_commands = 1 self.max_in_flight_firmware_load_commands = 1
self.pending_firmware_load_commands: collections.deque[hci.HCI_Command] = ( self.pending_firmware_load_commands: Deque[hci.HCI_Command] = (
collections.deque() collections.deque()
) )
self.can_send_firmware_load_command = asyncio.Event() self.can_send_firmware_load_command = asyncio.Event()
@@ -469,7 +471,6 @@ class Driver(common.Driver):
raise DriverError("hardware platform not supported") raise DriverError("hardware platform not supported")
if hardware_info.variant not in ( if hardware_info.variant not in (
HardwareVariant.TYPHOON_PEAK, HardwareVariant.TYPHOON_PEAK,
HardwareVariant.GARFIELD_PEAK,
HardwareVariant.GALE_PEAK, HardwareVariant.GALE_PEAK,
): ):
raise DriverError("hardware variant not supported") raise DriverError("hardware variant not supported")
+42 -52
View File
@@ -17,6 +17,10 @@ Based on various online bits of information, including the Linux kernel.
(see `drivers/bluetooth/btrtl.c`) (see `drivers/bluetooth/btrtl.c`)
""" """
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from dataclasses import dataclass
import asyncio import asyncio
import enum import enum
import logging import logging
@@ -25,14 +29,19 @@ import os
import pathlib import pathlib
import platform import platform
import struct import struct
from typing import Tuple
import weakref import weakref
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from dataclasses import dataclass, field
from bumble import core, hci from bumble import core
from bumble.hci import (
hci_vendor_command_op_code,
STATUS_SPEC,
HCI_SUCCESS,
HCI_Command,
HCI_Reset_Command,
HCI_Read_Local_Version_Information_Command,
)
from bumble.drivers import common from bumble.drivers import common
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -174,29 +183,27 @@ RTK_USB_PRODUCTS = {
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# HCI Commands # HCI Commands
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
HCI_RTK_READ_ROM_VERSION_COMMAND = hci.hci_vendor_command_op_code(0x6D) HCI_RTK_READ_ROM_VERSION_COMMAND = hci_vendor_command_op_code(0x6D)
HCI_RTK_DOWNLOAD_COMMAND = hci.hci_vendor_command_op_code(0x20) HCI_RTK_DOWNLOAD_COMMAND = hci_vendor_command_op_code(0x20)
HCI_RTK_DROP_FIRMWARE_COMMAND = hci.hci_vendor_command_op_code(0x66) HCI_RTK_DROP_FIRMWARE_COMMAND = hci_vendor_command_op_code(0x66)
hci.HCI_Command.register_commands(globals()) HCI_Command.register_commands(globals())
@hci.HCI_Command.command @HCI_Command.command(return_parameters_fields=[("status", STATUS_SPEC), ("version", 1)])
@dataclass class HCI_RTK_Read_ROM_Version_Command(HCI_Command):
class HCI_RTK_Read_ROM_Version_Command(hci.HCI_Command): pass
return_parameters_fields = [("status", hci.STATUS_SPEC), ("version", 1)]
@hci.HCI_Command.command @HCI_Command.command(
@dataclass fields=[("index", 1), ("payload", RTK_FRAGMENT_LENGTH)],
class HCI_RTK_Download_Command(hci.HCI_Command): return_parameters_fields=[("status", STATUS_SPEC), ("index", 1)],
index: int = field(metadata=hci.metadata(1)) )
payload: bytes = field(metadata=hci.metadata(RTK_FRAGMENT_LENGTH)) class HCI_RTK_Download_Command(HCI_Command):
return_parameters_fields = [("status", hci.STATUS_SPEC), ("index", 1)] pass
@hci.HCI_Command.command @HCI_Command.command()
@dataclass class HCI_RTK_Drop_Firmware_Command(HCI_Command):
class HCI_RTK_Drop_Firmware_Command(hci.HCI_Command):
pass pass
@@ -287,7 +294,7 @@ class Driver(common.Driver):
@dataclass @dataclass
class DriverInfo: class DriverInfo:
rom: int rom: int
hci: tuple[int, int] hci: Tuple[int, int]
config_needed: bool config_needed: bool
has_rom_version: bool has_rom_version: bool
has_msft_ext: bool = False has_msft_ext: bool = False
@@ -488,36 +495,21 @@ class Driver(common.Driver):
return True return True
@staticmethod
async def get_loaded_firmware_version(host):
response = await host.send_command(HCI_RTK_Read_ROM_Version_Command())
if response.return_parameters.status != hci.HCI_SUCCESS:
return None
response = await host.send_command(
hci.HCI_Read_Local_Version_Information_Command(), check_result=True
)
return (
response.return_parameters.hci_subversion << 16
| response.return_parameters.lmp_subversion
)
@classmethod @classmethod
async def driver_info_for_host(cls, host): async def driver_info_for_host(cls, host):
try: try:
await host.send_command( await host.send_command(
hci.HCI_Reset_Command(), HCI_Reset_Command(),
check_result=True, check_result=True,
response_timeout=cls.POST_RESET_DELAY, response_timeout=cls.POST_RESET_DELAY,
) )
host.ready = True # Needed to let the host know the controller is ready. host.ready = True # Needed to let the host know the controller is ready.
except asyncio.exceptions.TimeoutError: except asyncio.exceptions.TimeoutError:
logger.warning("timeout waiting for hci reset, retrying") logger.warning("timeout waiting for hci reset, retrying")
await host.send_command(hci.HCI_Reset_Command(), check_result=True) await host.send_command(HCI_Reset_Command(), check_result=True)
host.ready = True host.ready = True
command = hci.HCI_Read_Local_Version_Information_Command() command = HCI_Read_Local_Version_Information_Command()
response = await host.send_command(command, check_result=True) response = await host.send_command(command, check_result=True)
if response.command_opcode != command.op_code: if response.command_opcode != command.op_code:
logger.error("failed to probe local version information") logger.error("failed to probe local version information")
@@ -604,9 +596,9 @@ class Driver(common.Driver):
response = await self.host.send_command( response = await self.host.send_command(
HCI_RTK_Read_ROM_Version_Command(), check_result=True HCI_RTK_Read_ROM_Version_Command(), check_result=True
) )
if response.return_parameters.status != hci.HCI_SUCCESS: if response.return_parameters.status != HCI_SUCCESS:
logger.warning("can't get ROM version") logger.warning("can't get ROM version")
return None return
rom_version = response.return_parameters.version rom_version = response.return_parameters.version
logger.debug(f"ROM version before download: {rom_version:04X}") logger.debug(f"ROM version before download: {rom_version:04X}")
else: else:
@@ -614,14 +606,13 @@ class Driver(common.Driver):
firmware = Firmware(self.firmware) firmware = Firmware(self.firmware)
logger.debug(f"firmware: project_id=0x{firmware.project_id:04X}") logger.debug(f"firmware: project_id=0x{firmware.project_id:04X}")
logger.debug(f"firmware: version=0x{firmware.version:04X}")
for patch in firmware.patches: for patch in firmware.patches:
if patch[0] == rom_version + 1: if patch[0] == rom_version + 1:
logger.debug(f"using patch {patch[0]}") logger.debug(f"using patch {patch[0]}")
break break
else: else:
logger.warning("no valid patch found for rom version {rom_version}") logger.warning("no valid patch found for rom version {rom_version}")
return None return
# Append the config if there is one. # Append the config if there is one.
if self.config: if self.config:
@@ -643,8 +634,9 @@ class Driver(common.Driver):
fragment = payload[fragment_offset : fragment_offset + RTK_FRAGMENT_LENGTH] fragment = payload[fragment_offset : fragment_offset + RTK_FRAGMENT_LENGTH]
logger.debug(f"downloading fragment {fragment_index}") logger.debug(f"downloading fragment {fragment_index}")
await self.host.send_command( await self.host.send_command(
HCI_RTK_Download_Command(index=download_index, payload=fragment), HCI_RTK_Download_Command(
check_result=True, index=download_index, payload=fragment, check_result=True
)
) )
logger.debug("download complete!") logger.debug("download complete!")
@@ -653,13 +645,11 @@ class Driver(common.Driver):
response = await self.host.send_command( response = await self.host.send_command(
HCI_RTK_Read_ROM_Version_Command(), check_result=True HCI_RTK_Read_ROM_Version_Command(), check_result=True
) )
if response.return_parameters.status != hci.HCI_SUCCESS: if response.return_parameters.status != HCI_SUCCESS:
logger.warning("can't get ROM version") logger.warning("can't get ROM version")
else: else:
rom_version = response.return_parameters.version rom_version = response.return_parameters.version
logger.debug(f"ROM version after download: {rom_version:02X}") logger.debug(f"ROM version after download: {rom_version:04X}")
return firmware.version
async def download_firmware(self): async def download_firmware(self):
if self.driver_info.rom == RTK_ROM_LMP_8723A: if self.driver_info.rom == RTK_ROM_LMP_8723A:
@@ -678,7 +668,7 @@ class Driver(common.Driver):
async def init_controller(self): async def init_controller(self):
await self.download_firmware() await self.download_firmware()
await self.host.send_command(hci.HCI_Reset_Command(), check_result=True) await self.host.send_command(HCI_Reset_Command(), check_result=True)
logger.info(f"loaded FW image {self.driver_info.fw_name}") logger.info(f"loaded FW image {self.driver_info.fw_name}")
+4 -4
View File
@@ -19,11 +19,11 @@ import logging
import struct import struct
from bumble.gatt import ( from bumble.gatt import (
GATT_APPEARANCE_CHARACTERISTIC,
GATT_DEVICE_NAME_CHARACTERISTIC,
GATT_GENERIC_ACCESS_SERVICE,
Characteristic,
Service, Service,
Characteristic,
GATT_GENERIC_ACCESS_SERVICE,
GATT_DEVICE_NAME_CHARACTERISTIC,
GATT_APPEARANCE_CHARACTERISTIC,
) )
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
+11 -8
View File
@@ -23,16 +23,15 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import enum import enum
import functools import functools
import logging import logging
import struct import struct
from typing import Iterable, Optional, Sequence, TypeVar, Union from typing import Iterable, List, Optional, Sequence, TypeVar, Union
from bumble.att import Attribute, AttributeValue
from bumble.colors import color from bumble.colors import color
from bumble.core import UUID, BaseBumbleError from bumble.core import BaseBumbleError, UUID
from bumble.att import Attribute, AttributeValue
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Typing # Typing
@@ -351,8 +350,8 @@ class Service(Attribute):
''' '''
uuid: UUID uuid: UUID
characteristics: list[Characteristic] characteristics: List[Characteristic]
included_services: list[Service] included_services: List[Service]
def __init__( def __init__(
self, self,
@@ -475,7 +474,7 @@ class Characteristic(Attribute[_T]):
# The check for `p.name is not None` here is needed because for InFlag # The check for `p.name is not None` here is needed because for InFlag
# enums, the .name property can be None, when the enum value is 0, # enums, the .name property can be None, when the enum value is 0,
# so the type hint for .name is Optional[str]. # so the type hint for .name is Optional[str].
enum_list: list[str] = [p.name for p in cls if p.name is not None] enum_list: List[str] = [p.name for p in cls if p.name is not None]
enum_list_str = ",".join(enum_list) enum_list_str = ",".join(enum_list)
raise TypeError( raise TypeError(
f"Characteristic.Properties::from_string() error:\nExpected a string containing any of the keys, separated by , or |: {enum_list_str}\nGot: {properties_str}" f"Characteristic.Properties::from_string() error:\nExpected a string containing any of the keys, separated by , or |: {enum_list_str}\nGot: {properties_str}"
@@ -580,7 +579,11 @@ class Descriptor(Attribute):
if isinstance(self.value, bytes): if isinstance(self.value, bytes):
value_str = self.value.hex() value_str = self.value.hex()
elif isinstance(self.value, CharacteristicValue): elif isinstance(self.value, CharacteristicValue):
value_str = '<dynamic>' value = self.value.read(None)
if isinstance(value, bytes):
value_str = value.hex()
else:
value_str = '<async>'
else: else:
value_str = '<...>' value_str = '<...>'
return ( return (
+16 -7
View File
@@ -20,14 +20,23 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import struct import struct
from typing import Any, Callable, Generic, Iterable, Literal, Optional, TypeVar from typing import (
Any,
Callable,
Generic,
Iterable,
Literal,
Optional,
Type,
TypeVar,
)
from bumble import utils
from bumble.core import InvalidOperationError from bumble.core import InvalidOperationError
from bumble.gatt import Characteristic from bumble.gatt import Characteristic
from bumble.gatt_client import CharacteristicProxy from bumble.gatt_client import CharacteristicProxy
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Typing # Typing
@@ -261,7 +270,7 @@ class SerializableCharacteristicAdapter(CharacteristicAdapter[_T2]):
`to_bytes` and `__bytes__` methods, respectively. `to_bytes` and `__bytes__` methods, respectively.
''' '''
def __init__(self, characteristic: Characteristic, cls: type[_T2]) -> None: def __init__(self, characteristic: Characteristic, cls: Type[_T2]) -> None:
super().__init__(characteristic) super().__init__(characteristic)
self.cls = cls self.cls = cls
@@ -280,7 +289,7 @@ class SerializableCharacteristicProxyAdapter(CharacteristicProxyAdapter[_T2]):
''' '''
def __init__( def __init__(
self, characteristic_proxy: CharacteristicProxy, cls: type[_T2] self, characteristic_proxy: CharacteristicProxy, cls: Type[_T2]
) -> None: ) -> None:
super().__init__(characteristic_proxy) super().__init__(characteristic_proxy)
self.cls = cls self.cls = cls
@@ -302,7 +311,7 @@ class EnumCharacteristicAdapter(CharacteristicAdapter[_T3]):
def __init__( def __init__(
self, self,
characteristic: Characteristic, characteristic: Characteristic,
cls: type[_T3], cls: Type[_T3],
length: int, length: int,
byteorder: Literal['little', 'big'] = 'little', byteorder: Literal['little', 'big'] = 'little',
): ):
@@ -338,7 +347,7 @@ class EnumCharacteristicProxyAdapter(CharacteristicProxyAdapter[_T3]):
def __init__( def __init__(
self, self,
characteristic_proxy: CharacteristicProxy, characteristic_proxy: CharacteristicProxy,
cls: type[_T3], cls: Type[_T3],
length: int, length: int,
byteorder: Literal['little', 'big'] = 'little', byteorder: Literal['little', 'big'] = 'little',
): ):
+112 -95
View File
@@ -24,38 +24,65 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import logging import logging
import struct import struct
from datetime import datetime from datetime import datetime
from typing import ( from typing import (
TYPE_CHECKING,
Any, Any,
Callable, Callable,
Dict,
Generic, Generic,
Iterable, Iterable,
List,
Optional, Optional,
TypeVar, Set,
Tuple,
Union, Union,
Type,
TypeVar,
TYPE_CHECKING,
) )
from bumble import att, core, utils
from bumble.colors import color from bumble.colors import color
from bumble.hci import HCI_Constant
from bumble.att import (
ATT_ATTRIBUTE_NOT_FOUND_ERROR,
ATT_ATTRIBUTE_NOT_LONG_ERROR,
ATT_CID,
ATT_DEFAULT_MTU,
ATT_ERROR_RESPONSE,
ATT_INVALID_OFFSET_ERROR,
ATT_PDU,
ATT_RESPONSES,
ATT_Exchange_MTU_Request,
ATT_Find_By_Type_Value_Request,
ATT_Find_Information_Request,
ATT_Handle_Value_Confirmation,
ATT_Read_Blob_Request,
ATT_Read_By_Group_Type_Request,
ATT_Read_By_Type_Request,
ATT_Read_Request,
ATT_Write_Command,
ATT_Write_Request,
ATT_Error,
)
from bumble import utils
from bumble import core
from bumble.core import UUID, InvalidStateError from bumble.core import UUID, InvalidStateError
from bumble.gatt import ( from bumble.gatt import (
GATT_CHARACTERISTIC_ATTRIBUTE_TYPE, GATT_CHARACTERISTIC_ATTRIBUTE_TYPE,
GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR, GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR,
GATT_INCLUDE_ATTRIBUTE_TYPE,
GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE, GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE,
GATT_REQUEST_TIMEOUT, GATT_REQUEST_TIMEOUT,
GATT_SECONDARY_SERVICE_ATTRIBUTE_TYPE, GATT_SECONDARY_SERVICE_ATTRIBUTE_TYPE,
GATT_INCLUDE_ATTRIBUTE_TYPE,
Characteristic, Characteristic,
ClientCharacteristicConfigurationBits, ClientCharacteristicConfigurationBits,
InvalidServiceError, InvalidServiceError,
TemplateService, TemplateService,
) )
from bumble.hci import HCI_Constant
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Typing # Typing
@@ -122,8 +149,8 @@ class AttributeProxy(utils.EventEmitter, Generic[_T]):
class ServiceProxy(AttributeProxy): class ServiceProxy(AttributeProxy):
uuid: UUID uuid: UUID
characteristics: list[CharacteristicProxy[bytes]] characteristics: List[CharacteristicProxy[bytes]]
included_services: list[ServiceProxy] included_services: List[ServiceProxy]
@staticmethod @staticmethod
def from_client(service_class, client: Client, service_uuid: UUID): def from_client(service_class, client: Client, service_uuid: UUID):
@@ -172,8 +199,8 @@ class ServiceProxy(AttributeProxy):
class CharacteristicProxy(AttributeProxy[_T]): class CharacteristicProxy(AttributeProxy[_T]):
properties: Characteristic.Properties properties: Characteristic.Properties
descriptors: list[DescriptorProxy] descriptors: List[DescriptorProxy]
subscribers: dict[Any, Callable[[_T], Any]] subscribers: Dict[Any, Callable[[_T], Any]]
EVENT_UPDATE = "update" EVENT_UPDATE = "update"
@@ -250,7 +277,7 @@ class ProfileServiceProxy:
Base class for profile-specific service proxies Base class for profile-specific service proxies
''' '''
SERVICE_CLASS: type[TemplateService] SERVICE_CLASS: Type[TemplateService]
@classmethod @classmethod
def from_client(cls, client: Client) -> Optional[ProfileServiceProxy]: def from_client(cls, client: Client) -> Optional[ProfileServiceProxy]:
@@ -261,16 +288,16 @@ class ProfileServiceProxy:
# GATT Client # GATT Client
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Client: class Client:
services: list[ServiceProxy] services: List[ServiceProxy]
cached_values: dict[int, tuple[datetime, bytes]] cached_values: Dict[int, Tuple[datetime, bytes]]
notification_subscribers: dict[ notification_subscribers: Dict[
int, set[Union[CharacteristicProxy, Callable[[bytes], Any]]] int, Set[Union[CharacteristicProxy, Callable[[bytes], Any]]]
] ]
indication_subscribers: dict[ indication_subscribers: Dict[
int, set[Union[CharacteristicProxy, Callable[[bytes], Any]]] int, Set[Union[CharacteristicProxy, Callable[[bytes], Any]]]
] ]
pending_response: Optional[asyncio.futures.Future[att.ATT_PDU]] pending_response: Optional[asyncio.futures.Future[ATT_PDU]]
pending_request: Optional[att.ATT_PDU] pending_request: Optional[ATT_PDU]
def __init__(self, connection: Connection) -> None: def __init__(self, connection: Connection) -> None:
self.connection = connection self.connection = connection
@@ -286,15 +313,15 @@ class Client:
connection.on(connection.EVENT_DISCONNECTION, self.on_disconnection) connection.on(connection.EVENT_DISCONNECTION, self.on_disconnection)
def send_gatt_pdu(self, pdu: bytes) -> None: def send_gatt_pdu(self, pdu: bytes) -> None:
self.connection.send_l2cap_pdu(att.ATT_CID, pdu) self.connection.send_l2cap_pdu(ATT_CID, pdu)
async def send_command(self, command: att.ATT_PDU) -> None: async def send_command(self, command: ATT_PDU) -> None:
logger.debug( logger.debug(
f'GATT Command from client: [0x{self.connection.handle:04X}] {command}' f'GATT Command from client: [0x{self.connection.handle:04X}] {command}'
) )
self.send_gatt_pdu(bytes(command)) self.send_gatt_pdu(bytes(command))
async def send_request(self, request: att.ATT_PDU): async def send_request(self, request: ATT_PDU):
logger.debug( logger.debug(
f'GATT Request from client: [0x{self.connection.handle:04X}] {request}' f'GATT Request from client: [0x{self.connection.handle:04X}] {request}'
) )
@@ -323,9 +350,7 @@ class Client:
return response return response
def send_confirmation( def send_confirmation(self, confirmation: ATT_Handle_Value_Confirmation) -> None:
self, confirmation: att.ATT_Handle_Value_Confirmation
) -> None:
logger.debug( logger.debug(
f'GATT Confirmation from client: [0x{self.connection.handle:04X}] ' f'GATT Confirmation from client: [0x{self.connection.handle:04X}] '
f'{confirmation}' f'{confirmation}'
@@ -334,8 +359,8 @@ class Client:
async def request_mtu(self, mtu: int) -> int: async def request_mtu(self, mtu: int) -> int:
# Check the range # Check the range
if mtu < att.ATT_DEFAULT_MTU: if mtu < ATT_DEFAULT_MTU:
raise core.InvalidArgumentError(f'MTU must be >= {att.ATT_DEFAULT_MTU}') raise core.InvalidArgumentError(f'MTU must be >= {ATT_DEFAULT_MTU}')
if mtu > 0xFFFF: if mtu > 0xFFFF:
raise core.InvalidArgumentError('MTU must be <= 0xFFFF') raise core.InvalidArgumentError('MTU must be <= 0xFFFF')
@@ -345,23 +370,21 @@ class Client:
# Send the request # Send the request
self.mtu_exchange_done = True self.mtu_exchange_done = True
response = await self.send_request( response = await self.send_request(ATT_Exchange_MTU_Request(client_rx_mtu=mtu))
att.ATT_Exchange_MTU_Request(client_rx_mtu=mtu) if response.op_code == ATT_ERROR_RESPONSE:
) raise ATT_Error(error_code=response.error_code, message=response)
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE:
raise att.ATT_Error(error_code=response.error_code, message=response)
# Compute the final MTU # Compute the final MTU
self.connection.att_mtu = min(mtu, response.server_rx_mtu) self.connection.att_mtu = min(mtu, response.server_rx_mtu)
return self.connection.att_mtu return self.connection.att_mtu
def get_services_by_uuid(self, uuid: UUID) -> list[ServiceProxy]: def get_services_by_uuid(self, uuid: UUID) -> List[ServiceProxy]:
return [service for service in self.services if service.uuid == uuid] return [service for service in self.services if service.uuid == uuid]
def get_characteristics_by_uuid( def get_characteristics_by_uuid(
self, uuid: UUID, service: Optional[ServiceProxy] = None self, uuid: UUID, service: Optional[ServiceProxy] = None
) -> list[CharacteristicProxy[bytes]]: ) -> List[CharacteristicProxy[bytes]]:
services = [service] if service else self.services services = [service] if service else self.services
return [ return [
c c
@@ -372,8 +395,8 @@ class Client:
def get_attribute_grouping(self, attribute_handle: int) -> Optional[ def get_attribute_grouping(self, attribute_handle: int) -> Optional[
Union[ Union[
ServiceProxy, ServiceProxy,
tuple[ServiceProxy, CharacteristicProxy], Tuple[ServiceProxy, CharacteristicProxy],
tuple[ServiceProxy, CharacteristicProxy, DescriptorProxy], Tuple[ServiceProxy, CharacteristicProxy, DescriptorProxy],
] ]
]: ]:
""" """
@@ -406,7 +429,7 @@ class Client:
if not already_known: if not already_known:
self.services.append(service) self.services.append(service)
async def discover_services(self, uuids: Iterable[UUID] = ()) -> list[ServiceProxy]: async def discover_services(self, uuids: Iterable[UUID] = ()) -> List[ServiceProxy]:
''' '''
See Vol 3, Part G - 4.4.1 Discover All Primary Services See Vol 3, Part G - 4.4.1 Discover All Primary Services
''' '''
@@ -414,7 +437,7 @@ class Client:
services = [] services = []
while starting_handle < 0xFFFF: while starting_handle < 0xFFFF:
response = await self.send_request( response = await self.send_request(
att.ATT_Read_By_Group_Type_Request( ATT_Read_By_Group_Type_Request(
starting_handle=starting_handle, starting_handle=starting_handle,
ending_handle=0xFFFF, ending_handle=0xFFFF,
attribute_group_type=GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE, attribute_group_type=GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE,
@@ -425,14 +448,14 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering services: ' '!!! unexpected error while discovering services: '
f'{HCI_Constant.error_name(response.error_code)}' f'{HCI_Constant.error_name(response.error_code)}'
) )
raise att.ATT_Error( raise ATT_Error(
error_code=response.error_code, error_code=response.error_code,
message='Unexpected error while discovering services', message='Unexpected error while discovering services',
) )
@@ -478,7 +501,7 @@ class Client:
return services return services
async def discover_service(self, uuid: Union[str, UUID]) -> list[ServiceProxy]: async def discover_service(self, uuid: Union[str, UUID]) -> List[ServiceProxy]:
''' '''
See Vol 3, Part G - 4.4.2 Discover Primary Service by Service UUID See Vol 3, Part G - 4.4.2 Discover Primary Service by Service UUID
''' '''
@@ -491,7 +514,7 @@ class Client:
services = [] services = []
while starting_handle < 0xFFFF: while starting_handle < 0xFFFF:
response = await self.send_request( response = await self.send_request(
att.ATT_Find_By_Type_Value_Request( ATT_Find_By_Type_Value_Request(
starting_handle=starting_handle, starting_handle=starting_handle,
ending_handle=0xFFFF, ending_handle=0xFFFF,
attribute_type=GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE, attribute_type=GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE,
@@ -503,8 +526,8 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering services: ' '!!! unexpected error while discovering services: '
@@ -549,7 +572,7 @@ class Client:
async def discover_included_services( async def discover_included_services(
self, service: ServiceProxy self, service: ServiceProxy
) -> list[ServiceProxy]: ) -> List[ServiceProxy]:
''' '''
See Vol 3, Part G - 4.5.1 Find Included Services See Vol 3, Part G - 4.5.1 Find Included Services
''' '''
@@ -557,10 +580,10 @@ class Client:
starting_handle = service.handle starting_handle = service.handle
ending_handle = service.end_group_handle ending_handle = service.end_group_handle
included_services: list[ServiceProxy] = [] included_services: List[ServiceProxy] = []
while starting_handle <= ending_handle: while starting_handle <= ending_handle:
response = await self.send_request( response = await self.send_request(
att.ATT_Read_By_Type_Request( ATT_Read_By_Type_Request(
starting_handle=starting_handle, starting_handle=starting_handle,
ending_handle=ending_handle, ending_handle=ending_handle,
attribute_type=GATT_INCLUDE_ATTRIBUTE_TYPE, attribute_type=GATT_INCLUDE_ATTRIBUTE_TYPE,
@@ -571,14 +594,14 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering included services: ' '!!! unexpected error while discovering included services: '
f'{HCI_Constant.error_name(response.error_code)}' f'{HCI_Constant.error_name(response.error_code)}'
) )
raise att.ATT_Error( raise ATT_Error(
error_code=response.error_code, error_code=response.error_code,
message='Unexpected error while discovering included services', message='Unexpected error while discovering included services',
) )
@@ -613,7 +636,7 @@ class Client:
async def discover_characteristics( async def discover_characteristics(
self, uuids, service: Optional[ServiceProxy] self, uuids, service: Optional[ServiceProxy]
) -> list[CharacteristicProxy[bytes]]: ) -> List[CharacteristicProxy[bytes]]:
''' '''
See Vol 3, Part G - 4.6.1 Discover All Characteristics of a Service and 4.6.2 See Vol 3, Part G - 4.6.1 Discover All Characteristics of a Service and 4.6.2
Discover Characteristics by UUID Discover Characteristics by UUID
@@ -626,15 +649,15 @@ class Client:
services = [service] if service else self.services services = [service] if service else self.services
# Perform characteristic discovery for each service # Perform characteristic discovery for each service
discovered_characteristics: list[CharacteristicProxy[bytes]] = [] discovered_characteristics: List[CharacteristicProxy[bytes]] = []
for service in services: for service in services:
starting_handle = service.handle starting_handle = service.handle
ending_handle = service.end_group_handle ending_handle = service.end_group_handle
characteristics: list[CharacteristicProxy[bytes]] = [] characteristics: List[CharacteristicProxy[bytes]] = []
while starting_handle <= ending_handle: while starting_handle <= ending_handle:
response = await self.send_request( response = await self.send_request(
att.ATT_Read_By_Type_Request( ATT_Read_By_Type_Request(
starting_handle=starting_handle, starting_handle=starting_handle,
ending_handle=ending_handle, ending_handle=ending_handle,
attribute_type=GATT_CHARACTERISTIC_ATTRIBUTE_TYPE, attribute_type=GATT_CHARACTERISTIC_ATTRIBUTE_TYPE,
@@ -645,14 +668,14 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering characteristics: ' '!!! unexpected error while discovering characteristics: '
f'{HCI_Constant.error_name(response.error_code)}' f'{HCI_Constant.error_name(response.error_code)}'
) )
raise att.ATT_Error( raise ATT_Error(
error_code=response.error_code, error_code=response.error_code,
message='Unexpected error while discovering characteristics', message='Unexpected error while discovering characteristics',
) )
@@ -702,7 +725,7 @@ class Client:
characteristic: Optional[CharacteristicProxy] = None, characteristic: Optional[CharacteristicProxy] = None,
start_handle: Optional[int] = None, start_handle: Optional[int] = None,
end_handle: Optional[int] = None, end_handle: Optional[int] = None,
) -> list[DescriptorProxy]: ) -> List[DescriptorProxy]:
''' '''
See Vol 3, Part G - 4.7.1 Discover All Characteristic Descriptors See Vol 3, Part G - 4.7.1 Discover All Characteristic Descriptors
''' '''
@@ -715,10 +738,10 @@ class Client:
else: else:
return [] return []
descriptors: list[DescriptorProxy] = [] descriptors: List[DescriptorProxy] = []
while starting_handle <= ending_handle: while starting_handle <= ending_handle:
response = await self.send_request( response = await self.send_request(
att.ATT_Find_Information_Request( ATT_Find_Information_Request(
starting_handle=starting_handle, ending_handle=ending_handle starting_handle=starting_handle, ending_handle=ending_handle
) )
) )
@@ -727,8 +750,8 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering descriptors: ' '!!! unexpected error while discovering descriptors: '
@@ -764,7 +787,7 @@ class Client:
return descriptors return descriptors
async def discover_attributes(self) -> list[AttributeProxy[bytes]]: async def discover_attributes(self) -> List[AttributeProxy[bytes]]:
''' '''
Discover all attributes, regardless of type Discover all attributes, regardless of type
''' '''
@@ -773,7 +796,7 @@ class Client:
attributes = [] attributes = []
while True: while True:
response = await self.send_request( response = await self.send_request(
att.ATT_Find_Information_Request( ATT_Find_Information_Request(
starting_handle=starting_handle, ending_handle=ending_handle starting_handle=starting_handle, ending_handle=ending_handle
) )
) )
@@ -781,8 +804,8 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while discovering attributes: ' '!!! unexpected error while discovering attributes: '
@@ -936,12 +959,12 @@ class Client:
# Send a request to read # Send a request to read
attribute_handle = attribute if isinstance(attribute, int) else attribute.handle attribute_handle = attribute if isinstance(attribute, int) else attribute.handle
response = await self.send_request( response = await self.send_request(
att.ATT_Read_Request(attribute_handle=attribute_handle) ATT_Read_Request(attribute_handle=attribute_handle)
) )
if response is None: if response is None:
raise TimeoutError('read timeout') raise TimeoutError('read timeout')
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
raise att.ATT_Error(error_code=response.error_code, message=response) raise ATT_Error(error_code=response.error_code, message=response)
# If the value is the max size for the MTU, try to read more unless the caller # If the value is the max size for the MTU, try to read more unless the caller
# specifically asked not to do that # specifically asked not to do that
@@ -951,21 +974,19 @@ class Client:
offset = len(attribute_value) offset = len(attribute_value)
while True: while True:
response = await self.send_request( response = await self.send_request(
att.ATT_Read_Blob_Request( ATT_Read_Blob_Request(
attribute_handle=attribute_handle, value_offset=offset attribute_handle=attribute_handle, value_offset=offset
) )
) )
if response is None: if response is None:
raise TimeoutError('read timeout') raise TimeoutError('read timeout')
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code in ( if response.error_code in (
att.ATT_ATTRIBUTE_NOT_LONG_ERROR, ATT_ATTRIBUTE_NOT_LONG_ERROR,
att.ATT_INVALID_OFFSET_ERROR, ATT_INVALID_OFFSET_ERROR,
): ):
break break
raise att.ATT_Error( raise ATT_Error(error_code=response.error_code, message=response)
error_code=response.error_code, message=response
)
part = response.part_attribute_value part = response.part_attribute_value
attribute_value += part attribute_value += part
@@ -981,7 +1002,7 @@ class Client:
async def read_characteristics_by_uuid( async def read_characteristics_by_uuid(
self, uuid: UUID, service: Optional[ServiceProxy] self, uuid: UUID, service: Optional[ServiceProxy]
) -> list[bytes]: ) -> List[bytes]:
''' '''
See Vol 3, Part G - 4.8.2 Read Using Characteristic UUID See Vol 3, Part G - 4.8.2 Read Using Characteristic UUID
''' '''
@@ -996,7 +1017,7 @@ class Client:
characteristics_values = [] characteristics_values = []
while starting_handle <= ending_handle: while starting_handle <= ending_handle:
response = await self.send_request( response = await self.send_request(
att.ATT_Read_By_Type_Request( ATT_Read_By_Type_Request(
starting_handle=starting_handle, starting_handle=starting_handle,
ending_handle=ending_handle, ending_handle=ending_handle,
attribute_type=uuid, attribute_type=uuid,
@@ -1007,8 +1028,8 @@ class Client:
return [] return []
# Check if we reached the end of the iteration # Check if we reached the end of the iteration
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
if response.error_code != att.ATT_ATTRIBUTE_NOT_FOUND_ERROR: if response.error_code != ATT_ATTRIBUTE_NOT_FOUND_ERROR:
# Unexpected end # Unexpected end
logger.warning( logger.warning(
'!!! unexpected error while reading characteristics: ' '!!! unexpected error while reading characteristics: '
@@ -1053,15 +1074,15 @@ class Client:
attribute_handle = attribute if isinstance(attribute, int) else attribute.handle attribute_handle = attribute if isinstance(attribute, int) else attribute.handle
if with_response: if with_response:
response = await self.send_request( response = await self.send_request(
att.ATT_Write_Request( ATT_Write_Request(
attribute_handle=attribute_handle, attribute_value=value attribute_handle=attribute_handle, attribute_value=value
) )
) )
if response.op_code == att.Opcode.ATT_ERROR_RESPONSE: if response.op_code == ATT_ERROR_RESPONSE:
raise att.ATT_Error(error_code=response.error_code, message=response) raise ATT_Error(error_code=response.error_code, message=response)
else: else:
await self.send_command( await self.send_command(
att.ATT_Write_Command( ATT_Write_Command(
attribute_handle=attribute_handle, attribute_value=value attribute_handle=attribute_handle, attribute_value=value
) )
) )
@@ -1070,11 +1091,11 @@ class Client:
if self.pending_response and not self.pending_response.done(): if self.pending_response and not self.pending_response.done():
self.pending_response.cancel() self.pending_response.cancel()
def on_gatt_pdu(self, att_pdu: att.ATT_PDU) -> None: def on_gatt_pdu(self, att_pdu: ATT_PDU) -> None:
logger.debug( logger.debug(
f'GATT Response to client: [0x{self.connection.handle:04X}] {att_pdu}' f'GATT Response to client: [0x{self.connection.handle:04X}] {att_pdu}'
) )
if att_pdu.op_code in att.ATT_RESPONSES: if att_pdu.op_code in ATT_RESPONSES:
if self.pending_request is None: if self.pending_request is None:
# Not expected! # Not expected!
logger.warning('!!! unexpected response, there is no pending request') logger.warning('!!! unexpected response, there is no pending request')
@@ -1082,7 +1103,7 @@ class Client:
# The response should match the pending request unless it is # The response should match the pending request unless it is
# an error response # an error response
if att_pdu.op_code != att.Opcode.ATT_ERROR_RESPONSE: if att_pdu.op_code != ATT_ERROR_RESPONSE:
expected_response_name = self.pending_request.name.replace( expected_response_name = self.pending_request.name.replace(
'_REQUEST', '_RESPONSE' '_REQUEST', '_RESPONSE'
) )
@@ -1110,9 +1131,7 @@ class Client:
+ str(att_pdu) + str(att_pdu)
) )
def on_att_handle_value_notification( def on_att_handle_value_notification(self, notification):
self, notification: att.ATT_Handle_Value_Notification
):
# Call all subscribers # Call all subscribers
subscribers = self.notification_subscribers.get( subscribers = self.notification_subscribers.get(
notification.attribute_handle, set() notification.attribute_handle, set()
@@ -1127,9 +1146,7 @@ class Client:
else: else:
subscriber.emit(subscriber.EVENT_UPDATE, notification.attribute_value) subscriber.emit(subscriber.EVENT_UPDATE, notification.attribute_value)
def on_att_handle_value_indication( def on_att_handle_value_indication(self, indication):
self, indication: att.ATT_Handle_Value_Indication
):
# Call all subscribers # Call all subscribers
subscribers = self.indication_subscribers.get( subscribers = self.indication_subscribers.get(
indication.attribute_handle, set() indication.attribute_handle, set()
@@ -1145,7 +1162,7 @@ class Client:
subscriber.emit(subscriber.EVENT_UPDATE, indication.attribute_value) subscriber.emit(subscriber.EVENT_UPDATE, indication.attribute_value)
# Confirm that we received the indication # Confirm that we received the indication
self.send_confirmation(att.ATT_Handle_Value_Confirmation()) self.send_confirmation(ATT_Handle_Value_Confirmation())
def cache_value(self, attribute_handle: int, value: bytes) -> None: def cache_value(self, attribute_handle: int, value: bytes) -> None:
self.cached_values[attribute_handle] = ( self.cached_values[attribute_handle] = (
+136 -129
View File
@@ -13,7 +13,7 @@
# limitations under the License. # limitations under the License.
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# GATT - Generic att.Attribute Profile # GATT - Generic Attribute Profile
# Server # Server
# #
# See Bluetooth spec @ Vol 3, Part G # See Bluetooth spec @ Vol 3, Part G
@@ -24,16 +24,50 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import logging import logging
import struct
from collections import defaultdict from collections import defaultdict
from typing import TYPE_CHECKING, Iterable, Optional, TypeVar import struct
from typing import (
Dict,
Iterable,
List,
Optional,
Tuple,
TypeVar,
Type,
TYPE_CHECKING,
)
from bumble import att, utils
from bumble.colors import color from bumble.colors import color
from bumble.core import UUID from bumble.core import UUID
from bumble.att import (
ATT_ATTRIBUTE_NOT_FOUND_ERROR,
ATT_ATTRIBUTE_NOT_LONG_ERROR,
ATT_CID,
ATT_DEFAULT_MTU,
ATT_INVALID_ATTRIBUTE_LENGTH_ERROR,
ATT_INVALID_HANDLE_ERROR,
ATT_INVALID_OFFSET_ERROR,
ATT_REQUEST_NOT_SUPPORTED_ERROR,
ATT_REQUESTS,
ATT_PDU,
ATT_UNLIKELY_ERROR_ERROR,
ATT_UNSUPPORTED_GROUP_TYPE_ERROR,
ATT_Error,
ATT_Error_Response,
ATT_Exchange_MTU_Response,
ATT_Find_By_Type_Value_Response,
ATT_Find_Information_Response,
ATT_Handle_Value_Indication,
ATT_Handle_Value_Notification,
ATT_Read_Blob_Response,
ATT_Read_By_Group_Type_Response,
ATT_Read_By_Type_Response,
ATT_Read_Response,
ATT_Write_Response,
Attribute,
)
from bumble.gatt import ( from bumble.gatt import (
GATT_CHARACTERISTIC_ATTRIBUTE_TYPE, GATT_CHARACTERISTIC_ATTRIBUTE_TYPE,
GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR, GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR,
@@ -44,13 +78,14 @@ from bumble.gatt import (
Characteristic, Characteristic,
CharacteristicDeclaration, CharacteristicDeclaration,
CharacteristicValue, CharacteristicValue,
Descriptor,
IncludedServiceDeclaration, IncludedServiceDeclaration,
Descriptor,
Service, Service,
) )
from bumble import utils
if TYPE_CHECKING: if TYPE_CHECKING:
from bumble.device import Connection, Device from bumble.device import Device, Connection
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -68,10 +103,10 @@ GATT_SERVER_DEFAULT_MAX_MTU = 517
# GATT Server # GATT Server
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Server(utils.EventEmitter): class Server(utils.EventEmitter):
attributes: list[att.Attribute] attributes: List[Attribute]
services: list[Service] services: List[Service]
attributes_by_handle: dict[int, att.Attribute] attributes_by_handle: Dict[int, Attribute]
subscribers: dict[int, dict[int, bytes]] subscribers: Dict[int, Dict[int, bytes]]
indication_semaphores: defaultdict[int, asyncio.Semaphore] indication_semaphores: defaultdict[int, asyncio.Semaphore]
pending_confirmations: defaultdict[int, Optional[asyncio.futures.Future]] pending_confirmations: defaultdict[int, Optional[asyncio.futures.Future]]
@@ -81,7 +116,7 @@ class Server(utils.EventEmitter):
super().__init__() super().__init__()
self.device = device self.device = device
self.services = [] self.services = []
self.attributes = [] # att.Attributes, ordered by increasing handle values self.attributes = [] # Attributes, ordered by increasing handle values
self.attributes_by_handle = {} # Map for fast attribute access by handle self.attributes_by_handle = {} # Map for fast attribute access by handle
self.max_mtu = ( self.max_mtu = (
GATT_SERVER_DEFAULT_MAX_MTU # The max MTU we're willing to negotiate GATT_SERVER_DEFAULT_MAX_MTU # The max MTU we're willing to negotiate
@@ -96,12 +131,12 @@ class Server(utils.EventEmitter):
return "\n".join(map(str, self.attributes)) return "\n".join(map(str, self.attributes))
def send_gatt_pdu(self, connection_handle: int, pdu: bytes) -> None: def send_gatt_pdu(self, connection_handle: int, pdu: bytes) -> None:
self.device.send_l2cap_pdu(connection_handle, att.ATT_CID, pdu) self.device.send_l2cap_pdu(connection_handle, ATT_CID, pdu)
def next_handle(self) -> int: def next_handle(self) -> int:
return 1 + len(self.attributes) return 1 + len(self.attributes)
def get_advertising_service_data(self) -> dict[att.Attribute, bytes]: def get_advertising_service_data(self) -> Dict[Attribute, bytes]:
return { return {
attribute: data attribute: data
for attribute in self.attributes for attribute in self.attributes
@@ -109,7 +144,7 @@ class Server(utils.EventEmitter):
and (data := attribute.get_advertising_data()) and (data := attribute.get_advertising_data())
} }
def get_attribute(self, handle: int) -> Optional[att.Attribute]: def get_attribute(self, handle: int) -> Optional[Attribute]:
attribute = self.attributes_by_handle.get(handle) attribute = self.attributes_by_handle.get(handle)
if attribute: if attribute:
return attribute return attribute
@@ -125,7 +160,7 @@ class Server(utils.EventEmitter):
AttributeGroupType = TypeVar('AttributeGroupType', Service, Characteristic) AttributeGroupType = TypeVar('AttributeGroupType', Service, Characteristic)
def get_attribute_group( def get_attribute_group(
self, handle: int, group_type: type[AttributeGroupType] self, handle: int, group_type: Type[AttributeGroupType]
) -> Optional[AttributeGroupType]: ) -> Optional[AttributeGroupType]:
return next( return next(
( (
@@ -151,7 +186,7 @@ class Server(utils.EventEmitter):
def get_characteristic_attributes( def get_characteristic_attributes(
self, service_uuid: UUID, characteristic_uuid: UUID self, service_uuid: UUID, characteristic_uuid: UUID
) -> Optional[tuple[CharacteristicDeclaration, Characteristic]]: ) -> Optional[Tuple[CharacteristicDeclaration, Characteristic]]:
service_handle = self.get_service_attribute(service_uuid) service_handle = self.get_service_attribute(service_uuid)
if not service_handle: if not service_handle:
return None return None
@@ -200,7 +235,7 @@ class Server(utils.EventEmitter):
None, None,
) )
def add_attribute(self, attribute: att.Attribute) -> None: def add_attribute(self, attribute: Attribute) -> None:
# Assign a handle to this attribute # Assign a handle to this attribute
attribute.handle = self.next_handle() attribute.handle = self.next_handle()
attribute.end_group_handle = ( attribute.end_group_handle = (
@@ -255,7 +290,7 @@ class Server(utils.EventEmitter):
# pylint: disable=line-too-long # pylint: disable=line-too-long
Descriptor( Descriptor(
GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR, GATT_CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR,
att.Attribute.READABLE | att.Attribute.WRITEABLE, Attribute.READABLE | Attribute.WRITEABLE,
CharacteristicValue( CharacteristicValue(
read=lambda connection, characteristic=characteristic: self.read_cccd( read=lambda connection, characteristic=characteristic: self.read_cccd(
connection, characteristic connection, characteristic
@@ -280,8 +315,11 @@ class Server(utils.EventEmitter):
self.add_service(service) self.add_service(service)
def read_cccd( def read_cccd(
self, connection: Connection, characteristic: Characteristic self, connection: Optional[Connection], characteristic: Characteristic
) -> bytes: ) -> bytes:
if connection is None:
return bytes([0, 0])
subscribers = self.subscribers.get(connection.handle) subscribers = self.subscribers.get(connection.handle)
cccd = None cccd = None
if subscribers: if subscribers:
@@ -324,7 +362,7 @@ class Server(utils.EventEmitter):
indicate_enabled, indicate_enabled,
) )
def send_response(self, connection: Connection, response: att.ATT_PDU) -> None: def send_response(self, connection: Connection, response: ATT_PDU) -> None:
logger.debug( logger.debug(
f'GATT Response from server: [0x{connection.handle:04X}] {response}' f'GATT Response from server: [0x{connection.handle:04X}] {response}'
) )
@@ -333,7 +371,7 @@ class Server(utils.EventEmitter):
async def notify_subscriber( async def notify_subscriber(
self, self,
connection: Connection, connection: Connection,
attribute: att.Attribute, attribute: Attribute,
value: Optional[bytes] = None, value: Optional[bytes] = None,
force: bool = False, force: bool = False,
) -> None: ) -> None:
@@ -365,7 +403,7 @@ class Server(utils.EventEmitter):
value = value[: connection.att_mtu - 3] value = value[: connection.att_mtu - 3]
# Notify # Notify
notification = att.ATT_Handle_Value_Notification( notification = ATT_Handle_Value_Notification(
attribute_handle=attribute.handle, attribute_value=value attribute_handle=attribute.handle, attribute_value=value
) )
logger.debug( logger.debug(
@@ -376,7 +414,7 @@ class Server(utils.EventEmitter):
async def indicate_subscriber( async def indicate_subscriber(
self, self,
connection: Connection, connection: Connection,
attribute: att.Attribute, attribute: Attribute,
value: Optional[bytes] = None, value: Optional[bytes] = None,
force: bool = False, force: bool = False,
) -> None: ) -> None:
@@ -408,7 +446,7 @@ class Server(utils.EventEmitter):
value = value[: connection.att_mtu - 3] value = value[: connection.att_mtu - 3]
# Indicate # Indicate
indication = att.ATT_Handle_Value_Indication( indication = ATT_Handle_Value_Indication(
attribute_handle=attribute.handle, attribute_value=value attribute_handle=attribute.handle, attribute_value=value
) )
logger.debug( logger.debug(
@@ -436,7 +474,7 @@ class Server(utils.EventEmitter):
async def _notify_or_indicate_subscribers( async def _notify_or_indicate_subscribers(
self, self,
indicate: bool, indicate: bool,
attribute: att.Attribute, attribute: Attribute,
value: Optional[bytes] = None, value: Optional[bytes] = None,
force: bool = False, force: bool = False,
) -> None: ) -> None:
@@ -463,7 +501,7 @@ class Server(utils.EventEmitter):
async def notify_subscribers( async def notify_subscribers(
self, self,
attribute: att.Attribute, attribute: Attribute,
value: Optional[bytes] = None, value: Optional[bytes] = None,
force: bool = False, force: bool = False,
): ):
@@ -473,7 +511,7 @@ class Server(utils.EventEmitter):
async def indicate_subscribers( async def indicate_subscribers(
self, self,
attribute: att.Attribute, attribute: Attribute,
value: Optional[bytes] = None, value: Optional[bytes] = None,
force: bool = False, force: bool = False,
): ):
@@ -487,33 +525,33 @@ class Server(utils.EventEmitter):
if connection.handle in self.pending_confirmations: if connection.handle in self.pending_confirmations:
del self.pending_confirmations[connection.handle] del self.pending_confirmations[connection.handle]
def on_gatt_pdu(self, connection: Connection, att_pdu: att.ATT_PDU) -> None: def on_gatt_pdu(self, connection: Connection, att_pdu: ATT_PDU) -> None:
logger.debug(f'GATT Request to server: [0x{connection.handle:04X}] {att_pdu}') logger.debug(f'GATT Request to server: [0x{connection.handle:04X}] {att_pdu}')
handler_name = f'on_{att_pdu.name.lower()}' handler_name = f'on_{att_pdu.name.lower()}'
handler = getattr(self, handler_name, None) handler = getattr(self, handler_name, None)
if handler is not None: if handler is not None:
try: try:
handler(connection, att_pdu) handler(connection, att_pdu)
except att.ATT_Error as error: except ATT_Error as error:
logger.debug(f'normal exception returned by handler: {error}') logger.debug(f'normal exception returned by handler: {error}')
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=att_pdu.op_code, request_opcode_in_error=att_pdu.op_code,
attribute_handle_in_error=error.att_handle, attribute_handle_in_error=error.att_handle,
error_code=error.error_code, error_code=error.error_code,
) )
self.send_response(connection, response) self.send_response(connection, response)
except Exception: except Exception as error:
logger.exception(color("!!! Exception in handler:", "red")) logger.warning(f'{color("!!! Exception in handler:", "red")} {error}')
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=att_pdu.op_code, request_opcode_in_error=att_pdu.op_code,
attribute_handle_in_error=0x0000, attribute_handle_in_error=0x0000,
error_code=att.ATT_UNLIKELY_ERROR_ERROR, error_code=ATT_UNLIKELY_ERROR_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
raise raise error
else: else:
# No specific handler registered # No specific handler registered
if att_pdu.op_code in att.ATT_REQUESTS: if att_pdu.op_code in ATT_REQUESTS:
# Invoke the generic handler # Invoke the generic handler
self.on_att_request(connection, att_pdu) self.on_att_request(connection, att_pdu)
else: else:
@@ -529,7 +567,7 @@ class Server(utils.EventEmitter):
####################################################### #######################################################
# ATT handlers # ATT handlers
####################################################### #######################################################
def on_att_request(self, connection: Connection, pdu: att.ATT_PDU) -> None: def on_att_request(self, connection: Connection, pdu: ATT_PDU) -> None:
''' '''
Handler for requests without a more specific handler Handler for requests without a more specific handler
''' '''
@@ -539,25 +577,23 @@ class Server(utils.EventEmitter):
) )
+ str(pdu) + str(pdu)
) )
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=pdu.op_code, request_opcode_in_error=pdu.op_code,
attribute_handle_in_error=0x0000, attribute_handle_in_error=0x0000,
error_code=att.ATT_REQUEST_NOT_SUPPORTED_ERROR, error_code=ATT_REQUEST_NOT_SUPPORTED_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
def on_att_exchange_mtu_request( def on_att_exchange_mtu_request(self, connection, request):
self, connection: Connection, request: att.ATT_Exchange_MTU_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.2.1 Exchange MTU Request See Bluetooth spec Vol 3, Part F - 3.4.2.1 Exchange MTU Request
''' '''
self.send_response( self.send_response(
connection, att.ATT_Exchange_MTU_Response(server_rx_mtu=self.max_mtu) connection, ATT_Exchange_MTU_Response(server_rx_mtu=self.max_mtu)
) )
# Compute the final MTU # Compute the final MTU
if request.client_rx_mtu >= att.ATT_DEFAULT_MTU: if request.client_rx_mtu >= ATT_DEFAULT_MTU:
mtu = min(self.max_mtu, request.client_rx_mtu) mtu = min(self.max_mtu, request.client_rx_mtu)
# Notify the device # Notify the device
@@ -565,14 +601,11 @@ class Server(utils.EventEmitter):
else: else:
logger.warning('invalid client_rx_mtu received, MTU not changed') logger.warning('invalid client_rx_mtu received, MTU not changed')
def on_att_find_information_request( def on_att_find_information_request(self, connection, request):
self, connection: Connection, request: att.ATT_Find_Information_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.3.1 Find Information Request See Bluetooth spec Vol 3, Part F - 3.4.3.1 Find Information Request
''' '''
response: att.ATT_PDU
# Check the request parameters # Check the request parameters
if ( if (
request.starting_handle == 0 request.starting_handle == 0
@@ -580,17 +613,17 @@ class Server(utils.EventEmitter):
): ):
self.send_response( self.send_response(
connection, connection,
att.ATT_Error_Response( ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_INVALID_HANDLE_ERROR, error_code=ATT_INVALID_HANDLE_ERROR,
), ),
) )
return return
# Build list of returned attributes # Build list of returned attributes
pdu_space_available = connection.att_mtu - 2 pdu_space_available = connection.att_mtu - 2
attributes: list[att.Attribute] = [] attributes = []
uuid_size = 0 uuid_size = 0
for attribute in ( for attribute in (
attribute attribute
@@ -620,23 +653,21 @@ class Server(utils.EventEmitter):
struct.pack('<H', attribute.handle) + attribute.type.to_pdu_bytes() struct.pack('<H', attribute.handle) + attribute.type.to_pdu_bytes()
for attribute in attributes for attribute in attributes
] ]
response = att.ATT_Find_Information_Response( response = ATT_Find_Information_Response(
format=1 if len(attributes[0].type.to_pdu_bytes()) == 2 else 2, format=1 if len(attributes[0].type.to_pdu_bytes()) == 2 else 2,
information_data=b''.join(information_data_list), information_data=b''.join(information_data_list),
) )
else: else:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_ATTRIBUTE_NOT_FOUND_ERROR, error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_find_by_type_value_request( async def on_att_find_by_type_value_request(self, connection, request):
self, connection: Connection, request: att.ATT_Find_By_Type_Value_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.3.3 Find By Type Value Request See Bluetooth spec Vol 3, Part F - 3.4.3.3 Find By Type Value Request
''' '''
@@ -644,7 +675,6 @@ class Server(utils.EventEmitter):
# Build list of returned attributes # Build list of returned attributes
pdu_space_available = connection.att_mtu - 2 pdu_space_available = connection.att_mtu - 2
attributes = [] attributes = []
response: att.ATT_PDU
async for attribute in ( async for attribute in (
attribute attribute
for attribute in self.attributes for attribute in self.attributes
@@ -677,35 +707,33 @@ class Server(utils.EventEmitter):
handles_information_list.append( handles_information_list.append(
struct.pack('<HH', attribute.handle, group_end_handle) struct.pack('<HH', attribute.handle, group_end_handle)
) )
response = att.ATT_Find_By_Type_Value_Response( response = ATT_Find_By_Type_Value_Response(
handles_information_list=b''.join(handles_information_list) handles_information_list=b''.join(handles_information_list)
) )
else: else:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_ATTRIBUTE_NOT_FOUND_ERROR, error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_read_by_type_request( async def on_att_read_by_type_request(self, connection, request):
self, connection: Connection, request: att.ATT_Read_By_Type_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.4.1 Read By Type Request See Bluetooth spec Vol 3, Part F - 3.4.4.1 Read By Type Request
''' '''
pdu_space_available = connection.att_mtu - 2 pdu_space_available = connection.att_mtu - 2
response: att.ATT_PDU = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_ATTRIBUTE_NOT_FOUND_ERROR, error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
) )
attributes: list[tuple[int, bytes]] = [] attributes = []
for attribute in ( for attribute in (
attribute attribute
for attribute in self.attributes for attribute in self.attributes
@@ -716,11 +744,11 @@ class Server(utils.EventEmitter):
): ):
try: try:
attribute_value = await attribute.read_value(connection) attribute_value = await attribute.read_value(connection)
except att.ATT_Error as error: except ATT_Error as error:
# If the first attribute is unreadable, return an error # If the first attribute is unreadable, return an error
# Otherwise return attributes up to this point # Otherwise return attributes up to this point
if not attributes: if not attributes:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=attribute.handle, attribute_handle_in_error=attribute.handle,
error_code=error.error_code, error_code=error.error_code,
@@ -749,7 +777,7 @@ class Server(utils.EventEmitter):
attribute_data_list = [ attribute_data_list = [
struct.pack('<H', handle) + value for handle, value in attributes struct.pack('<H', handle) + value for handle, value in attributes
] ]
response = att.ATT_Read_By_Type_Response( response = ATT_Read_By_Type_Response(
length=entry_size, attribute_data_list=b''.join(attribute_data_list) length=entry_size, attribute_data_list=b''.join(attribute_data_list)
) )
else: else:
@@ -758,104 +786,95 @@ class Server(utils.EventEmitter):
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_read_request( async def on_att_read_request(self, connection, request):
self, connection: Connection, request: att.ATT_Read_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.4.3 Read Request See Bluetooth spec Vol 3, Part F - 3.4.4.3 Read Request
''' '''
response: att.ATT_PDU
if attribute := self.get_attribute(request.attribute_handle): if attribute := self.get_attribute(request.attribute_handle):
try: try:
value = await attribute.read_value(connection) value = await attribute.read_value(connection)
except att.ATT_Error as error: except ATT_Error as error:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=error.error_code, error_code=error.error_code,
) )
else: else:
value_size = min(connection.att_mtu - 1, len(value)) value_size = min(connection.att_mtu - 1, len(value))
response = att.ATT_Read_Response(attribute_value=value[:value_size]) response = ATT_Read_Response(attribute_value=value[:value_size])
else: else:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_INVALID_HANDLE_ERROR, error_code=ATT_INVALID_HANDLE_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_read_blob_request( async def on_att_read_blob_request(self, connection, request):
self, connection: Connection, request: att.ATT_Read_Blob_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.4.5 Read Blob Request See Bluetooth spec Vol 3, Part F - 3.4.4.5 Read Blob Request
''' '''
response: att.ATT_PDU
if attribute := self.get_attribute(request.attribute_handle): if attribute := self.get_attribute(request.attribute_handle):
try: try:
value = await attribute.read_value(connection) value = await attribute.read_value(connection)
except att.ATT_Error as error: except ATT_Error as error:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=error.error_code, error_code=error.error_code,
) )
else: else:
if request.value_offset > len(value): if request.value_offset > len(value):
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_INVALID_OFFSET_ERROR, error_code=ATT_INVALID_OFFSET_ERROR,
) )
elif len(value) <= connection.att_mtu - 1: elif len(value) <= connection.att_mtu - 1:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_ATTRIBUTE_NOT_LONG_ERROR, error_code=ATT_ATTRIBUTE_NOT_LONG_ERROR,
) )
else: else:
part_size = min( part_size = min(
connection.att_mtu - 1, len(value) - request.value_offset connection.att_mtu - 1, len(value) - request.value_offset
) )
response = att.ATT_Read_Blob_Response( response = ATT_Read_Blob_Response(
part_attribute_value=value[ part_attribute_value=value[
request.value_offset : request.value_offset + part_size request.value_offset : request.value_offset + part_size
] ]
) )
else: else:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_INVALID_HANDLE_ERROR, error_code=ATT_INVALID_HANDLE_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_read_by_group_type_request( async def on_att_read_by_group_type_request(self, connection, request):
self, connection: Connection, request: att.ATT_Read_By_Group_Type_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.4.9 Read by Group Type Request See Bluetooth spec Vol 3, Part F - 3.4.4.9 Read by Group Type Request
''' '''
response: att.ATT_PDU
if request.attribute_group_type not in ( if request.attribute_group_type not in (
GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE, GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE,
GATT_SECONDARY_SERVICE_ATTRIBUTE_TYPE, GATT_SECONDARY_SERVICE_ATTRIBUTE_TYPE,
): ):
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_UNSUPPORTED_GROUP_TYPE_ERROR, error_code=ATT_UNSUPPORTED_GROUP_TYPE_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
return return
pdu_space_available = connection.att_mtu - 2 pdu_space_available = connection.att_mtu - 2
attributes: list[tuple[int, int, bytes]] = [] attributes = []
for attribute in ( for attribute in (
attribute attribute
for attribute in self.attributes for attribute in self.attributes
@@ -892,23 +911,21 @@ class Server(utils.EventEmitter):
struct.pack('<HH', handle, end_group_handle) + value struct.pack('<HH', handle, end_group_handle) + value
for handle, end_group_handle, value in attributes for handle, end_group_handle, value in attributes
] ]
response = att.ATT_Read_By_Group_Type_Response( response = ATT_Read_By_Group_Type_Response(
length=len(attribute_data_list[0]), length=len(attribute_data_list[0]),
attribute_data_list=b''.join(attribute_data_list), attribute_data_list=b''.join(attribute_data_list),
) )
else: else:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle, attribute_handle_in_error=request.starting_handle,
error_code=att.ATT_ATTRIBUTE_NOT_FOUND_ERROR, error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
) )
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_write_request( async def on_att_write_request(self, connection, request):
self, connection: Connection, request: att.ATT_Write_Request
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.5.1 Write Request See Bluetooth spec Vol 3, Part F - 3.4.5.1 Write Request
''' '''
@@ -918,10 +935,10 @@ class Server(utils.EventEmitter):
if attribute is None: if attribute is None:
self.send_response( self.send_response(
connection, connection,
att.ATT_Error_Response( ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_INVALID_HANDLE_ERROR, error_code=ATT_INVALID_HANDLE_ERROR,
), ),
) )
return return
@@ -932,33 +949,30 @@ class Server(utils.EventEmitter):
if len(request.attribute_value) > GATT_MAX_ATTRIBUTE_VALUE_SIZE: if len(request.attribute_value) > GATT_MAX_ATTRIBUTE_VALUE_SIZE:
self.send_response( self.send_response(
connection, connection,
att.ATT_Error_Response( ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=att.ATT_INVALID_ATTRIBUTE_LENGTH_ERROR, error_code=ATT_INVALID_ATTRIBUTE_LENGTH_ERROR,
), ),
) )
return return
response: att.ATT_PDU
try: try:
# Accept the value # Accept the value
await attribute.write_value(connection, request.attribute_value) await attribute.write_value(connection, request.attribute_value)
except att.ATT_Error as error: except ATT_Error as error:
response = att.ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle, attribute_handle_in_error=request.attribute_handle,
error_code=error.error_code, error_code=error.error_code,
) )
else: else:
# Done # Done
response = att.ATT_Write_Response() response = ATT_Write_Response()
self.send_response(connection, response) self.send_response(connection, response)
@utils.AsyncRunner.run_in_task() @utils.AsyncRunner.run_in_task()
async def on_att_write_command( async def on_att_write_command(self, connection, request):
self, connection: Connection, request: att.ATT_Write_Command
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.5.3 Write Command See Bluetooth spec Vol 3, Part F - 3.4.5.3 Write Command
''' '''
@@ -977,25 +991,18 @@ class Server(utils.EventEmitter):
# Accept the value # Accept the value
try: try:
await attribute.write_value(connection, request.attribute_value) await attribute.write_value(connection, request.attribute_value)
except Exception: except Exception as error:
logger.exception('!!! ignoring exception') logger.exception(f'!!! ignoring exception: {error}')
def on_att_handle_value_confirmation( def on_att_handle_value_confirmation(self, connection, _confirmation):
self,
connection: Connection,
confirmation: att.ATT_Handle_Value_Confirmation,
):
''' '''
See Bluetooth spec Vol 3, Part F - 3.4.7.3 Handle Value Confirmation See Bluetooth spec Vol 3, Part F - 3.4.7.3 Handle Value Confirmation
''' '''
del confirmation # Unused. if self.pending_confirmations[connection.handle] is None:
if (
pending_confirmation := self.pending_confirmations[connection.handle]
) is None:
# Not expected! # Not expected!
logger.warning( logger.warning(
'!!! unexpected confirmation, there is no pending indication' '!!! unexpected confirmation, there is no pending indication'
) )
return return
pending_confirmation.set_result(None) self.pending_confirmations[connection.handle].set_result(None)
+2902 -2690
View File
File diff suppressed because it is too large Load Diff
+31 -23
View File
@@ -17,36 +17,44 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import datetime
import logging
from collections.abc import Callable, MutableMapping from collections.abc import Callable, MutableMapping
from typing import Any, Optional, cast import datetime
from typing import cast, Any, Optional
import logging
from bumble import avc, avctp, avdtp, avrcp, crypto, rfcomm, sdp from bumble import avc
from bumble.att import ATT_CID, ATT_PDU from bumble import avctp
from bumble import avdtp
from bumble import avrcp
from bumble import crypto
from bumble import rfcomm
from bumble import sdp
from bumble.colors import color from bumble.colors import color
from bumble.att import ATT_CID, ATT_PDU
from bumble.smp import SMP_CID, SMP_Command
from bumble.core import name_or_number from bumble.core import name_or_number
from bumble.hci import (
HCI_ACL_DATA_PACKET,
HCI_DISCONNECTION_COMPLETE_EVENT,
HCI_EVENT_PACKET,
Address,
HCI_AclDataPacket,
HCI_AclDataPacketAssembler,
HCI_Disconnection_Complete_Event,
HCI_Event,
HCI_Packet,
)
from bumble.l2cap import ( from bumble.l2cap import (
L2CAP_LE_SIGNALING_CID,
L2CAP_PDU, L2CAP_PDU,
L2CAP_CONNECTION_REQUEST,
L2CAP_CONNECTION_RESPONSE,
L2CAP_SIGNALING_CID, L2CAP_SIGNALING_CID,
CommandCode, L2CAP_LE_SIGNALING_CID,
L2CAP_Control_Frame,
L2CAP_Connection_Request, L2CAP_Connection_Request,
L2CAP_Connection_Response, L2CAP_Connection_Response,
L2CAP_Control_Frame,
) )
from bumble.smp import SMP_CID, SMP_Command from bumble.hci import (
Address,
HCI_EVENT_PACKET,
HCI_ACL_DATA_PACKET,
HCI_DISCONNECTION_COMPLETE_EVENT,
HCI_AclDataPacketAssembler,
HCI_Packet,
HCI_Event,
HCI_AclDataPacket,
HCI_Disconnection_Complete_Event,
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -98,14 +106,14 @@ class PacketTracer:
self.analyzer.emit(control_frame) self.analyzer.emit(control_frame)
# Check if this signals a new channel # Check if this signals a new channel
if control_frame.code == CommandCode.L2CAP_CONNECTION_REQUEST: if control_frame.code == L2CAP_CONNECTION_REQUEST:
connection_request = cast(L2CAP_Connection_Request, control_frame) connection_request = cast(L2CAP_Connection_Request, control_frame)
self.psms[connection_request.source_cid] = connection_request.psm self.psms[connection_request.source_cid] = connection_request.psm
elif control_frame.code == CommandCode.L2CAP_CONNECTION_RESPONSE: elif control_frame.code == L2CAP_CONNECTION_RESPONSE:
connection_response = cast(L2CAP_Connection_Response, control_frame) connection_response = cast(L2CAP_Connection_Response, control_frame)
if ( if (
connection_response.result connection_response.result
== L2CAP_Connection_Response.Result.CONNECTION_SUCCESSFUL == L2CAP_Connection_Response.CONNECTION_SUCCESSFUL
): ):
if self.peer and ( if self.peer and (
psm := self.peer.psms.get(connection_response.source_cid) psm := self.peer.psms.get(connection_response.source_cid)
+58 -42
View File
@@ -17,34 +17,50 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio
import collections import collections
import collections.abc import collections.abc
import logging
import asyncio
import dataclasses import dataclasses
import enum import enum
import logging
import re
import traceback import traceback
from typing import TYPE_CHECKING, Any, ClassVar, Iterable, Optional, Union import re
from typing import (
Dict,
List,
Union,
Set,
Any,
Optional,
Type,
Tuple,
ClassVar,
Iterable,
TYPE_CHECKING,
)
from typing_extensions import Self from typing_extensions import Self
from bumble import at, device, rfcomm, sdp, utils from bumble import at
from bumble import device
from bumble import rfcomm
from bumble import sdp
from bumble import utils
from bumble.colors import color from bumble.colors import color
from bumble.core import ( from bumble.core import (
ProtocolError,
BT_GENERIC_AUDIO_SERVICE, BT_GENERIC_AUDIO_SERVICE,
BT_HANDSFREE_AUDIO_GATEWAY_SERVICE,
BT_HANDSFREE_SERVICE, BT_HANDSFREE_SERVICE,
BT_HANDSFREE_AUDIO_GATEWAY_SERVICE,
BT_L2CAP_PROTOCOL_ID, BT_L2CAP_PROTOCOL_ID,
BT_RFCOMM_PROTOCOL_ID, BT_RFCOMM_PROTOCOL_ID,
ProtocolError,
) )
from bumble.hci import ( from bumble.hci import (
CodecID,
CodingFormat,
HCI_Enhanced_Setup_Synchronous_Connection_Command, HCI_Enhanced_Setup_Synchronous_Connection_Command,
CodingFormat,
CodecID,
) )
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -359,7 +375,7 @@ class CallLineIdentification:
cli_validity: Optional[int] = None cli_validity: Optional[int] = None
@classmethod @classmethod
def parse_from(cls, parameters: list[bytes]) -> Self: def parse_from(cls: Type[Self], parameters: List[bytes]) -> Self:
return cls( return cls(
number=parameters[0].decode(), number=parameters[0].decode(),
type=int(parameters[1]), type=int(parameters[1]),
@@ -489,9 +505,9 @@ STATUS_CODES = {
@dataclasses.dataclass @dataclasses.dataclass
class HfConfiguration: class HfConfiguration:
supported_hf_features: list[HfFeature] supported_hf_features: List[HfFeature]
supported_hf_indicators: list[HfIndicator] supported_hf_indicators: List[HfIndicator]
supported_audio_codecs: list[AudioCodec] supported_audio_codecs: List[AudioCodec]
@dataclasses.dataclass @dataclasses.dataclass
@@ -519,7 +535,7 @@ class AtResponse:
parameters: list parameters: list
@classmethod @classmethod
def parse_from(cls: type[Self], buffer: bytearray) -> Self: def parse_from(cls: Type[Self], buffer: bytearray) -> Self:
code_and_parameters = buffer.split(b':') code_and_parameters = buffer.split(b':')
parameters = ( parameters = (
code_and_parameters[1] if len(code_and_parameters) > 1 else bytearray() code_and_parameters[1] if len(code_and_parameters) > 1 else bytearray()
@@ -547,7 +563,7 @@ class AtCommand:
) )
@classmethod @classmethod
def parse_from(cls: type[Self], buffer: bytearray) -> Self: def parse_from(cls: Type[Self], buffer: bytearray) -> Self:
if not (match := cls._PARSE_PATTERN.fullmatch(buffer.decode())): if not (match := cls._PARSE_PATTERN.fullmatch(buffer.decode())):
if buffer.startswith(b'ATA'): if buffer.startswith(b'ATA'):
return cls(code='A', sub_code=AtCommand.SubCode.NONE, parameters=[]) return cls(code='A', sub_code=AtCommand.SubCode.NONE, parameters=[])
@@ -582,7 +598,7 @@ class AgIndicatorState:
""" """
indicator: AgIndicator indicator: AgIndicator
supported_values: set[int] supported_values: Set[int]
current_status: int current_status: int
index: Optional[int] = None index: Optional[int] = None
enabled: bool = True enabled: bool = True
@@ -600,14 +616,14 @@ class AgIndicatorState:
return f'(\"{self.indicator.value}\",{supported_values_text})' return f'(\"{self.indicator.value}\",{supported_values_text})'
@classmethod @classmethod
def call(cls: type[Self]) -> Self: def call(cls: Type[Self]) -> Self:
"""Default call indicator state.""" """Default call indicator state."""
return cls( return cls(
indicator=AgIndicator.CALL, supported_values={0, 1}, current_status=0 indicator=AgIndicator.CALL, supported_values={0, 1}, current_status=0
) )
@classmethod @classmethod
def callsetup(cls: type[Self]) -> Self: def callsetup(cls: Type[Self]) -> Self:
"""Default callsetup indicator state.""" """Default callsetup indicator state."""
return cls( return cls(
indicator=AgIndicator.CALL_SETUP, indicator=AgIndicator.CALL_SETUP,
@@ -616,7 +632,7 @@ class AgIndicatorState:
) )
@classmethod @classmethod
def callheld(cls: type[Self]) -> Self: def callheld(cls: Type[Self]) -> Self:
"""Default call indicator state.""" """Default call indicator state."""
return cls( return cls(
indicator=AgIndicator.CALL_HELD, indicator=AgIndicator.CALL_HELD,
@@ -625,14 +641,14 @@ class AgIndicatorState:
) )
@classmethod @classmethod
def service(cls: type[Self]) -> Self: def service(cls: Type[Self]) -> Self:
"""Default service indicator state.""" """Default service indicator state."""
return cls( return cls(
indicator=AgIndicator.SERVICE, supported_values={0, 1}, current_status=0 indicator=AgIndicator.SERVICE, supported_values={0, 1}, current_status=0
) )
@classmethod @classmethod
def signal(cls: type[Self]) -> Self: def signal(cls: Type[Self]) -> Self:
"""Default signal indicator state.""" """Default signal indicator state."""
return cls( return cls(
indicator=AgIndicator.SIGNAL, indicator=AgIndicator.SIGNAL,
@@ -641,14 +657,14 @@ class AgIndicatorState:
) )
@classmethod @classmethod
def roam(cls: type[Self]) -> Self: def roam(cls: Type[Self]) -> Self:
"""Default roam indicator state.""" """Default roam indicator state."""
return cls( return cls(
indicator=AgIndicator.CALL, supported_values={0, 1}, current_status=0 indicator=AgIndicator.CALL, supported_values={0, 1}, current_status=0
) )
@classmethod @classmethod
def battchg(cls: type[Self]) -> Self: def battchg(cls: Type[Self]) -> Self:
"""Default battery charge indicator state.""" """Default battery charge indicator state."""
return cls( return cls(
indicator=AgIndicator.BATTERY_CHARGE, indicator=AgIndicator.BATTERY_CHARGE,
@@ -716,13 +732,13 @@ class HfProtocol(utils.EventEmitter):
"""Termination signal for run() loop.""" """Termination signal for run() loop."""
supported_hf_features: int supported_hf_features: int
supported_audio_codecs: list[AudioCodec] supported_audio_codecs: List[AudioCodec]
supported_ag_features: int supported_ag_features: int
supported_ag_call_hold_operations: list[CallHoldOperation] supported_ag_call_hold_operations: List[CallHoldOperation]
ag_indicators: list[AgIndicatorState] ag_indicators: List[AgIndicatorState]
hf_indicators: dict[HfIndicator, HfIndicatorState] hf_indicators: Dict[HfIndicator, HfIndicatorState]
dlc: rfcomm.DLC dlc: rfcomm.DLC
command_lock: asyncio.Lock command_lock: asyncio.Lock
@@ -820,7 +836,7 @@ class HfProtocol(utils.EventEmitter):
cmd: str, cmd: str,
timeout: float = 1.0, timeout: float = 1.0,
response_type: AtResponseType = AtResponseType.NONE, response_type: AtResponseType = AtResponseType.NONE,
) -> Union[None, AtResponse, list[AtResponse]]: ) -> Union[None, AtResponse, List[AtResponse]]:
""" """
Sends an AT command and wait for the peer response. Sends an AT command and wait for the peer response.
Wait for the AT responses sent by the peer, to the status code. Wait for the AT responses sent by the peer, to the status code.
@@ -837,7 +853,7 @@ class HfProtocol(utils.EventEmitter):
async with self.command_lock: async with self.command_lock:
logger.debug(f">>> {cmd}") logger.debug(f">>> {cmd}")
self.dlc.write(cmd + '\r') self.dlc.write(cmd + '\r')
responses: list[AtResponse] = [] responses: List[AtResponse] = []
while True: while True:
result = await asyncio.wait_for( result = await asyncio.wait_for(
@@ -1057,7 +1073,7 @@ class HfProtocol(utils.EventEmitter):
# code, with the value indicating (call=0). # code, with the value indicating (call=0).
await self.execute_command("AT+CHUP") await self.execute_command("AT+CHUP")
async def query_current_calls(self) -> list[CallInfo]: async def query_current_calls(self) -> List[CallInfo]:
"""4.32.1 Query List of Current Calls in AG. """4.32.1 Query List of Current Calls in AG.
Return: Return:
@@ -1188,27 +1204,27 @@ class AgProtocol(utils.EventEmitter):
EVENT_MICROPHONE_VOLUME = "microphone_volume" EVENT_MICROPHONE_VOLUME = "microphone_volume"
supported_hf_features: int supported_hf_features: int
supported_hf_indicators: set[HfIndicator] supported_hf_indicators: Set[HfIndicator]
supported_audio_codecs: list[AudioCodec] supported_audio_codecs: List[AudioCodec]
supported_ag_features: int supported_ag_features: int
supported_ag_call_hold_operations: list[CallHoldOperation] supported_ag_call_hold_operations: List[CallHoldOperation]
ag_indicators: list[AgIndicatorState] ag_indicators: List[AgIndicatorState]
hf_indicators: collections.OrderedDict[HfIndicator, HfIndicatorState] hf_indicators: collections.OrderedDict[HfIndicator, HfIndicatorState]
dlc: rfcomm.DLC dlc: rfcomm.DLC
read_buffer: bytearray read_buffer: bytearray
active_codec: AudioCodec active_codec: AudioCodec
calls: list[CallInfo] calls: List[CallInfo]
indicator_report_enabled: bool indicator_report_enabled: bool
inband_ringtone_enabled: bool inband_ringtone_enabled: bool
cme_error_enabled: bool cme_error_enabled: bool
cli_notification_enabled: bool cli_notification_enabled: bool
call_waiting_enabled: bool call_waiting_enabled: bool
_remained_slc_setup_features: set[HfFeature] _remained_slc_setup_features: Set[HfFeature]
def __init__(self, dlc: rfcomm.DLC, configuration: AgConfiguration) -> None: def __init__(self, dlc: rfcomm.DLC, configuration: AgConfiguration) -> None:
super().__init__() super().__init__()
@@ -1678,7 +1694,7 @@ def make_hf_sdp_records(
rfcomm_channel: int, rfcomm_channel: int,
configuration: HfConfiguration, configuration: HfConfiguration,
version: ProfileVersion = ProfileVersion.V1_8, version: ProfileVersion = ProfileVersion.V1_8,
) -> list[sdp.ServiceAttribute]: ) -> List[sdp.ServiceAttribute]:
""" """
Generates the SDP record for HFP Hands-Free support. Generates the SDP record for HFP Hands-Free support.
@@ -1764,7 +1780,7 @@ def make_ag_sdp_records(
rfcomm_channel: int, rfcomm_channel: int,
configuration: AgConfiguration, configuration: AgConfiguration,
version: ProfileVersion = ProfileVersion.V1_8, version: ProfileVersion = ProfileVersion.V1_8,
) -> list[sdp.ServiceAttribute]: ) -> List[sdp.ServiceAttribute]:
""" """
Generates the SDP record for HFP Audio-Gateway support. Generates the SDP record for HFP Audio-Gateway support.
@@ -1844,7 +1860,7 @@ def make_ag_sdp_records(
async def find_hf_sdp_record( async def find_hf_sdp_record(
connection: device.Connection, connection: device.Connection,
) -> Optional[tuple[int, ProfileVersion, HfSdpFeature]]: ) -> Optional[Tuple[int, ProfileVersion, HfSdpFeature]]:
"""Searches a Hands-Free SDP record from remote device. """Searches a Hands-Free SDP record from remote device.
Args: Args:
@@ -1896,7 +1912,7 @@ async def find_hf_sdp_record(
async def find_ag_sdp_record( async def find_ag_sdp_record(
connection: device.Connection, connection: device.Connection,
) -> Optional[tuple[int, ProfileVersion, AgSdpFeature]]: ) -> Optional[Tuple[int, ProfileVersion, AgSdpFeature]]:
"""Searches an Audio-Gateway SDP record from remote device. """Searches an Audio-Gateway SDP record from remote device.
Args: Args:
@@ -1994,7 +2010,7 @@ class EscoParameters:
transmit_codec_frame_size: int = 60 transmit_codec_frame_size: int = 60
receive_codec_frame_size: int = 60 receive_codec_frame_size: int = 60
def asdict(self) -> dict[str, Any]: def asdict(self) -> Dict[str, Any]:
# dataclasses.asdict() will recursively deep-copy the entire object, # dataclasses.asdict() will recursively deep-copy the entire object,
# which is expensive and breaks CodingFormat object, so let it simply copy here. # which is expensive and breaks CodingFormat object, so let it simply copy here.
return self.__dict__ return self.__dict__
+17 -23
View File
@@ -16,20 +16,22 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import enum
import logging
import struct
from abc import ABC, abstractmethod
from dataclasses import dataclass from dataclasses import dataclass
from typing import Callable, Optional import logging
import enum
import struct
from abc import ABC, abstractmethod
from typing import Optional, Callable
from typing_extensions import override from typing_extensions import override
from bumble import device, l2cap, utils from bumble import l2cap
from bumble import device
from bumble import utils
from bumble.core import InvalidStateError, ProtocolError from bumble.core import InvalidStateError, ProtocolError
from bumble.hci import Address from bumble.hci import Address
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -217,41 +219,33 @@ class HID(ABC, utils.EventEmitter):
self.role = role self.role = role
# Register ourselves with the L2CAP channel manager # Register ourselves with the L2CAP channel manager
device.create_l2cap_server( device.register_l2cap_server(HID_CONTROL_PSM, self.on_l2cap_connection)
l2cap.ClassicChannelSpec(HID_CONTROL_PSM), self.on_l2cap_connection device.register_l2cap_server(HID_INTERRUPT_PSM, self.on_l2cap_connection)
)
device.create_l2cap_server(
l2cap.ClassicChannelSpec(HID_INTERRUPT_PSM), self.on_l2cap_connection
)
device.on(device.EVENT_CONNECTION, self.on_device_connection) device.on(device.EVENT_CONNECTION, self.on_device_connection)
async def connect_control_channel(self) -> None: async def connect_control_channel(self) -> None:
if not self.connection:
raise InvalidStateError("Connection is not established!")
# Create a new L2CAP connection - control channel # Create a new L2CAP connection - control channel
try: try:
channel = await self.connection.create_l2cap_channel( channel = await self.device.l2cap_channel_manager.connect(
l2cap.ClassicChannelSpec(HID_CONTROL_PSM) self.connection, HID_CONTROL_PSM
) )
channel.sink = self.on_ctrl_pdu channel.sink = self.on_ctrl_pdu
self.l2cap_ctrl_channel = channel self.l2cap_ctrl_channel = channel
except ProtocolError: except ProtocolError:
logging.exception('L2CAP connection failed.') logging.exception(f'L2CAP connection failed.')
raise raise
async def connect_interrupt_channel(self) -> None: async def connect_interrupt_channel(self) -> None:
if not self.connection:
raise InvalidStateError("Connection is not established!")
# Create a new L2CAP connection - interrupt channel # Create a new L2CAP connection - interrupt channel
try: try:
channel = await self.connection.create_l2cap_channel( channel = await self.device.l2cap_channel_manager.connect(
l2cap.ClassicChannelSpec(HID_CONTROL_PSM) self.connection, HID_INTERRUPT_PSM
) )
channel.sink = self.on_intr_pdu channel.sink = self.on_intr_pdu
self.l2cap_intr_channel = channel self.l2cap_intr_channel = channel
except ProtocolError: except ProtocolError:
logging.exception('L2CAP connection failed.') logging.exception(f'L2CAP connection failed.')
raise raise
async def disconnect_interrupt_channel(self) -> None: async def disconnect_interrupt_channel(self) -> None:
+139 -286
View File
@@ -16,19 +16,37 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import collections import collections
import dataclasses import dataclasses
import logging import logging
import struct import struct
from typing import TYPE_CHECKING, Any, Awaitable, Callable, Optional, Union, cast
from bumble import drivers, hci, utils from typing import (
Any,
Awaitable,
Callable,
Deque,
Dict,
Optional,
Set,
cast,
TYPE_CHECKING,
)
from bumble.colors import color from bumble.colors import color
from bumble.core import ConnectionPHY, InvalidStateError, PhysicalTransport
from bumble.l2cap import L2CAP_PDU from bumble.l2cap import L2CAP_PDU
from bumble.snoop import Snooper from bumble.snoop import Snooper
from bumble import drivers
from bumble import hci
from bumble.core import (
PhysicalTransport,
PhysicalTransport,
ConnectionPHY,
ConnectionParameters,
)
from bumble import utils
from bumble.transport.common import TransportLostError from bumble.transport.common import TransportLostError
if TYPE_CHECKING: if TYPE_CHECKING:
@@ -57,11 +75,6 @@ class DataPacketQueue(utils.EventEmitter):
max_packet_size: int max_packet_size: int
class PerConnectionState:
def __init__(self) -> None:
self.in_flight = 0
self.drained = asyncio.Event()
def __init__( def __init__(
self, self,
max_packet_size: int, max_packet_size: int,
@@ -72,16 +85,11 @@ class DataPacketQueue(utils.EventEmitter):
self.max_packet_size = max_packet_size self.max_packet_size = max_packet_size
self.max_in_flight = max_in_flight self.max_in_flight = max_in_flight
self._in_flight = 0 # Total number of packets in flight across all connections self._in_flight = 0 # Total number of packets in flight across all connections
self._connection_state: dict[int, DataPacketQueue.PerConnectionState] = ( self._in_flight_per_connection: dict[int, int] = collections.defaultdict(
collections.defaultdict(DataPacketQueue.PerConnectionState) int
) ) # Number of packets in flight per connection
self._drained_per_connection: dict[int, asyncio.Event] = (
collections.defaultdict(asyncio.Event)
)
self._send = send self._send = send
self._packets: collections.deque[tuple[hci.HCI_Packet, int]] = ( self._packets: Deque[tuple[hci.HCI_Packet, int]] = collections.deque()
collections.deque()
)
self._queued = 0 self._queued = 0
self._completed = 0 self._completed = 0
@@ -129,40 +137,36 @@ class DataPacketQueue(utils.EventEmitter):
self._completed += flushed_count self._completed += flushed_count
self._packets = collections.deque(packets_to_keep) self._packets = collections.deque(packets_to_keep)
if connection_state := self._connection_state.pop(connection_handle, None): if connection_handle in self._in_flight_per_connection:
in_flight = connection_state.in_flight in_flight = self._in_flight_per_connection[connection_handle]
self._completed += in_flight self._completed += in_flight
self._in_flight -= in_flight self._in_flight -= in_flight
connection_state.drained.set() del self._in_flight_per_connection[connection_handle]
def _check_queue(self) -> None: def _check_queue(self) -> None:
while self._packets and self._in_flight < self.max_in_flight: while self._packets and self._in_flight < self.max_in_flight:
packet, connection_handle = self._packets.pop() packet, connection_handle = self._packets.pop()
self._send(packet) self._send(packet)
self._in_flight += 1 self._in_flight += 1
connection_state = self._connection_state[connection_handle] self._in_flight_per_connection[connection_handle] += 1
connection_state.in_flight += 1
connection_state.drained.clear()
def on_packets_completed(self, packet_count: int, connection_handle: int) -> None: def on_packets_completed(self, packet_count: int, connection_handle: int) -> None:
"""Mark one or more packets associated with a connection as completed.""" """Mark one or more packets associated with a connection as completed."""
if connection_handle not in self._connection_state: if connection_handle not in self._in_flight_per_connection:
logger.warning( logger.warning(
f'received completion for unknown connection {connection_handle}' f'received completion for unknown connection {connection_handle}'
) )
return return
connection_state = self._connection_state[connection_handle] in_flight_for_connection = self._in_flight_per_connection[connection_handle]
if packet_count <= connection_state.in_flight: if packet_count <= in_flight_for_connection:
connection_state.in_flight -= packet_count self._in_flight_per_connection[connection_handle] -= packet_count
else: else:
logger.warning( logger.warning(
f'{packet_count} completed for {connection_handle} ' f'{packet_count} completed for {connection_handle} '
f'but only {connection_state.in_flight} in flight' f'but only {in_flight_for_connection} in flight'
) )
connection_state.in_flight = 0 self._in_flight_per_connection[connection_handle] = 0
if connection_state.in_flight == 0:
connection_state.drained.set()
if packet_count <= self._in_flight: if packet_count <= self._in_flight:
self._in_flight -= packet_count self._in_flight -= packet_count
@@ -177,13 +181,6 @@ class DataPacketQueue(utils.EventEmitter):
self._check_queue() self._check_queue()
self.emit('flow') self.emit('flow')
async def drain(self, connection_handle: int) -> None:
"""Wait until there are no pending packets for a connection."""
if not (connection_state := self._connection_state.get(connection_handle)):
raise ValueError('no such connection')
await connection_state.drained.wait()
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Connection: class Connection:
@@ -237,16 +234,16 @@ class IsoLink:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Host(utils.EventEmitter): class Host(utils.EventEmitter):
connections: dict[int, Connection] connections: Dict[int, Connection]
cis_links: dict[int, IsoLink] cis_links: Dict[int, IsoLink]
bis_links: dict[int, IsoLink] bis_links: Dict[int, IsoLink]
sco_links: dict[int, ScoLink] sco_links: Dict[int, ScoLink]
bigs: dict[int, set[int]] bigs: dict[int, set[int]]
acl_packet_queue: Optional[DataPacketQueue] = None acl_packet_queue: Optional[DataPacketQueue] = None
le_acl_packet_queue: Optional[DataPacketQueue] = None le_acl_packet_queue: Optional[DataPacketQueue] = None
iso_packet_queue: Optional[DataPacketQueue] = None iso_packet_queue: Optional[DataPacketQueue] = None
hci_sink: Optional[TransportSink] = None hci_sink: Optional[TransportSink] = None
hci_metadata: dict[str, Any] hci_metadata: Dict[str, Any]
long_term_key_provider: Optional[ long_term_key_provider: Optional[
Callable[[int, bytes, int], Awaitable[Optional[bytes]]] Callable[[int, bytes, int], Awaitable[Optional[bytes]]]
] ]
@@ -550,7 +547,7 @@ class Host(utils.EventEmitter):
logger.debug( logger.debug(
'HCI LE flow control: ' 'HCI LE flow control: '
f'le_acl_data_packet_length={le_acl_data_packet_length},' f'le_acl_data_packet_length={le_acl_data_packet_length},'
f'total_num_le_acl_data_packets={total_num_le_acl_data_packets},' f'total_num_le_acl_data_packets={total_num_le_acl_data_packets}'
f'iso_data_packet_length={iso_data_packet_length},' f'iso_data_packet_length={iso_data_packet_length},'
f'total_num_iso_data_packets={total_num_iso_data_packets}' f'total_num_iso_data_packets={total_num_iso_data_packets}'
) )
@@ -693,9 +690,11 @@ class Host(utils.EventEmitter):
raise hci.HCI_Error(status) raise hci.HCI_Error(status)
return response return response
except Exception: except Exception as error:
logger.exception(color("!!! Exception while sending command:", "red")) logger.exception(
raise f'{color("!!! Exception while sending command:", "red")} {error}'
)
raise error
finally: finally:
self.pending_command = None self.pending_command = None
self.pending_response = None self.pending_response = None
@@ -814,7 +813,7 @@ class Host(utils.EventEmitter):
) != 0 ) != 0
@property @property
def supported_commands(self) -> set[int]: def supported_commands(self) -> Set[int]:
return set( return set(
op_code op_code
for op_code, mask in hci.HCI_SUPPORTED_COMMANDS_MASKS.items() for op_code, mask in hci.HCI_SUPPORTED_COMMANDS_MASKS.items()
@@ -837,8 +836,8 @@ class Host(utils.EventEmitter):
def on_packet(self, packet: bytes) -> None: def on_packet(self, packet: bytes) -> None:
try: try:
hci_packet = hci.HCI_Packet.from_bytes(packet) hci_packet = hci.HCI_Packet.from_bytes(packet)
except Exception: except Exception as error:
logger.exception('!!! error parsing packet from bytes') logger.warning(f'!!! error parsing packet from bytes: {error}')
return return
if self.ready or ( if self.ready or (
@@ -902,14 +901,10 @@ class Host(utils.EventEmitter):
def on_l2cap_pdu(self, connection: Connection, cid: int, pdu: bytes) -> None: def on_l2cap_pdu(self, connection: Connection, cid: int, pdu: bytes) -> None:
self.emit('l2cap_pdu', connection.handle, cid, pdu) self.emit('l2cap_pdu', connection.handle, cid, pdu)
def on_command_processed( def on_command_processed(self, event):
self, event: Union[hci.HCI_Command_Complete_Event, hci.HCI_Command_Status_Event]
):
if self.pending_response: if self.pending_response:
# Check that it is what we were expecting # Check that it is what we were expecting
if self.pending_command is None: if self.pending_command.op_code != event.command_opcode:
logger.warning('!!! pending_command is None ')
elif self.pending_command.op_code != event.command_opcode:
logger.warning( logger.warning(
'!!! command result mismatch, expected ' '!!! command result mismatch, expected '
f'0x{self.pending_command.op_code:X} but got ' f'0x{self.pending_command.op_code:X} but got '
@@ -923,10 +918,10 @@ class Host(utils.EventEmitter):
############################################################ ############################################################
# HCI handlers # HCI handlers
############################################################ ############################################################
def on_hci_event(self, event: hci.HCI_Event): def on_hci_event(self, event):
logger.warning(f'{color(f"--- Ignoring event {event}", "red")}') logger.warning(f'{color(f"--- Ignoring event {event}", "red")}')
def on_hci_command_complete_event(self, event: hci.HCI_Command_Complete_Event): def on_hci_command_complete_event(self, event):
if event.command_opcode == 0: if event.command_opcode == 0:
# This is used just for the Num_HCI_Command_Packets field, not related to # This is used just for the Num_HCI_Command_Packets field, not related to
# an actual command # an actual command
@@ -935,7 +930,7 @@ class Host(utils.EventEmitter):
return self.on_command_processed(event) return self.on_command_processed(event)
def on_hci_command_status_event(self, event: hci.HCI_Command_Status_Event): def on_hci_command_status_event(self, event):
return self.on_command_processed(event) return self.on_command_processed(event)
def on_hci_number_of_completed_packets_event( def on_hci_number_of_completed_packets_event(
@@ -955,7 +950,7 @@ class Host(utils.EventEmitter):
) )
# Classic only # Classic only
def on_hci_connection_request_event(self, event: hci.HCI_Connection_Request_Event): def on_hci_connection_request_event(self, event):
# Notify the listeners # Notify the listeners
self.emit( self.emit(
'connection_request', 'connection_request',
@@ -964,14 +959,7 @@ class Host(utils.EventEmitter):
event.link_type, event.link_type,
) )
def on_hci_le_connection_complete_event( def on_hci_le_connection_complete_event(self, event):
self,
event: Union[
hci.HCI_LE_Connection_Complete_Event,
hci.HCI_LE_Enhanced_Connection_Complete_Event,
hci.HCI_LE_Enhanced_Connection_Complete_V2_Event,
],
):
# Check if this is a cancellation # Check if this is a cancellation
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
# Create/update the connection # Create/update the connection
@@ -991,16 +979,20 @@ class Host(utils.EventEmitter):
self.connections[event.connection_handle] = connection self.connections[event.connection_handle] = connection
# Notify the client # Notify the client
connection_parameters = ConnectionParameters(
event.connection_interval,
event.peripheral_latency,
event.supervision_timeout,
)
self.emit( self.emit(
'le_connection', 'connection',
event.connection_handle, event.connection_handle,
PhysicalTransport.LE,
event.peer_address, event.peer_address,
getattr(event, 'local_resolvable_private_address', None), getattr(event, 'local_resolvable_private_address', None),
getattr(event, 'peer_resolvable_private_address', None), getattr(event, 'peer_resolvable_private_address', None),
hci.Role(event.role), hci.Role(event.role),
event.connection_interval, connection_parameters,
event.peripheral_latency,
event.supervision_timeout,
) )
else: else:
logger.debug(f'### CONNECTION FAILED: {event.status}') logger.debug(f'### CONNECTION FAILED: {event.status}')
@@ -1013,25 +1005,15 @@ class Host(utils.EventEmitter):
event.status, event.status,
) )
def on_hci_le_enhanced_connection_complete_event( def on_hci_le_enhanced_connection_complete_event(self, event):
self,
event: Union[
hci.HCI_LE_Enhanced_Connection_Complete_Event,
hci.HCI_LE_Enhanced_Connection_Complete_V2_Event,
],
):
# Just use the same implementation as for the non-enhanced event for now # Just use the same implementation as for the non-enhanced event for now
self.on_hci_le_connection_complete_event(event) self.on_hci_le_connection_complete_event(event)
def on_hci_le_enhanced_connection_complete_v2_event( def on_hci_le_enhanced_connection_complete_v2_event(self, event):
self, event: hci.HCI_LE_Enhanced_Connection_Complete_V2_Event
):
# Just use the same implementation as for the v1 event for now # Just use the same implementation as for the v1 event for now
self.on_hci_le_enhanced_connection_complete_event(event) self.on_hci_le_enhanced_connection_complete_event(event)
def on_hci_connection_complete_event( def on_hci_connection_complete_event(self, event):
self, event: hci.HCI_Connection_Complete_Event
):
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
# Create/update the connection # Create/update the connection
logger.debug( logger.debug(
@@ -1051,9 +1033,14 @@ class Host(utils.EventEmitter):
# Notify the client # Notify the client
self.emit( self.emit(
'classic_connection', 'connection',
event.connection_handle, event.connection_handle,
PhysicalTransport.BR_EDR,
event.bd_addr, event.bd_addr,
None,
None,
None,
None,
) )
else: else:
logger.debug(f'### BR/EDR CONNECTION FAILED: {event.status}') logger.debug(f'### BR/EDR CONNECTION FAILED: {event.status}')
@@ -1066,9 +1053,7 @@ class Host(utils.EventEmitter):
event.status, event.status,
) )
def on_hci_disconnection_complete_event( def on_hci_disconnection_complete_event(self, event):
self, event: hci.HCI_Disconnection_Complete_Event
):
# Find the connection # Find the connection
handle = event.connection_handle handle = event.connection_handle
if ( if (
@@ -1107,30 +1092,27 @@ class Host(utils.EventEmitter):
# Notify the listeners # Notify the listeners
self.emit('disconnection_failure', handle, event.status) self.emit('disconnection_failure', handle, event.status)
def on_hci_le_connection_update_complete_event( def on_hci_le_connection_update_complete_event(self, event):
self, event: hci.HCI_LE_Connection_Update_Complete_Event
):
if (connection := self.connections.get(event.connection_handle)) is None: if (connection := self.connections.get(event.connection_handle)) is None:
logger.warning('!!! CONNECTION PARAMETERS UPDATE COMPLETE: unknown handle') logger.warning('!!! CONNECTION PARAMETERS UPDATE COMPLETE: unknown handle')
return return
# Notify the client # Notify the client
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit( connection_parameters = ConnectionParameters(
'connection_parameters_update',
connection.handle,
event.connection_interval, event.connection_interval,
event.peripheral_latency, event.peripheral_latency,
event.supervision_timeout, event.supervision_timeout,
) )
self.emit(
'connection_parameters_update', connection.handle, connection_parameters
)
else: else:
self.emit( self.emit(
'connection_parameters_update_failure', connection.handle, event.status 'connection_parameters_update_failure', connection.handle, event.status
) )
def on_hci_le_phy_update_complete_event( def on_hci_le_phy_update_complete_event(self, event):
self, event: hci.HCI_LE_PHY_Update_Complete_Event
):
if (connection := self.connections.get(event.connection_handle)) is None: if (connection := self.connections.get(event.connection_handle)) is None:
logger.warning('!!! CONNECTION PHY UPDATE COMPLETE: unknown handle') logger.warning('!!! CONNECTION PHY UPDATE COMPLETE: unknown handle')
return return
@@ -1145,24 +1127,14 @@ class Host(utils.EventEmitter):
else: else:
self.emit('connection_phy_update_failure', connection.handle, event.status) self.emit('connection_phy_update_failure', connection.handle, event.status)
def on_hci_le_advertising_report_event( def on_hci_le_advertising_report_event(self, event):
self,
event: (
hci.HCI_LE_Advertising_Report_Event
| hci.HCI_LE_Extended_Advertising_Report_Event
),
):
for report in event.reports: for report in event.reports:
self.emit('advertising_report', report) self.emit('advertising_report', report)
def on_hci_le_extended_advertising_report_event( def on_hci_le_extended_advertising_report_event(self, event):
self, event: hci.HCI_LE_Extended_Advertising_Report_Event
):
self.on_hci_le_advertising_report_event(event) self.on_hci_le_advertising_report_event(event)
def on_hci_le_advertising_set_terminated_event( def on_hci_le_advertising_set_terminated_event(self, event):
self, event: hci.HCI_LE_Advertising_Set_Terminated_Event
):
self.emit( self.emit(
'advertising_set_termination', 'advertising_set_termination',
event.status, event.status,
@@ -1171,9 +1143,7 @@ class Host(utils.EventEmitter):
event.num_completed_extended_advertising_events, event.num_completed_extended_advertising_events,
) )
def on_hci_le_periodic_advertising_sync_established_event( def on_hci_le_periodic_advertising_sync_established_event(self, event):
self, event: hci.HCI_LE_Periodic_Advertising_Sync_Established_Event
):
self.emit( self.emit(
'periodic_advertising_sync_establishment', 'periodic_advertising_sync_establishment',
event.status, event.status,
@@ -1185,22 +1155,16 @@ class Host(utils.EventEmitter):
event.advertiser_clock_accuracy, event.advertiser_clock_accuracy,
) )
def on_hci_le_periodic_advertising_sync_lost_event( def on_hci_le_periodic_advertising_sync_lost_event(self, event):
self, event: hci.HCI_LE_Periodic_Advertising_Sync_Lost_Event
):
self.emit('periodic_advertising_sync_loss', event.sync_handle) self.emit('periodic_advertising_sync_loss', event.sync_handle)
def on_hci_le_periodic_advertising_report_event( def on_hci_le_periodic_advertising_report_event(self, event):
self, event: hci.HCI_LE_Periodic_Advertising_Report_Event
):
self.emit('periodic_advertising_report', event.sync_handle, event) self.emit('periodic_advertising_report', event.sync_handle, event)
def on_hci_le_biginfo_advertising_report_event( def on_hci_le_biginfo_advertising_report_event(self, event):
self, event: hci.HCI_LE_BIGInfo_Advertising_Report_Event
):
self.emit('biginfo_advertising_report', event.sync_handle, event) self.emit('biginfo_advertising_report', event.sync_handle, event)
def on_hci_le_cis_request_event(self, event: hci.HCI_LE_CIS_Request_Event): def on_hci_le_cis_request_event(self, event):
self.emit( self.emit(
'cis_request', 'cis_request',
event.acl_connection_handle, event.acl_connection_handle,
@@ -1209,12 +1173,10 @@ class Host(utils.EventEmitter):
event.cis_id, event.cis_id,
) )
def on_hci_le_create_big_complete_event( def on_hci_le_create_big_complete_event(self, event):
self, event: hci.HCI_LE_Create_BIG_Complete_Event
):
self.bigs[event.big_handle] = set(event.connection_handle) self.bigs[event.big_handle] = set(event.connection_handle)
if self.iso_packet_queue is None: if self.iso_packet_queue is None:
raise InvalidStateError("BIS established but ISO packets not supported") logger.warning("BIS established but ISO packets not supported")
for connection_handle in event.connection_handle: for connection_handle in event.connection_handle:
self.bis_links[connection_handle] = IsoLink( self.bis_links[connection_handle] = IsoLink(
@@ -1237,13 +1199,8 @@ class Host(utils.EventEmitter):
event.iso_interval, event.iso_interval,
) )
def on_hci_le_big_sync_established_event( def on_hci_le_big_sync_established_event(self, event):
self, event: hci.HCI_LE_BIG_Sync_Established_Event
):
self.bigs[event.big_handle] = set(event.connection_handle) self.bigs[event.big_handle] = set(event.connection_handle)
if self.iso_packet_queue is None:
raise InvalidStateError("BIS established but ISO packets not supported")
for connection_handle in event.connection_handle: for connection_handle in event.connection_handle:
self.bis_links[connection_handle] = IsoLink( self.bis_links[connection_handle] = IsoLink(
connection_handle, self.iso_packet_queue connection_handle, self.iso_packet_queue
@@ -1263,19 +1220,15 @@ class Host(utils.EventEmitter):
event.connection_handle, event.connection_handle,
) )
def on_hci_le_big_sync_lost_event(self, event: hci.HCI_LE_BIG_Sync_Lost_Event): def on_hci_le_big_sync_lost_event(self, event):
self.remove_big(event.big_handle) self.remove_big(event.big_handle)
self.emit('big_sync_lost', event.big_handle, event.reason) self.emit('big_sync_lost', event.big_handle, event.reason)
def on_hci_le_terminate_big_complete_event( def on_hci_le_terminate_big_complete_event(self, event):
self, event: hci.HCI_LE_Terminate_BIG_Complete_Event
):
self.remove_big(event.big_handle) self.remove_big(event.big_handle)
self.emit('big_termination', event.reason, event.big_handle) self.emit('big_termination', event.reason, event.big_handle)
def on_hci_le_periodic_advertising_sync_transfer_received_event( def on_hci_le_periodic_advertising_sync_transfer_received_event(self, event):
self, event: hci.HCI_LE_Periodic_Advertising_Sync_Transfer_Received_Event
):
self.emit( self.emit(
'periodic_advertising_sync_transfer', 'periodic_advertising_sync_transfer',
event.status, event.status,
@@ -1288,9 +1241,7 @@ class Host(utils.EventEmitter):
event.advertiser_clock_accuracy, event.advertiser_clock_accuracy,
) )
def on_hci_le_periodic_advertising_sync_transfer_received_v2_event( def on_hci_le_periodic_advertising_sync_transfer_received_v2_event(self, event):
self, event: hci.HCI_LE_Periodic_Advertising_Sync_Transfer_Received_V2_Event
):
self.emit( self.emit(
'periodic_advertising_sync_transfer', 'periodic_advertising_sync_transfer',
event.status, event.status,
@@ -1303,40 +1254,21 @@ class Host(utils.EventEmitter):
event.advertiser_clock_accuracy, event.advertiser_clock_accuracy,
) )
def on_hci_le_cis_established_event(self, event: hci.HCI_LE_CIS_Established_Event): def on_hci_le_cis_established_event(self, event):
# The remaining parameters are unused for now. # The remaining parameters are unused for now.
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
if self.iso_packet_queue is None: if self.iso_packet_queue is None:
raise InvalidStateError("CIS established but ISO packets not supported") logger.warning("CIS established but ISO packets not supported")
self.cis_links[event.connection_handle] = IsoLink( self.cis_links[event.connection_handle] = IsoLink(
handle=event.connection_handle, packet_queue=self.iso_packet_queue handle=event.connection_handle, packet_queue=self.iso_packet_queue
) )
self.emit( self.emit('cis_establishment', event.connection_handle)
'cis_establishment',
event.connection_handle,
event.cig_sync_delay,
event.cis_sync_delay,
event.transport_latency_c_to_p,
event.transport_latency_p_to_c,
event.phy_c_to_p,
event.phy_p_to_c,
event.nse,
event.bn_c_to_p,
event.bn_p_to_c,
event.ft_c_to_p,
event.ft_p_to_c,
event.max_pdu_c_to_p,
event.max_pdu_p_to_c,
event.iso_interval,
)
else: else:
self.emit( self.emit(
'cis_establishment_failure', event.connection_handle, event.status 'cis_establishment_failure', event.connection_handle, event.status
) )
def on_hci_le_remote_connection_parameter_request_event( def on_hci_le_remote_connection_parameter_request_event(self, event):
self, event: hci.HCI_LE_Remote_Connection_Parameter_Request_Event
):
if event.connection_handle not in self.connections: if event.connection_handle not in self.connections:
logger.warning('!!! REMOTE CONNECTION PARAMETER REQUEST: unknown handle') logger.warning('!!! REMOTE CONNECTION PARAMETER REQUEST: unknown handle')
return return
@@ -1355,9 +1287,7 @@ class Host(utils.EventEmitter):
) )
) )
def on_hci_le_long_term_key_request_event( def on_hci_le_long_term_key_request_event(self, event):
self, event: hci.HCI_LE_Long_Term_Key_Request_Event
):
if (connection := self.connections.get(event.connection_handle)) is None: if (connection := self.connections.get(event.connection_handle)) is None:
logger.warning('!!! LE LONG TERM KEY REQUEST: unknown handle') logger.warning('!!! LE LONG TERM KEY REQUEST: unknown handle')
return return
@@ -1391,9 +1321,7 @@ class Host(utils.EventEmitter):
asyncio.create_task(send_long_term_key()) asyncio.create_task(send_long_term_key())
def on_hci_synchronous_connection_complete_event( def on_hci_synchronous_connection_complete_event(self, event):
self, event: hci.HCI_Synchronous_Connection_Complete_Event
):
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
# Create/update the connection # Create/update the connection
logger.debug( logger.debug(
@@ -1419,21 +1347,10 @@ class Host(utils.EventEmitter):
# Notify the client # Notify the client
self.emit('sco_connection_failure', event.bd_addr, event.status) self.emit('sco_connection_failure', event.bd_addr, event.status)
def on_hci_synchronous_connection_changed_event( def on_hci_synchronous_connection_changed_event(self, event):
self, event: hci.HCI_Synchronous_Connection_Changed_Event
):
pass pass
def on_hci_mode_change_event(self, event: hci.HCI_Mode_Change_Event): def on_hci_role_change_event(self, event):
self.emit(
'mode_change',
event.connection_handle,
event.status,
event.current_mode,
event.interval,
)
def on_hci_role_change_event(self, event: hci.HCI_Role_Change_Event):
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
logger.debug( logger.debug(
f'role change for {event.bd_addr}: ' f'role change for {event.bd_addr}: '
@@ -1447,13 +1364,7 @@ class Host(utils.EventEmitter):
) )
self.emit('role_change_failure', event.bd_addr, event.status) self.emit('role_change_failure', event.bd_addr, event.status)
def on_hci_le_data_length_change_event( def on_hci_le_data_length_change_event(self, event):
self, event: hci.HCI_LE_Data_Length_Change_Event
):
if (connection := self.connections.get(event.connection_handle)) is None:
logger.warning('!!! DATA LENGTH CHANGE: unknown handle')
return
self.emit( self.emit(
'connection_data_length_change', 'connection_data_length_change',
event.connection_handle, event.connection_handle,
@@ -1463,9 +1374,7 @@ class Host(utils.EventEmitter):
event.max_rx_time, event.max_rx_time,
) )
def on_hci_authentication_complete_event( def on_hci_authentication_complete_event(self, event):
self, event: hci.HCI_Authentication_Complete_Event
):
# Notify the client # Notify the client
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit('connection_authentication', event.connection_handle) self.emit('connection_authentication', event.connection_handle)
@@ -1476,7 +1385,7 @@ class Host(utils.EventEmitter):
event.status, event.status,
) )
def on_hci_encryption_change_event(self, event: hci.HCI_Encryption_Change_Event): def on_hci_encryption_change_event(self, event):
# Notify the client # Notify the client
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit( self.emit(
@@ -1490,9 +1399,7 @@ class Host(utils.EventEmitter):
'connection_encryption_failure', event.connection_handle, event.status 'connection_encryption_failure', event.connection_handle, event.status
) )
def on_hci_encryption_change_v2_event( def on_hci_encryption_change_v2_event(self, event):
self, event: hci.HCI_Encryption_Change_V2_Event
):
# Notify the client # Notify the client
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit( self.emit(
@@ -1506,9 +1413,7 @@ class Host(utils.EventEmitter):
'connection_encryption_failure', event.connection_handle, event.status 'connection_encryption_failure', event.connection_handle, event.status
) )
def on_hci_encryption_key_refresh_complete_event( def on_hci_encryption_key_refresh_complete_event(self, event):
self, event: hci.HCI_Encryption_Key_Refresh_Complete_Event
):
# Notify the client # Notify the client
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit('connection_encryption_key_refresh', event.connection_handle) self.emit('connection_encryption_key_refresh', event.connection_handle)
@@ -1519,7 +1424,7 @@ class Host(utils.EventEmitter):
event.status, event.status,
) )
def on_hci_qos_setup_complete_event(self, event: hci.HCI_QOS_Setup_Complete_Event): def on_hci_qos_setup_complete_event(self, event):
if event.status == hci.HCI_SUCCESS: if event.status == hci.HCI_SUCCESS:
self.emit( self.emit(
'connection_qos_setup', event.connection_handle, event.service_type 'connection_qos_setup', event.connection_handle, event.service_type
@@ -1531,31 +1436,23 @@ class Host(utils.EventEmitter):
event.status, event.status,
) )
def on_hci_link_supervision_timeout_changed_event( def on_hci_link_supervision_timeout_changed_event(self, event):
self, event: hci.HCI_Link_Supervision_Timeout_Changed_Event
):
pass pass
def on_hci_max_slots_change_event(self, event: hci.HCI_Max_Slots_Change_Event): def on_hci_max_slots_change_event(self, event):
pass pass
def on_hci_page_scan_repetition_mode_change_event( def on_hci_page_scan_repetition_mode_change_event(self, event):
self, event: hci.HCI_Page_Scan_Repetition_Mode_Change_Event
):
pass pass
def on_hci_link_key_notification_event( def on_hci_link_key_notification_event(self, event):
self, event: hci.HCI_Link_Key_Notification_Event
):
logger.debug( logger.debug(
f'link key for {event.bd_addr}: {event.link_key.hex()}, ' f'link key for {event.bd_addr}: {event.link_key.hex()}, '
f'type={hci.HCI_Constant.link_key_type_name(event.key_type)}' f'type={hci.HCI_Constant.link_key_type_name(event.key_type)}'
) )
self.emit('link_key', event.bd_addr, event.link_key, event.key_type) self.emit('link_key', event.bd_addr, event.link_key, event.key_type)
def on_hci_simple_pairing_complete_event( def on_hci_simple_pairing_complete_event(self, event):
self, event: hci.HCI_Simple_Pairing_Complete_Event
):
logger.debug( logger.debug(
f'simple pairing complete for {event.bd_addr}: ' f'simple pairing complete for {event.bd_addr}: '
f'status={hci.HCI_Constant.status_name(event.status)}' f'status={hci.HCI_Constant.status_name(event.status)}'
@@ -1565,10 +1462,10 @@ class Host(utils.EventEmitter):
else: else:
self.emit('classic_pairing_failure', event.bd_addr, event.status) self.emit('classic_pairing_failure', event.bd_addr, event.status)
def on_hci_pin_code_request_event(self, event: hci.HCI_PIN_Code_Request_Event): def on_hci_pin_code_request_event(self, event):
self.emit('pin_code_request', event.bd_addr) self.emit('pin_code_request', event.bd_addr)
def on_hci_link_key_request_event(self, event: hci.HCI_Link_Key_Request_Event): def on_hci_link_key_request_event(self, event):
async def send_link_key(): async def send_link_key():
if self.link_key_provider is None: if self.link_key_provider is None:
logger.debug('no link key provider') logger.debug('no link key provider')
@@ -1593,14 +1490,10 @@ class Host(utils.EventEmitter):
asyncio.create_task(send_link_key()) asyncio.create_task(send_link_key())
def on_hci_io_capability_request_event( def on_hci_io_capability_request_event(self, event):
self, event: hci.HCI_IO_Capability_Request_Event
):
self.emit('authentication_io_capability_request', event.bd_addr) self.emit('authentication_io_capability_request', event.bd_addr)
def on_hci_io_capability_response_event( def on_hci_io_capability_response_event(self, event):
self, event: hci.HCI_IO_Capability_Response_Event
):
self.emit( self.emit(
'authentication_io_capability_response', 'authentication_io_capability_response',
event.bd_addr, event.bd_addr,
@@ -1608,47 +1501,35 @@ class Host(utils.EventEmitter):
event.authentication_requirements, event.authentication_requirements,
) )
def on_hci_user_confirmation_request_event( def on_hci_user_confirmation_request_event(self, event):
self, event: hci.HCI_User_Confirmation_Request_Event
):
self.emit( self.emit(
'authentication_user_confirmation_request', 'authentication_user_confirmation_request',
event.bd_addr, event.bd_addr,
event.numeric_value, event.numeric_value,
) )
def on_hci_user_passkey_request_event( def on_hci_user_passkey_request_event(self, event):
self, event: hci.HCI_User_Passkey_Request_Event
):
self.emit('authentication_user_passkey_request', event.bd_addr) self.emit('authentication_user_passkey_request', event.bd_addr)
def on_hci_user_passkey_notification_event( def on_hci_user_passkey_notification_event(self, event):
self, event: hci.HCI_User_Passkey_Notification_Event
):
self.emit( self.emit(
'authentication_user_passkey_notification', event.bd_addr, event.passkey 'authentication_user_passkey_notification', event.bd_addr, event.passkey
) )
def on_hci_inquiry_complete_event(self, _event: hci.HCI_Inquiry_Complete_Event): def on_hci_inquiry_complete_event(self, _event):
self.emit('inquiry_complete') self.emit('inquiry_complete')
def on_hci_inquiry_result_with_rssi_event( def on_hci_inquiry_result_with_rssi_event(self, event):
self, event: hci.HCI_Inquiry_Result_With_RSSI_Event for response in event.responses:
):
for bd_addr, class_of_device, rssi in zip(
event.bd_addr, event.class_of_device, event.rssi
):
self.emit( self.emit(
'inquiry_result', 'inquiry_result',
bd_addr, response.bd_addr,
class_of_device, response.class_of_device,
b'', b'',
rssi, response.rssi,
) )
def on_hci_extended_inquiry_result_event( def on_hci_extended_inquiry_result_event(self, event):
self, event: hci.HCI_Extended_Inquiry_Result_Event
):
self.emit( self.emit(
'inquiry_result', 'inquiry_result',
event.bd_addr, event.bd_addr,
@@ -1657,9 +1538,7 @@ class Host(utils.EventEmitter):
event.rssi, event.rssi,
) )
def on_hci_remote_name_request_complete_event( def on_hci_remote_name_request_complete_event(self, event):
self, event: hci.HCI_Remote_Name_Request_Complete_Event
):
if event.status != hci.HCI_SUCCESS: if event.status != hci.HCI_SUCCESS:
self.emit('remote_name_failure', event.bd_addr, event.status) self.emit('remote_name_failure', event.bd_addr, event.status)
else: else:
@@ -1670,18 +1549,14 @@ class Host(utils.EventEmitter):
self.emit('remote_name', event.bd_addr, utf8_name) self.emit('remote_name', event.bd_addr, utf8_name)
def on_hci_remote_host_supported_features_notification_event( def on_hci_remote_host_supported_features_notification_event(self, event):
self, event: hci.HCI_Remote_Host_Supported_Features_Notification_Event
):
self.emit( self.emit(
'remote_host_supported_features', 'remote_host_supported_features',
event.bd_addr, event.bd_addr,
event.host_supported_features, event.host_supported_features,
) )
def on_hci_le_read_remote_features_complete_event( def on_hci_le_read_remote_features_complete_event(self, event):
self, event: hci.HCI_LE_Read_Remote_Features_Complete_Event
):
if event.status != hci.HCI_SUCCESS: if event.status != hci.HCI_SUCCESS:
self.emit( self.emit(
'le_remote_features_failure', event.connection_handle, event.status 'le_remote_features_failure', event.connection_handle, event.status
@@ -1693,45 +1568,23 @@ class Host(utils.EventEmitter):
int.from_bytes(event.le_features, 'little'), int.from_bytes(event.le_features, 'little'),
) )
def on_hci_le_cs_read_remote_supported_capabilities_complete_event( def on_hci_le_cs_read_remote_supported_capabilities_complete_event(self, event):
self, event: hci.HCI_LE_CS_Read_Remote_Supported_Capabilities_Complete_Event
):
self.emit('cs_remote_supported_capabilities', event) self.emit('cs_remote_supported_capabilities', event)
def on_hci_le_cs_security_enable_complete_event( def on_hci_le_cs_security_enable_complete_event(self, event):
self, event: hci.HCI_LE_CS_Security_Enable_Complete_Event
):
self.emit('cs_security', event) self.emit('cs_security', event)
def on_hci_le_cs_config_complete_event( def on_hci_le_cs_config_complete_event(self, event):
self, event: hci.HCI_LE_CS_Config_Complete_Event
):
self.emit('cs_config', event) self.emit('cs_config', event)
def on_hci_le_cs_procedure_enable_complete_event( def on_hci_le_cs_procedure_enable_complete_event(self, event):
self, event: hci.HCI_LE_CS_Procedure_Enable_Complete_Event
):
self.emit('cs_procedure', event) self.emit('cs_procedure', event)
def on_hci_le_cs_subevent_result_event( def on_hci_le_cs_subevent_result_event(self, event):
self, event: hci.HCI_LE_CS_Subevent_Result_Event
):
self.emit('cs_subevent_result', event) self.emit('cs_subevent_result', event)
def on_hci_le_cs_subevent_result_continue_event( def on_hci_le_cs_subevent_result_continue_event(self, event):
self, event: hci.HCI_LE_CS_Subevent_Result_Continue_Event
):
self.emit('cs_subevent_result_continue', event) self.emit('cs_subevent_result_continue', event)
def on_hci_le_subrate_change_event(self, event: hci.HCI_LE_Subrate_Change_Event): def on_hci_vendor_event(self, event):
self.emit(
'le_subrate_change',
event.connection_handle,
event.subrate_factor,
event.peripheral_latency,
event.continuation_number,
event.supervision_timeout,
)
def on_hci_vendor_event(self, event: hci.HCI_Vendor_Event):
self.emit('vendor_event', event) self.emit('vendor_event', event)
+7 -9
View File
@@ -21,18 +21,16 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import dataclasses import dataclasses
import json
import logging import logging
import os import os
from typing import TYPE_CHECKING, Any, Optional import json
from typing import TYPE_CHECKING, Dict, List, Optional, Tuple, Type, Any
from typing_extensions import Self from typing_extensions import Self
from bumble import hci
from bumble.colors import color from bumble.colors import color
from bumble import hci
if TYPE_CHECKING: if TYPE_CHECKING:
from bumble.device import Device from bumble.device import Device
@@ -159,7 +157,7 @@ class KeyStore:
async def get(self, _name: str) -> Optional[PairingKeys]: async def get(self, _name: str) -> Optional[PairingKeys]:
return None return None
async def get_all(self) -> list[tuple[str, PairingKeys]]: async def get_all(self) -> List[Tuple[str, PairingKeys]]:
return [] return []
async def delete_all(self) -> None: async def delete_all(self) -> None:
@@ -274,7 +272,7 @@ class JsonKeyStore(KeyStore):
@classmethod @classmethod
def from_device( def from_device(
cls: type[Self], device: Device, filename: Optional[str] = None cls: Type[Self], device: Device, filename: Optional[str] = None
) -> Self: ) -> Self:
if not filename: if not filename:
# Extract the filename from the config if there is one # Extract the filename from the config if there is one
@@ -358,7 +356,7 @@ class JsonKeyStore(KeyStore):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class MemoryKeyStore(KeyStore): class MemoryKeyStore(KeyStore):
all_keys: dict[str, PairingKeys] all_keys: Dict[str, PairingKeys]
def __init__(self) -> None: def __init__(self) -> None:
self.all_keys = {} self.all_keys = {}
@@ -373,5 +371,5 @@ class MemoryKeyStore(KeyStore):
async def get(self, name: str) -> Optional[PairingKeys]: async def get(self, name: str) -> Optional[PairingKeys]:
return self.all_keys.get(name) return self.all_keys.get(name)
async def get_all(self) -> list[tuple[str, PairingKeys]]: async def get_all(self) -> List[Tuple[str, PairingKeys]]:
return list(self.all_keys.items()) return list(self.all_keys.items())
+476 -426
View File
File diff suppressed because it is too large Load Diff
+291 -26
View File
@@ -12,24 +12,31 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import asyncio
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import logging import logging
from typing import Optional import asyncio
from functools import partial
from bumble import controller, core from bumble.core import (
from bumble.hci import ( PhysicalTransport,
HCI_CONNECTION_ACCEPT_TIMEOUT_ERROR, InvalidStateError,
HCI_PAGE_TIMEOUT_ERROR,
HCI_SUCCESS,
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
Address,
HCI_Connection_Complete_Event,
Role,
) )
from bumble.colors import color
from bumble.hci import (
Address,
Role,
HCI_SUCCESS,
HCI_CONNECTION_ACCEPT_TIMEOUT_ERROR,
HCI_CONNECTION_TIMEOUT_ERROR,
HCI_UNKNOWN_CONNECTION_IDENTIFIER_ERROR,
HCI_PAGE_TIMEOUT_ERROR,
HCI_Connection_Complete_Event,
)
from bumble import controller
from typing import Optional, Set
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -58,7 +65,7 @@ class LocalLink:
Link bus for controllers to communicate with each other Link bus for controllers to communicate with each other
''' '''
controllers: set[controller.Controller] controllers: Set[controller.Controller]
def __init__(self): def __init__(self):
self.controllers = set() self.controllers = set()
@@ -108,10 +115,10 @@ class LocalLink:
def send_acl_data(self, sender_controller, destination_address, transport, data): def send_acl_data(self, sender_controller, destination_address, transport, data):
# Send the data to the first controller with a matching address # Send the data to the first controller with a matching address
if transport == core.PhysicalTransport.LE: if transport == PhysicalTransport.LE:
destination_controller = self.find_controller(destination_address) destination_controller = self.find_controller(destination_address)
source_address = sender_controller.random_address source_address = sender_controller.random_address
elif transport == core.PhysicalTransport.BR_EDR: elif transport == PhysicalTransport.BR_EDR:
destination_controller = self.find_classic_controller(destination_address) destination_controller = self.find_classic_controller(destination_address)
source_address = sender_controller.public_address source_address = sender_controller.public_address
else: else:
@@ -158,29 +165,29 @@ class LocalLink:
asyncio.get_running_loop().call_soon(self.on_connection_complete) asyncio.get_running_loop().call_soon(self.on_connection_complete)
def on_disconnection_complete( def on_disconnection_complete(
self, initiating_address, target_address, disconnect_command self, central_address, peripheral_address, disconnect_command
): ):
# Find the controller that initiated the disconnection # Find the controller that initiated the disconnection
if not (initiating_controller := self.find_controller(initiating_address)): if not (central_controller := self.find_controller(central_address)):
logger.warning('!!! Initiating controller not found') logger.warning('!!! Initiating controller not found')
return return
# Disconnect from the first controller with a matching address # Disconnect from the first controller with a matching address
if target_controller := self.find_controller(target_address): if peripheral_controller := self.find_controller(peripheral_address):
target_controller.on_link_disconnected( peripheral_controller.on_link_central_disconnected(
initiating_address, disconnect_command.reason central_address, disconnect_command.reason
) )
initiating_controller.on_link_disconnection_complete( central_controller.on_link_peripheral_disconnection_complete(
disconnect_command, HCI_SUCCESS disconnect_command, HCI_SUCCESS
) )
def disconnect(self, initiating_address, target_address, disconnect_command): def disconnect(self, central_address, peripheral_address, disconnect_command):
logger.debug( logger.debug(
f'$$$ DISCONNECTION {initiating_address} -> ' f'$$$ DISCONNECTION {central_address} -> '
f'{target_address}: reason = {disconnect_command.reason}' f'{peripheral_address}: reason = {disconnect_command.reason}'
) )
args = [initiating_address, target_address, disconnect_command] args = [central_address, peripheral_address, disconnect_command]
asyncio.get_running_loop().call_soon(self.on_disconnection_complete, *args) asyncio.get_running_loop().call_soon(self.on_disconnection_complete, *args)
# pylint: disable=too-many-arguments # pylint: disable=too-many-arguments
@@ -267,7 +274,7 @@ class LocalLink:
responder_controller.on_classic_connection_request( responder_controller.on_classic_connection_request(
initiator_controller.public_address, initiator_controller.public_address,
HCI_Connection_Complete_Event.LinkType.ACL, HCI_Connection_Complete_Event.ACL_LINK_TYPE,
) )
def classic_accept_connection( def classic_accept_connection(
@@ -377,3 +384,261 @@ class LocalLink:
responder_controller.on_classic_sco_connection_complete( responder_controller.on_classic_sco_connection_complete(
initiator_controller.public_address, HCI_SUCCESS, link_type initiator_controller.public_address, HCI_SUCCESS, link_type
) )
# -----------------------------------------------------------------------------
class RemoteLink:
'''
A Link implementation that communicates with other virtual controllers via a
WebSocket relay
'''
def __init__(self, uri):
self.controller = None
self.uri = uri
self.execution_queue = asyncio.Queue()
self.websocket = asyncio.get_running_loop().create_future()
self.rpc_result = None
self.pending_connection = None
self.central_connections = set() # List of addresses that we have connected to
self.peripheral_connections = (
set()
) # List of addresses that have connected to us
# Connect and run asynchronously
asyncio.create_task(self.run_connection())
asyncio.create_task(self.run_executor_loop())
def add_controller(self, controller):
if self.controller:
raise InvalidStateError('controller already set')
self.controller = controller
def remove_controller(self, controller):
if self.controller != controller:
raise InvalidStateError('controller mismatch')
self.controller = None
def get_pending_connection(self):
return self.pending_connection
def get_pending_classic_connection(self):
return self.pending_classic_connection
async def wait_until_connected(self):
await self.websocket
def execute(self, async_function):
self.execution_queue.put_nowait(async_function())
async def run_executor_loop(self):
logger.debug('executor loop starting')
while True:
item = await self.execution_queue.get()
try:
await item
except Exception as error:
logger.warning(
f'{color("!!! Exception in async handler:", "red")} {error}'
)
async def run_connection(self):
import websockets # lazy import
# Connect to the relay
logger.debug(f'connecting to {self.uri}')
# pylint: disable-next=no-member
websocket = await websockets.connect(self.uri)
self.websocket.set_result(websocket)
logger.debug(f'connected to {self.uri}')
while True:
message = await websocket.recv()
logger.debug(f'received message: {message}')
keyword, *payload = message.split(':', 1)
handler_name = f'on_{keyword}_received'
handler = getattr(self, handler_name, None)
if handler:
await handler(payload[0] if payload else None)
def close(self):
if self.websocket.done():
logger.debug('closing websocket')
websocket = self.websocket.result()
asyncio.create_task(websocket.close())
async def on_result_received(self, result):
if self.rpc_result:
self.rpc_result.set_result(result)
async def on_left_received(self, address):
if address in self.central_connections:
self.controller.on_link_peripheral_disconnected(Address(address))
self.central_connections.remove(address)
if address in self.peripheral_connections:
self.controller.on_link_central_disconnected(
address, HCI_CONNECTION_TIMEOUT_ERROR
)
self.peripheral_connections.remove(address)
async def on_unreachable_received(self, target):
await self.on_left_received(target)
async def on_message_received(self, message):
sender, *payload = message.split('/', 1)
if payload:
keyword, *payload = payload[0].split(':', 1)
handler_name = f'on_{keyword}_message_received'
handler = getattr(self, handler_name, None)
if handler:
await handler(sender, payload[0] if payload else None)
async def on_advertisement_message_received(self, sender, advertisement):
try:
self.controller.on_link_advertising_data(
Address(sender), bytes.fromhex(advertisement)
)
except Exception:
logger.exception('exception')
async def on_acl_message_received(self, sender, acl_data):
try:
self.controller.on_link_acl_data(Address(sender), bytes.fromhex(acl_data))
except Exception:
logger.exception('exception')
async def on_connect_message_received(self, sender, _):
# Remember the connection
self.peripheral_connections.add(sender)
# Notify the controller
logger.debug(f'connection from central {sender}')
self.controller.on_link_central_connected(Address(sender))
# Accept the connection by responding to it
await self.send_targeted_message(sender, 'connected')
async def on_connected_message_received(self, sender, _):
if not self.pending_connection:
logger.warning('received a connection ack, but no connection is pending')
return
# Remember the connection
self.central_connections.add(sender)
# Notify the controller
logger.debug(f'connected to peripheral {self.pending_connection.peer_address}')
self.controller.on_link_peripheral_connection_complete(
self.pending_connection, HCI_SUCCESS
)
async def on_disconnect_message_received(self, sender, message):
# Notify the controller
params = parse_parameters(message)
reason = int(params.get('reason', str(HCI_CONNECTION_TIMEOUT_ERROR)))
self.controller.on_link_central_disconnected(Address(sender), reason)
# Forget the connection
if sender in self.peripheral_connections:
self.peripheral_connections.remove(sender)
async def on_encrypted_message_received(self, sender, _):
# TODO parse params to get real args
self.controller.on_link_encrypted(Address(sender), bytes(8), 0, bytes(16))
async def send_rpc_command(self, command):
# Ensure we have a connection
websocket = await self.websocket
# Create a future value to hold the eventual result
assert self.rpc_result is None
self.rpc_result = asyncio.get_running_loop().create_future()
# Send the command
await websocket.send(command)
# Wait for the result
rpc_result = await self.rpc_result
self.rpc_result = None
logger.debug(f'rpc_result: {rpc_result}')
# TODO: parse the result
async def send_targeted_message(self, target, message):
# Ensure we have a connection
websocket = await self.websocket
# Send the message
await websocket.send(f'@{target} {message}')
async def notify_address_changed(self):
await self.send_rpc_command(f'/set-address {self.controller.random_address}')
def on_address_changed(self, controller):
logger.info(f'address changed for {controller}: {controller.random_address}')
# Notify the relay of the change
self.execute(self.notify_address_changed)
async def send_advertising_data_to_relay(self, data):
await self.send_targeted_message('*', f'advertisement:{data.hex()}')
def send_advertising_data(self, _, data):
self.execute(partial(self.send_advertising_data_to_relay, data))
async def send_acl_data_to_relay(self, peer_address, data):
await self.send_targeted_message(peer_address, f'acl:{data.hex()}')
def send_acl_data(self, _, peer_address, _transport, data):
# TODO: handle different transport
self.execute(partial(self.send_acl_data_to_relay, peer_address, data))
async def send_connection_request_to_relay(self, peer_address):
await self.send_targeted_message(peer_address, 'connect')
def connect(self, _, le_create_connection_command):
if self.pending_connection:
logger.warning('connection already pending')
return
self.pending_connection = le_create_connection_command
self.execute(
partial(
self.send_connection_request_to_relay,
str(le_create_connection_command.peer_address),
)
)
def on_disconnection_complete(self, disconnect_command):
self.controller.on_link_peripheral_disconnection_complete(
disconnect_command, HCI_SUCCESS
)
def disconnect(self, central_address, peripheral_address, disconnect_command):
logger.debug(
f'disconnect {central_address} -> '
f'{peripheral_address}: reason = {disconnect_command.reason}'
)
self.execute(
partial(
self.send_targeted_message,
peripheral_address,
f'disconnect:reason={disconnect_command.reason}',
)
)
asyncio.get_running_loop().call_soon(
self.on_disconnection_complete, disconnect_command
)
def on_connection_encrypted(self, _, peripheral_address, rand, ediv, ltk):
asyncio.get_running_loop().call_soon(
self.controller.on_link_encrypted, peripheral_address, rand, ediv, ltk
)
self.execute(
partial(
self.send_targeted_message,
peripheral_address,
f'encrypted:ltk={ltk.hex()}',
)
)
-65
View File
@@ -1,65 +0,0 @@
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
import functools
import logging
import os
from bumble import colors
# -----------------------------------------------------------------------------
class ColorFormatter(logging.Formatter):
_colorizers = {
logging.DEBUG: functools.partial(colors.color, fg="white"),
logging.INFO: functools.partial(colors.color, fg="green"),
logging.WARNING: functools.partial(colors.color, fg="yellow"),
logging.ERROR: functools.partial(colors.color, fg="red"),
logging.CRITICAL: functools.partial(colors.color, fg="black", bg="red"),
}
_formatters = {
level: logging.Formatter(
fmt=colorizer("{asctime}.{msecs:03.0f} {levelname:.1} {name}: ")
+ "{message}",
datefmt="%H:%M:%S",
style="{",
)
for level, colorizer in _colorizers.items()
}
def format(self, record: logging.LogRecord) -> str:
return self._formatters[record.levelno].format(record)
def setup_basic_logging(default_level: str = "INFO") -> None:
"""
Set up basic logging with logging.basicConfig, configured with a simple formatter
that prints out the date and log level in color.
If the BUMBLE_LOGLEVEL environment variable is set to the name of a log level, it
is used. Otherwise the default_level argument is used.
Args:
default_level: default logging level
"""
handler = logging.StreamHandler()
handler.setFormatter(ColorFormatter())
logging.basicConfig(
level=os.environ.get("BUMBLE_LOGLEVEL", default_level).upper(),
handlers=[handler],
)
+24 -28
View File
@@ -16,28 +16,32 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import enum import enum
import secrets
from dataclasses import dataclass from dataclasses import dataclass
from typing import Optional from typing import Optional, Tuple
from bumble import hci from bumble.hci import (
from bumble.core import AdvertisingData, LeRole Address,
HCI_NO_INPUT_NO_OUTPUT_IO_CAPABILITY,
HCI_DISPLAY_ONLY_IO_CAPABILITY,
HCI_DISPLAY_YES_NO_IO_CAPABILITY,
HCI_KEYBOARD_ONLY_IO_CAPABILITY,
)
from bumble.smp import ( from bumble.smp import (
SMP_NO_INPUT_NO_OUTPUT_IO_CAPABILITY,
SMP_KEYBOARD_ONLY_IO_CAPABILITY,
SMP_DISPLAY_ONLY_IO_CAPABILITY, SMP_DISPLAY_ONLY_IO_CAPABILITY,
SMP_DISPLAY_YES_NO_IO_CAPABILITY, SMP_DISPLAY_YES_NO_IO_CAPABILITY,
SMP_KEYBOARD_DISPLAY_IO_CAPABILITY,
SMP_ENC_KEY_DISTRIBUTION_FLAG, SMP_ENC_KEY_DISTRIBUTION_FLAG,
SMP_ID_KEY_DISTRIBUTION_FLAG, SMP_ID_KEY_DISTRIBUTION_FLAG,
SMP_KEYBOARD_DISPLAY_IO_CAPABILITY,
SMP_KEYBOARD_ONLY_IO_CAPABILITY,
SMP_LINK_KEY_DISTRIBUTION_FLAG,
SMP_NO_INPUT_NO_OUTPUT_IO_CAPABILITY,
SMP_SIGN_KEY_DISTRIBUTION_FLAG, SMP_SIGN_KEY_DISTRIBUTION_FLAG,
SMP_LINK_KEY_DISTRIBUTION_FLAG,
OobContext, OobContext,
OobLegacyContext, OobLegacyContext,
OobSharedData, OobSharedData,
) )
from bumble.core import AdvertisingData, LeRole
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -45,7 +49,7 @@ from bumble.smp import (
class OobData: class OobData:
"""OOB data that can be sent from one device to another.""" """OOB data that can be sent from one device to another."""
address: Optional[hci.Address] = None address: Optional[Address] = None
role: Optional[LeRole] = None role: Optional[LeRole] = None
shared_data: Optional[OobSharedData] = None shared_data: Optional[OobSharedData] = None
legacy_context: Optional[OobLegacyContext] = None legacy_context: Optional[OobLegacyContext] = None
@@ -57,7 +61,7 @@ class OobData:
shared_data_r: Optional[bytes] = None shared_data_r: Optional[bytes] = None
for ad_type, ad_data in ad.ad_structures: for ad_type, ad_data in ad.ad_structures:
if ad_type == AdvertisingData.LE_BLUETOOTH_DEVICE_ADDRESS: if ad_type == AdvertisingData.LE_BLUETOOTH_DEVICE_ADDRESS:
instance.address = hci.Address(ad_data) instance.address = Address(ad_data)
elif ad_type == AdvertisingData.LE_ROLE: elif ad_type == AdvertisingData.LE_ROLE:
instance.role = LeRole(ad_data[0]) instance.role = LeRole(ad_data[0])
elif ad_type == AdvertisingData.LE_SECURE_CONNECTIONS_CONFIRMATION_VALUE: elif ad_type == AdvertisingData.LE_SECURE_CONNECTIONS_CONFIRMATION_VALUE:
@@ -125,11 +129,11 @@ class PairingDelegate:
# Default mapping from abstract to Classic I/O capabilities. # Default mapping from abstract to Classic I/O capabilities.
# Subclasses may override this if they prefer a different mapping. # Subclasses may override this if they prefer a different mapping.
CLASSIC_IO_CAPABILITIES_MAP = { CLASSIC_IO_CAPABILITIES_MAP = {
NO_OUTPUT_NO_INPUT: hci.IoCapability.NO_INPUT_NO_OUTPUT, NO_OUTPUT_NO_INPUT: HCI_NO_INPUT_NO_OUTPUT_IO_CAPABILITY,
KEYBOARD_INPUT_ONLY: hci.IoCapability.KEYBOARD_ONLY, KEYBOARD_INPUT_ONLY: HCI_KEYBOARD_ONLY_IO_CAPABILITY,
DISPLAY_OUTPUT_ONLY: hci.IoCapability.DISPLAY_ONLY, DISPLAY_OUTPUT_ONLY: HCI_DISPLAY_ONLY_IO_CAPABILITY,
DISPLAY_OUTPUT_AND_YES_NO_INPUT: hci.IoCapability.DISPLAY_YES_NO, DISPLAY_OUTPUT_AND_YES_NO_INPUT: HCI_DISPLAY_YES_NO_IO_CAPABILITY,
DISPLAY_OUTPUT_AND_KEYBOARD_INPUT: hci.IoCapability.DISPLAY_YES_NO, DISPLAY_OUTPUT_AND_KEYBOARD_INPUT: HCI_DISPLAY_YES_NO_IO_CAPABILITY,
} }
io_capability: IoCapability io_capability: IoCapability
@@ -155,7 +159,7 @@ class PairingDelegate:
# pylint: disable=line-too-long # pylint: disable=line-too-long
return self.CLASSIC_IO_CAPABILITIES_MAP.get( return self.CLASSIC_IO_CAPABILITIES_MAP.get(
self.io_capability, hci.IoCapability.NO_INPUT_NO_OUTPUT self.io_capability, HCI_NO_INPUT_NO_OUTPUT_IO_CAPABILITY
) )
@property @property
@@ -201,7 +205,7 @@ class PairingDelegate:
# [LE only] # [LE only]
async def key_distribution_response( async def key_distribution_response(
self, peer_initiator_key_distribution: int, peer_responder_key_distribution: int self, peer_initiator_key_distribution: int, peer_responder_key_distribution: int
) -> tuple[int, int]: ) -> Tuple[int, int]:
""" """
Return the key distribution response in an SMP protocol context. Return the key distribution response in an SMP protocol context.
@@ -218,22 +222,14 @@ class PairingDelegate:
), ),
) )
async def generate_passkey(self) -> int:
"""
Return a passkey value between 0 and 999999 (inclusive).
"""
# By default, generate a random passkey.
return secrets.randbelow(1000000)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class PairingConfig: class PairingConfig:
"""Configuration for the Pairing protocol.""" """Configuration for the Pairing protocol."""
class AddressType(enum.IntEnum): class AddressType(enum.IntEnum):
PUBLIC = hci.Address.PUBLIC_DEVICE_ADDRESS PUBLIC = Address.PUBLIC_DEVICE_ADDRESS
RANDOM = hci.Address.RANDOM_DEVICE_ADDRESS RANDOM = Address.RANDOM_DEVICE_ADDRESS
@dataclass @dataclass
class OobConfig: class OobConfig:
+9 -10
View File
@@ -19,22 +19,21 @@ This module implement the Pandora Bluetooth test APIs for the Bumble stack.
__version__ = "0.0.1" __version__ = "0.0.1"
from typing import Callable, List, Optional
import grpc import grpc
import grpc.aio import grpc.aio
from pandora.host_grpc_aio import add_HostServicer_to_server
from pandora.l2cap_grpc_aio import add_L2CAPServicer_to_server
from pandora.security_grpc_aio import (
add_SecurityServicer_to_server,
add_SecurityStorageServicer_to_server,
)
from bumble.pandora.config import Config from bumble.pandora.config import Config
from bumble.pandora.device import PandoraDevice from bumble.pandora.device import PandoraDevice
from bumble.pandora.host import HostService from bumble.pandora.host import HostService
from bumble.pandora.l2cap import L2CAPService from bumble.pandora.l2cap import L2CAPService
from bumble.pandora.security import SecurityService, SecurityStorageService from bumble.pandora.security import SecurityService, SecurityStorageService
from pandora.host_grpc_aio import add_HostServicer_to_server
from pandora.l2cap_grpc_aio import add_L2CAPServicer_to_server
from pandora.security_grpc_aio import (
add_SecurityServicer_to_server,
add_SecurityStorageServicer_to_server,
)
from typing import Callable, List, Optional
# public symbols # public symbols
__all__ = [ __all__ = [
@@ -46,11 +45,11 @@ __all__ = [
# Add servicers hooks. # Add servicers hooks.
_SERVICERS_HOOKS: list[Callable[[PandoraDevice, Config, grpc.aio.Server], None]] = [] _SERVICERS_HOOKS: List[Callable[[PandoraDevice, Config, grpc.aio.Server], None]] = []
def register_servicer_hook( def register_servicer_hook(
hook: Callable[[PandoraDevice, Config, grpc.aio.Server], None], hook: Callable[[PandoraDevice, Config, grpc.aio.Server], None]
) -> None: ) -> None:
_SERVICERS_HOOKS.append(hook) _SERVICERS_HOOKS.append(hook)
+3 -5
View File
@@ -13,11 +13,9 @@
# limitations under the License. # limitations under the License.
from __future__ import annotations from __future__ import annotations
from dataclasses import dataclass
from typing import Any
from bumble.pairing import PairingConfig, PairingDelegate from bumble.pairing import PairingConfig, PairingDelegate
from dataclasses import dataclass
from typing import Any, Dict
@dataclass @dataclass
@@ -34,7 +32,7 @@ class Config:
PairingDelegate.DEFAULT_KEY_DISTRIBUTION PairingDelegate.DEFAULT_KEY_DISTRIBUTION
) )
def load_from_dict(self, config: dict[str, Any]) -> None: def load_from_dict(self, config: Dict[str, Any]) -> None:
io_capability_name: str = config.get( io_capability_name: str = config.get(
'io_capability', 'no_output_no_input' 'io_capability', 'no_output_no_input'
).upper() ).upper()
+7 -8
View File
@@ -15,9 +15,6 @@
"""Generic & dependency free Bumble (reference) device.""" """Generic & dependency free Bumble (reference) device."""
from __future__ import annotations from __future__ import annotations
from typing import Any, Optional
from bumble import transport from bumble import transport
from bumble.core import ( from bumble.core import (
BT_GENERIC_AUDIO_SERVICE, BT_GENERIC_AUDIO_SERVICE,
@@ -35,6 +32,8 @@ from bumble.sdp import (
DataElement, DataElement,
ServiceAttribute, ServiceAttribute,
) )
from typing import Any, Dict, List, Optional
# Default rootcanal HCI TCP address # Default rootcanal HCI TCP address
ROOTCANAL_HCI_ADDRESS = "localhost:6402" ROOTCANAL_HCI_ADDRESS = "localhost:6402"
@@ -50,13 +49,13 @@ class PandoraDevice:
# Bumble device instance & configuration. # Bumble device instance & configuration.
device: Device device: Device
config: dict[str, Any] config: Dict[str, Any]
# HCI transport name & instance. # HCI transport name & instance.
_hci_name: str _hci_name: str
_hci: Optional[transport.Transport] # type: ignore[name-defined] _hci: Optional[transport.Transport] # type: ignore[name-defined]
def __init__(self, config: dict[str, Any]) -> None: def __init__(self, config: Dict[str, Any]) -> None:
self.config = config self.config = config
self.device = _make_device(config) self.device = _make_device(config)
self._hci_name = config.get( self._hci_name = config.get(
@@ -96,14 +95,14 @@ class PandoraDevice:
await self.close() await self.close()
await self.open() await self.open()
def info(self) -> Optional[dict[str, str]]: def info(self) -> Optional[Dict[str, str]]:
return { return {
'public_bd_address': str(self.device.public_address), 'public_bd_address': str(self.device.public_address),
'random_address': str(self.device.random_address), 'random_address': str(self.device.random_address),
} }
def _make_device(config: dict[str, Any]) -> Device: def _make_device(config: Dict[str, Any]) -> Device:
"""Initialize an idle Bumble device instance.""" """Initialize an idle Bumble device instance."""
# initialize bumble device. # initialize bumble device.
@@ -118,7 +117,7 @@ def _make_device(config: dict[str, Any]) -> Device:
# TODO(b/267540823): remove when Pandora A2dp is supported # TODO(b/267540823): remove when Pandora A2dp is supported
def _make_sdp_records(rfcomm_channel: int) -> dict[int, list[ServiceAttribute]]: def _make_sdp_records(rfcomm_channel: int) -> Dict[int, List[ServiceAttribute]]:
return { return {
0x00010001: [ 0x00010001: [
ServiceAttribute( ServiceAttribute(
+64 -65
View File
@@ -13,23 +13,51 @@
# limitations under the License. # limitations under the License.
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import logging import bumble.device
import struct
from typing import AsyncGenerator, Optional, cast
import grpc import grpc
import grpc.aio import grpc.aio
import logging
import struct
import bumble.utils
from bumble.pandora import utils
from bumble.pandora.config import Config
from bumble.core import (
PhysicalTransport,
UUID,
AdvertisingData,
Appearance,
ConnectionError,
)
from bumble.device import (
DEVICE_DEFAULT_SCAN_INTERVAL,
DEVICE_DEFAULT_SCAN_WINDOW,
Advertisement,
AdvertisingParameters,
AdvertisingEventProperties,
AdvertisingType,
Device,
)
from bumble.gatt import Service
from bumble.hci import (
HCI_CONNECTION_ALREADY_EXISTS_ERROR,
HCI_PAGE_TIMEOUT_ERROR,
HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR,
Address,
Phy,
Role,
OwnAddressType,
)
from google.protobuf import any_pb2 # pytype: disable=pyi-error from google.protobuf import any_pb2 # pytype: disable=pyi-error
from google.protobuf import empty_pb2 # pytype: disable=pyi-error from google.protobuf import empty_pb2 # pytype: disable=pyi-error
from pandora import host_pb2
from pandora.host_grpc_aio import HostServicer from pandora.host_grpc_aio import HostServicer
from pandora import host_pb2
from pandora.host_pb2 import ( from pandora.host_pb2 import (
DISCOVERABLE_GENERAL,
DISCOVERABLE_LIMITED,
NOT_CONNECTABLE, NOT_CONNECTABLE,
NOT_DISCOVERABLE, NOT_DISCOVERABLE,
DISCOVERABLE_LIMITED,
DISCOVERABLE_GENERAL,
PRIMARY_1M, PRIMARY_1M,
PRIMARY_CODED, PRIMARY_CODED,
SECONDARY_1M, SECONDARY_1M,
@@ -45,6 +73,7 @@ from pandora.host_pb2 import (
ConnectResponse, ConnectResponse,
DataTypes, DataTypes,
DisconnectRequest, DisconnectRequest,
DiscoverabilityMode,
InquiryResponse, InquiryResponse,
PrimaryPhy, PrimaryPhy,
ReadLocalAddressResponse, ReadLocalAddressResponse,
@@ -57,39 +86,9 @@ from pandora.host_pb2 import (
WaitConnectionResponse, WaitConnectionResponse,
WaitDisconnectionRequest, WaitDisconnectionRequest,
) )
from typing import AsyncGenerator, Dict, List, Optional, Set, Tuple, cast
import bumble.device PRIMARY_PHY_MAP: Dict[int, PrimaryPhy] = {
import bumble.utils
from bumble.core import (
UUID,
AdvertisingData,
Appearance,
ConnectionError,
PhysicalTransport,
)
from bumble.device import (
DEVICE_DEFAULT_SCAN_INTERVAL,
DEVICE_DEFAULT_SCAN_WINDOW,
Advertisement,
AdvertisingEventProperties,
AdvertisingParameters,
AdvertisingType,
Device,
)
from bumble.gatt import Service
from bumble.hci import (
HCI_CONNECTION_ALREADY_EXISTS_ERROR,
HCI_PAGE_TIMEOUT_ERROR,
HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR,
Address,
OwnAddressType,
Phy,
Role,
)
from bumble.pandora import utils
from bumble.pandora.config import Config
PRIMARY_PHY_MAP: dict[int, PrimaryPhy] = {
# Default value reported by Bumble for legacy Advertising reports. # Default value reported by Bumble for legacy Advertising reports.
# FIXME(uael): `None` might be a better value, but Bumble need to change accordingly. # FIXME(uael): `None` might be a better value, but Bumble need to change accordingly.
0: PRIMARY_1M, 0: PRIMARY_1M,
@@ -97,26 +96,26 @@ PRIMARY_PHY_MAP: dict[int, PrimaryPhy] = {
3: PRIMARY_CODED, 3: PRIMARY_CODED,
} }
SECONDARY_PHY_MAP: dict[int, SecondaryPhy] = { SECONDARY_PHY_MAP: Dict[int, SecondaryPhy] = {
0: SECONDARY_NONE, 0: SECONDARY_NONE,
1: SECONDARY_1M, 1: SECONDARY_1M,
2: SECONDARY_2M, 2: SECONDARY_2M,
3: SECONDARY_CODED, 3: SECONDARY_CODED,
} }
PRIMARY_PHY_TO_BUMBLE_PHY_MAP: dict[PrimaryPhy, Phy] = { PRIMARY_PHY_TO_BUMBLE_PHY_MAP: Dict[PrimaryPhy, Phy] = {
PRIMARY_1M: Phy.LE_1M, PRIMARY_1M: Phy.LE_1M,
PRIMARY_CODED: Phy.LE_CODED, PRIMARY_CODED: Phy.LE_CODED,
} }
SECONDARY_PHY_TO_BUMBLE_PHY_MAP: dict[SecondaryPhy, Phy] = { SECONDARY_PHY_TO_BUMBLE_PHY_MAP: Dict[SecondaryPhy, Phy] = {
SECONDARY_NONE: Phy.LE_1M, SECONDARY_NONE: Phy.LE_1M,
SECONDARY_1M: Phy.LE_1M, SECONDARY_1M: Phy.LE_1M,
SECONDARY_2M: Phy.LE_2M, SECONDARY_2M: Phy.LE_2M,
SECONDARY_CODED: Phy.LE_CODED, SECONDARY_CODED: Phy.LE_CODED,
} }
OWN_ADDRESS_MAP: dict[host_pb2.OwnAddressType, OwnAddressType] = { OWN_ADDRESS_MAP: Dict[host_pb2.OwnAddressType, OwnAddressType] = {
host_pb2.PUBLIC: OwnAddressType.PUBLIC, host_pb2.PUBLIC: OwnAddressType.PUBLIC,
host_pb2.RANDOM: OwnAddressType.RANDOM, host_pb2.RANDOM: OwnAddressType.RANDOM,
host_pb2.RESOLVABLE_OR_PUBLIC: OwnAddressType.RESOLVABLE_OR_PUBLIC, host_pb2.RESOLVABLE_OR_PUBLIC: OwnAddressType.RESOLVABLE_OR_PUBLIC,
@@ -125,7 +124,7 @@ OWN_ADDRESS_MAP: dict[host_pb2.OwnAddressType, OwnAddressType] = {
class HostService(HostServicer): class HostService(HostServicer):
waited_connections: set[int] waited_connections: Set[int]
def __init__( def __init__(
self, grpc_server: grpc.aio.Server, device: Device, config: Config self, grpc_server: grpc.aio.Server, device: Device, config: Config
@@ -619,7 +618,7 @@ class HostService(HostServicer):
self.log.debug('Inquiry') self.log.debug('Inquiry')
inquiry_queue: asyncio.Queue[ inquiry_queue: asyncio.Queue[
Optional[tuple[Address, int, AdvertisingData, int]] Optional[Tuple[Address, int, AdvertisingData, int]]
] = asyncio.Queue() ] = asyncio.Queue()
complete_handler = self.device.on( complete_handler = self.device.on(
self.device.EVENT_INQUIRY_COMPLETE, lambda: inquiry_queue.put_nowait(None) self.device.EVENT_INQUIRY_COMPLETE, lambda: inquiry_queue.put_nowait(None)
@@ -671,10 +670,10 @@ class HostService(HostServicer):
return empty_pb2.Empty() return empty_pb2.Empty()
def unpack_data_types(self, dt: DataTypes) -> AdvertisingData: def unpack_data_types(self, dt: DataTypes) -> AdvertisingData:
ad_structures: list[tuple[int, bytes]] = [] ad_structures: List[Tuple[int, bytes]] = []
uuids: list[str] uuids: List[str]
datas: dict[str, bytes] datas: Dict[str, bytes]
def uuid128_from_str(uuid: str) -> bytes: def uuid128_from_str(uuid: str) -> bytes:
"""Decode a 128-bit uuid encoded as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX """Decode a 128-bit uuid encoded as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
@@ -888,50 +887,50 @@ class HostService(HostServicer):
def pack_data_types(self, ad: AdvertisingData) -> DataTypes: def pack_data_types(self, ad: AdvertisingData) -> DataTypes:
dt = DataTypes() dt = DataTypes()
uuids: list[UUID] uuids: List[UUID]
s: str s: str
i: int i: int
ij: tuple[int, int] ij: Tuple[int, int]
uuid_data: tuple[UUID, bytes] uuid_data: Tuple[UUID, bytes]
data: bytes data: bytes
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.incomplete_service_class_uuids16.extend( dt.incomplete_service_class_uuids16.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.complete_service_class_uuids16.extend( dt.complete_service_class_uuids16.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.INCOMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.INCOMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.incomplete_service_class_uuids32.extend( dt.incomplete_service_class_uuids32.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.COMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.COMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.complete_service_class_uuids32.extend( dt.complete_service_class_uuids32.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.INCOMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.INCOMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.incomplete_service_class_uuids128.extend( dt.incomplete_service_class_uuids128.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.COMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS), ad.get(AdvertisingData.COMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS),
): ):
dt.complete_service_class_uuids128.extend( dt.complete_service_class_uuids128.extend(
@@ -946,42 +945,42 @@ class HostService(HostServicer):
if i := cast(int, ad.get(AdvertisingData.CLASS_OF_DEVICE)): if i := cast(int, ad.get(AdvertisingData.CLASS_OF_DEVICE)):
dt.class_of_device = i dt.class_of_device = i
if ij := cast( if ij := cast(
tuple[int, int], Tuple[int, int],
ad.get(AdvertisingData.PERIPHERAL_CONNECTION_INTERVAL_RANGE), ad.get(AdvertisingData.PERIPHERAL_CONNECTION_INTERVAL_RANGE),
): ):
dt.peripheral_connection_interval_min = ij[0] dt.peripheral_connection_interval_min = ij[0]
dt.peripheral_connection_interval_max = ij[1] dt.peripheral_connection_interval_max = ij[1]
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.LIST_OF_16_BIT_SERVICE_SOLICITATION_UUIDS), ad.get(AdvertisingData.LIST_OF_16_BIT_SERVICE_SOLICITATION_UUIDS),
): ):
dt.service_solicitation_uuids16.extend( dt.service_solicitation_uuids16.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.LIST_OF_32_BIT_SERVICE_SOLICITATION_UUIDS), ad.get(AdvertisingData.LIST_OF_32_BIT_SERVICE_SOLICITATION_UUIDS),
): ):
dt.service_solicitation_uuids32.extend( dt.service_solicitation_uuids32.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuids := cast( if uuids := cast(
list[UUID], List[UUID],
ad.get(AdvertisingData.LIST_OF_128_BIT_SERVICE_SOLICITATION_UUIDS), ad.get(AdvertisingData.LIST_OF_128_BIT_SERVICE_SOLICITATION_UUIDS),
): ):
dt.service_solicitation_uuids128.extend( dt.service_solicitation_uuids128.extend(
list(map(lambda x: x.to_hex_str('-'), uuids)) list(map(lambda x: x.to_hex_str('-'), uuids))
) )
if uuid_data := cast( if uuid_data := cast(
tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_16_BIT_UUID) Tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_16_BIT_UUID)
): ):
dt.service_data_uuid16[uuid_data[0].to_hex_str('-')] = uuid_data[1] dt.service_data_uuid16[uuid_data[0].to_hex_str('-')] = uuid_data[1]
if uuid_data := cast( if uuid_data := cast(
tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_32_BIT_UUID) Tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_32_BIT_UUID)
): ):
dt.service_data_uuid32[uuid_data[0].to_hex_str('-')] = uuid_data[1] dt.service_data_uuid32[uuid_data[0].to_hex_str('-')] = uuid_data[1]
if uuid_data := cast( if uuid_data := cast(
tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_128_BIT_UUID) Tuple[UUID, bytes], ad.get(AdvertisingData.SERVICE_DATA_128_BIT_UUID)
): ):
dt.service_data_uuid128[uuid_data[0].to_hex_str('-')] = uuid_data[1] dt.service_data_uuid128[uuid_data[0].to_hex_str('-')] = uuid_data[1]
if data := cast(bytes, ad.get(AdvertisingData.PUBLIC_TARGET_ADDRESS, raw=True)): if data := cast(bytes, ad.get(AdvertisingData.PUBLIC_TARGET_ADDRESS, raw=True)):
+22 -23
View File
@@ -12,21 +12,31 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import grpc
import json import json
import logging import logging
from asyncio import Future
from asyncio import Queue as AsyncQueue
from dataclasses import dataclass
from typing import AsyncGenerator, Optional, Union
import grpc from asyncio import Queue as AsyncQueue, Future
from bumble.pandora import utils
from bumble.pandora.config import Config
from bumble.core import OutOfResourcesError, InvalidArgumentError
from bumble.device import Device
from bumble.l2cap import (
ClassicChannel,
ClassicChannelServer,
ClassicChannelSpec,
LeCreditBasedChannel,
LeCreditBasedChannelServer,
LeCreditBasedChannelSpec,
)
from google.protobuf import any_pb2, empty_pb2 # pytype: disable=pyi-error from google.protobuf import any_pb2, empty_pb2 # pytype: disable=pyi-error
from pandora.l2cap_grpc_aio import L2CAPServicer # pytype: disable=pyi-error from pandora.l2cap_grpc_aio import L2CAPServicer # pytype: disable=pyi-error
from pandora.l2cap_pb2 import COMMAND_NOT_UNDERSTOOD, INVALID_CID_IN_REQUEST from pandora.l2cap_pb2 import ( # pytype: disable=pyi-error
from pandora.l2cap_pb2 import Channel as PandoraChannel # pytype: disable=pyi-error COMMAND_NOT_UNDERSTOOD,
from pandora.l2cap_pb2 import ( INVALID_CID_IN_REQUEST,
Channel as PandoraChannel,
ConnectRequest, ConnectRequest,
ConnectResponse, ConnectResponse,
CreditBasedChannelRequest, CreditBasedChannelRequest,
@@ -41,19 +51,8 @@ from pandora.l2cap_pb2 import (
WaitDisconnectionRequest, WaitDisconnectionRequest,
WaitDisconnectionResponse, WaitDisconnectionResponse,
) )
from typing import AsyncGenerator, Dict, Optional, Union
from bumble.core import InvalidArgumentError, OutOfResourcesError from dataclasses import dataclass
from bumble.device import Device
from bumble.l2cap import (
ClassicChannel,
ClassicChannelServer,
ClassicChannelSpec,
LeCreditBasedChannel,
LeCreditBasedChannelServer,
LeCreditBasedChannelSpec,
)
from bumble.pandora import utils
from bumble.pandora.config import Config
L2capChannel = Union[ClassicChannel, LeCreditBasedChannel] L2capChannel = Union[ClassicChannel, LeCreditBasedChannel]
@@ -71,7 +70,7 @@ class L2CAPService(L2CAPServicer):
) )
self.device = device self.device = device
self.config = config self.config = config
self.channels: dict[bytes, ChannelContext] = {} self.channels: Dict[bytes, ChannelContext] = {}
def register_event(self, l2cap_channel: L2capChannel) -> ChannelContext: def register_event(self, l2cap_channel: L2capChannel) -> ChannelContext:
close_future = asyncio.get_running_loop().create_future() close_future = asyncio.get_running_loop().create_future()
+20 -20
View File
@@ -13,14 +13,24 @@
# limitations under the License. # limitations under the License.
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import contextlib import contextlib
import logging
from collections.abc import Awaitable from collections.abc import Awaitable
from typing import Any, AsyncGenerator, AsyncIterator, Callable, Optional, Union
import grpc import grpc
import logging
from bumble.pandora import utils
from bumble.pandora.config import Config
from bumble import hci
from bumble.core import (
PhysicalTransport,
ProtocolError,
InvalidArgumentError,
)
import bumble.utils
from bumble.device import Connection as BumbleConnection, Device
from bumble.hci import HCI_Error, Role
from bumble.pairing import PairingConfig, PairingDelegate as BasePairingDelegate
from google.protobuf import any_pb2 # pytype: disable=pyi-error from google.protobuf import any_pb2 # pytype: disable=pyi-error
from google.protobuf import empty_pb2 # pytype: disable=pyi-error from google.protobuf import empty_pb2 # pytype: disable=pyi-error
from google.protobuf import wrappers_pb2 # pytype: disable=pyi-error from google.protobuf import wrappers_pb2 # pytype: disable=pyi-error
@@ -47,17 +57,7 @@ from pandora.security_pb2 import (
WaitSecurityRequest, WaitSecurityRequest,
WaitSecurityResponse, WaitSecurityResponse,
) )
from typing import Any, AsyncGenerator, AsyncIterator, Callable, Dict, Optional, Union
import bumble.utils
from bumble import hci
from bumble.core import InvalidArgumentError, PhysicalTransport, ProtocolError
from bumble.device import Connection as BumbleConnection
from bumble.device import Device
from bumble.hci import HCI_Error, Role
from bumble.pairing import PairingConfig
from bumble.pairing import PairingDelegate as BasePairingDelegate
from bumble.pandora import utils
from bumble.pandora.config import Config
class PairingDelegate(BasePairingDelegate): class PairingDelegate(BasePairingDelegate):
@@ -244,16 +244,16 @@ class SecurityService(SecurityServicer):
and connection.authenticated and connection.authenticated
and link_key_type and link_key_type
in ( in (
hci.LinkKeyType.AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_192, hci.HCI_AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_192_TYPE,
hci.LinkKeyType.AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_256, hci.HCI_AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_256_TYPE,
) )
) )
if level == LEVEL4: if level == LEVEL4:
return ( return (
connection.encryption == hci.HCI_Encryption_Change_Event.Enabled.AES_CCM connection.encryption == hci.HCI_Encryption_Change_Event.AES_CCM
and connection.authenticated and connection.authenticated
and link_key_type and link_key_type
== hci.LinkKeyType.AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_256 == hci.HCI_AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P_256_TYPE
) )
raise InvalidArgumentError(f"Unexpected level {level}") raise InvalidArgumentError(f"Unexpected level {level}")
@@ -457,7 +457,7 @@ class SecurityService(SecurityServicer):
if self.need_pairing(connection, level): if self.need_pairing(connection, level):
pair_task = asyncio.create_task(connection.pair()) pair_task = asyncio.create_task(connection.pair())
listeners: dict[str, Callable[..., Union[None, Awaitable[None]]]] = { listeners: Dict[str, Callable[..., Union[None, Awaitable[None]]]] = {
'disconnection': set_failure('connection_died'), 'disconnection': set_failure('connection_died'),
'pairing_failure': set_failure('pairing_failure'), 'pairing_failure': set_failure('pairing_failure'),
'connection_authentication_failure': set_failure('authentication_failure'), 'connection_authentication_failure': set_failure('authentication_failure'),
+5 -7
View File
@@ -13,20 +13,18 @@
# limitations under the License. # limitations under the License.
from __future__ import annotations from __future__ import annotations
import contextlib import contextlib
import functools import functools
import grpc
import inspect import inspect
import logging import logging
from typing import Any, Generator, MutableMapping, Optional
import grpc
from google.protobuf.message import Message # pytype: disable=pyi-error
from bumble.device import Device from bumble.device import Device
from bumble.hci import Address, AddressType from bumble.hci import Address, AddressType
from google.protobuf.message import Message # pytype: disable=pyi-error
from typing import Any, Dict, Generator, MutableMapping, Optional, Tuple
ADDRESS_TYPES: dict[str, AddressType] = { ADDRESS_TYPES: Dict[str, AddressType] = {
"public": Address.PUBLIC_DEVICE_ADDRESS, "public": Address.PUBLIC_DEVICE_ADDRESS,
"random": Address.RANDOM_DEVICE_ADDRESS, "random": Address.RANDOM_DEVICE_ADDRESS,
"public_identity": Address.PUBLIC_IDENTITY_ADDRESS, "public_identity": Address.PUBLIC_IDENTITY_ADDRESS,
@@ -45,7 +43,7 @@ class BumbleServerLoggerAdapter(logging.LoggerAdapter): # type: ignore
def process( def process(
self, msg: str, kwargs: MutableMapping[str, Any] self, msg: str, kwargs: MutableMapping[str, Any]
) -> tuple[str, MutableMapping[str, Any]]: ) -> Tuple[str, MutableMapping[str, Any]]:
assert self.extra assert self.extra
service_name = self.extra['service_name'] service_name = self.extra['service_name']
assert isinstance(service_name, str) assert isinstance(service_name, str)
+16 -14
View File
@@ -18,27 +18,26 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import logging import logging
import struct import struct
from dataclasses import dataclass from dataclasses import dataclass
from typing import Optional from typing import Optional
from bumble import utils
from bumble.att import ATT_Error
from bumble.device import Connection from bumble.device import Connection
from bumble.att import ATT_Error
from bumble.gatt import ( from bumble.gatt import (
GATT_AUDIO_INPUT_CONTROL_POINT_CHARACTERISTIC,
GATT_AUDIO_INPUT_CONTROL_SERVICE,
GATT_AUDIO_INPUT_DESCRIPTION_CHARACTERISTIC,
GATT_AUDIO_INPUT_STATE_CHARACTERISTIC,
GATT_AUDIO_INPUT_STATUS_CHARACTERISTIC,
GATT_AUDIO_INPUT_TYPE_CHARACTERISTIC,
GATT_GAIN_SETTINGS_ATTRIBUTE_CHARACTERISTIC,
Attribute, Attribute,
Characteristic, Characteristic,
CharacteristicValue,
TemplateService, TemplateService,
CharacteristicValue,
GATT_AUDIO_INPUT_CONTROL_SERVICE,
GATT_AUDIO_INPUT_STATE_CHARACTERISTIC,
GATT_GAIN_SETTINGS_ATTRIBUTE_CHARACTERISTIC,
GATT_AUDIO_INPUT_TYPE_CHARACTERISTIC,
GATT_AUDIO_INPUT_STATUS_CHARACTERISTIC,
GATT_AUDIO_INPUT_CONTROL_POINT_CHARACTERISTIC,
GATT_AUDIO_INPUT_DESCRIPTION_CHARACTERISTIC,
) )
from bumble.gatt_adapters import ( from bumble.gatt_adapters import (
CharacteristicProxy, CharacteristicProxy,
@@ -49,6 +48,7 @@ from bumble.gatt_adapters import (
UTF8CharacteristicProxyAdapter, UTF8CharacteristicProxyAdapter,
) )
from bumble.gatt_client import ProfileServiceProxy, ServiceProxy from bumble.gatt_client import ProfileServiceProxy, ServiceProxy
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -198,7 +198,8 @@ class AudioInputControlPoint:
audio_input_state: AudioInputState audio_input_state: AudioInputState
gain_settings_properties: GainSettingsProperties gain_settings_properties: GainSettingsProperties
async def on_write(self, connection: Connection, value: bytes) -> None: async def on_write(self, connection: Optional[Connection], value: bytes) -> None:
assert connection
opcode = AudioInputControlPointOpCode(value[0]) opcode = AudioInputControlPointOpCode(value[0])
@@ -319,10 +320,11 @@ class AudioInputDescription:
audio_input_description: str = "Bluetooth" audio_input_description: str = "Bluetooth"
attribute: Optional[Attribute] = None attribute: Optional[Attribute] = None
def on_read(self, _connection: Connection) -> str: def on_read(self, _connection: Optional[Connection]) -> str:
return self.audio_input_description return self.audio_input_description
async def on_write(self, connection: Connection, value: str) -> None: async def on_write(self, connection: Optional[Connection], value: str) -> None:
assert connection
assert self.attribute assert self.attribute
self.audio_input_description = value self.audio_input_description = value
-403
View File
@@ -1,403 +0,0 @@
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Apple Media Service (AMS).
"""
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from __future__ import annotations
import asyncio
import dataclasses
import enum
import logging
from typing import Iterable, Optional, Union
from bumble import utils
from bumble.device import Peer
from bumble.gatt import (
GATT_AMS_ENTITY_ATTRIBUTE_CHARACTERISTIC,
GATT_AMS_ENTITY_UPDATE_CHARACTERISTIC,
GATT_AMS_REMOTE_COMMAND_CHARACTERISTIC,
GATT_AMS_SERVICE,
Characteristic,
TemplateService,
)
from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy
# -----------------------------------------------------------------------------
# Logging
# -----------------------------------------------------------------------------
logger = logging.getLogger(__name__)
# -----------------------------------------------------------------------------
# Protocol
# -----------------------------------------------------------------------------
class RemoteCommandId(utils.OpenIntEnum):
PLAY = 0
PAUSE = 1
TOGGLE_PLAY_PAUSE = 2
NEXT_TRACK = 3
PREVIOUS_TRACK = 4
VOLUME_UP = 5
VOLUME_DOWN = 6
ADVANCE_REPEAT_MODE = 7
ADVANCE_SHUFFLE_MODE = 8
SKIP_FORWARD = 9
SKIP_BACKWARD = 10
LIKE_TRACK = 11
DISLIKE_TRACK = 12
BOOKMARK_TRACK = 13
class EntityId(utils.OpenIntEnum):
PLAYER = 0
QUEUE = 1
TRACK = 2
class ActionId(utils.OpenIntEnum):
POSITIVE = 0
NEGATIVE = 1
class EntityUpdateFlags(enum.IntFlag):
TRUNCATED = 1
class PlayerAttributeId(utils.OpenIntEnum):
NAME = 0
PLAYBACK_INFO = 1
VOLUME = 2
class QueueAttributeId(utils.OpenIntEnum):
INDEX = 0
COUNT = 1
SHUFFLE_MODE = 2
REPEAT_MODE = 3
class ShuffleMode(utils.OpenIntEnum):
OFF = 0
ONE = 1
ALL = 2
class RepeatMode(utils.OpenIntEnum):
OFF = 0
ONE = 1
ALL = 2
class TrackAttributeId(utils.OpenIntEnum):
ARTIST = 0
ALBUM = 1
TITLE = 2
DURATION = 3
class PlaybackState(utils.OpenIntEnum):
PAUSED = 0
PLAYING = 1
REWINDING = 2
FAST_FORWARDING = 3
@dataclasses.dataclass
class PlaybackInfo:
playback_state: PlaybackState = PlaybackState.PAUSED
playback_rate: float = 1.0
elapsed_time: float = 0.0
# -----------------------------------------------------------------------------
# GATT Server-side
# -----------------------------------------------------------------------------
class Ams(TemplateService):
UUID = GATT_AMS_SERVICE
remote_command_characteristic: Characteristic
entity_update_characteristic: Characteristic
entity_attribute_characteristic: Characteristic
def __init__(self) -> None:
# TODO not the final implementation
self.remote_command_characteristic = Characteristic(
GATT_AMS_REMOTE_COMMAND_CHARACTERISTIC,
Characteristic.Properties.NOTIFY
| Characteristic.Properties.WRITE_WITHOUT_RESPONSE,
Characteristic.Permissions.WRITEABLE,
)
# TODO not the final implementation
self.entity_update_characteristic = Characteristic(
GATT_AMS_ENTITY_UPDATE_CHARACTERISTIC,
Characteristic.Properties.NOTIFY | Characteristic.Properties.WRITE,
Characteristic.Permissions.WRITEABLE,
)
# TODO not the final implementation
self.entity_attribute_characteristic = Characteristic(
GATT_AMS_ENTITY_ATTRIBUTE_CHARACTERISTIC,
Characteristic.Properties.READ
| Characteristic.Properties.WRITE_WITHOUT_RESPONSE,
Characteristic.Permissions.WRITEABLE | Characteristic.Permissions.READABLE,
)
super().__init__(
[
self.remote_command_characteristic,
self.entity_update_characteristic,
self.entity_attribute_characteristic,
]
)
# -----------------------------------------------------------------------------
# GATT Client-side
# -----------------------------------------------------------------------------
class AmsProxy(ProfileServiceProxy):
SERVICE_CLASS = Ams
# NOTE: these don't use adapters, because the format for write and notifications
# are different.
remote_command: CharacteristicProxy[bytes]
entity_update: CharacteristicProxy[bytes]
entity_attribute: CharacteristicProxy[bytes]
def __init__(self, service_proxy: ServiceProxy):
self.remote_command = service_proxy.get_required_characteristic_by_uuid(
GATT_AMS_REMOTE_COMMAND_CHARACTERISTIC
)
self.entity_update = service_proxy.get_required_characteristic_by_uuid(
GATT_AMS_ENTITY_UPDATE_CHARACTERISTIC
)
self.entity_attribute = service_proxy.get_required_characteristic_by_uuid(
GATT_AMS_ENTITY_ATTRIBUTE_CHARACTERISTIC
)
class AmsClient(utils.EventEmitter):
EVENT_SUPPORTED_COMMANDS = "supported_commands"
EVENT_PLAYER_NAME = "player_name"
EVENT_PLAYER_PLAYBACK_INFO = "player_playback_info"
EVENT_PLAYER_VOLUME = "player_volume"
EVENT_QUEUE_COUNT = "queue_count"
EVENT_QUEUE_INDEX = "queue_index"
EVENT_QUEUE_SHUFFLE_MODE = "queue_shuffle_mode"
EVENT_QUEUE_REPEAT_MODE = "queue_repeat_mode"
EVENT_TRACK_ARTIST = "track_artist"
EVENT_TRACK_ALBUM = "track_album"
EVENT_TRACK_TITLE = "track_title"
EVENT_TRACK_DURATION = "track_duration"
supported_commands: set[RemoteCommandId]
player_name: str = ""
player_playback_info: PlaybackInfo = PlaybackInfo(PlaybackState.PAUSED, 0.0, 0.0)
player_volume: float = 1.0
queue_count: int = 0
queue_index: int = 0
queue_shuffle_mode: ShuffleMode = ShuffleMode.OFF
queue_repeat_mode: RepeatMode = RepeatMode.OFF
track_artist: str = ""
track_album: str = ""
track_title: str = ""
track_duration: float = 0.0
def __init__(self, ams_proxy: AmsProxy) -> None:
super().__init__()
self._ams_proxy = ams_proxy
self._started = False
self._read_attribute_semaphore = asyncio.Semaphore()
self.supported_commands = set()
@classmethod
async def for_peer(cls, peer: Peer) -> Optional[AmsClient]:
ams_proxy = await peer.discover_service_and_create_proxy(AmsProxy)
if ams_proxy is None:
return None
return cls(ams_proxy)
async def start(self) -> None:
logger.debug("subscribing to remote command characteristic")
await self._ams_proxy.remote_command.subscribe(
self._on_remote_command_notification
)
logger.debug("subscribing to entity update characteristic")
await self._ams_proxy.entity_update.subscribe(
lambda data: utils.AsyncRunner.spawn(
self._on_entity_update_notification(data)
)
)
self._started = True
async def stop(self) -> None:
await self._ams_proxy.remote_command.unsubscribe(
self._on_remote_command_notification
)
await self._ams_proxy.entity_update.unsubscribe(
self._on_entity_update_notification
)
self._started = False
async def observe(
self,
entity: EntityId,
attributes: Iterable[
Union[PlayerAttributeId, QueueAttributeId, TrackAttributeId]
],
) -> None:
await self._ams_proxy.entity_update.write_value(
bytes([entity] + list(attributes)), with_response=True
)
async def command(self, command: RemoteCommandId) -> None:
await self._ams_proxy.remote_command.write_value(
bytes([command]), with_response=True
)
async def play(self) -> None:
await self.command(RemoteCommandId.PLAY)
async def pause(self) -> None:
await self.command(RemoteCommandId.PAUSE)
async def toggle_play_pause(self) -> None:
await self.command(RemoteCommandId.TOGGLE_PLAY_PAUSE)
async def next_track(self) -> None:
await self.command(RemoteCommandId.NEXT_TRACK)
async def previous_track(self) -> None:
await self.command(RemoteCommandId.PREVIOUS_TRACK)
async def volume_up(self) -> None:
await self.command(RemoteCommandId.VOLUME_UP)
async def volume_down(self) -> None:
await self.command(RemoteCommandId.VOLUME_DOWN)
async def advance_repeat_mode(self) -> None:
await self.command(RemoteCommandId.ADVANCE_REPEAT_MODE)
async def advance_shuffle_mode(self) -> None:
await self.command(RemoteCommandId.ADVANCE_SHUFFLE_MODE)
async def skip_forward(self) -> None:
await self.command(RemoteCommandId.SKIP_FORWARD)
async def skip_backward(self) -> None:
await self.command(RemoteCommandId.SKIP_BACKWARD)
async def like_track(self) -> None:
await self.command(RemoteCommandId.LIKE_TRACK)
async def dislike_track(self) -> None:
await self.command(RemoteCommandId.DISLIKE_TRACK)
async def bookmark_track(self) -> None:
await self.command(RemoteCommandId.BOOKMARK_TRACK)
def _on_remote_command_notification(self, data: bytes) -> None:
supported_commands = [RemoteCommandId(command) for command in data]
logger.debug(
f"supported commands: {[command.name for command in supported_commands]}"
)
for command in supported_commands:
self.supported_commands.add(command)
self.emit(self.EVENT_SUPPORTED_COMMANDS)
async def _on_entity_update_notification(self, data: bytes) -> None:
entity = EntityId(data[0])
flags = EntityUpdateFlags(data[2])
value = data[3:]
if flags & EntityUpdateFlags.TRUNCATED:
logger.debug("truncated attribute, fetching full value")
# Write the entity and attribute we're interested in
# (protected by a semaphore, so that we only read one attribute at a time)
async with self._read_attribute_semaphore:
await self._ams_proxy.entity_attribute.write_value(
data[:2], with_response=True
)
value = await self._ams_proxy.entity_attribute.read_value()
if entity == EntityId.PLAYER:
player_attribute = PlayerAttributeId(data[1])
if player_attribute == PlayerAttributeId.NAME:
self.player_name = value.decode()
self.emit(self.EVENT_PLAYER_NAME)
elif player_attribute == PlayerAttributeId.PLAYBACK_INFO:
playback_state_str, playback_rate_str, elapsed_time_str = (
value.decode().split(",")
)
self.player_playback_info = PlaybackInfo(
PlaybackState(int(playback_state_str)),
float(playback_rate_str),
float(elapsed_time_str),
)
self.emit(self.EVENT_PLAYER_PLAYBACK_INFO)
elif player_attribute == PlayerAttributeId.VOLUME:
self.player_volume = float(value.decode())
self.emit(self.EVENT_PLAYER_VOLUME)
else:
logger.warning(f"received unknown player attribute {player_attribute}")
elif entity == EntityId.QUEUE:
queue_attribute = QueueAttributeId(data[1])
if queue_attribute == QueueAttributeId.COUNT:
self.queue_count = int(value)
self.emit(self.EVENT_QUEUE_COUNT)
elif queue_attribute == QueueAttributeId.INDEX:
self.queue_index = int(value)
self.emit(self.EVENT_QUEUE_INDEX)
elif queue_attribute == QueueAttributeId.REPEAT_MODE:
self.queue_repeat_mode = RepeatMode(int(value))
self.emit(self.EVENT_QUEUE_REPEAT_MODE)
elif queue_attribute == QueueAttributeId.SHUFFLE_MODE:
self.queue_shuffle_mode = ShuffleMode(int(value))
self.emit(self.EVENT_QUEUE_SHUFFLE_MODE)
else:
logger.warning(f"received unknown queue attribute {queue_attribute}")
elif entity == EntityId.TRACK:
track_attribute = TrackAttributeId(data[1])
if track_attribute == TrackAttributeId.ARTIST:
self.track_artist = value.decode()
self.emit(self.EVENT_TRACK_ARTIST)
elif track_attribute == TrackAttributeId.ALBUM:
self.track_album = value.decode()
self.emit(self.EVENT_TRACK_ALBUM)
elif track_attribute == TrackAttributeId.TITLE:
self.track_title = value.decode()
self.emit(self.EVENT_TRACK_TITLE)
elif track_attribute == TrackAttributeId.DURATION:
self.track_duration = float(value.decode())
self.emit(self.EVENT_TRACK_DURATION)
else:
logger.warning(f"received unknown track attribute {track_attribute}")
else:
logger.warning(f"received unknown attribute ID {data[1]}")
+7 -6
View File
@@ -20,7 +20,6 @@ Apple Notification Center Service (ANCS).
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import dataclasses import dataclasses
import datetime import datetime
@@ -29,19 +28,21 @@ import logging
import struct import struct
from typing import Optional, Sequence, Union from typing import Optional, Sequence, Union
from bumble import utils
from bumble.att import ATT_Error from bumble.att import ATT_Error
from bumble.device import Peer from bumble.device import Peer
from bumble.gatt import ( from bumble.gatt import (
Characteristic,
GATT_ANCS_SERVICE,
GATT_ANCS_NOTIFICATION_SOURCE_CHARACTERISTIC,
GATT_ANCS_CONTROL_POINT_CHARACTERISTIC, GATT_ANCS_CONTROL_POINT_CHARACTERISTIC,
GATT_ANCS_DATA_SOURCE_CHARACTERISTIC, GATT_ANCS_DATA_SOURCE_CHARACTERISTIC,
GATT_ANCS_NOTIFICATION_SOURCE_CHARACTERISTIC,
GATT_ANCS_SERVICE,
Characteristic,
TemplateService, TemplateService,
) )
from bumble.gatt_adapters import SerializableCharacteristicProxyAdapter
from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy
from bumble.gatt_adapters import SerializableCharacteristicProxyAdapter
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
+135 -141
View File
@@ -19,16 +19,18 @@
from __future__ import annotations from __future__ import annotations
import enum import enum
import functools
import logging import logging
import struct import struct
from collections.abc import Sequence from typing import Any, Dict, List, Optional, Sequence, Tuple, Type, Union
from dataclasses import dataclass, field
from typing import Any, Optional, TypeVar, Union
from bumble import colors, device, gatt, gatt_client, hci, utils from bumble import utils
from bumble.profiles import le_audio from bumble import colors
from bumble.profiles.bap import CodecSpecificConfiguration from bumble.profiles.bap import CodecSpecificConfiguration
from bumble.profiles import le_audio
from bumble import device
from bumble import gatt
from bumble import gatt_client
from bumble import hci
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -46,11 +48,11 @@ class ASE_Operation:
See Audio Stream Control Service - 5 ASE Control operations. See Audio Stream Control Service - 5 ASE Control operations.
''' '''
classes: dict[int, type[ASE_Operation]] = {} classes: Dict[int, Type[ASE_Operation]] = {}
op_code: Opcode op_code: int
name: str name: str
fields: Optional[Sequence[Any]] = None fields: Optional[Sequence[Any]] = None
ase_id: Sequence[int] ase_id: List[int]
class Opcode(enum.IntEnum): class Opcode(enum.IntEnum):
# fmt: off # fmt: off
@@ -63,30 +65,51 @@ class ASE_Operation:
UPDATE_METADATA = 0x07 UPDATE_METADATA = 0x07
RELEASE = 0x08 RELEASE = 0x08
@classmethod @staticmethod
def from_bytes(cls, pdu: bytes) -> ASE_Operation: def from_bytes(pdu: bytes) -> ASE_Operation:
op_code = pdu[0] op_code = pdu[0]
clazz = ASE_Operation.classes[op_code] cls = ASE_Operation.classes.get(op_code)
return clazz( if cls is None:
**hci.HCI_Object.dict_from_bytes(pdu, offset=1, fields=clazz.fields) instance = ASE_Operation(pdu)
) instance.name = ASE_Operation.Opcode(op_code).name
instance.op_code = op_code
return instance
self = cls.__new__(cls)
ASE_Operation.__init__(self, pdu)
if self.fields is not None:
self.init_from_bytes(pdu, 1)
return self
_OP = TypeVar("_OP", bound="ASE_Operation") @staticmethod
def subclass(fields):
def inner(cls: Type[ASE_Operation]):
try:
operation = ASE_Operation.Opcode[cls.__name__[4:].upper()]
cls.name = operation.name
cls.op_code = operation
except:
raise KeyError(f'PDU name {cls.name} not found in Ase_Operation.Opcode')
cls.fields = fields
@classmethod # Register a factory for this class
def subclass(cls, clazz: type[_OP]) -> type[_OP]: ASE_Operation.classes[cls.op_code] = cls
clazz.name = f"ASE_{clazz.op_code.name.upper()}"
clazz.fields = hci.HCI_Object.fields_from_dataclass(clazz)
# Register a factory for this class
ASE_Operation.classes[clazz.op_code] = clazz
return clazz
@functools.cached_property return cls
def pdu(self) -> bytes:
return bytes([self.op_code]) + hci.HCI_Object.dict_to_bytes( return inner
self.__dict__, self.fields
) def __init__(self, pdu: Optional[bytes] = None, **kwargs) -> None:
if self.fields is not None and kwargs:
hci.HCI_Object.init_from_fields(self, self.fields, kwargs)
if pdu is None:
pdu = bytes([self.op_code]) + hci.HCI_Object.dict_to_bytes(
kwargs, self.fields
)
self.pdu = pdu
def init_from_bytes(self, pdu: bytes, offset: int):
return hci.HCI_Object.init_from_bytes(self, pdu, offset, self.fields)
def __bytes__(self) -> bytes: def __bytes__(self) -> bytes:
return self.pdu return self.pdu
@@ -101,128 +124,105 @@ class ASE_Operation:
return result return result
@ASE_Operation.subclass @ASE_Operation.subclass(
@dataclass [
[
('ase_id', 1),
('target_latency', 1),
('target_phy', 1),
('codec_id', hci.CodingFormat.parse_from_bytes),
('codec_specific_configuration', 'v'),
],
]
)
class ASE_Config_Codec(ASE_Operation): class ASE_Config_Codec(ASE_Operation):
''' '''
See Audio Stream Control Service 5.1 - Config Codec Operation See Audio Stream Control Service 5.1 - Config Codec Operation
''' '''
op_code = ASE_Operation.Opcode.CONFIG_CODEC target_latency: List[int]
target_phy: List[int]
ase_id: Sequence[int] = field(metadata=hci.metadata(1, list_begin=True)) codec_id: List[hci.CodingFormat]
target_latency: Sequence[int] = field(metadata=hci.metadata(1)) codec_specific_configuration: List[bytes]
target_phy: Sequence[int] = field(metadata=hci.metadata(1))
codec_id: Sequence[hci.CodingFormat] = field(
metadata=hci.metadata(hci.CodingFormat.parse_from_bytes)
)
codec_specific_configuration: Sequence[bytes] = field(
metadata=hci.metadata('v', list_end=True)
)
@ASE_Operation.subclass @ASE_Operation.subclass(
@dataclass [
[
('ase_id', 1),
('cig_id', 1),
('cis_id', 1),
('sdu_interval', 3),
('framing', 1),
('phy', 1),
('max_sdu', 2),
('retransmission_number', 1),
('max_transport_latency', 2),
('presentation_delay', 3),
],
]
)
class ASE_Config_QOS(ASE_Operation): class ASE_Config_QOS(ASE_Operation):
''' '''
See Audio Stream Control Service 5.2 - Config Qos Operation See Audio Stream Control Service 5.2 - Config Qos Operation
''' '''
op_code = ASE_Operation.Opcode.CONFIG_QOS cig_id: List[int]
cis_id: List[int]
ase_id: Sequence[int] = field(metadata=hci.metadata(1, list_begin=True)) sdu_interval: List[int]
cig_id: Sequence[int] = field(metadata=hci.metadata(1)) framing: List[int]
cis_id: Sequence[int] = field(metadata=hci.metadata(1)) phy: List[int]
sdu_interval: Sequence[int] = field(metadata=hci.metadata(3)) max_sdu: List[int]
framing: Sequence[int] = field(metadata=hci.metadata(1)) retransmission_number: List[int]
phy: Sequence[int] = field(metadata=hci.metadata(1)) max_transport_latency: List[int]
max_sdu: Sequence[int] = field(metadata=hci.metadata(2)) presentation_delay: List[int]
retransmission_number: Sequence[int] = field(metadata=hci.metadata(1))
max_transport_latency: Sequence[int] = field(metadata=hci.metadata(2))
presentation_delay: Sequence[int] = field(metadata=hci.metadata(3, list_end=True))
@ASE_Operation.subclass @ASE_Operation.subclass([[('ase_id', 1), ('metadata', 'v')]])
@dataclass
class ASE_Enable(ASE_Operation): class ASE_Enable(ASE_Operation):
''' '''
See Audio Stream Control Service 5.3 - Enable Operation See Audio Stream Control Service 5.3 - Enable Operation
''' '''
op_code = ASE_Operation.Opcode.ENABLE metadata: bytes
ase_id: Sequence[int] = field(metadata=hci.metadata(1, list_begin=True))
metadata: Sequence[bytes] = field(metadata=hci.metadata('v', list_end=True))
@ASE_Operation.subclass @ASE_Operation.subclass([[('ase_id', 1)]])
@dataclass
class ASE_Receiver_Start_Ready(ASE_Operation): class ASE_Receiver_Start_Ready(ASE_Operation):
''' '''
See Audio Stream Control Service 5.4 - Receiver Start Ready Operation See Audio Stream Control Service 5.4 - Receiver Start Ready Operation
''' '''
op_code = ASE_Operation.Opcode.RECEIVER_START_READY
ase_id: Sequence[int] = field( @ASE_Operation.subclass([[('ase_id', 1)]])
metadata=hci.metadata(1, list_begin=True, list_end=True)
)
@ASE_Operation.subclass
@dataclass
class ASE_Disable(ASE_Operation): class ASE_Disable(ASE_Operation):
''' '''
See Audio Stream Control Service 5.5 - Disable Operation See Audio Stream Control Service 5.5 - Disable Operation
''' '''
op_code = ASE_Operation.Opcode.DISABLE
ase_id: Sequence[int] = field( @ASE_Operation.subclass([[('ase_id', 1)]])
metadata=hci.metadata(1, list_begin=True, list_end=True)
)
@ASE_Operation.subclass
@dataclass
class ASE_Receiver_Stop_Ready(ASE_Operation): class ASE_Receiver_Stop_Ready(ASE_Operation):
''' '''
See Audio Stream Control Service 5.6 - Receiver Stop Ready Operation See Audio Stream Control Service 5.6 - Receiver Stop Ready Operation
''' '''
op_code = ASE_Operation.Opcode.RECEIVER_STOP_READY
ase_id: Sequence[int] = field( @ASE_Operation.subclass([[('ase_id', 1), ('metadata', 'v')]])
metadata=hci.metadata(1, list_begin=True, list_end=True)
)
@ASE_Operation.subclass
@dataclass
class ASE_Update_Metadata(ASE_Operation): class ASE_Update_Metadata(ASE_Operation):
''' '''
See Audio Stream Control Service 5.7 - Update Metadata Operation See Audio Stream Control Service 5.7 - Update Metadata Operation
''' '''
op_code = ASE_Operation.Opcode.UPDATE_METADATA metadata: List[bytes]
ase_id: Sequence[int] = field(metadata=hci.metadata(1, list_begin=True))
metadata: Sequence[bytes] = field(metadata=hci.metadata('v', list_end=True))
@ASE_Operation.subclass @ASE_Operation.subclass([[('ase_id', 1)]])
@dataclass
class ASE_Release(ASE_Operation): class ASE_Release(ASE_Operation):
''' '''
See Audio Stream Control Service 5.8 - Release Operation See Audio Stream Control Service 5.8 - Release Operation
''' '''
op_code = ASE_Operation.Opcode.RELEASE
ase_id: Sequence[int] = field(
metadata=hci.metadata(1, list_begin=True, list_end=True)
)
class AseResponseCode(enum.IntEnum): class AseResponseCode(enum.IntEnum):
# fmt: off # fmt: off
@@ -338,16 +338,22 @@ class AseStateMachine(gatt.Characteristic):
self.service.device.EVENT_CIS_ESTABLISHMENT, self.on_cis_establishment self.service.device.EVENT_CIS_ESTABLISHMENT, self.on_cis_establishment
) )
def on_cis_request(self, cis_link: device.CisLink) -> None: def on_cis_request(
self,
acl_connection: device.Connection,
cis_handle: int,
cig_id: int,
cis_id: int,
) -> None:
if ( if (
cis_link.cig_id == self.cig_id cig_id == self.cig_id
and cis_link.cis_id == self.cis_id and cis_id == self.cis_id
and self.state == self.State.ENABLING and self.state == self.State.ENABLING
): ):
utils.cancel_on_event( utils.cancel_on_event(
cis_link.acl_connection, acl_connection,
'flush', 'flush',
self.service.device.accept_cis_request(cis_link), self.service.device.accept_cis_request(cis_handle),
) )
def on_cis_establishment(self, cis_link: device.CisLink) -> None: def on_cis_establishment(self, cis_link: device.CisLink) -> None:
@@ -378,7 +384,7 @@ class AseStateMachine(gatt.Characteristic):
target_phy: int, target_phy: int,
codec_id: hci.CodingFormat, codec_id: hci.CodingFormat,
codec_specific_configuration: bytes, codec_specific_configuration: bytes,
) -> tuple[AseResponseCode, AseReasonCode]: ) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state not in ( if self.state not in (
self.State.IDLE, self.State.IDLE,
self.State.CODEC_CONFIGURED, self.State.CODEC_CONFIGURED,
@@ -414,7 +420,7 @@ class AseStateMachine(gatt.Characteristic):
retransmission_number: int, retransmission_number: int,
max_transport_latency: int, max_transport_latency: int,
presentation_delay: int, presentation_delay: int,
) -> tuple[AseResponseCode, AseReasonCode]: ) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state not in ( if self.state not in (
AseStateMachine.State.CODEC_CONFIGURED, AseStateMachine.State.CODEC_CONFIGURED,
AseStateMachine.State.QOS_CONFIGURED, AseStateMachine.State.QOS_CONFIGURED,
@@ -438,7 +444,7 @@ class AseStateMachine(gatt.Characteristic):
return (AseResponseCode.SUCCESS, AseReasonCode.NONE) return (AseResponseCode.SUCCESS, AseReasonCode.NONE)
def on_enable(self, metadata: bytes) -> tuple[AseResponseCode, AseReasonCode]: def on_enable(self, metadata: bytes) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state != AseStateMachine.State.QOS_CONFIGURED: if self.state != AseStateMachine.State.QOS_CONFIGURED:
return ( return (
AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION, AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION,
@@ -447,20 +453,10 @@ class AseStateMachine(gatt.Characteristic):
self.metadata = le_audio.Metadata.from_bytes(metadata) self.metadata = le_audio.Metadata.from_bytes(metadata)
self.state = self.State.ENABLING self.state = self.State.ENABLING
# CIS could be established before enable.
if cis_link := next(
(
cis_link
for cis_link in self.service.device.cis_links.values()
if cis_link.cig_id == self.cig_id and cis_link.cis_id == self.cis_id
),
None,
):
self.on_cis_establishment(cis_link)
return (AseResponseCode.SUCCESS, AseReasonCode.NONE) return (AseResponseCode.SUCCESS, AseReasonCode.NONE)
def on_receiver_start_ready(self) -> tuple[AseResponseCode, AseReasonCode]: def on_receiver_start_ready(self) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state != AseStateMachine.State.ENABLING: if self.state != AseStateMachine.State.ENABLING:
return ( return (
AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION, AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION,
@@ -469,7 +465,7 @@ class AseStateMachine(gatt.Characteristic):
self.state = self.State.STREAMING self.state = self.State.STREAMING
return (AseResponseCode.SUCCESS, AseReasonCode.NONE) return (AseResponseCode.SUCCESS, AseReasonCode.NONE)
def on_disable(self) -> tuple[AseResponseCode, AseReasonCode]: def on_disable(self) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state not in ( if self.state not in (
AseStateMachine.State.ENABLING, AseStateMachine.State.ENABLING,
AseStateMachine.State.STREAMING, AseStateMachine.State.STREAMING,
@@ -484,7 +480,7 @@ class AseStateMachine(gatt.Characteristic):
self.state = self.State.DISABLING self.state = self.State.DISABLING
return (AseResponseCode.SUCCESS, AseReasonCode.NONE) return (AseResponseCode.SUCCESS, AseReasonCode.NONE)
def on_receiver_stop_ready(self) -> tuple[AseResponseCode, AseReasonCode]: def on_receiver_stop_ready(self) -> Tuple[AseResponseCode, AseReasonCode]:
if ( if (
self.role != AudioRole.SOURCE self.role != AudioRole.SOURCE
or self.state != AseStateMachine.State.DISABLING or self.state != AseStateMachine.State.DISABLING
@@ -498,7 +494,7 @@ class AseStateMachine(gatt.Characteristic):
def on_update_metadata( def on_update_metadata(
self, metadata: bytes self, metadata: bytes
) -> tuple[AseResponseCode, AseReasonCode]: ) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state not in ( if self.state not in (
AseStateMachine.State.ENABLING, AseStateMachine.State.ENABLING,
AseStateMachine.State.STREAMING, AseStateMachine.State.STREAMING,
@@ -510,7 +506,7 @@ class AseStateMachine(gatt.Characteristic):
self.metadata = le_audio.Metadata.from_bytes(metadata) self.metadata = le_audio.Metadata.from_bytes(metadata)
return (AseResponseCode.SUCCESS, AseReasonCode.NONE) return (AseResponseCode.SUCCESS, AseReasonCode.NONE)
def on_release(self) -> tuple[AseResponseCode, AseReasonCode]: def on_release(self) -> Tuple[AseResponseCode, AseReasonCode]:
if self.state == AseStateMachine.State.IDLE: if self.state == AseStateMachine.State.IDLE:
return ( return (
AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION, AseResponseCode.INVALID_ASE_STATE_MACHINE_TRANSITION,
@@ -520,7 +516,7 @@ class AseStateMachine(gatt.Characteristic):
async def remove_cis_async(): async def remove_cis_async():
if self.cis_link: if self.cis_link:
await self.cis_link.remove_data_path([self.role]) await self.cis_link.remove_data_path(self.role)
self.state = self.State.IDLE self.state = self.State.IDLE
await self.service.device.notify_subscribers(self, self.value) await self.service.device.notify_subscribers(self, self.value)
@@ -594,7 +590,7 @@ class AseStateMachine(gatt.Characteristic):
# Readonly. Do nothing in the setter. # Readonly. Do nothing in the setter.
pass pass
def on_read(self, _: device.Connection) -> bytes: def on_read(self, _: Optional[device.Connection]) -> bytes:
return self.value return self.value
def __str__(self) -> str: def __str__(self) -> str:
@@ -608,7 +604,7 @@ class AseStateMachine(gatt.Characteristic):
class AudioStreamControlService(gatt.TemplateService): class AudioStreamControlService(gatt.TemplateService):
UUID = gatt.GATT_AUDIO_STREAM_CONTROL_SERVICE UUID = gatt.GATT_AUDIO_STREAM_CONTROL_SERVICE
ase_state_machines: dict[int, AseStateMachine] ase_state_machines: Dict[int, AseStateMachine]
ase_control_point: gatt.Characteristic[bytes] ase_control_point: gatt.Characteristic[bytes]
_active_client: Optional[device.Connection] = None _active_client: Optional[device.Connection] = None
@@ -653,9 +649,7 @@ class AudioStreamControlService(gatt.TemplateService):
ase.state = AseStateMachine.State.IDLE ase.state = AseStateMachine.State.IDLE
self._active_client = None self._active_client = None
def on_write_ase_control_point( def on_write_ase_control_point(self, connection, data):
self, connection: device.Connection, data: bytes
) -> None:
if not self._active_client and connection: if not self._active_client and connection:
self._active_client = connection self._active_client = connection
connection.once('disconnection', self._on_client_disconnected) connection.once('disconnection', self._on_client_disconnected)
@@ -664,7 +658,7 @@ class AudioStreamControlService(gatt.TemplateService):
responses = [] responses = []
logger.debug(f'*** ASCS Write {operation} ***') logger.debug(f'*** ASCS Write {operation} ***')
if isinstance(operation, ASE_Config_Codec): if operation.op_code == ASE_Operation.Opcode.CONFIG_CODEC:
for ase_id, *args in zip( for ase_id, *args in zip(
operation.ase_id, operation.ase_id,
operation.target_latency, operation.target_latency,
@@ -673,7 +667,7 @@ class AudioStreamControlService(gatt.TemplateService):
operation.codec_specific_configuration, operation.codec_specific_configuration,
): ):
responses.append(self.on_operation(operation.op_code, ase_id, args)) responses.append(self.on_operation(operation.op_code, ase_id, args))
elif isinstance(operation, ASE_Config_QOS): elif operation.op_code == ASE_Operation.Opcode.CONFIG_QOS:
for ase_id, *args in zip( for ase_id, *args in zip(
operation.ase_id, operation.ase_id,
operation.cig_id, operation.cig_id,
@@ -687,20 +681,20 @@ class AudioStreamControlService(gatt.TemplateService):
operation.presentation_delay, operation.presentation_delay,
): ):
responses.append(self.on_operation(operation.op_code, ase_id, args)) responses.append(self.on_operation(operation.op_code, ase_id, args))
elif isinstance(operation, (ASE_Enable, ASE_Update_Metadata)): elif operation.op_code in (
ASE_Operation.Opcode.ENABLE,
ASE_Operation.Opcode.UPDATE_METADATA,
):
for ase_id, *args in zip( for ase_id, *args in zip(
operation.ase_id, operation.ase_id,
operation.metadata, operation.metadata,
): ):
responses.append(self.on_operation(operation.op_code, ase_id, args)) responses.append(self.on_operation(operation.op_code, ase_id, args))
elif isinstance( elif operation.op_code in (
operation, ASE_Operation.Opcode.RECEIVER_START_READY,
( ASE_Operation.Opcode.DISABLE,
ASE_Receiver_Start_Ready, ASE_Operation.Opcode.RECEIVER_STOP_READY,
ASE_Disable, ASE_Operation.Opcode.RELEASE,
ASE_Receiver_Stop_Ready,
ASE_Release,
),
): ):
for ase_id in operation.ase_id: for ase_id in operation.ase_id:
responses.append(self.on_operation(operation.op_code, ase_id, [])) responses.append(self.on_operation(operation.op_code, ase_id, []))
@@ -729,8 +723,8 @@ class AudioStreamControlService(gatt.TemplateService):
class AudioStreamControlServiceProxy(gatt_client.ProfileServiceProxy): class AudioStreamControlServiceProxy(gatt_client.ProfileServiceProxy):
SERVICE_CLASS = AudioStreamControlService SERVICE_CLASS = AudioStreamControlService
sink_ase: list[gatt_client.CharacteristicProxy[bytes]] sink_ase: List[gatt_client.CharacteristicProxy[bytes]]
source_ase: list[gatt_client.CharacteristicProxy[bytes]] source_ase: List[gatt_client.CharacteristicProxy[bytes]]
ase_control_point: gatt_client.CharacteristicProxy[bytes] ase_control_point: gatt_client.CharacteristicProxy[bytes]
def __init__(self, service_proxy: gatt_client.ServiceProxy): def __init__(self, service_proxy: gatt_client.ServiceProxy):
+15 -11
View File
@@ -17,13 +17,16 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import enum import enum
import logging
import struct import struct
from typing import Any, Callable, Optional, Union import logging
from typing import List, Optional, Callable, Union, Any
from bumble import data_types, gatt, gatt_client, l2cap, utils from bumble import l2cap
from bumble import utils
from bumble import gatt
from bumble import gatt_client
from bumble.core import AdvertisingData from bumble.core import AdvertisingData
from bumble.device import Connection, Device from bumble.device import Device, Connection
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -100,7 +103,7 @@ class AshaService(gatt.TemplateService):
def __init__( def __init__(
self, self,
capability: int, capability: int,
hisyncid: Union[list[int], bytes], hisyncid: Union[List[int], bytes],
device: Device, device: Device,
psm: int = 0, psm: int = 0,
audio_sink: Optional[Callable[[bytes], Any]] = None, audio_sink: Optional[Callable[[bytes], Any]] = None,
@@ -185,18 +188,19 @@ class AshaService(gatt.TemplateService):
return bytes( return bytes(
AdvertisingData( AdvertisingData(
[ [
data_types.ServiceData16BitUUID( (
gatt.GATT_ASHA_SERVICE, AdvertisingData.SERVICE_DATA_16_BIT_UUID,
bytes([self.protocol_version, self.capability]) bytes(gatt.GATT_ASHA_SERVICE)
+ bytes([self.protocol_version, self.capability])
+ self.hisyncid[:4], + self.hisyncid[:4],
) ),
] ]
) )
) )
# Handler for audio control commands # Handler for audio control commands
async def _on_audio_control_point_write( async def _on_audio_control_point_write(
self, connection: Connection, value: bytes self, connection: Optional[Connection], value: bytes
) -> None: ) -> None:
_logger.debug(f'--- AUDIO CONTROL POINT Write:{value.hex()}') _logger.debug(f'--- AUDIO CONTROL POINT Write:{value.hex()}')
opcode = value[0] opcode = value[0]
@@ -243,7 +247,7 @@ class AshaService(gatt.TemplateService):
) )
# Handler for volume control # Handler for volume control
def _on_volume_write(self, connection: Connection, value: bytes) -> None: def _on_volume_write(self, connection: Optional[Connection], value: bytes) -> None:
_logger.debug(f'--- VOLUME Write:{value[0]}') _logger.debug(f'--- VOLUME Write:{value[0]}')
self.volume = value[0] self.volume = value[0]
self.emit(self.EVENT_VOLUME_CHANGED) self.emit(self.EVENT_VOLUME_CHANGED)
+27 -14
View File
@@ -18,18 +18,22 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
from collections.abc import Sequence
import dataclasses import dataclasses
import enum import enum
import struct
import functools import functools
import logging import logging
import struct from typing import List
from collections.abc import Sequence
from typing_extensions import Self from typing_extensions import Self
from bumble import core, data_types, gatt, hci, utils from bumble import core
from bumble import hci
from bumble import gatt
from bumble import utils
from bumble.profiles import le_audio from bumble.profiles import le_audio
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -257,10 +261,11 @@ class UnicastServerAdvertisingData:
return bytes( return bytes(
core.AdvertisingData( core.AdvertisingData(
[ [
data_types.ServiceData16BitUUID( (
gatt.GATT_AUDIO_STREAM_CONTROL_SERVICE, core.AdvertisingData.SERVICE_DATA_16_BIT_UUID,
struct.pack( struct.pack(
'<BIB', '<2sBIB',
bytes(gatt.GATT_AUDIO_STREAM_CONTROL_SERVICE),
self.announcement_type, self.announcement_type,
self.available_audio_contexts, self.available_audio_contexts,
len(self.metadata), len(self.metadata),
@@ -277,7 +282,7 @@ class UnicastServerAdvertisingData:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
def bits_to_channel_counts(data: int) -> list[int]: def bits_to_channel_counts(data: int) -> List[int]:
pos = 0 pos = 0
counts = [] counts = []
while data != 0: while data != 0:
@@ -489,8 +494,12 @@ class BroadcastAudioAnnouncement:
return bytes( return bytes(
core.AdvertisingData( core.AdvertisingData(
[ [
data_types.ServiceData16BitUUID( (
gatt.GATT_BROADCAST_AUDIO_ANNOUNCEMENT_SERVICE, bytes(self) core.AdvertisingData.SERVICE_DATA_16_BIT_UUID,
(
bytes(gatt.GATT_BROADCAST_AUDIO_ANNOUNCEMENT_SERVICE)
+ bytes(self)
),
) )
] ]
) )
@@ -518,7 +527,7 @@ class BasicAudioAnnouncement:
codec_id: hci.CodingFormat codec_id: hci.CodingFormat
codec_specific_configuration: CodecSpecificConfiguration codec_specific_configuration: CodecSpecificConfiguration
metadata: le_audio.Metadata metadata: le_audio.Metadata
bis: list[BasicAudioAnnouncement.BIS] bis: List[BasicAudioAnnouncement.BIS]
def __bytes__(self) -> bytes: def __bytes__(self) -> bytes:
metadata_bytes = bytes(self.metadata) metadata_bytes = bytes(self.metadata)
@@ -536,7 +545,7 @@ class BasicAudioAnnouncement:
) )
presentation_delay: int presentation_delay: int
subgroups: list[BasicAudioAnnouncement.Subgroup] subgroups: List[BasicAudioAnnouncement.Subgroup]
@classmethod @classmethod
def from_bytes(cls, data: bytes) -> Self: def from_bytes(cls, data: bytes) -> Self:
@@ -602,8 +611,12 @@ class BasicAudioAnnouncement:
return bytes( return bytes(
core.AdvertisingData( core.AdvertisingData(
[ [
data_types.ServiceData16BitUUID( (
gatt.GATT_BASIC_AUDIO_ANNOUNCEMENT_SERVICE, bytes(self) core.AdvertisingData.SERVICE_DATA_16_BIT_UUID,
(
bytes(gatt.GATT_BASIC_AUDIO_ANNOUNCEMENT_SERVICE)
+ bytes(self)
),
) )
] ]
) )
+7 -2
View File
@@ -17,13 +17,18 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses import dataclasses
import logging import logging
import struct import struct
from typing import ClassVar, Optional, Sequence from typing import ClassVar, Optional, Sequence
from bumble import core, device, gatt, gatt_adapters, gatt_client, hci, utils from bumble import core
from bumble import device
from bumble import gatt
from bumble import gatt_adapters
from bumble import gatt_client
from bumble import hci
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
+4 -3
View File
@@ -18,18 +18,19 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from typing import Optional from typing import Optional
from bumble.gatt_client import ProfileServiceProxy
from bumble.gatt import ( from bumble.gatt import (
GATT_BATTERY_LEVEL_CHARACTERISTIC,
GATT_BATTERY_SERVICE, GATT_BATTERY_SERVICE,
GATT_BATTERY_LEVEL_CHARACTERISTIC,
TemplateService,
Characteristic, Characteristic,
CharacteristicValue, CharacteristicValue,
TemplateService,
) )
from bumble.gatt_client import CharacteristicProxy
from bumble.gatt_adapters import ( from bumble.gatt_adapters import (
PackedCharacteristicAdapter, PackedCharacteristicAdapter,
PackedCharacteristicProxyAdapter, PackedCharacteristicProxyAdapter,
) )
from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
+2 -1
View File
@@ -18,7 +18,8 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
from bumble import gatt, gatt_client from bumble import gatt
from bumble import gatt_client
from bumble.profiles import csip from bumble.profiles import csip
+11 -5
View File
@@ -17,12 +17,16 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import enum import enum
import struct import struct
from typing import Optional from typing import Optional, Tuple
from bumble import core
from bumble import crypto
from bumble import device
from bumble import gatt
from bumble import gatt_client
from bumble import core, crypto, device, gatt, gatt_client
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -160,10 +164,12 @@ class CoordinatedSetIdentificationService(gatt.TemplateService):
super().__init__(characteristics) super().__init__(characteristics)
async def on_sirk_read(self, connection: device.Connection) -> bytes: async def on_sirk_read(self, connection: Optional[device.Connection]) -> bytes:
if self.set_identity_resolving_key_type == SirkType.PLAINTEXT: if self.set_identity_resolving_key_type == SirkType.PLAINTEXT:
sirk_bytes = self.set_identity_resolving_key sirk_bytes = self.set_identity_resolving_key
else: else:
assert connection
if connection.transport == core.PhysicalTransport.LE: if connection.transport == core.PhysicalTransport.LE:
key = await connection.device.get_long_term_key( key = await connection.device.get_long_term_key(
connection_handle=connection.handle, rand=b'', ediv=0 connection_handle=connection.handle, rand=b'', ediv=0
@@ -224,7 +230,7 @@ class CoordinatedSetIdentificationProxy(gatt_client.ProfileServiceProxy):
): ):
self.set_member_rank = characteristics[0] self.set_member_rank = characteristics[0]
async def read_set_identity_resolving_key(self) -> tuple[SirkType, bytes]: async def read_set_identity_resolving_key(self) -> Tuple[SirkType, bytes]:
'''Reads SIRK and decrypts if encrypted.''' '''Reads SIRK and decrypts if encrypted.'''
response = await self.set_identity_resolving_key.read_value() response = await self.set_identity_resolving_key.read_value()
if len(response) != SET_IDENTITY_RESOLVING_KEY_LENGTH + 1: if len(response) != SET_IDENTITY_RESOLVING_KEY_LENGTH + 1:
@@ -17,7 +17,7 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import struct import struct
from typing import Optional from typing import Optional, Tuple
from bumble.gatt import ( from bumble.gatt import (
GATT_DEVICE_INFORMATION_SERVICE, GATT_DEVICE_INFORMATION_SERVICE,
@@ -25,12 +25,12 @@ from bumble.gatt import (
GATT_HARDWARE_REVISION_STRING_CHARACTERISTIC, GATT_HARDWARE_REVISION_STRING_CHARACTERISTIC,
GATT_MANUFACTURER_NAME_STRING_CHARACTERISTIC, GATT_MANUFACTURER_NAME_STRING_CHARACTERISTIC,
GATT_MODEL_NUMBER_STRING_CHARACTERISTIC, GATT_MODEL_NUMBER_STRING_CHARACTERISTIC,
GATT_REGULATORY_CERTIFICATION_DATA_LIST_CHARACTERISTIC,
GATT_SERIAL_NUMBER_STRING_CHARACTERISTIC, GATT_SERIAL_NUMBER_STRING_CHARACTERISTIC,
GATT_SOFTWARE_REVISION_STRING_CHARACTERISTIC, GATT_SOFTWARE_REVISION_STRING_CHARACTERISTIC,
GATT_SYSTEM_ID_CHARACTERISTIC, GATT_SYSTEM_ID_CHARACTERISTIC,
Characteristic, GATT_REGULATORY_CERTIFICATION_DATA_LIST_CHARACTERISTIC,
TemplateService, TemplateService,
Characteristic,
) )
from bumble.gatt_adapters import ( from bumble.gatt_adapters import (
DelegatedCharacteristicProxyAdapter, DelegatedCharacteristicProxyAdapter,
@@ -60,7 +60,7 @@ class DeviceInformationService(TemplateService):
hardware_revision: Optional[str] = None, hardware_revision: Optional[str] = None,
firmware_revision: Optional[str] = None, firmware_revision: Optional[str] = None,
software_revision: Optional[str] = None, software_revision: Optional[str] = None,
system_id: Optional[tuple[int, int]] = None, # (OUI, Manufacturer ID) system_id: Optional[Tuple[int, int]] = None, # (OUI, Manufacturer ID)
ieee_regulatory_certification_data_list: Optional[bytes] = None, ieee_regulatory_certification_data_list: Optional[bytes] = None,
# TODO: pnp_id # TODO: pnp_id
): ):
+6 -6
View File
@@ -19,15 +19,15 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import logging import logging
import struct import struct
from typing import Optional, Union from typing import Optional, Tuple, Union
from bumble.core import Appearance from bumble.core import Appearance
from bumble.gatt import ( from bumble.gatt import (
GATT_APPEARANCE_CHARACTERISTIC,
GATT_DEVICE_NAME_CHARACTERISTIC,
GATT_GENERIC_ACCESS_SERVICE,
Characteristic,
TemplateService, TemplateService,
Characteristic,
GATT_GENERIC_ACCESS_SERVICE,
GATT_DEVICE_NAME_CHARACTERISTIC,
GATT_APPEARANCE_CHARACTERISTIC,
) )
from bumble.gatt_adapters import ( from bumble.gatt_adapters import (
DelegatedCharacteristicProxyAdapter, DelegatedCharacteristicProxyAdapter,
@@ -54,7 +54,7 @@ class GenericAccessService(TemplateService):
appearance_characteristic: Characteristic[bytes] appearance_characteristic: Characteristic[bytes]
def __init__( def __init__(
self, device_name: str, appearance: Union[Appearance, tuple[int, int], int] = 0 self, device_name: str, appearance: Union[Appearance, Tuple[int, int], int] = 0
): ):
if isinstance(appearance, int): if isinstance(appearance, int):
appearance_int = appearance appearance_int = appearance
+7 -2
View File
@@ -17,7 +17,10 @@ from __future__ import annotations
import struct import struct
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
from bumble import att, crypto, gatt, gatt_client from bumble import att
from bumble import gatt
from bumble import gatt_client
from bumble import crypto
if TYPE_CHECKING: if TYPE_CHECKING:
from bumble import device from bumble import device
@@ -124,7 +127,9 @@ class GenericAttributeProfileService(gatt.TemplateService):
return b'' return b''
def get_database_hash(self, connection: device.Connection) -> bytes: def get_database_hash(self, connection: device.Connection | None) -> bytes:
assert connection
m = b''.join( m = b''.join(
[ [
self.get_attribute_data(attribute) self.get_attribute_data(attribute)
+5 -5
View File
@@ -18,21 +18,21 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import struct import struct
from enum import IntFlag
from typing import Optional from typing import Optional
from bumble.gatt import ( from bumble.gatt import (
GATT_BGR_FEATURES_CHARACTERISTIC, TemplateService,
GATT_BGS_FEATURES_CHARACTERISTIC, Characteristic,
GATT_GAMING_AUDIO_SERVICE, GATT_GAMING_AUDIO_SERVICE,
GATT_GMAP_ROLE_CHARACTERISTIC, GATT_GMAP_ROLE_CHARACTERISTIC,
GATT_UGG_FEATURES_CHARACTERISTIC, GATT_UGG_FEATURES_CHARACTERISTIC,
GATT_UGT_FEATURES_CHARACTERISTIC, GATT_UGT_FEATURES_CHARACTERISTIC,
Characteristic, GATT_BGS_FEATURES_CHARACTERISTIC,
TemplateService, GATT_BGR_FEATURES_CHARACTERISTIC,
) )
from bumble.gatt_adapters import DelegatedCharacteristicProxyAdapter from bumble.gatt_adapters import DelegatedCharacteristicProxyAdapter
from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy
from enum import IntFlag
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
+108 -124
View File
@@ -16,15 +16,16 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import asyncio import asyncio
import logging import functools
from dataclasses import dataclass, field from dataclasses import dataclass, field
from typing import Any, Optional, Union import logging
from typing import Any, Dict, List, Optional, Set, Union
from bumble import att, gatt, gatt_adapters, gatt_client, utils from bumble import att, gatt, gatt_adapters, gatt_client
from bumble.core import InvalidArgumentError, InvalidStateError from bumble.core import InvalidArgumentError, InvalidStateError
from bumble.device import Connection, Device from bumble.device import Device, Connection
from bumble import utils
from bumble.hci import Address from bumble.hci import Address
@@ -227,25 +228,23 @@ class HearingAccessService(gatt.TemplateService):
hearing_aid_preset_control_point: gatt.Characteristic[bytes] hearing_aid_preset_control_point: gatt.Characteristic[bytes]
active_preset_index_characteristic: gatt.Characteristic[bytes] active_preset_index_characteristic: gatt.Characteristic[bytes]
active_preset_index: int active_preset_index: int
active_preset_index_per_device: dict[Address, int] active_preset_index_per_device: Dict[Address, int]
device: Device device: Device
server_features: HearingAidFeatures server_features: HearingAidFeatures
preset_records: dict[int, PresetRecord] # key is the preset index preset_records: Dict[int, PresetRecord] # key is the preset index
read_presets_request_in_progress: bool read_presets_request_in_progress: bool
other_server_in_binaural_set: Optional[HearingAccessService] = None preset_changed_operations_history_per_device: Dict[
Address, List[PresetChangedOperation]
preset_changed_operations_history_per_device: dict[
Address, list[PresetChangedOperation]
] ]
# Keep an updated list of connected client to send notification to # Keep an updated list of connected client to send notification to
currently_connected_clients: set[Connection] currently_connected_clients: Set[Connection]
def __init__( def __init__(
self, device: Device, features: HearingAidFeatures, presets: list[PresetRecord] self, device: Device, features: HearingAidFeatures, presets: List[PresetRecord]
) -> None: ) -> None:
self.active_preset_index_per_device = {} self.active_preset_index_per_device = {}
self.read_presets_request_in_progress = False self.read_presets_request_in_progress = False
@@ -271,21 +270,14 @@ class HearingAccessService(gatt.TemplateService):
def on_connection(connection: Connection) -> None: def on_connection(connection: Connection) -> None:
@connection.on(connection.EVENT_DISCONNECTION) @connection.on(connection.EVENT_DISCONNECTION)
def on_disconnection(_reason) -> None: def on_disconnection(_reason) -> None:
self.currently_connected_clients.discard(connection) self.currently_connected_clients.remove(connection)
@connection.on(connection.EVENT_CONNECTION_ATT_MTU_UPDATE)
def on_mtu_update(*_: Any) -> None:
self.on_incoming_connection(connection)
@connection.on(connection.EVENT_CONNECTION_ENCRYPTION_CHANGE)
def on_encryption_change(*_: Any) -> None:
self.on_incoming_connection(connection)
@connection.on(connection.EVENT_PAIRING) @connection.on(connection.EVENT_PAIRING)
def on_pairing(*_: Any) -> None: def on_pairing(*_: Any) -> None:
self.on_incoming_connection(connection) self.on_incoming_paired_connection(connection)
self.on_incoming_connection(connection) if connection.peer_resolvable_address:
self.on_incoming_paired_connection(connection)
self.hearing_aid_features_characteristic = gatt.Characteristic( self.hearing_aid_features_characteristic = gatt.Characteristic(
uuid=gatt.GATT_HEARING_AID_FEATURES_CHARACTERISTIC, uuid=gatt.GATT_HEARING_AID_FEATURES_CHARACTERISTIC,
@@ -322,30 +314,9 @@ class HearingAccessService(gatt.TemplateService):
] ]
) )
def on_incoming_connection(self, connection: Connection): def on_incoming_paired_connection(self, connection: Connection):
'''Setup initial operations to handle a remote bonded HAP device''' '''Setup initial operations to handle a remote bonded HAP device'''
# TODO Should we filter on HAP device only ? # TODO Should we filter on HAP device only ?
if not connection.is_encrypted:
logging.debug(f'HAS: {connection.peer_address} is not encrypted')
return
if not connection.peer_resolvable_address:
logging.debug(f'HAS: {connection.peer_address} is not paired')
return
if connection.att_mtu < 49:
logging.debug(
f'HAS: {connection.peer_address} invalid MTU={connection.att_mtu}'
)
return
if connection.peer_address in self.currently_connected_clients:
logging.debug(
f'HAS: Already connected to {connection.peer_address} nothing to do'
)
return
self.currently_connected_clients.add(connection) self.currently_connected_clients.add(connection)
if ( if (
connection.peer_address connection.peer_address
@@ -362,10 +333,11 @@ class HearingAccessService(gatt.TemplateService):
# Update the active preset index if needed # Update the active preset index if needed
await self.notify_active_preset_for_connection(connection) await self.notify_active_preset_for_connection(connection)
connection.cancel_on_disconnection(on_connection_async()) utils.cancel_on_event(connection, 'disconnection', on_connection_async())
def _on_read_active_preset_index(self, connection: Connection) -> bytes: def _on_read_active_preset_index(
del connection # Unused self, __connection__: Optional[Connection]
) -> bytes:
return bytes([self.active_preset_index]) return bytes([self.active_preset_index])
# TODO this need to be triggered when device is unbonded # TODO this need to be triggered when device is unbonded
@@ -373,13 +345,18 @@ class HearingAccessService(gatt.TemplateService):
self.preset_changed_operations_history_per_device.pop(addr) self.preset_changed_operations_history_per_device.pop(addr)
async def _on_write_hearing_aid_preset_control_point( async def _on_write_hearing_aid_preset_control_point(
self, connection: Connection, value: bytes self, connection: Optional[Connection], value: bytes
): ):
assert connection
opcode = HearingAidPresetControlPointOpcode(value[0]) opcode = HearingAidPresetControlPointOpcode(value[0])
handler = getattr(self, '_on_' + opcode.name.lower()) handler = getattr(self, '_on_' + opcode.name.lower())
await handler(connection, value) await handler(connection, value)
async def _on_read_presets_request(self, connection: Connection, value: bytes): async def _on_read_presets_request(
self, connection: Optional[Connection], value: bytes
):
assert connection
if connection.att_mtu < 49: # 2.5. GATT sub-procedure requirements if connection.att_mtu < 49: # 2.5. GATT sub-procedure requirements
logging.warning(f'HAS require MTU >= 49: {connection}') logging.warning(f'HAS require MTU >= 49: {connection}')
@@ -400,19 +377,17 @@ class HearingAccessService(gatt.TemplateService):
self.preset_records[key] self.preset_records[key]
for key in sorted(self.preset_records.keys()) for key in sorted(self.preset_records.keys())
if self.preset_records[key].index >= start_index if self.preset_records[key].index >= start_index
][:num_presets] ]
del presets[num_presets:]
if len(presets) == 0: if len(presets) == 0:
raise att.ATT_Error(att.ErrorCode.OUT_OF_RANGE) raise att.ATT_Error(att.ErrorCode.OUT_OF_RANGE)
utils.AsyncRunner.spawn(self._read_preset_response(connection, presets)) utils.AsyncRunner.spawn(self._read_preset_response(connection, presets))
async def _read_preset_response( async def _read_preset_response(
self, connection: Connection, presets: list[PresetRecord] self, connection: Connection, presets: List[PresetRecord]
): ):
# If the ATT bearer is terminated before all notifications or indications are # If the ATT bearer is terminated before all notifications or indications are sent, then the server shall consider the Read Presets Request operation aborted and shall not either continue or restart the operation when the client reconnects.
# sent, then the server shall consider the Read Presets Request operation
# aborted and shall not either continue or restart the operation when the client
# reconnects.
try: try:
for i, preset in enumerate(presets): for i, preset in enumerate(presets):
await connection.device.indicate_subscriber( await connection.device.indicate_subscriber(
@@ -433,7 +408,7 @@ class HearingAccessService(gatt.TemplateService):
async def generic_update(self, op: PresetChangedOperation) -> None: async def generic_update(self, op: PresetChangedOperation) -> None:
'''Server API to perform a generic update. It is the responsibility of the caller to modify the preset_records to match the PresetChangedOperation being sent''' '''Server API to perform a generic update. It is the responsibility of the caller to modify the preset_records to match the PresetChangedOperation being sent'''
await self._notify_preset_operations(op) await self._notifyPresetOperations(op)
async def delete_preset(self, index: int) -> None: async def delete_preset(self, index: int) -> None:
'''Server API to delete a preset. It should not be the current active preset''' '''Server API to delete a preset. It should not be the current active preset'''
@@ -442,14 +417,14 @@ class HearingAccessService(gatt.TemplateService):
raise InvalidStateError('Cannot delete active preset') raise InvalidStateError('Cannot delete active preset')
del self.preset_records[index] del self.preset_records[index]
await self._notify_preset_operations(PresetChangedOperationDeleted(index)) await self._notifyPresetOperations(PresetChangedOperationDeleted(index))
async def available_preset(self, index: int) -> None: async def available_preset(self, index: int) -> None:
'''Server API to make a preset available''' '''Server API to make a preset available'''
preset = self.preset_records[index] preset = self.preset_records[index]
preset.properties.is_available = PresetRecord.Property.IsAvailable.IS_AVAILABLE preset.properties.is_available = PresetRecord.Property.IsAvailable.IS_AVAILABLE
await self._notify_preset_operations(PresetChangedOperationAvailable(index)) await self._notifyPresetOperations(PresetChangedOperationAvailable(index))
async def unavailable_preset(self, index: int) -> None: async def unavailable_preset(self, index: int) -> None:
'''Server API to make a preset unavailable. It should not be the current active preset''' '''Server API to make a preset unavailable. It should not be the current active preset'''
@@ -461,7 +436,7 @@ class HearingAccessService(gatt.TemplateService):
preset.properties.is_available = ( preset.properties.is_available = (
PresetRecord.Property.IsAvailable.IS_UNAVAILABLE PresetRecord.Property.IsAvailable.IS_UNAVAILABLE
) )
await self._notify_preset_operations(PresetChangedOperationUnavailable(index)) await self._notifyPresetOperations(PresetChangedOperationUnavailable(index))
async def _preset_changed_operation(self, connection: Connection) -> None: async def _preset_changed_operation(self, connection: Connection) -> None:
'''Send all PresetChangedOperation saved for a given connection''' '''Send all PresetChangedOperation saved for a given connection'''
@@ -476,31 +451,30 @@ class HearingAccessService(gatt.TemplateService):
return op.additional_parameters return op.additional_parameters
op_list.sort(key=get_op_index) op_list.sort(key=get_op_index)
# If the ATT bearer is terminated before all notifications or indications are # If the ATT bearer is terminated before all notifications or indications are sent, then the server shall consider the Preset Changed operation aborted and shall continue the operation when the client reconnects.
# sent, then the server shall consider the Preset Changed operation aborted and while len(op_list) > 0:
# shall continue the operation when the client reconnects.
while op_list:
try: try:
await connection.device.indicate_subscriber( await connection.device.indicate_subscriber(
connection, connection,
self.hearing_aid_preset_control_point, self.hearing_aid_preset_control_point,
value=op_list[0].to_bytes(len(op_list) == 1), value=op_list[0].to_bytes(len(op_list) == 1),
force=True, # TODO GATT notification subscription should be persistent
) )
# Remove item once sent, and keep the non sent item in the list # Remove item once sent, and keep the non sent item in the list
op_list.pop(0) op_list.pop(0)
except TimeoutError: except TimeoutError:
break break
async def _notify_preset_operations(self, op: PresetChangedOperation) -> None: async def _notifyPresetOperations(self, op: PresetChangedOperation) -> None:
for history_list in self.preset_changed_operations_history_per_device.values(): for historyList in self.preset_changed_operations_history_per_device.values():
history_list.append(op) historyList.append(op)
for connection in self.currently_connected_clients: for connection in self.currently_connected_clients:
await self._preset_changed_operation(connection) await self._preset_changed_operation(connection)
async def _on_write_preset_name(self, connection: Connection, value: bytes): async def _on_write_preset_name(
del connection # Unused self, connection: Optional[Connection], value: bytes
):
assert connection
if self.read_presets_request_in_progress: if self.read_presets_request_in_progress:
raise att.ATT_Error(att.ErrorCode.PROCEDURE_ALREADY_IN_PROGRESS) raise att.ATT_Error(att.ErrorCode.PROCEDURE_ALREADY_IN_PROGRESS)
@@ -548,7 +522,10 @@ class HearingAccessService(gatt.TemplateService):
for connection in self.currently_connected_clients: for connection in self.currently_connected_clients:
await self.notify_active_preset_for_connection(connection) await self.notify_active_preset_for_connection(connection)
async def set_active_preset(self, value: bytes) -> None: async def set_active_preset(
self, connection: Optional[Connection], value: bytes
) -> None:
assert connection
index = value[1] index = value[1]
preset = self.preset_records.get(index, None) preset = self.preset_records.get(index, None)
if ( if (
@@ -565,85 +542,86 @@ class HearingAccessService(gatt.TemplateService):
self.active_preset_index = index self.active_preset_index = index
await self.notify_active_preset() await self.notify_active_preset()
async def _on_set_active_preset(self, connection: Connection, value: bytes): async def _on_set_active_preset(
del connection # Unused self, connection: Optional[Connection], value: bytes
await self.set_active_preset(value) ):
await self.set_active_preset(connection, value)
async def set_next_or_previous_preset(self, is_previous: bool) -> None: async def set_next_or_previous_preset(
self, connection: Optional[Connection], is_previous
):
'''Set the next or the previous preset as active''' '''Set the next or the previous preset as active'''
assert connection
if self.active_preset_index == 0x00: if self.active_preset_index == 0x00:
raise att.ATT_Error(ErrorCode.PRESET_OPERATION_NOT_POSSIBLE) raise att.ATT_Error(ErrorCode.PRESET_OPERATION_NOT_POSSIBLE)
presets = sorted( first_preset: Optional[PresetRecord] = None # To loop to first preset
[ next_preset: Optional[PresetRecord] = None
record for index, record in sorted(self.preset_records.items(), reverse=is_previous):
for record in self.preset_records.values() if not record.is_available():
if record.is_available() continue
], if first_preset == None:
key=lambda record: record.index, first_preset = record
) if is_previous:
current_preset = self.preset_records[self.active_preset_index] if index >= self.active_preset_index:
current_preset_pos = presets.index(current_preset) continue
if is_previous: elif index <= self.active_preset_index:
new_preset = presets[(current_preset_pos - 1) % len(presets)] continue
else: next_preset = record
new_preset = presets[(current_preset_pos + 1) % len(presets)] break
if current_preset == new_preset: # If no other preset are available if not first_preset: # If no other preset are available
raise att.ATT_Error(ErrorCode.PRESET_OPERATION_NOT_POSSIBLE) raise att.ATT_Error(ErrorCode.PRESET_OPERATION_NOT_POSSIBLE)
self.active_preset_index = new_preset.index if next_preset:
self.active_preset_index = next_preset.index
else:
self.active_preset_index = first_preset.index
await self.notify_active_preset() await self.notify_active_preset()
async def _on_set_next_preset(self, connection: Connection, value: bytes) -> None: async def _on_set_next_preset(
del connection, value # Unused. self, connection: Optional[Connection], __value__: bytes
await self.set_next_or_previous_preset(False) ) -> None:
await self.set_next_or_previous_preset(connection, False)
async def _on_set_previous_preset( async def _on_set_previous_preset(
self, connection: Connection, value: bytes self, connection: Optional[Connection], __value__: bytes
) -> None: ) -> None:
del connection, value # Unused. await self.set_next_or_previous_preset(connection, True)
await self.set_next_or_previous_preset(True)
async def _on_set_active_preset_synchronized_locally( async def _on_set_active_preset_synchronized_locally(
self, connection: Connection, value: bytes self, connection: Optional[Connection], value: bytes
): ):
del connection # Unused.
if ( if (
self.server_features.preset_synchronization_support self.server_features.preset_synchronization_support
== PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_NOT_SUPPORTED == PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_SUPPORTED
): ):
raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED) raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED)
await self.set_active_preset(value) await self.set_active_preset(connection, value)
if self.other_server_in_binaural_set: # TODO (low priority) inform other server of the change
await self.other_server_in_binaural_set.set_active_preset(value)
async def _on_set_next_preset_synchronized_locally( async def _on_set_next_preset_synchronized_locally(
self, connection: Connection, value: bytes self, connection: Optional[Connection], __value__: bytes
): ):
del connection, value # Unused.
if ( if (
self.server_features.preset_synchronization_support self.server_features.preset_synchronization_support
== PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_NOT_SUPPORTED == PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_SUPPORTED
): ):
raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED) raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED)
await self.set_next_or_previous_preset(False) await self.set_next_or_previous_preset(connection, False)
if self.other_server_in_binaural_set: # TODO (low priority) inform other server of the change
await self.other_server_in_binaural_set.set_next_or_previous_preset(False)
async def _on_set_previous_preset_synchronized_locally( async def _on_set_previous_preset_synchronized_locally(
self, connection: Connection, value: bytes self, connection: Optional[Connection], __value__: bytes
): ):
del connection, value # Unused.
if ( if (
self.server_features.preset_synchronization_support self.server_features.preset_synchronization_support
== PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_NOT_SUPPORTED == PresetSynchronizationSupport.PRESET_SYNCHRONIZATION_IS_SUPPORTED
): ):
raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED) raise att.ATT_Error(ErrorCode.PRESET_SYNCHRONIZATION_NOT_SUPPORTED)
await self.set_next_or_previous_preset(True) await self.set_next_or_previous_preset(connection, True)
if self.other_server_in_binaural_set: # TODO (low priority) inform other server of the change
await self.other_server_in_binaural_set.set_next_or_previous_preset(True)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -653,13 +631,11 @@ class HearingAccessServiceProxy(gatt_client.ProfileServiceProxy):
SERVICE_CLASS = HearingAccessService SERVICE_CLASS = HearingAccessService
hearing_aid_preset_control_point: gatt_client.CharacteristicProxy hearing_aid_preset_control_point: gatt_client.CharacteristicProxy
preset_control_point_indications: asyncio.Queue[bytes] preset_control_point_indications: asyncio.Queue
active_preset_index_notification: asyncio.Queue[bytes] active_preset_index_notification: asyncio.Queue
def __init__(self, service_proxy: gatt_client.ServiceProxy) -> None: def __init__(self, service_proxy: gatt_client.ServiceProxy) -> None:
self.service_proxy = service_proxy self.service_proxy = service_proxy
self.preset_control_point_indications = asyncio.Queue()
self.active_preset_index_notification = asyncio.Queue()
self.server_features = gatt_adapters.PackedCharacteristicProxyAdapter( self.server_features = gatt_adapters.PackedCharacteristicProxyAdapter(
service_proxy.get_characteristics_by_uuid( service_proxy.get_characteristics_by_uuid(
@@ -681,12 +657,20 @@ class HearingAccessServiceProxy(gatt_client.ProfileServiceProxy):
'B', 'B',
) )
async def setup_subscription(self) -> None: async def setup_subscription(self):
self.preset_control_point_indications = asyncio.Queue()
self.active_preset_index_notification = asyncio.Queue()
def on_active_preset_index_notification(data: bytes):
self.active_preset_index_notification.put_nowait(data)
def on_preset_control_point_indication(data: bytes):
self.preset_control_point_indications.put_nowait(data)
await self.hearing_aid_preset_control_point.subscribe( await self.hearing_aid_preset_control_point.subscribe(
self.preset_control_point_indications.put_nowait, functools.partial(on_preset_control_point_indication), prefer_notify=False
prefer_notify=False,
) )
await self.active_preset_index.subscribe( await self.active_preset_index.subscribe(
self.active_preset_index_notification.put_nowait functools.partial(on_active_preset_index_notification)
) )
+4 -5
View File
@@ -17,21 +17,20 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import struct
from enum import IntEnum from enum import IntEnum
import struct
from typing import Optional from typing import Optional
from bumble import core from bumble import core
from bumble.att import ATT_Error from bumble.att import ATT_Error
from bumble.gatt import ( from bumble.gatt import (
GATT_HEART_RATE_SERVICE,
GATT_HEART_RATE_MEASUREMENT_CHARACTERISTIC,
GATT_BODY_SENSOR_LOCATION_CHARACTERISTIC, GATT_BODY_SENSOR_LOCATION_CHARACTERISTIC,
GATT_HEART_RATE_CONTROL_POINT_CHARACTERISTIC, GATT_HEART_RATE_CONTROL_POINT_CHARACTERISTIC,
GATT_HEART_RATE_MEASUREMENT_CHARACTERISTIC, TemplateService,
GATT_HEART_RATE_SERVICE,
Characteristic, Characteristic,
CharacteristicValue, CharacteristicValue,
TemplateService,
) )
from bumble.gatt_adapters import ( from bumble.gatt_adapters import (
DelegatedCharacteristicAdapter, DelegatedCharacteristicAdapter,
+5 -7
View File
@@ -16,16 +16,14 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses import dataclasses
import enum import enum
import struct import struct
from typing import Any from typing import Any, List, Type
from typing_extensions import Self from typing_extensions import Self
from bumble import utils
from bumble.profiles import bap from bumble.profiles import bap
from bumble import utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -110,13 +108,13 @@ class Metadata:
return self.data return self.data
@classmethod @classmethod
def from_bytes(cls: type[Self], data: bytes) -> Self: def from_bytes(cls: Type[Self], data: bytes) -> Self:
return cls(tag=Metadata.Tag(data[0]), data=data[1:]) return cls(tag=Metadata.Tag(data[0]), data=data[1:])
def __bytes__(self) -> bytes: def __bytes__(self) -> bytes:
return bytes([len(self.data) + 1, self.tag]) + self.data return bytes([len(self.data) + 1, self.tag]) + self.data
entries: list[Entry] = dataclasses.field(default_factory=list) entries: List[Entry] = dataclasses.field(default_factory=list)
def pretty_print(self, indent: str) -> str: def pretty_print(self, indent: str) -> str:
"""Convenience method to generate a string with one key-value pair per line.""" """Convenience method to generate a string with one key-value pair per line."""
@@ -142,7 +140,7 @@ class Metadata:
) )
@classmethod @classmethod
def from_bytes(cls: type[Self], data: bytes) -> Self: def from_bytes(cls: Type[Self], data: bytes) -> Self:
entries = [] entries = []
offset = 0 offset = 0
length = len(data) length = len(data)
+14 -7
View File
@@ -22,12 +22,16 @@ import asyncio
import dataclasses import dataclasses
import enum import enum
import struct import struct
from typing import TYPE_CHECKING, ClassVar, Optional
from bumble import core
from bumble import device
from bumble import gatt
from bumble import gatt_client
from bumble import utils
from typing import Type, Optional, ClassVar, Dict, TYPE_CHECKING
from typing_extensions import Self from typing_extensions import Self
from bumble import core, device, gatt, gatt_client, utils
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -163,7 +167,7 @@ class ObjectId(int):
'''See Media Control Service 4.4.2. Object ID field.''' '''See Media Control Service 4.4.2. Object ID field.'''
@classmethod @classmethod
def create_from_bytes(cls: type[Self], data: bytes) -> Self: def create_from_bytes(cls: Type[Self], data: bytes) -> Self:
return cls(int.from_bytes(data, byteorder='little', signed=False)) return cls(int.from_bytes(data, byteorder='little', signed=False))
def __bytes__(self) -> bytes: def __bytes__(self) -> bytes:
@@ -178,7 +182,7 @@ class GroupObjectType:
object_id: ObjectId object_id: ObjectId
@classmethod @classmethod
def from_bytes(cls: type[Self], data: bytes) -> Self: def from_bytes(cls: Type[Self], data: bytes) -> Self:
return cls( return cls(
object_type=ObjectType(data[0]), object_type=ObjectType(data[0]),
object_id=ObjectId.create_from_bytes(data[1:]), object_id=ObjectId.create_from_bytes(data[1:]),
@@ -283,8 +287,11 @@ class MediaControlService(gatt.TemplateService):
) )
async def on_media_control_point( async def on_media_control_point(
self, connection: device.Connection, data: bytes self, connection: Optional[device.Connection], data: bytes
) -> None: ) -> None:
if not connection:
raise core.InvalidStateError()
opcode = MediaControlPointOpcode(data[0]) opcode = MediaControlPointOpcode(data[0])
await connection.device.notify_subscriber( await connection.device.notify_subscriber(
@@ -306,7 +313,7 @@ class MediaControlServiceProxy(
): ):
SERVICE_CLASS = MediaControlService SERVICE_CLASS = MediaControlService
_CHARACTERISTICS: ClassVar[dict[str, core.UUID]] = { _CHARACTERISTICS: ClassVar[Dict[str, core.UUID]] = {
'media_player_name': gatt.GATT_MEDIA_PLAYER_NAME_CHARACTERISTIC, 'media_player_name': gatt.GATT_MEDIA_PLAYER_NAME_CHARACTERISTIC,
'media_player_icon_object_id': gatt.GATT_MEDIA_PLAYER_ICON_OBJECT_ID_CHARACTERISTIC, 'media_player_icon_object_id': gatt.GATT_MEDIA_PLAYER_ICON_OBJECT_ID_CHARACTERISTIC,
'media_player_icon_url': gatt.GATT_MEDIA_PLAYER_ICON_URL_CHARACTERISTIC, 'media_player_icon_url': gatt.GATT_MEDIA_PLAYER_ICON_URL_CHARACTERISTIC,
+6 -3
View File
@@ -17,15 +17,18 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses import dataclasses
import logging import logging
import struct import struct
from typing import Optional, Sequence, Union from typing import Optional, Sequence, Union
from bumble import gatt, gatt_adapters, gatt_client, hci
from bumble.profiles import le_audio
from bumble.profiles.bap import AudioLocation, CodecSpecificCapabilities, ContextType from bumble.profiles.bap import AudioLocation, CodecSpecificCapabilities, ContextType
from bumble.profiles import le_audio
from bumble import gatt
from bumble import gatt_adapters
from bumble import gatt_client
from bumble import hci
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
-2
View File
@@ -16,10 +16,8 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses import dataclasses
import enum import enum
from typing_extensions import Self from typing_extensions import Self
from bumble.profiles import le_audio from bumble.profiles import le_audio
+3 -2
View File
@@ -22,14 +22,15 @@ import logging
import struct import struct
from bumble.gatt import ( from bumble.gatt import (
TemplateService,
Characteristic,
GATT_TELEPHONY_AND_MEDIA_AUDIO_SERVICE, GATT_TELEPHONY_AND_MEDIA_AUDIO_SERVICE,
GATT_TMAP_ROLE_CHARACTERISTIC, GATT_TMAP_ROLE_CHARACTERISTIC,
Characteristic,
TemplateService,
) )
from bumble.gatt_adapters import DelegatedCharacteristicProxyAdapter from bumble.gatt_adapters import DelegatedCharacteristicProxyAdapter
from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy from bumble.gatt_client import CharacteristicProxy, ProfileServiceProxy, ServiceProxy
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
+17 -7
View File
@@ -17,12 +17,18 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations from __future__ import annotations
import dataclasses import dataclasses
import enum import enum
from typing import Sequence
from bumble import att, device, gatt, gatt_adapters, gatt_client, utils from typing import Optional, Sequence
from bumble import att
from bumble import utils
from bumble import device
from bumble import gatt
from bumble import gatt_adapters
from bumble import gatt_client
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -140,12 +146,14 @@ class VolumeControlService(gatt.TemplateService):
included_services=list(included_services), included_services=list(included_services),
) )
def _on_read_volume_state(self, _connection: device.Connection) -> bytes: def _on_read_volume_state(self, _connection: Optional[device.Connection]) -> bytes:
return bytes(VolumeState(self.volume_setting, self.muted, self.change_counter)) return bytes(VolumeState(self.volume_setting, self.muted, self.change_counter))
def _on_write_volume_control_point( def _on_write_volume_control_point(
self, connection: device.Connection, value: bytes self, connection: Optional[device.Connection], value: bytes
) -> None: ) -> None:
assert connection
opcode = VolumeControlPointOpcode(value[0]) opcode = VolumeControlPointOpcode(value[0])
change_counter = value[1] change_counter = value[1]
@@ -155,8 +163,10 @@ class VolumeControlService(gatt.TemplateService):
handler = getattr(self, '_on_' + opcode.name.lower()) handler = getattr(self, '_on_' + opcode.name.lower())
if handler(*value[2:]): if handler(*value[2:]):
self.change_counter = (self.change_counter + 1) % 256 self.change_counter = (self.change_counter + 1) % 256
connection.cancel_on_disconnection( utils.cancel_on_event(
connection.device.notify_subscribers(attribute=self.volume_state) connection,
'disconnection',
connection.device.notify_subscribers(attribute=self.volume_state),
) )
self.emit(self.EVENT_VOLUME_STATE_CHANGE) self.emit(self.EVENT_VOLUME_STATE_CHANGE)

Some files were not shown because too many files have changed in this diff Show More