Compare commits

..

60 Commits

Author SHA1 Message Date
Gilles Boccon-Gibod
c4fb63d35c Merge pull request #146 from google/gbg/snoop-file
add auto-snooping for transports
2023-03-21 09:15:07 -07:00
Gilles Boccon-Gibod
aa9af61cbe improve exception messages 2023-03-20 12:14:28 -07:00
Gilles Boccon-Gibod
dc3ac3060e add auto-snooping for transports 2023-03-20 11:06:50 -07:00
Gilles Boccon-Gibod
e77723a5f9 Merge pull request #135 from google/gbg/snoop
add snoop support
2023-03-07 09:16:33 -08:00
Gilles Boccon-Gibod
fe8cf51432 Merge pull request #139 from google/gbg/hotfix-001
two small hotfixes
2023-03-07 09:16:15 -08:00
Gilles Boccon-Gibod
97a0e115ae two small hotfixes 2023-03-05 20:24:16 -08:00
Lucas Abel
46e7aac77c Merge pull request #138 from rahularya50/aryarahul/fix-att-perms
Add support for ATT permissions on server-side
2023-03-03 16:18:45 -08:00
Rahul Arya
08a6f4fa49 Add support for ATT permissions on server-side 2023-03-03 16:11:33 -08:00
Lucas Abel
ca063eda0b Merge pull request #132 from rahularya50/aryarahul/fix-uuid
Fix UUID byte-order in serialization
2023-03-03 15:48:50 -08:00
Rahul Arya
c97ba4319f Fix UUID byte-order in serialization 2023-03-03 22:38:21 +00:00
Gilles Boccon-Gibod
a5275ade29 add snoop support 2023-03-02 14:34:49 -08:00
Lucas Abel
e7b39c4188 Merge pull request #130 from google/uael/self-host-ainsicolors
Effort to make Bumble self hosted into AOSP
2023-02-23 15:31:23 -08:00
uael
0594eaef09 link: make websockets import lazy 2023-02-23 21:06:12 +00:00
uael
05200284d2 a2dp: get rid of construct dependency 2023-02-23 21:01:17 +00:00
uael
d21da78aa3 overall: host a minimal copy of ainsicolors 2023-02-23 20:53:06 +00:00
Gilles Boccon-Gibod
fbc7cf02a3 Merge pull request #129 from google/gbg/smp-improvements
improve smp compatibility with other OS flows
2023-02-14 19:10:51 -08:00
Gilles Boccon-Gibod
a8beb6b1ff remove stale comment 2023-02-14 16:05:46 -08:00
Gilles Boccon-Gibod
2d44de611f make pylint happy 2023-02-14 16:04:20 -08:00
Lucas Abel
9874bb3b37 Merge pull request #128 from google/uael/device-smp-patch
Small patches for device and SMP
2023-02-14 13:15:16 -08:00
uael
6645ad47ee smp: add a small type hint 2023-02-14 21:04:39 +00:00
uael
ad27de7717 device: remove "feature" which enable accept to return the same connection has connect 2023-02-14 21:04:39 +00:00
Gilles Boccon-Gibod
e6fc63b2d8 improve smp compatibility with other OS flows 2023-02-13 10:53:00 -08:00
Gilles Boccon-Gibod
1321c7da81 Merge pull request #125 from google/gbg/gh-124
fix getting the filename from the keystore option.
2023-02-10 20:17:38 -08:00
Gilles Boccon-Gibod
5a1b03fd91 format 2023-02-08 10:54:27 -08:00
Gilles Boccon-Gibod
de47721753 fix typo caused by an earlier refactor. 2023-02-08 09:56:11 -08:00
Gilles Boccon-Gibod
83a76a75d3 fix getting the filename from the keystore option. 2023-02-08 09:40:19 -08:00
Lucas Abel
d5b5ef8313 Merge pull request #122 from google/uael/abort-on-fix-invalid-state
utils: fix possible invalide state error while canceling future for `abort_on`
2023-02-06 17:13:34 -08:00
uael
856a8d53cd utils: fix possible invalide state error while canceling future for abort_on 2023-02-06 16:58:23 +00:00
Gilles Boccon-Gibod
177c273a57 Merge pull request #121 from google/gbg/replace-bitstruct
replace bitstruct with construct
2023-02-05 11:33:36 -08:00
Gilles Boccon-Gibod
24a863983d Merge branch 'gbg/replace-bitstruct' of https://github.com/google/bumble into gbg/replace-bitstruct
# Conflicts:
#	bumble/a2dp.py
#	pyproject.toml
2023-02-04 09:31:18 -08:00
Gilles Boccon-Gibod
b7ef09d4a3 fix format 2023-02-04 09:26:31 -08:00
Gilles Boccon-Gibod
b5b6cd13b8 replace bitstruct with construct 2023-02-04 09:23:13 -08:00
Gilles Boccon-Gibod
ef781bc374 replace bitstruct with construct 2023-02-03 19:41:07 -08:00
Lucas Abel
00978c1d63 Merge pull request #118 from google/uael/type-hints
overall: add types hints to the small subset used by avatar
2023-02-02 12:48:40 -08:00
uael
b731f6f556 overall: add types hints to the small subset used by avatar 2023-02-02 19:37:55 +00:00
Lucas Abel
ed261886e1 Merge pull request #119 from google/uael/fix-ci-packages-version
build: fix version of packages running checks in CI
2023-02-02 11:03:34 -08:00
uael
5e18094c31 build: fix version of packages running checks in CI 2023-02-02 17:23:15 +00:00
Lucas Abel
9a9b4e5bf1 Merge pull request #117 from google/uael/host-fixes
host: fixed `.latency` attribute error
2023-01-27 17:38:11 -08:00
Abel Lucas
895f1618d8 host: fixed .latency attribute error 2023-01-27 23:05:43 +00:00
Gilles Boccon-Gibod
52746e0c68 Merge pull request #116 from google/barbibulle-patch-1
fix libusb-package dependency
2023-01-25 15:59:42 -08:00
Gilles Boccon-Gibod
f9b7072423 Update setup.cfg 2023-01-25 15:37:33 -08:00
Gilles Boccon-Gibod
fa4be1958f Merge pull request #114 from google/gbg/fix-constant-typo
fix typo in constant name
2023-01-23 08:50:07 -08:00
Gilles Boccon-Gibod
f1686d8a9a fix typo in constant name 2023-01-22 19:10:13 -08:00
Gilles Boccon-Gibod
5c6a7f2036 Merge pull request #113 from google/gbg/mypy
add basic support for mypy type checking
2023-01-20 08:08:19 -08:00
Gilles Boccon-Gibod
99758e4b7d add basic support for mypy type checking 2023-01-20 00:20:50 -08:00
Alan Rosenthal
7385de6a69 Merge pull request #95 from AlanRosenthal/alan/fix_show_attributes
Fix `show attributes`
2023-01-19 14:57:22 -05:00
Alan Rosenthal
bb297e7516 Fix show attributes
`show attributes` wasn't being populated since `show_attributes()` was never called.

Also updated `show attributes` to match the color and indentation of `show services`
2023-01-19 12:21:37 -05:00
Lucas Abel
8a91c614c7 Merge pull request #109 from qiaoccolato/main
transport: make libusb_package optional
2023-01-18 14:48:05 -08:00
Qiao Yang
70a50a74b7 transport: make libusb_package optional 2023-01-17 15:17:11 -08:00
Gilles Boccon-Gibod
6a16c61c5f Merge pull request #111 from google/gbg/fix-null-address-setting
don't set a random address when it is 00:00:00:00:00:00
2023-01-13 21:35:32 -08:00
Gilles Boccon-Gibod
0a22f2f7c7 use HCI_LE_Rand 2023-01-13 16:59:34 -08:00
Gilles Boccon-Gibod
422b05ad51 don't set a random address when it is 00:00:00:00:00:00 2023-01-13 13:22:27 -08:00
Gilles Boccon-Gibod
16e926a216 Merge pull request #107 from yuyangh/yuyangh/add_ASHA_L2CAP
add ASHA L2CAP and Event Emitter
2023-01-13 11:05:16 -08:00
Gilles Boccon-Gibod
e94dc66d0c Merge pull request #110 from aleksandrovrts/hci-socket_fix
Fix bug when use hci-socket transport
2023-01-11 09:35:23 -08:00
Aleksandr Aleksandrov
e37c77532b hci_socket.py: fix socket.fileno() call 2023-01-11 16:16:45 +03:00
Yuyang Huang
64b75be29b add psm parameter for testing support 2023-01-03 16:39:45 -08:00
Yuyang Huang
06018211fe emit event for ASHA l2cap packet 2023-01-03 15:01:32 -08:00
Yuyang Huang
e640991608 Merge branch 'google:main' into yuyangh/add_ASHA_L2CAP 2023-01-03 14:58:37 -08:00
Yuyang Huang
1068a6858d improve logging 2022-12-20 13:33:18 -08:00
Yuyang Huang
6febd1ba35 add L2CAP CoC to ASHA 2022-12-20 11:15:58 -08:00
77 changed files with 1478 additions and 495 deletions

View File

@@ -71,5 +71,10 @@
"editor.rulers": [88] "editor.rulers": [88]
}, },
"python.formatting.provider": "black", "python.formatting.provider": "black",
"pylint.importStrategy": "useBundled" "pylint.importStrategy": "useBundled",
"python.testing.pytestArgs": [
"."
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
} }

View File

@@ -27,7 +27,6 @@ import re
from collections import OrderedDict from collections import OrderedDict
import click import click
import colors
from prompt_toolkit import Application from prompt_toolkit import Application
from prompt_toolkit.history import FileHistory from prompt_toolkit.history import FileHistory
@@ -53,11 +52,12 @@ from prompt_toolkit.layout import (
from bumble import __version__ from bumble import __version__
import bumble.core import bumble.core
from bumble import colors
from bumble.core import UUID, AdvertisingData, BT_LE_TRANSPORT from bumble.core import UUID, AdvertisingData, BT_LE_TRANSPORT
from bumble.device import ConnectionParametersPreferences, Device, Connection, Peer from bumble.device import ConnectionParametersPreferences, Device, Connection, Peer
from bumble.utils import AsyncRunner from bumble.utils import AsyncRunner
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.gatt import Characteristic from bumble.gatt import Characteristic, Service, CharacteristicDeclaration, Descriptor
from bumble.hci import ( from bumble.hci import (
HCI_Constant, HCI_Constant,
HCI_LE_1M_PHY, HCI_LE_1M_PHY,
@@ -154,10 +154,10 @@ class ConsoleApp:
'rssi': {'on': None, 'off': None}, 'rssi': {'on': None, 'off': None},
'show': { 'show': {
'scan': None, 'scan': None,
'services': None,
'attributes': None,
'log': None, 'log': None,
'device': None, 'device': None,
'local-services': None,
'remote-services': None,
}, },
'filter': { 'filter': {
'address': None, 'address': None,
@@ -197,8 +197,8 @@ class ConsoleApp:
) )
self.output_max_lines = 20 self.output_max_lines = 20
self.scan_results_text = FormattedTextControl() self.scan_results_text = FormattedTextControl()
self.services_text = FormattedTextControl() self.local_services_text = FormattedTextControl()
self.attributes_text = FormattedTextControl() self.remote_services_text = FormattedTextControl()
self.device_text = FormattedTextControl() self.device_text = FormattedTextControl()
self.log_text = FormattedTextControl( self.log_text = FormattedTextControl(
get_cursor_position=lambda: Point(0, max(0, len(self.log_lines) - 1)) get_cursor_position=lambda: Point(0, max(0, len(self.log_lines) - 1))
@@ -214,12 +214,12 @@ class ConsoleApp:
filter=Condition(lambda: self.top_tab == 'scan'), filter=Condition(lambda: self.top_tab == 'scan'),
), ),
ConditionalContainer( ConditionalContainer(
Frame(Window(self.services_text), title='Services'), Frame(Window(self.local_services_text), title='Local Services'),
filter=Condition(lambda: self.top_tab == 'services'), filter=Condition(lambda: self.top_tab == 'local-services'),
), ),
ConditionalContainer( ConditionalContainer(
Frame(Window(self.attributes_text), title='Attributes'), Frame(Window(self.remote_services_text), title='Remove Services'),
filter=Condition(lambda: self.top_tab == 'attributes'), filter=Condition(lambda: self.top_tab == 'remote-services'),
), ),
ConditionalContainer( ConditionalContainer(
Frame(Window(self.log_text, height=self.log_height), title='Log'), Frame(Window(self.log_text, height=self.log_height), title='Log'),
@@ -281,6 +281,7 @@ class ConsoleApp:
self.device.listener = DeviceListener(self) self.device.listener = DeviceListener(self)
await self.device.power_on() await self.device.power_on()
self.show_device(self.device) self.show_device(self.device)
self.show_local_services(self.device.gatt_server.attributes)
# Run the UI # Run the UI
await self.ui.run_async() await self.ui.run_async()
@@ -359,32 +360,38 @@ class ConsoleApp:
self.scan_results_text.text = ANSI('\n'.join(lines)) self.scan_results_text.text = ANSI('\n'.join(lines))
self.ui.invalidate() self.ui.invalidate()
def show_services(self, services): def show_remote_services(self, services):
lines = [] lines = []
del self.known_attributes[:] del self.known_attributes[:]
for service in services: for service in services:
lines.append(('ansicyan', str(service) + '\n')) lines.append(("ansicyan", f"{service}\n"))
for characteristic in service.characteristics: for characteristic in service.characteristics:
lines.append(('ansimagenta', ' ' + str(characteristic) + '\n')) lines.append(('ansimagenta', f' {characteristic} + \n'))
self.known_attributes.append( self.known_attributes.append(
f'{service.uuid.to_hex_str()}.{characteristic.uuid.to_hex_str()}' f'{service.uuid.to_hex_str()}.{characteristic.uuid.to_hex_str()}'
) )
self.known_attributes.append(f'*.{characteristic.uuid.to_hex_str()}') self.known_attributes.append(f'*.{characteristic.uuid.to_hex_str()}')
self.known_attributes.append(f'#{characteristic.handle:X}') self.known_attributes.append(f'#{characteristic.handle:X}')
for descriptor in characteristic.descriptors: for descriptor in characteristic.descriptors:
lines.append(('ansigreen', ' ' + str(descriptor) + '\n')) lines.append(("ansigreen", f" {descriptor}\n"))
self.services_text.text = lines self.remote_services_text.text = lines
self.ui.invalidate() self.ui.invalidate()
def show_attributes(self, attributes): def show_local_services(self, attributes):
lines = [] lines = []
for attribute in attributes: for attribute in attributes:
lines.append(('ansicyan', f'{attribute}\n')) if isinstance(attribute, Service):
lines.append(("ansicyan", f"{attribute}\n"))
elif isinstance(attribute, (Characteristic, CharacteristicDeclaration)):
lines.append(("ansimagenta", f" {attribute}\n"))
elif isinstance(attribute, Descriptor):
lines.append(("ansigreen", f" {attribute}\n"))
else:
lines.append(("ansiyellow", f"{attribute}\n"))
self.attributes_text.text = lines self.local_services_text.text = lines
self.ui.invalidate() self.ui.invalidate()
def show_device(self, device): def show_device(self, device):
@@ -469,7 +476,7 @@ class ConsoleApp:
await self.connected_peer.discover_descriptors(characteristic) await self.connected_peer.discover_descriptors(characteristic)
self.append_to_output('discovery completed') self.append_to_output('discovery completed')
self.show_services(self.connected_peer.services) self.show_remote_services(self.connected_peer.services)
async def discover_attributes(self): async def discover_attributes(self):
if not self.connected_peer: if not self.connected_peer:
@@ -655,7 +662,13 @@ class ConsoleApp:
async def do_show(self, params): async def do_show(self, params):
if params: if params:
if params[0] in {'scan', 'services', 'attributes', 'log', 'device'}: if params[0] in {
'scan',
'log',
'device',
'local-services',
'remote-services',
}:
self.top_tab = params[0] self.top_tab = params[0]
self.ui.invalidate() self.ui.invalidate()

View File

@@ -19,9 +19,9 @@ import asyncio
import os import os
import logging import logging
import click import click
from 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 (
map_null_terminated_utf8_string, map_null_terminated_utf8_string,

View File

@@ -19,9 +19,9 @@ import asyncio
import os import os
import logging import logging
import click import click
from colors import color
import bumble.core import bumble.core
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_or_link from bumble.transport import open_transport_or_link

View File

@@ -20,8 +20,8 @@ import os
import struct import struct
import logging import logging
import click import click
from colors import color
from bumble.colors import color
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.core import AdvertisingData from bumble.core import AdvertisingData
from bumble.gatt import Service, Characteristic, CharacteristicValue from bumble.gatt import Service, Characteristic, CharacteristicValue

View File

@@ -19,8 +19,8 @@ import asyncio
import logging import logging
import os import os
import click import click
from colors import color
from bumble.colors import color
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.device import Device from bumble.device import Device
from bumble.utils import FlowControlAsyncPipe from bumble.utils import FlowControlAsyncPipe

View File

@@ -23,9 +23,10 @@ import argparse
import uuid import uuid
import os import os
from urllib.parse import urlparse from urllib.parse import urlparse
from colors import color
import websockets import websockets
from bumble.colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------

View File

@@ -19,9 +19,9 @@ import asyncio
import os import os
import logging import logging
import click import click
import aioconsole from prompt_toolkit.shortcuts import PromptSession
from colors import color
from bumble.colors import color
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.smp import PairingDelegate, PairingConfig from bumble.smp import PairingDelegate, PairingConfig
@@ -42,9 +42,23 @@ from bumble.att import (
) )
# -----------------------------------------------------------------------------
class Waiter:
instance = None
def __init__(self):
self.done = asyncio.get_running_loop().create_future()
def terminate(self):
self.done.set_result(None)
async def wait_until_terminated(self):
return await self.done
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Delegate(PairingDelegate): class Delegate(PairingDelegate):
def __init__(self, mode, connection, capability_string, prompt): def __init__(self, mode, connection, capability_string, do_prompt):
super().__init__( super().__init__(
{ {
'keyboard': PairingDelegate.KEYBOARD_INPUT_ONLY, 'keyboard': PairingDelegate.KEYBOARD_INPUT_ONLY,
@@ -58,7 +72,18 @@ class Delegate(PairingDelegate):
self.mode = mode self.mode = mode
self.peer = Peer(connection) self.peer = Peer(connection)
self.peer_name = None self.peer_name = None
self.prompt = prompt self.do_prompt = do_prompt
def print(self, message):
print(color(message, 'yellow'))
async def prompt(self, message):
# Wait a bit to allow some of the log lines to print before we prompt
await asyncio.sleep(1)
session = PromptSession(message)
response = await session.prompt_async()
return response.lower().strip()
async def update_peer_name(self): async def update_peer_name(self):
if self.peer_name is not None: if self.peer_name is not None:
@@ -73,19 +98,15 @@ class Delegate(PairingDelegate):
self.peer_name = '[?]' self.peer_name = '[?]'
async def accept(self): async def accept(self):
if self.prompt: if self.do_prompt:
await self.update_peer_name() await self.update_peer_name()
# Wait a bit to allow some of the log lines to print before we prompt
await asyncio.sleep(1)
# Prompt for acceptance # Prompt for acceptance
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
print(color(f'### Pairing request from {self.peer_name}', 'yellow')) self.print(f'### Pairing request from {self.peer_name}')
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
while True: while True:
response = await aioconsole.ainput(color('>>> Accept? ', 'yellow')) response = await self.prompt('>>> Accept? ')
response = response.lower().strip()
if response == 'yes': if response == 'yes':
return True return True
@@ -96,23 +117,17 @@ class Delegate(PairingDelegate):
# Accept silently # Accept silently
return True return True
async def compare_numbers(self, number, digits=6): async def compare_numbers(self, number, digits):
await self.update_peer_name() await self.update_peer_name()
# Wait a bit to allow some of the log lines to print before we prompt
await asyncio.sleep(1)
# Prompt for a numeric comparison # Prompt for a numeric comparison
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
print(color(f'### Pairing with {self.peer_name}', 'yellow')) self.print(f'### Pairing with {self.peer_name}')
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
while True: while True:
response = await aioconsole.ainput( response = await self.prompt(
color( f'>>> Does the other device display {number:0{digits}}? '
f'>>> Does the other device display {number:0{digits}}? ', 'yellow'
)
) )
response = response.lower().strip()
if response == 'yes': if response == 'yes':
return True return True
@@ -123,30 +138,24 @@ class Delegate(PairingDelegate):
async def get_number(self): async def get_number(self):
await self.update_peer_name() await self.update_peer_name()
# Wait a bit to allow some of the log lines to print before we prompt
await asyncio.sleep(1)
# Prompt for a PIN # Prompt for a PIN
while True: while True:
try: try:
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
print(color(f'### Pairing with {self.peer_name}', 'yellow')) self.print(f'### Pairing with {self.peer_name}')
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
return int(await aioconsole.ainput(color('>>> Enter PIN: ', 'yellow'))) return int(await self.prompt('>>> Enter PIN: '))
except ValueError: except ValueError:
pass pass
async def display_number(self, number, digits=6): async def display_number(self, number, digits):
await self.update_peer_name() await self.update_peer_name()
# Wait a bit to allow some of the log lines to print before we prompt
await asyncio.sleep(1)
# Display a PIN code # Display a PIN code
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
print(color(f'### Pairing with {self.peer_name}', 'yellow')) self.print(f'### Pairing with {self.peer_name}')
print(color(f'### PIN: {number:0{digits}}', 'yellow')) self.print(f'### PIN: {number:0{digits}}')
print(color('###-----------------------------------', 'yellow')) self.print('###-----------------------------------')
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -238,6 +247,7 @@ def on_pairing(keys):
print(color('*** Paired!', 'cyan')) print(color('*** Paired!', 'cyan'))
keys.print(prefix=color('*** ', 'cyan')) keys.print(prefix=color('*** ', 'cyan'))
print(color('***-----------------------------------', 'cyan')) print(color('***-----------------------------------', 'cyan'))
Waiter.instance.terminate()
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -245,6 +255,7 @@ def on_pairing_failure(reason):
print(color('***-----------------------------------', 'red')) print(color('***-----------------------------------', 'red'))
print(color(f'*** Pairing failed: {smp_error_name(reason)}', 'red')) print(color(f'*** Pairing failed: {smp_error_name(reason)}', 'red'))
print(color('***-----------------------------------', 'red')) print(color('***-----------------------------------', 'red'))
Waiter.instance.terminate()
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -262,6 +273,8 @@ async def pair(
hci_transport, hci_transport,
address_or_name, address_or_name,
): ):
Waiter.instance = Waiter()
print('<<< connecting to HCI...') print('<<< connecting to HCI...')
async with await open_transport_or_link(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')
@@ -332,7 +345,19 @@ async def pair(
# Advertise so that peers can find us and connect # Advertise so that peers can find us and connect
await device.start_advertising(auto_restart=True) await device.start_advertising(auto_restart=True)
await hci_source.wait_for_termination() # Run until the user asks to exit
await Waiter.instance.wait_until_terminated()
# -----------------------------------------------------------------------------
class LogHandler(logging.Handler):
def __init__(self):
super().__init__()
self.setFormatter(logging.Formatter('%(levelname)s:%(name)s:%(message)s'))
def emit(self, record):
message = self.format(record)
print(message)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -366,7 +391,11 @@ async def pair(
'--request', is_flag=True, help='Request that the connecting peer initiate pairing' '--request', is_flag=True, help='Request that the connecting peer initiate pairing'
) )
@click.option('--print-keys', is_flag=True, help='Print the bond keys before pairing') @click.option('--print-keys', is_flag=True, help='Print the bond keys before pairing')
@click.option('--keystore-file', help='File in which to store the pairing keys') @click.option(
'--keystore-file',
metavar='<filename>',
help='File in which to store the pairing keys',
)
@click.argument('device-config') @click.argument('device-config')
@click.argument('hci_transport') @click.argument('hci_transport')
@click.argument('address-or-name', required=False) @click.argument('address-or-name', required=False)
@@ -384,7 +413,13 @@ def main(
hci_transport, hci_transport,
address_or_name, address_or_name,
): ):
logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper()) # Setup logging
log_handler = LogHandler()
root_logger = logging.getLogger()
root_logger.addHandler(log_handler)
root_logger.setLevel(os.environ.get('BUMBLE_LOGLEVEL', 'INFO').upper())
# Pair
asyncio.run( asyncio.run(
pair( pair(
mode, mode,

View File

@@ -19,8 +19,8 @@ import asyncio
import os import os
import logging import logging
import click import click
from colors import color
from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.keys import JsonKeyStore from bumble.keys import JsonKeyStore

View File

@@ -17,8 +17,8 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import struct import struct
import click import click
from colors import color
from bumble.colors import color
from bumble import hci from bumble import hci
from bumble.transport.common import PacketReader from bumble.transport.common import PacketReader
from bumble.helpers import PacketTracer from bumble.helpers import PacketTracer

View File

@@ -30,8 +30,8 @@ import os
import logging import logging
import click import click
import usb1 import usb1
from colors import color
from bumble.colors import color
from bumble.transport.usb import load_libusb from bumble.transport.usb import load_libusb

View File

@@ -18,7 +18,6 @@
import struct import struct
import logging import logging
from collections import namedtuple from collections import namedtuple
import bitstruct
from .company_ids import COMPANY_IDENTIFIERS from .company_ids import COMPANY_IDENTIFIERS
from .sdp import ( from .sdp import (
@@ -258,7 +257,6 @@ class SbcMediaCodecInformation(
A2DP spec - 4.3.2 Codec Specific Information Elements A2DP spec - 4.3.2 Codec Specific Information Elements
''' '''
BIT_FIELDS = 'u4u4u4u2u2u8u8'
SAMPLING_FREQUENCY_BITS = {16000: 1 << 3, 32000: 1 << 2, 44100: 1 << 1, 48000: 1} SAMPLING_FREQUENCY_BITS = {16000: 1 << 3, 32000: 1 << 2, 44100: 1 << 1, 48000: 1}
CHANNEL_MODE_BITS = { CHANNEL_MODE_BITS = {
SBC_MONO_CHANNEL_MODE: 1 << 3, SBC_MONO_CHANNEL_MODE: 1 << 3,
@@ -274,9 +272,22 @@ class SbcMediaCodecInformation(
} }
@staticmethod @staticmethod
def from_bytes(data): def from_bytes(data: bytes) -> 'SbcMediaCodecInformation':
sampling_frequency = (data[0] >> 4) & 0x0F
channel_mode = (data[0] >> 0) & 0x0F
block_length = (data[1] >> 4) & 0x0F
subbands = (data[1] >> 2) & 0x03
allocation_method = (data[1] >> 0) & 0x03
minimum_bitpool_value = (data[2] >> 0) & 0xFF
maximum_bitpool_value = (data[3] >> 0) & 0xFF
return SbcMediaCodecInformation( return SbcMediaCodecInformation(
*bitstruct.unpack(SbcMediaCodecInformation.BIT_FIELDS, data) sampling_frequency,
channel_mode,
block_length,
subbands,
allocation_method,
minimum_bitpool_value,
maximum_bitpool_value,
) )
@classmethod @classmethod
@@ -325,8 +336,17 @@ class SbcMediaCodecInformation(
maximum_bitpool_value=maximum_bitpool_value, maximum_bitpool_value=maximum_bitpool_value,
) )
def __bytes__(self): def __bytes__(self) -> bytes:
return bitstruct.pack(self.BIT_FIELDS, *self) return bytes(
[
(self.sampling_frequency << 4) | self.channel_mode,
(self.block_length << 4)
| (self.subbands << 2)
| self.allocation_method,
self.minimum_bitpool_value,
self.maximum_bitpool_value,
]
)
def __str__(self): def __str__(self):
channel_modes = ['MONO', 'DUAL_CHANNEL', 'STEREO', 'JOINT_STEREO'] channel_modes = ['MONO', 'DUAL_CHANNEL', 'STEREO', 'JOINT_STEREO']
@@ -350,14 +370,13 @@ class SbcMediaCodecInformation(
class AacMediaCodecInformation( class AacMediaCodecInformation(
namedtuple( namedtuple(
'AacMediaCodecInformation', 'AacMediaCodecInformation',
['object_type', 'sampling_frequency', 'channels', 'vbr', 'bitrate'], ['object_type', 'sampling_frequency', 'channels', 'rfa', 'vbr', 'bitrate'],
) )
): ):
''' '''
A2DP spec - 4.5.2 Codec Specific Information Elements A2DP spec - 4.5.2 Codec Specific Information Elements
''' '''
BIT_FIELDS = 'u8u12u2p2u1u23'
OBJECT_TYPE_BITS = { OBJECT_TYPE_BITS = {
MPEG_2_AAC_LC_OBJECT_TYPE: 1 << 7, MPEG_2_AAC_LC_OBJECT_TYPE: 1 << 7,
MPEG_4_AAC_LC_OBJECT_TYPE: 1 << 6, MPEG_4_AAC_LC_OBJECT_TYPE: 1 << 6,
@@ -381,9 +400,15 @@ class AacMediaCodecInformation(
CHANNELS_BITS = {1: 1 << 1, 2: 1} CHANNELS_BITS = {1: 1 << 1, 2: 1}
@staticmethod @staticmethod
def from_bytes(data): def from_bytes(data: bytes) -> 'AacMediaCodecInformation':
object_type = data[0]
sampling_frequency = (data[1] << 4) | ((data[2] >> 4) & 0x0F)
channels = (data[2] >> 2) & 0x03
rfa = 0
vbr = (data[3] >> 7) & 0x01
bitrate = ((data[3] & 0x7F) << 16) | (data[4] << 8) | data[5]
return AacMediaCodecInformation( return AacMediaCodecInformation(
*bitstruct.unpack(AacMediaCodecInformation.BIT_FIELDS, data) object_type, sampling_frequency, channels, rfa, vbr, bitrate
) )
@classmethod @classmethod
@@ -394,6 +419,7 @@ class AacMediaCodecInformation(
object_type=cls.OBJECT_TYPE_BITS[object_type], object_type=cls.OBJECT_TYPE_BITS[object_type],
sampling_frequency=cls.SAMPLING_FREQUENCY_BITS[sampling_frequency], sampling_frequency=cls.SAMPLING_FREQUENCY_BITS[sampling_frequency],
channels=cls.CHANNELS_BITS[channels], channels=cls.CHANNELS_BITS[channels],
rfa=0,
vbr=vbr, vbr=vbr,
bitrate=bitrate, bitrate=bitrate,
) )
@@ -410,8 +436,17 @@ class AacMediaCodecInformation(
bitrate=bitrate, bitrate=bitrate,
) )
def __bytes__(self): def __bytes__(self) -> bytes:
return bitstruct.pack(self.BIT_FIELDS, *self) return bytes(
[
self.object_type & 0xFF,
(self.sampling_frequency >> 4) & 0xFF,
(((self.sampling_frequency & 0x0F) << 4) | (self.channels << 2)) & 0xFF,
((self.vbr << 7) | ((self.bitrate >> 16) & 0x7F)) & 0xFF,
((self.bitrate >> 8) & 0xFF) & 0xFF,
self.bitrate & 0xFF,
]
)
def __str__(self): def __str__(self):
object_types = [ object_types = [

View File

@@ -22,13 +22,17 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import struct import struct
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from typing import Dict, Type, TYPE_CHECKING
from bumble.core import UUID, name_or_number from bumble.core import UUID, name_or_number
from bumble.hci import HCI_Object, key_with_value from bumble.hci import HCI_Object, key_with_value
from bumble.colors import color
if TYPE_CHECKING:
from bumble.device import Connection
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Constants # Constants
@@ -197,7 +201,7 @@ 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 = {} pdu_classes: Dict[int, Type[ATT_PDU]] = {}
op_code = 0 op_code = 0
name = None name = None
@@ -747,7 +751,25 @@ class Attribute(EventEmitter):
def decode_value(self, value_bytes): def decode_value(self, value_bytes):
return value_bytes return value_bytes
def read_value(self, connection): def read_value(self, connection: Connection):
if (
self.permissions & self.READ_REQUIRES_ENCRYPTION
) and not connection.encryption:
raise ATT_Error(
error_code=ATT_INSUFFICIENT_ENCRYPTION_ERROR, att_handle=self.handle
)
if (
self.permissions & self.READ_REQUIRES_AUTHENTICATION
) and not connection.authenticated:
raise ATT_Error(
error_code=ATT_INSUFFICIENT_AUTHENTICATION_ERROR, att_handle=self.handle
)
if self.permissions & self.READ_REQUIRES_AUTHORIZATION:
# TODO: handle authorization better
raise ATT_Error(
error_code=ATT_INSUFFICIENT_AUTHORIZATION_ERROR, att_handle=self.handle
)
if read := getattr(self.value, 'read', None): if read := getattr(self.value, 'read', None):
try: try:
value = read(connection) # pylint: disable=not-callable value = read(connection) # pylint: disable=not-callable
@@ -760,7 +782,25 @@ class Attribute(EventEmitter):
return self.encode_value(value) return self.encode_value(value)
def write_value(self, connection, value_bytes): def write_value(self, connection: Connection, value_bytes):
if (
self.permissions & self.WRITE_REQUIRES_ENCRYPTION
) and not connection.encryption:
raise ATT_Error(
error_code=ATT_INSUFFICIENT_ENCRYPTION_ERROR, att_handle=self.handle
)
if (
self.permissions & self.WRITE_REQUIRES_AUTHENTICATION
) and not connection.authenticated:
raise ATT_Error(
error_code=ATT_INSUFFICIENT_AUTHENTICATION_ERROR, att_handle=self.handle
)
if self.permissions & self.WRITE_REQUIRES_AUTHORIZATION:
# TODO: handle authorization better
raise ATT_Error(
error_code=ATT_INSUFFICIENT_AUTHORIZATION_ERROR, att_handle=self.handle
)
value = self.decode_value(value_bytes) value = self.decode_value(value_bytes)
if write := getattr(self.value, 'write', None): if write := getattr(self.value, 'write', None):

View File

@@ -15,12 +15,13 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import asyncio import asyncio
import struct import struct
import time import time
import logging import logging
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from typing import Dict, Type
from .core import ( from .core import (
BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE, BT_ADVANCED_AUDIO_DISTRIBUTION_SERVICE,
@@ -38,6 +39,7 @@ from .a2dp import (
VendorSpecificMediaCodecInformation, VendorSpecificMediaCodecInformation,
) )
from . import sdp from . import sdp
from .colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -627,7 +629,8 @@ class Message: # pylint:disable=attribute-defined-outside-init
RESPONSE_REJECT: 'RESPONSE_REJECT', RESPONSE_REJECT: 'RESPONSE_REJECT',
} }
subclasses = {} # Subclasses, by signal identifier and message type # Subclasses, by signal identifier and message type
subclasses: Dict[int, Dict[int, Type[Message]]] = {}
@staticmethod @staticmethod
def message_type_name(message_type): def message_type_name(message_type):

103
bumble/colors.py Normal file
View File

@@ -0,0 +1,103 @@
# Copyright (c) 2012 Giorgos Verigakis <verigak@gmail.com>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
from functools import partial
from typing import List, Optional, Union
# ANSI color names. There is also a "default"
COLORS = ('black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white')
# ANSI style names
STYLES = (
'none',
'bold',
'faint',
'italic',
'underline',
'blink',
'blink2',
'negative',
'concealed',
'crossed',
)
ColorSpec = Union[str, int]
def _join(*values: ColorSpec) -> str:
return ';'.join(str(v) for v in values)
def _color_code(spec: ColorSpec, base: int) -> str:
if isinstance(spec, str):
spec = spec.strip().lower()
if spec == 'default':
return _join(base + 9)
elif spec in COLORS:
return _join(base + COLORS.index(spec))
elif isinstance(spec, int) and 0 <= spec <= 255:
return _join(base + 8, 5, spec)
else:
raise ValueError('Invalid color spec "%s"' % spec)
def color(
s: str,
fg: Optional[ColorSpec] = None,
bg: Optional[ColorSpec] = None,
style: Optional[str] = None,
) -> str:
codes: List[ColorSpec] = []
if fg:
codes.append(_color_code(fg, 30))
if bg:
codes.append(_color_code(bg, 40))
if style:
for style_part in style.split('+'):
if style_part in STYLES:
codes.append(STYLES.index(style_part))
else:
raise ValueError('Invalid style "%s"' % style_part)
if codes:
return '\x1b[{0}m{1}\x1b[0m'.format(_join(*codes), s)
else:
return s
# Foreground color shortcuts
black = partial(color, fg='black')
red = partial(color, fg='red')
green = partial(color, fg='green')
yellow = partial(color, fg='yellow')
blue = partial(color, fg='blue')
magenta = partial(color, fg='magenta')
cyan = partial(color, fg='cyan')
white = partial(color, fg='white')
# Style shortcuts
bold = partial(color, style='bold')
none = partial(color, style='none')
faint = partial(color, style='faint')
italic = partial(color, style='italic')
underline = partial(color, style='underline')
blink = partial(color, style='blink')
blink2 = partial(color, style='blink2')
negative = partial(color, style='negative')
concealed = partial(color, style='concealed')
crossed = partial(color, style='crossed')

View File

@@ -20,7 +20,7 @@ import asyncio
import itertools import itertools
import random import random
import struct import struct
from colors import color from bumble.colors import color
from bumble.core import BT_CENTRAL_ROLE, BT_PERIPHERAL_ROLE from bumble.core import BT_CENTRAL_ROLE, BT_PERIPHERAL_ROLE
from bumble.hci import ( from bumble.hci import (
@@ -46,7 +46,6 @@ from bumble.hci import (
HCI_LE_Connection_Complete_Event, HCI_LE_Connection_Complete_Event,
HCI_LE_Read_Remote_Features_Complete_Event, HCI_LE_Read_Remote_Features_Complete_Event,
HCI_Number_Of_Completed_Packets_Event, HCI_Number_Of_Completed_Packets_Event,
HCI_Object,
HCI_Packet, HCI_Packet,
) )
@@ -1029,7 +1028,7 @@ class Controller:
} }
return bytes([HCI_SUCCESS]) return bytes([HCI_SUCCESS])
def on_hci_le_read_transmit_power_command(self, command): def on_hci_le_read_transmit_power_command(self, _command):
''' '''
See Bluetooth spec Vol 2, Part E - 7.8.74 LE Read Transmit Power Command See Bluetooth spec Vol 2, Part E - 7.8.74 LE Read Transmit Power Command
''' '''

View File

@@ -15,7 +15,9 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import struct import struct
from typing import List, Optional, Tuple, Union, cast
from .company_ids import COMPANY_IDENTIFIERS from .company_ids import COMPANY_IDENTIFIERS
@@ -142,10 +144,13 @@ class ConnectionError(BaseError): # pylint: disable=redefined-builtin
class UUID: class UUID:
''' '''
See Bluetooth spec Vol 3, Part B - 2.5.1 UUID See Bluetooth spec Vol 3, Part B - 2.5.1 UUID
Note that this class expects and works in little-endian byte-order throughout.
The exception is when interacting with strings, which are in big-endian byte-order.
''' '''
BASE_UUID = bytes.fromhex('00001000800000805F9B34FB') BASE_UUID = bytes.fromhex('00001000800000805F9B34FB')[::-1] # little-endian
UUIDS = [] # Registry of all instances created UUIDS: List[UUID] = [] # Registry of all instances created
def __init__(self, uuid_str_or_int, name=None): def __init__(self, uuid_str_or_int, name=None):
if isinstance(uuid_str_or_int, int): if isinstance(uuid_str_or_int, int):
@@ -180,7 +185,7 @@ class UUID:
return self return self
@classmethod @classmethod
def from_bytes(cls, uuid_bytes, name=None): def from_bytes(cls, uuid_bytes: bytes, name: Optional[str] = None) -> UUID:
if len(uuid_bytes) in (2, 4, 16): if len(uuid_bytes) in (2, 4, 16):
self = cls.__new__(cls) self = cls.__new__(cls)
self.uuid_bytes = uuid_bytes self.uuid_bytes = uuid_bytes
@@ -207,13 +212,20 @@ class UUID:
return offset + 2, cls.from_bytes(uuid_as_bytes[offset : offset + 2]) return offset + 2, cls.from_bytes(uuid_as_bytes[offset : offset + 2])
def to_bytes(self, force_128=False): def to_bytes(self, force_128=False):
if len(self.uuid_bytes) == 16 or not force_128: '''
Serialize UUID in little-endian byte-order
'''
if not force_128:
return self.uuid_bytes return self.uuid_bytes
if len(self.uuid_bytes) == 4: if len(self.uuid_bytes) == 2:
return self.uuid_bytes + UUID.BASE_UUID return self.BASE_UUID + self.uuid_bytes + bytes([0, 0])
elif len(self.uuid_bytes) == 4:
return self.uuid_bytes + bytes([0, 0]) + UUID.BASE_UUID return self.BASE_UUID + self.uuid_bytes
elif len(self.uuid_bytes) == 16:
return self.uuid_bytes
else:
assert False, "unreachable"
def to_pdu_bytes(self): def to_pdu_bytes(self):
''' '''
@@ -224,7 +236,7 @@ class UUID:
''' '''
return self.to_bytes(force_128=(len(self.uuid_bytes) == 4)) return self.to_bytes(force_128=(len(self.uuid_bytes) == 4))
def to_hex_str(self): def to_hex_str(self) -> str:
if len(self.uuid_bytes) == 2 or len(self.uuid_bytes) == 4: if len(self.uuid_bytes) == 2 or len(self.uuid_bytes) == 4:
return bytes(reversed(self.uuid_bytes)).hex().upper() return bytes(reversed(self.uuid_bytes)).hex().upper()
@@ -606,6 +618,11 @@ class DeviceClass:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Advertising Data # Advertising Data
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
AdvertisingObject = Union[
List[UUID], Tuple[UUID, bytes], bytes, str, int, Tuple[int, int], Tuple[int, bytes]
]
class AdvertisingData: class AdvertisingData:
# fmt: off # fmt: off
# pylint: disable=line-too-long # pylint: disable=line-too-long
@@ -721,10 +738,12 @@ class AdvertisingData:
BR_EDR_CONTROLLER_FLAG = 0x08 BR_EDR_CONTROLLER_FLAG = 0x08
BR_EDR_HOST_FLAG = 0x10 BR_EDR_HOST_FLAG = 0x10
ad_structures: List[Tuple[int, bytes]]
# fmt: on # fmt: on
# pylint: enable=line-too-long # pylint: enable=line-too-long
def __init__(self, ad_structures=None): def __init__(self, ad_structures: Optional[List[Tuple[int, bytes]]] = None) -> None:
if ad_structures is None: if ad_structures is None:
ad_structures = [] ad_structures = []
self.ad_structures = ad_structures[:] self.ad_structures = ad_structures[:]
@@ -751,7 +770,7 @@ class AdvertisingData:
return ','.join(bit_flags_to_strings(flags, flag_names)) return ','.join(bit_flags_to_strings(flags, flag_names))
@staticmethod @staticmethod
def uuid_list_to_objects(ad_data, uuid_size): def uuid_list_to_objects(ad_data: bytes, uuid_size: int) -> List[UUID]:
uuids = [] uuids = []
offset = 0 offset = 0
while (uuid_size * (offset + 1)) <= len(ad_data): while (uuid_size * (offset + 1)) <= len(ad_data):
@@ -828,7 +847,7 @@ class AdvertisingData:
# pylint: disable=too-many-return-statements # pylint: disable=too-many-return-statements
@staticmethod @staticmethod
def ad_data_to_object(ad_type, ad_data): def ad_data_to_object(ad_type: int, ad_data: bytes) -> AdvertisingObject:
if ad_type in ( if ad_type in (
AdvertisingData.COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS, AdvertisingData.COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS,
AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS, AdvertisingData.INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS,
@@ -867,22 +886,22 @@ class AdvertisingData:
return ad_data.decode("utf-8") return ad_data.decode("utf-8")
if ad_type in (AdvertisingData.TX_POWER_LEVEL, AdvertisingData.FLAGS): if ad_type in (AdvertisingData.TX_POWER_LEVEL, AdvertisingData.FLAGS):
return ad_data[0] return cast(int, struct.unpack('B', ad_data)[0])
if ad_type in ( if ad_type in (
AdvertisingData.APPEARANCE, AdvertisingData.APPEARANCE,
AdvertisingData.ADVERTISING_INTERVAL, AdvertisingData.ADVERTISING_INTERVAL,
): ):
return struct.unpack('<H', ad_data)[0] return cast(int, struct.unpack('<H', ad_data)[0])
if ad_type == AdvertisingData.CLASS_OF_DEVICE: if ad_type == AdvertisingData.CLASS_OF_DEVICE:
return struct.unpack('<I', bytes([*ad_data, 0]))[0] return cast(int, struct.unpack('<I', bytes([*ad_data, 0]))[0])
if ad_type == AdvertisingData.PERIPHERAL_CONNECTION_INTERVAL_RANGE: if ad_type == AdvertisingData.PERIPHERAL_CONNECTION_INTERVAL_RANGE:
return struct.unpack('<HH', ad_data) return cast(Tuple[int, int], struct.unpack('<HH', ad_data))
if ad_type == AdvertisingData.MANUFACTURER_SPECIFIC_DATA: if ad_type == AdvertisingData.MANUFACTURER_SPECIFIC_DATA:
return (struct.unpack_from('<H', ad_data, 0)[0], ad_data[2:]) return (cast(int, struct.unpack_from('<H', ad_data, 0)[0]), ad_data[2:])
return ad_data return ad_data
@@ -897,26 +916,27 @@ class AdvertisingData:
self.ad_structures.append((ad_type, ad_data)) self.ad_structures.append((ad_type, ad_data))
offset += length offset += length
def get(self, type_id, return_all=False, raw=False): def get_all(self, type_id: int, raw: bool = False) -> List[AdvertisingObject]:
''' '''
Get Advertising Data Structure(s) with a given type Get Advertising Data Structure(s) with a given type
If return_all is True, returns a (possibly empty) list of matches, Returns a (possibly empty) list of matches.
else returns the first entry, or None if no structure matches.
''' '''
def process_ad_data(ad_data): def process_ad_data(ad_data: bytes) -> AdvertisingObject:
return ad_data if raw else self.ad_data_to_object(type_id, ad_data) return ad_data if raw else self.ad_data_to_object(type_id, ad_data)
if return_all: return [process_ad_data(ad[1]) for ad in self.ad_structures if ad[0] == type_id]
return [
process_ad_data(ad[1]) for ad in self.ad_structures if ad[0] == type_id
]
return next( def get(self, type_id: int, raw: bool = False) -> Optional[AdvertisingObject]:
(process_ad_data(ad[1]) for ad in self.ad_structures if ad[0] == type_id), '''
None, Get Advertising Data Structure(s) with a given type
)
Returns the first entry, or None if no structure matches.
'''
all = self.get_all(type_id, raw=raw)
return all[0] if all else None
def __bytes__(self): def __bytes__(self):
return b''.join( return b''.join(

View File

@@ -15,6 +15,7 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
from enum import IntEnum from enum import IntEnum
import functools import functools
import json import json
@@ -22,8 +23,9 @@ import asyncio
import logging import logging
from contextlib import asynccontextmanager, AsyncExitStack from contextlib import asynccontextmanager, AsyncExitStack
from dataclasses import dataclass from dataclasses import dataclass
from colors import color from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union
from .colors import color
from .att import ATT_CID, ATT_DEFAULT_MTU, ATT_PDU from .att import ATT_CID, ATT_DEFAULT_MTU, ATT_PDU
from .gatt import Characteristic, Descriptor, Service from .gatt import Characteristic, Descriptor, Service
from .hci import ( from .hci import (
@@ -46,6 +48,7 @@ from .hci import (
HCI_LE_CODED_PHY_LE_SUPPORTED_FEATURE, HCI_LE_CODED_PHY_LE_SUPPORTED_FEATURE,
HCI_LE_EXTENDED_ADVERTISING_LE_SUPPORTED_FEATURE, HCI_LE_EXTENDED_ADVERTISING_LE_SUPPORTED_FEATURE,
HCI_LE_EXTENDED_CREATE_CONNECTION_COMMAND, HCI_LE_EXTENDED_CREATE_CONNECTION_COMMAND,
HCI_LE_RAND_COMMAND,
HCI_LE_READ_PHY_COMMAND, HCI_LE_READ_PHY_COMMAND,
HCI_MITM_NOT_REQUIRED_GENERAL_BONDING_AUTHENTICATION_REQUIREMENTS, HCI_MITM_NOT_REQUIRED_GENERAL_BONDING_AUTHENTICATION_REQUIREMENTS,
HCI_MITM_NOT_REQUIRED_NO_BONDING_AUTHENTICATION_REQUIREMENTS, HCI_MITM_NOT_REQUIRED_NO_BONDING_AUTHENTICATION_REQUIREMENTS,
@@ -78,6 +81,7 @@ from .hci import (
HCI_LE_Enable_Encryption_Command, HCI_LE_Enable_Encryption_Command,
HCI_LE_Extended_Advertising_Report_Event, HCI_LE_Extended_Advertising_Report_Event,
HCI_LE_Extended_Create_Connection_Command, HCI_LE_Extended_Create_Connection_Command,
HCI_LE_Rand_Command,
HCI_LE_Read_PHY_Command, HCI_LE_Read_PHY_Command,
HCI_LE_Set_Advertising_Data_Command, HCI_LE_Set_Advertising_Data_Command,
HCI_LE_Set_Advertising_Enable_Command, HCI_LE_Set_Advertising_Enable_Command,
@@ -192,6 +196,8 @@ DEVICE_DEFAULT_L2CAP_COC_MAX_CREDITS = l2cap.L2CAP_LE_CREDIT_BASED_CONN
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Advertisement: class Advertisement:
address: Address
TX_POWER_NOT_AVAILABLE = ( TX_POWER_NOT_AVAILABLE = (
HCI_LE_Extended_Advertising_Report_Event.TX_POWER_INFORMATION_NOT_AVAILABLE HCI_LE_Extended_Advertising_Report_Event.TX_POWER_INFORMATION_NOT_AVAILABLE
) )
@@ -492,6 +498,7 @@ class Peer:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@dataclass @dataclass
class ConnectionParametersPreferences: class ConnectionParametersPreferences:
default: ClassVar[ConnectionParametersPreferences]
connection_interval_min: int = DEVICE_DEFAULT_CONNECTION_INTERVAL_MIN connection_interval_min: int = DEVICE_DEFAULT_CONNECTION_INTERVAL_MIN
connection_interval_max: int = DEVICE_DEFAULT_CONNECTION_INTERVAL_MAX connection_interval_max: int = DEVICE_DEFAULT_CONNECTION_INTERVAL_MAX
max_latency: int = DEVICE_DEFAULT_CONNECTION_MAX_LATENCY max_latency: int = DEVICE_DEFAULT_CONNECTION_MAX_LATENCY
@@ -505,6 +512,17 @@ ConnectionParametersPreferences.default = ConnectionParametersPreferences()
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Connection(CompositeEventEmitter): class Connection(CompositeEventEmitter):
device: Device
handle: int
transport: int
self_address: Address
peer_address: Address
role: int
encryption: int
authenticated: bool
sc: bool
link_key_type: int
@composite_listener @composite_listener
class Listener: class Listener:
def on_disconnection(self, reason): def on_disconnection(self, reason):
@@ -516,6 +534,9 @@ class Connection(CompositeEventEmitter):
def on_connection_parameters_update_failure(self, error): def on_connection_parameters_update_failure(self, error):
pass pass
def on_connection_data_length_change(self):
pass
def on_connection_phy_update(self): def on_connection_phy_update(self):
pass pass
@@ -605,6 +626,10 @@ class Connection(CompositeEventEmitter):
def is_encrypted(self): def is_encrypted(self):
return self.encryption != 0 return self.encryption != 0
@property
def is_incomplete(self) -> bool:
return self.handle == None
def send_l2cap_pdu(self, cid, pdu): def send_l2cap_pdu(self, cid, pdu):
self.device.send_l2cap_pdu(self.handle, cid, pdu) self.device.send_l2cap_pdu(self.handle, cid, pdu)
@@ -620,20 +645,22 @@ class Connection(CompositeEventEmitter):
): ):
return await self.device.open_l2cap_channel(self, psm, max_credits, mtu, mps) return await self.device.open_l2cap_channel(self, psm, max_credits, mtu, mps)
async def disconnect(self, reason=HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR): async def disconnect(
return await self.device.disconnect(self, reason) self, reason: int = HCI_REMOTE_USER_TERMINATED_CONNECTION_ERROR
) -> None:
await self.device.disconnect(self, reason)
async def pair(self): async def pair(self) -> None:
return await self.device.pair(self) return await self.device.pair(self)
def request_pairing(self): def request_pairing(self) -> None:
return self.device.request_pairing(self) return self.device.request_pairing(self)
# [Classic only] # [Classic only]
async def authenticate(self): async def authenticate(self) -> None:
return await self.device.authenticate(self) return await self.device.authenticate(self)
async def encrypt(self, enable=True): async def encrypt(self, enable: bool = True) -> None:
return await self.device.encrypt(self, enable) return await self.device.encrypt(self, enable)
async def sustain(self, timeout=None): async def sustain(self, timeout=None):
@@ -701,10 +728,10 @@ class Connection(CompositeEventEmitter):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class DeviceConfiguration: class DeviceConfiguration:
def __init__(self): def __init__(self) -> None:
# Setup defaults # Setup defaults
self.name = DEVICE_DEFAULT_NAME self.name = DEVICE_DEFAULT_NAME
self.address = DEVICE_DEFAULT_ADDRESS self.address = Address(DEVICE_DEFAULT_ADDRESS)
self.class_of_device = DEVICE_DEFAULT_CLASS_OF_DEVICE self.class_of_device = DEVICE_DEFAULT_CLASS_OF_DEVICE
self.scan_response_data = DEVICE_DEFAULT_SCAN_RESPONSE_DATA self.scan_response_data = DEVICE_DEFAULT_SCAN_RESPONSE_DATA
self.advertising_interval_min = DEVICE_DEFAULT_ADVERTISING_INTERVAL self.advertising_interval_min = DEVICE_DEFAULT_ADVERTISING_INTERVAL
@@ -724,12 +751,13 @@ class DeviceConfiguration:
) )
self.irk = bytes(16) # This really must be changed for any level of security self.irk = bytes(16) # This really must be changed for any level of security
self.keystore = None self.keystore = None
self.gatt_services = [] self.gatt_services: List[Dict[str, Any]] = []
def load_from_dict(self, config): def load_from_dict(self, config: Dict[str, Any]) -> None:
# Load simple properties # Load simple properties
self.name = config.get('name', self.name) self.name = config.get('name', self.name)
self.address = Address(config.get('address', self.address)) if address := config.get('address', None):
self.address = Address(address)
self.class_of_device = config.get('class_of_device', self.class_of_device) self.class_of_device = config.get('class_of_device', self.class_of_device)
self.advertising_interval_min = config.get( self.advertising_interval_min = config.get(
'advertising_interval', self.advertising_interval_min 'advertising_interval', self.advertising_interval_min
@@ -831,11 +859,27 @@ def host_event_handler(function):
# List of host event handlers for the Device class. # List of host event handlers for the Device class.
# (we define this list outside the class, because referencing a class in method # (we define this list outside the class, because referencing a class in method
# decorators is not straightforward) # decorators is not straightforward)
device_host_event_handlers = [] device_host_event_handlers: list[str] = []
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Device(CompositeEventEmitter): class Device(CompositeEventEmitter):
# incomplete list of fields.
random_address: Address
public_address: Address
classic_enabled: bool
name: str
class_of_device: int
gatt_server: gatt_server.Server
advertising_data: bytes
scan_response_data: bytes
connections: Dict[int, Connection]
pending_connections: Dict[Address, Connection]
classic_pending_accepts: Dict[
Address, List[asyncio.Future[Union[Connection, Tuple[Address, int, int]]]]
]
advertisement_accumulators: Dict[Address, AdvertisementDataAccumulator]
@composite_listener @composite_listener
class Listener: class Listener:
def on_advertisement(self, advertisement): def on_advertisement(self, advertisement):
@@ -882,12 +926,12 @@ class Device(CompositeEventEmitter):
def __init__( def __init__(
self, self,
name=None, name: Optional[str] = None,
address=None, address: Optional[Address] = None,
config=None, config: Optional[DeviceConfiguration] = None,
host=None, host: Optional[Host] = None,
generic_access_service=True, generic_access_service: bool = True,
): ) -> None:
super().__init__() super().__init__()
self._host = None self._host = None
@@ -989,10 +1033,12 @@ class Device(CompositeEventEmitter):
setup_event_forwarding(self.gatt_server, self, 'characteristic_subscription') setup_event_forwarding(self.gatt_server, self, 'characteristic_subscription')
# Set the initial host # Set the initial host
self.host = host if host:
self.host = host
@property @property
def host(self): def host(self) -> Host:
assert self._host
return self._host return self._host
@host.setter @host.setter
@@ -1026,15 +1072,18 @@ class Device(CompositeEventEmitter):
def sdp_service_records(self, service_records): def sdp_service_records(self, service_records):
self.sdp_server.service_records = service_records self.sdp_server.service_records = service_records
def lookup_connection(self, connection_handle): def lookup_connection(self, connection_handle: int) -> Optional[Connection]:
if connection := self.connections.get(connection_handle): if connection := self.connections.get(connection_handle):
return connection return connection
return None return None
def find_connection_by_bd_addr( def find_connection_by_bd_addr(
self, bd_addr, transport=None, check_address_type=False self,
): bd_addr: Address,
transport: Optional[int] = None,
check_address_type: bool = False,
) -> Optional[Connection]:
for connection in self.connections.values(): for connection in self.connections.values():
if connection.peer_address.to_bytes() == bd_addr.to_bytes(): if connection.peer_address.to_bytes() == bd_addr.to_bytes():
if ( if (
@@ -1092,11 +1141,11 @@ class Device(CompositeEventEmitter):
logger.warning('!!! Command timed out') logger.warning('!!! Command timed out')
raise CommandTimeoutError() from error raise CommandTimeoutError() from error
async def power_on(self): async def power_on(self) -> None:
# Reset the controller # Reset the controller
await self.host.reset() await self.host.reset()
response = await self.send_command(HCI_Read_BD_ADDR_Command()) response = await self.send_command(HCI_Read_BD_ADDR_Command()) # type: ignore[call-arg]
if response.return_parameters.status == HCI_SUCCESS: if response.return_parameters.status == HCI_SUCCESS:
logger.debug( logger.debug(
color(f'BD_ADDR: {response.return_parameters.bd_addr}', 'yellow') color(f'BD_ADDR: {response.return_parameters.bd_addr}', 'yellow')
@@ -1108,21 +1157,46 @@ class Device(CompositeEventEmitter):
HCI_Write_LE_Host_Support_Command( HCI_Write_LE_Host_Support_Command(
le_supported_host=int(self.le_enabled), le_supported_host=int(self.le_enabled),
simultaneous_le_host=int(self.le_simultaneous_enabled), simultaneous_le_host=int(self.le_simultaneous_enabled),
) ) # type: ignore[call-arg]
) )
if self.le_enabled: if self.le_enabled:
# Set the controller address # Set the controller address
await self.send_command( if self.random_address == Address.ANY_RANDOM:
HCI_LE_Set_Random_Address_Command(random_address=self.random_address), # Try to use an address generated at random by the controller
check_result=True, if self.host.supports_command(HCI_LE_RAND_COMMAND):
) # Get 8 random bytes
response = await self.send_command(
HCI_LE_Rand_Command(), check_result=True # type: ignore[call-arg]
)
# Ensure the address bytes can be a static random address
address_bytes = response.return_parameters.random_number[
:5
] + bytes([response.return_parameters.random_number[5] | 0xC0])
# Create a static random address from the random bytes
self.random_address = Address(address_bytes)
if self.random_address != Address.ANY_RANDOM:
logger.debug(
color(
f'LE Random Address: {self.random_address}',
'yellow',
)
)
await self.send_command(
HCI_LE_Set_Random_Address_Command(
random_address=self.random_address
), # type: ignore[call-arg]
check_result=True,
)
# Load the address resolving list # Load the address resolving list
if self.keystore and self.host.supports_command( if self.keystore and self.host.supports_command(
HCI_LE_CLEAR_RESOLVING_LIST_COMMAND HCI_LE_CLEAR_RESOLVING_LIST_COMMAND
): ):
await self.send_command(HCI_LE_Clear_Resolving_List_Command()) await self.send_command(HCI_LE_Clear_Resolving_List_Command()) # type: ignore[call-arg]
resolving_keys = await self.keystore.get_resolving_keys() resolving_keys = await self.keystore.get_resolving_keys()
for (irk, address) in resolving_keys: for (irk, address) in resolving_keys:
@@ -1132,7 +1206,7 @@ class Device(CompositeEventEmitter):
peer_identity_address=address, peer_identity_address=address,
peer_irk=irk, peer_irk=irk,
local_irk=self.irk, local_irk=self.irk,
) ) # type: ignore[call-arg]
) )
# Enable address resolution # Enable address resolution
@@ -1147,28 +1221,24 @@ class Device(CompositeEventEmitter):
if self.classic_enabled: if self.classic_enabled:
await self.send_command( await self.send_command(
HCI_Write_Local_Name_Command(local_name=self.name.encode('utf8')) HCI_Write_Local_Name_Command(local_name=self.name.encode('utf8')) # type: ignore[call-arg]
) )
await self.send_command( await self.send_command(
HCI_Write_Class_Of_Device_Command(class_of_device=self.class_of_device) HCI_Write_Class_Of_Device_Command(class_of_device=self.class_of_device) # type: ignore[call-arg]
) )
await self.send_command( await self.send_command(
HCI_Write_Simple_Pairing_Mode_Command( HCI_Write_Simple_Pairing_Mode_Command(
simple_pairing_mode=int(self.classic_ssp_enabled) simple_pairing_mode=int(self.classic_ssp_enabled)
) ) # type: ignore[call-arg]
) )
await self.send_command( await self.send_command(
HCI_Write_Secure_Connections_Host_Support_Command( HCI_Write_Secure_Connections_Host_Support_Command(
secure_connections_host_support=int(self.classic_sc_enabled) secure_connections_host_support=int(self.classic_sc_enabled)
) ) # type: ignore[call-arg]
) )
await self.set_connectable(self.connectable) await self.set_connectable(self.connectable)
await self.set_discoverable(self.discoverable) await self.set_discoverable(self.discoverable)
# Let the SMP manager know about the address
# TODO: allow using a public address
self.smp_manager.address = self.random_address
# Done # Done
self.powered_on = True self.powered_on = True
@@ -1190,11 +1260,11 @@ class Device(CompositeEventEmitter):
async def start_advertising( async def start_advertising(
self, self,
advertising_type=AdvertisingType.UNDIRECTED_CONNECTABLE_SCANNABLE, advertising_type: AdvertisingType = AdvertisingType.UNDIRECTED_CONNECTABLE_SCANNABLE,
target=None, target: Optional[Address] = None,
own_address_type=OwnAddressType.RANDOM, own_address_type: int = OwnAddressType.RANDOM,
auto_restart=False, auto_restart: bool = False,
): ) -> None:
# If we're advertising, stop first # If we're advertising, stop first
if self.advertising: if self.advertising:
await self.stop_advertising() await self.stop_advertising()
@@ -1204,7 +1274,7 @@ class Device(CompositeEventEmitter):
await self.send_command( await self.send_command(
HCI_LE_Set_Advertising_Data_Command( HCI_LE_Set_Advertising_Data_Command(
advertising_data=self.advertising_data advertising_data=self.advertising_data
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1213,7 +1283,7 @@ class Device(CompositeEventEmitter):
await self.send_command( await self.send_command(
HCI_LE_Set_Scan_Response_Data_Command( HCI_LE_Set_Scan_Response_Data_Command(
scan_response_data=self.scan_response_data scan_response_data=self.scan_response_data
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1239,13 +1309,13 @@ class Device(CompositeEventEmitter):
peer_address=peer_address, peer_address=peer_address,
advertising_channel_map=7, advertising_channel_map=7,
advertising_filter_policy=0, advertising_filter_policy=0,
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
# Enable advertising # Enable advertising
await self.send_command( await self.send_command(
HCI_LE_Set_Advertising_Enable_Command(advertising_enable=1), HCI_LE_Set_Advertising_Enable_Command(advertising_enable=1), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1254,11 +1324,11 @@ class Device(CompositeEventEmitter):
self.advertising_type = advertising_type self.advertising_type = advertising_type
self.advertising = True self.advertising = True
async def stop_advertising(self): async def stop_advertising(self) -> None:
# Disable advertising # Disable advertising
if self.advertising: if self.advertising:
await self.send_command( await self.send_command(
HCI_LE_Set_Advertising_Enable_Command(advertising_enable=0), HCI_LE_Set_Advertising_Enable_Command(advertising_enable=0), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1273,14 +1343,14 @@ class Device(CompositeEventEmitter):
async def start_scanning( async def start_scanning(
self, self,
legacy=False, legacy: bool = False,
active=True, active: bool = True,
scan_interval=DEVICE_DEFAULT_SCAN_INTERVAL, # Scan interval in ms scan_interval: int = DEVICE_DEFAULT_SCAN_INTERVAL, # Scan interval in ms
scan_window=DEVICE_DEFAULT_SCAN_WINDOW, # Scan window in ms scan_window: int = DEVICE_DEFAULT_SCAN_WINDOW, # Scan window in ms
own_address_type=OwnAddressType.RANDOM, own_address_type: int = OwnAddressType.RANDOM,
filter_duplicates=False, filter_duplicates: bool = False,
scanning_phys=(HCI_LE_1M_PHY, HCI_LE_CODED_PHY), scanning_phys: Tuple[int, int] = (HCI_LE_1M_PHY, HCI_LE_CODED_PHY),
): ) -> None:
# Check that the arguments are legal # Check that the arguments are legal
if scan_interval < scan_window: if scan_interval < scan_window:
raise ValueError('scan_interval must be >= scan_window') raise ValueError('scan_interval must be >= scan_window')
@@ -1330,7 +1400,7 @@ class Device(CompositeEventEmitter):
scan_types=[scan_type] * scanning_phy_count, scan_types=[scan_type] * scanning_phy_count,
scan_intervals=[int(scan_window / 0.625)] * scanning_phy_count, scan_intervals=[int(scan_window / 0.625)] * scanning_phy_count,
scan_windows=[int(scan_window / 0.625)] * scanning_phy_count, scan_windows=[int(scan_window / 0.625)] * scanning_phy_count,
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1341,7 +1411,7 @@ class Device(CompositeEventEmitter):
filter_duplicates=1 if filter_duplicates else 0, filter_duplicates=1 if filter_duplicates else 0,
duration=0, # TODO allow other values duration=0, # TODO allow other values
period=0, # TODO allow other values period=0, # TODO allow other values
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
else: else:
@@ -1359,7 +1429,7 @@ class Device(CompositeEventEmitter):
le_scan_window=int(scan_window / 0.625), le_scan_window=int(scan_window / 0.625),
own_address_type=own_address_type, own_address_type=own_address_type,
scanning_filter_policy=HCI_LE_Set_Scan_Parameters_Command.BASIC_UNFILTERED_POLICY, scanning_filter_policy=HCI_LE_Set_Scan_Parameters_Command.BASIC_UNFILTERED_POLICY,
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1367,25 +1437,25 @@ class Device(CompositeEventEmitter):
await self.send_command( await self.send_command(
HCI_LE_Set_Scan_Enable_Command( HCI_LE_Set_Scan_Enable_Command(
le_scan_enable=1, filter_duplicates=1 if filter_duplicates else 0 le_scan_enable=1, filter_duplicates=1 if filter_duplicates else 0
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
self.scanning_is_passive = not active self.scanning_is_passive = not active
self.scanning = True self.scanning = True
async def stop_scanning(self): async def stop_scanning(self) -> None:
# Disable scanning # Disable scanning
if self.supports_le_feature(HCI_LE_EXTENDED_ADVERTISING_LE_SUPPORTED_FEATURE): if self.supports_le_feature(HCI_LE_EXTENDED_ADVERTISING_LE_SUPPORTED_FEATURE):
await self.send_command( await self.send_command(
HCI_LE_Set_Extended_Scan_Enable_Command( HCI_LE_Set_Extended_Scan_Enable_Command(
enable=0, filter_duplicates=0, duration=0, period=0 enable=0, filter_duplicates=0, duration=0, period=0
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
else: else:
await self.send_command( await self.send_command(
HCI_LE_Set_Scan_Enable_Command(le_scan_enable=0, filter_duplicates=0), HCI_LE_Set_Scan_Enable_Command(le_scan_enable=0, filter_duplicates=0), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1403,9 +1473,9 @@ class Device(CompositeEventEmitter):
if advertisement := accumulator.update(report): if advertisement := accumulator.update(report):
self.emit('advertisement', advertisement) self.emit('advertisement', advertisement)
async def start_discovery(self, auto_restart=True): async def start_discovery(self, auto_restart: bool = True) -> None:
await self.send_command( await self.send_command(
HCI_Write_Inquiry_Mode_Command(inquiry_mode=HCI_EXTENDED_INQUIRY_MODE), HCI_Write_Inquiry_Mode_Command(inquiry_mode=HCI_EXTENDED_INQUIRY_MODE), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
@@ -1414,7 +1484,7 @@ class Device(CompositeEventEmitter):
lap=HCI_GENERAL_INQUIRY_LAP, lap=HCI_GENERAL_INQUIRY_LAP,
inquiry_length=DEVICE_DEFAULT_INQUIRY_LENGTH, inquiry_length=DEVICE_DEFAULT_INQUIRY_LENGTH,
num_responses=0, # Unlimited number of responses. num_responses=0, # Unlimited number of responses.
) ) # type: ignore[call-arg]
) )
if response.status != HCI_Command_Status_Event.PENDING: if response.status != HCI_Command_Status_Event.PENDING:
self.discovering = False self.discovering = False
@@ -1423,9 +1493,9 @@ class Device(CompositeEventEmitter):
self.auto_restart_inquiry = auto_restart self.auto_restart_inquiry = auto_restart
self.discovering = True self.discovering = True
async def stop_discovery(self): async def stop_discovery(self) -> None:
if self.discovering: if self.discovering:
await self.send_command(HCI_Inquiry_Cancel_Command(), check_result=True) await self.send_command(HCI_Inquiry_Cancel_Command(), check_result=True) # type: ignore[call-arg]
self.auto_restart_inquiry = True self.auto_restart_inquiry = True
self.discovering = False self.discovering = False
@@ -1453,7 +1523,7 @@ class Device(CompositeEventEmitter):
HCI_Write_Scan_Enable_Command(scan_enable=scan_enable) HCI_Write_Scan_Enable_Command(scan_enable=scan_enable)
) )
async def set_discoverable(self, discoverable=True): async def set_discoverable(self, discoverable: bool = True) -> None:
self.discoverable = discoverable self.discoverable = discoverable
if self.classic_enabled: if self.classic_enabled:
# Synthesize an inquiry response if none is set already # Synthesize an inquiry response if none is set already
@@ -1473,7 +1543,7 @@ class Device(CompositeEventEmitter):
await self.send_command( await self.send_command(
HCI_Write_Extended_Inquiry_Response_Command( HCI_Write_Extended_Inquiry_Response_Command(
fec_required=0, extended_inquiry_response=self.inquiry_response fec_required=0, extended_inquiry_response=self.inquiry_response
), ), # type: ignore[call-arg]
check_result=True, check_result=True,
) )
await self.set_scan_enable( await self.set_scan_enable(
@@ -1481,7 +1551,7 @@ class Device(CompositeEventEmitter):
page_scan_enabled=self.connectable, page_scan_enabled=self.connectable,
) )
async def set_connectable(self, connectable=True): async def set_connectable(self, connectable: bool = True) -> None:
self.connectable = connectable self.connectable = connectable
if self.classic_enabled: if self.classic_enabled:
await self.set_scan_enable( await self.set_scan_enable(
@@ -1491,12 +1561,14 @@ class Device(CompositeEventEmitter):
async def connect( async def connect(
self, self,
peer_address, peer_address: Union[Address, str],
transport=BT_LE_TRANSPORT, transport: int = BT_LE_TRANSPORT,
connection_parameters_preferences=None, connection_parameters_preferences: Optional[
own_address_type=OwnAddressType.RANDOM, Dict[int, ConnectionParametersPreferences]
timeout=DEVICE_DEFAULT_CONNECT_TIMEOUT, ] = None,
): own_address_type: int = OwnAddressType.RANDOM,
timeout: Optional[float] = DEVICE_DEFAULT_CONNECT_TIMEOUT,
) -> Connection:
''' '''
Request a connection to a peer. Request a connection to a peer.
When transport is BLE, this method cannot be called if there is already a When transport is BLE, this method cannot be called if there is already a
@@ -1543,6 +1615,8 @@ class Device(CompositeEventEmitter):
): ):
raise ValueError('BR/EDR addresses must be PUBLIC') raise ValueError('BR/EDR addresses must be PUBLIC')
assert isinstance(peer_address, Address)
def on_connection(connection): def on_connection(connection):
if transport == BT_LE_TRANSPORT or ( if transport == BT_LE_TRANSPORT or (
# match BR/EDR connection event against peer address # match BR/EDR connection event against peer address
@@ -1660,7 +1734,7 @@ class Device(CompositeEventEmitter):
supervision_timeouts=supervision_timeouts, supervision_timeouts=supervision_timeouts,
min_ce_lengths=min_ce_lengths, min_ce_lengths=min_ce_lengths,
max_ce_lengths=max_ce_lengths, max_ce_lengths=max_ce_lengths,
) ) # type: ignore[call-arg]
) )
else: else:
if HCI_LE_1M_PHY not in connection_parameters_preferences: if HCI_LE_1M_PHY not in connection_parameters_preferences:
@@ -1689,7 +1763,7 @@ class Device(CompositeEventEmitter):
supervision_timeout=int(prefs.supervision_timeout / 10), supervision_timeout=int(prefs.supervision_timeout / 10),
min_ce_length=int(prefs.min_ce_length / 0.625), min_ce_length=int(prefs.min_ce_length / 0.625),
max_ce_length=int(prefs.max_ce_length / 0.625), max_ce_length=int(prefs.max_ce_length / 0.625),
) ) # type: ignore[call-arg]
) )
else: else:
# Save pending connection # Save pending connection
@@ -1706,7 +1780,7 @@ class Device(CompositeEventEmitter):
clock_offset=0x0000, clock_offset=0x0000,
allow_role_switch=0x01, allow_role_switch=0x01,
reserved=0, reserved=0,
) ) # type: ignore[call-arg]
) )
if result.status != HCI_Command_Status_Event.PENDING: if result.status != HCI_Command_Status_Event.PENDING:
@@ -1725,10 +1799,10 @@ class Device(CompositeEventEmitter):
) )
except asyncio.TimeoutError: except asyncio.TimeoutError:
if transport == BT_LE_TRANSPORT: if transport == BT_LE_TRANSPORT:
await self.send_command(HCI_LE_Create_Connection_Cancel_Command()) await self.send_command(HCI_LE_Create_Connection_Cancel_Command()) # type: ignore[call-arg]
else: else:
await self.send_command( await self.send_command(
HCI_Create_Connection_Cancel_Command(bd_addr=peer_address) HCI_Create_Connection_Cancel_Command(bd_addr=peer_address) # type: ignore[call-arg]
) )
try: try:
@@ -1746,16 +1820,16 @@ class Device(CompositeEventEmitter):
async def accept( async def accept(
self, self,
peer_address=Address.ANY, peer_address: Union[Address, str] = Address.ANY,
role=BT_PERIPHERAL_ROLE, role: int = BT_PERIPHERAL_ROLE,
timeout=DEVICE_DEFAULT_CONNECT_TIMEOUT, timeout: Optional[float] = DEVICE_DEFAULT_CONNECT_TIMEOUT,
): ) -> Connection:
''' '''
Wait and accept any incoming connection or a connection from `peer_address` when Wait and accept any incoming connection or a connection from `peer_address` when
set. set.
Notes: Notes:
* A `connect` to the same peer will also complete this call. * A `connect` to the same peer will not complete this call.
* The `timeout` parameter is only handled while waiting for the connection * The `timeout` parameter is only handled while waiting for the connection
request, once received and accepted, the controller shall issue a connection request, once received and accepted, the controller shall issue a connection
complete event. complete event.
@@ -1771,22 +1845,24 @@ class Device(CompositeEventEmitter):
peer_address, BT_BR_EDR_TRANSPORT peer_address, BT_BR_EDR_TRANSPORT
) # TODO: timeout ) # TODO: timeout
assert isinstance(peer_address, Address)
if peer_address == Address.NIL: if peer_address == Address.NIL:
raise ValueError('accept on nil address') raise ValueError('accept on nil address')
# Create a future so that we can wait for the request # Create a future so that we can wait for the request
pending_request = asyncio.get_running_loop().create_future() pending_request_fut = asyncio.get_running_loop().create_future()
if peer_address == Address.ANY: if peer_address == Address.ANY:
self.classic_pending_accepts[Address.ANY].append(pending_request) self.classic_pending_accepts[Address.ANY].append(pending_request_fut)
elif peer_address in self.classic_pending_accepts: elif peer_address in self.classic_pending_accepts:
raise InvalidStateError('accept connection already pending') raise InvalidStateError('accept connection already pending')
else: else:
self.classic_pending_accepts[peer_address] = pending_request self.classic_pending_accepts[peer_address] = [pending_request_fut]
try: try:
# Wait for a request or a completed connection # Wait for a request or a completed connection
pending_request = self.abort_on('flush', pending_request) pending_request = self.abort_on('flush', pending_request_fut)
result = await ( result = await (
asyncio.wait_for(pending_request, timeout) asyncio.wait_for(pending_request, timeout)
if timeout if timeout
@@ -1795,7 +1871,7 @@ class Device(CompositeEventEmitter):
except Exception: except Exception:
# Remove future from device context # Remove future from device context
if peer_address == Address.ANY: if peer_address == Address.ANY:
self.classic_pending_accepts[Address.ANY].remove(pending_request) self.classic_pending_accepts[Address.ANY].remove(pending_request_fut)
else: else:
self.classic_pending_accepts.pop(peer_address) self.classic_pending_accepts.pop(peer_address)
raise raise
@@ -1807,6 +1883,7 @@ class Device(CompositeEventEmitter):
# Otherwise, result came from `on_connection_request` # Otherwise, result came from `on_connection_request`
peer_address, _class_of_device, _link_type = result peer_address, _class_of_device, _link_type = result
assert isinstance(peer_address, Address)
# Create a future so that we can wait for the connection's result # Create a future so that we can wait for the connection's result
pending_connection = asyncio.get_running_loop().create_future() pending_connection = asyncio.get_running_loop().create_future()
@@ -1836,7 +1913,7 @@ class Device(CompositeEventEmitter):
try: try:
# Accept connection request # Accept connection request
await self.send_command( await self.send_command(
HCI_Accept_Connection_Request_Command(bd_addr=peer_address, role=role) HCI_Accept_Connection_Request_Command(bd_addr=peer_address, role=role) # type: ignore[call-arg]
) )
# Wait for connection complete # Wait for connection complete
@@ -1934,7 +2011,7 @@ class Device(CompositeEventEmitter):
NOTE: the name of the parameters may look odd, but it just follows the names NOTE: the name of the parameters may look odd, but it just follows the names
used in the Bluetooth spec. used in the Bluetooth spec.
''' '''
await self.send_command( result = await self.send_command(
HCI_LE_Connection_Update_Command( HCI_LE_Connection_Update_Command(
connection_handle=connection.handle, connection_handle=connection.handle,
connection_interval_min=connection_interval_min, connection_interval_min=connection_interval_min,
@@ -1943,9 +2020,10 @@ class Device(CompositeEventEmitter):
supervision_timeout=supervision_timeout, supervision_timeout=supervision_timeout,
min_ce_length=min_ce_length, min_ce_length=min_ce_length,
max_ce_length=max_ce_length, max_ce_length=max_ce_length,
), )
check_result=True,
) )
if result.status != HCI_Command_Status_Event.PENDING:
raise HCI_StatusError(result)
async def get_connection_rssi(self, connection): async def get_connection_rssi(self, connection):
result = await self.send_command( result = await self.send_command(
@@ -2212,7 +2290,7 @@ class Device(CompositeEventEmitter):
) )
# [Classic only] # [Classic only]
async def request_remote_name(self, remote): # remote: Connection | Address async def request_remote_name(self, remote: Union[Address, Connection]) -> str:
# Set up event handlers # Set up event handlers
pending_name = asyncio.get_running_loop().create_future() pending_name = asyncio.get_running_loop().create_future()
@@ -2240,7 +2318,7 @@ class Device(CompositeEventEmitter):
page_scan_repetition_mode=HCI_Remote_Name_Request_Command.R2, page_scan_repetition_mode=HCI_Remote_Name_Request_Command.R2,
reserved=0, reserved=0,
clock_offset=0, # TODO investigate non-0 values clock_offset=0, # TODO investigate non-0 values
) ) # type: ignore[call-arg]
) )
if result.status != HCI_COMMAND_STATUS_PENDING: if result.status != HCI_COMMAND_STATUS_PENDING:
@@ -2328,22 +2406,12 @@ class Device(CompositeEventEmitter):
if transport == BT_BR_EDR_TRANSPORT: if transport == BT_BR_EDR_TRANSPORT:
# Create a new connection # Create a new connection
connection: Connection = self.pending_connections.pop(peer_address) connection = self.pending_connections.pop(peer_address)
connection.complete( connection.complete(
connection_handle, peer_resolvable_address, role, connection_parameters connection_handle, peer_resolvable_address, role, connection_parameters
) )
self.connections[connection_handle] = connection self.connections[connection_handle] = connection
# We may have an accept ongoing waiting for a connection request for
# `peer_address`.
# Typically happen when using `connect` to the same `peer_address` we are
# waiting for with an `accept`.
# In this case, set the completed `connection` to the `accept` future
# result.
if peer_address in self.classic_pending_accepts:
future = self.classic_pending_accepts.pop(peer_address)
future.set_result(connection)
# Emit an event to notify listeners of the new connection # Emit an event to notify listeners of the new connection
self.emit('connection', connection) self.emit('connection', connection)
else: else:
@@ -2442,7 +2510,7 @@ class Device(CompositeEventEmitter):
# match a pending future using `bd_addr` # match a pending future using `bd_addr`
if bd_addr in self.classic_pending_accepts: if bd_addr in self.classic_pending_accepts:
future = self.classic_pending_accepts.pop(bd_addr) future, *_ = self.classic_pending_accepts.pop(bd_addr)
future.set_result((bd_addr, class_of_device, link_type)) future.set_result((bd_addr, class_of_device, link_type))
# match first pending future for ANY address # match first pending future for ANY address

View File

@@ -28,9 +28,9 @@ import enum
import functools import functools
import logging import logging
import struct import struct
from typing import Sequence from typing import Optional, Sequence
from colors import color
from .colors import color
from .core import UUID, get_dict_key_by_value from .core import UUID, get_dict_key_by_value
from .att import Attribute from .att import Attribute
@@ -204,6 +204,8 @@ class Service(Attribute):
See Vol 3, Part G - 3.1 SERVICE DEFINITION See Vol 3, Part G - 3.1 SERVICE DEFINITION
''' '''
uuid: UUID
def __init__(self, uuid, characteristics: list[Characteristic], primary=True): def __init__(self, uuid, characteristics: list[Characteristic], primary=True):
# Convert the uuid to a UUID object if it isn't already # Convert the uuid to a UUID object if it isn't already
if isinstance(uuid, str): if isinstance(uuid, str):
@@ -217,11 +219,11 @@ class Service(Attribute):
uuid.to_pdu_bytes(), uuid.to_pdu_bytes(),
) )
self.uuid = uuid self.uuid = uuid
self.included_services = [] # self.included_services = []
self.characteristics = characteristics[:] self.characteristics = characteristics[:]
self.primary = primary self.primary = primary
def get_advertising_data(self): def get_advertising_data(self) -> Optional[bytes]:
""" """
Get Service specific advertising data Get Service specific advertising data
Defined by each Service, default value is empty Defined by each Service, default value is empty

View File

@@ -27,9 +27,9 @@ import asyncio
import logging import logging
import struct import struct
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from .colors import color
from .hci import HCI_Constant from .hci import HCI_Constant
from .att import ( from .att import (
ATT_ATTRIBUTE_NOT_FOUND_ERROR, ATT_ATTRIBUTE_NOT_FOUND_ERROR,

View File

@@ -27,10 +27,10 @@ import asyncio
import logging import logging
from collections import defaultdict from collections import defaultdict
import struct import struct
from typing import Tuple, Optional from typing import List, Tuple, Optional
from pyee import EventEmitter from pyee import EventEmitter
from colors import color
from .colors import color
from .core import UUID from .core import UUID
from .att import ( from .att import (
ATT_ATTRIBUTE_NOT_FOUND_ERROR, ATT_ATTRIBUTE_NOT_FOUND_ERROR,
@@ -61,7 +61,6 @@ from .att import (
from .gatt import ( from .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_MAX_ATTRIBUTE_VALUE_SIZE, GATT_MAX_ATTRIBUTE_VALUE_SIZE,
GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE, GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE,
GATT_REQUEST_TIMEOUT, GATT_REQUEST_TIMEOUT,
@@ -90,6 +89,8 @@ GATT_SERVER_DEFAULT_MAX_MTU = 517
# GATT Server # GATT Server
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Server(EventEmitter): class Server(EventEmitter):
attributes: List[Attribute]
def __init__(self, device): def __init__(self, device):
super().__init__() super().__init__()
self.device = device self.device = device
@@ -140,6 +141,7 @@ class Server(EventEmitter):
attribute attribute
for attribute in self.attributes for attribute in self.attributes
if attribute.type == GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE if attribute.type == GATT_PRIMARY_SERVICE_ATTRIBUTE_TYPE
and isinstance(attribute, Service)
and attribute.uuid == service_uuid and attribute.uuid == service_uuid
), ),
None, None,
@@ -540,8 +542,6 @@ class Server(EventEmitter):
if attribute.handle >= request.starting_handle if attribute.handle >= request.starting_handle
and attribute.handle <= request.ending_handle and attribute.handle <= request.ending_handle
): ):
# TODO: check permissions
this_uuid_size = len(attribute.type.to_pdu_bytes()) this_uuid_size = len(attribute.type.to_pdu_bytes())
if attributes: if attributes:
@@ -635,6 +635,13 @@ class Server(EventEmitter):
''' '''
pdu_space_available = connection.att_mtu - 2 pdu_space_available = connection.att_mtu - 2
response = ATT_Error_Response(
request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle,
error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
)
attributes = [] attributes = []
for attribute in ( for attribute in (
attribute attribute
@@ -644,10 +651,21 @@ class Server(EventEmitter):
and attribute.handle <= request.ending_handle and attribute.handle <= request.ending_handle
and pdu_space_available and pdu_space_available
): ):
# TODO: check permissions
try:
attribute_value = attribute.read_value(connection)
except ATT_Error as error:
# If the first attribute is unreadable, return an error
# Otherwise return attributes up to this point
if not attributes:
response = ATT_Error_Response(
request_opcode_in_error=request.op_code,
attribute_handle_in_error=attribute.handle,
error_code=error.error_code,
)
break
# Check the attribute value size # Check the attribute value size
attribute_value = attribute.read_value(connection)
max_attribute_size = min(connection.att_mtu - 4, 253) max_attribute_size = min(connection.att_mtu - 4, 253)
if len(attribute_value) > max_attribute_size: if len(attribute_value) > max_attribute_size:
# We need to truncate # We need to truncate
@@ -673,11 +691,7 @@ class Server(EventEmitter):
length=entry_size, attribute_data_list=b''.join(attribute_data_list) length=entry_size, attribute_data_list=b''.join(attribute_data_list)
) )
else: else:
response = ATT_Error_Response( logging.warning(f"not found {request}")
request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.starting_handle,
error_code=ATT_ATTRIBUTE_NOT_FOUND_ERROR,
)
self.send_response(connection, response) self.send_response(connection, response)
@@ -687,10 +701,17 @@ class Server(EventEmitter):
''' '''
if attribute := self.get_attribute(request.attribute_handle): if attribute := self.get_attribute(request.attribute_handle):
# TODO: check permissions try:
value = attribute.read_value(connection) value = attribute.read_value(connection)
value_size = min(connection.att_mtu - 1, len(value)) except ATT_Error as error:
response = ATT_Read_Response(attribute_value=value[:value_size]) response = ATT_Error_Response(
request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle,
error_code=error.error_code,
)
else:
value_size = min(connection.att_mtu - 1, len(value))
response = ATT_Read_Response(attribute_value=value[:value_size])
else: else:
response = ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
@@ -705,29 +726,36 @@ class Server(EventEmitter):
''' '''
if attribute := self.get_attribute(request.attribute_handle): if attribute := self.get_attribute(request.attribute_handle):
# TODO: check permissions try:
value = attribute.read_value(connection) value = attribute.read_value(connection)
if request.value_offset > len(value): except ATT_Error as error:
response = 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_INVALID_OFFSET_ERROR, error_code=error.error_code,
)
elif len(value) <= connection.att_mtu - 1:
response = ATT_Error_Response(
request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle,
error_code=ATT_ATTRIBUTE_NOT_LONG_ERROR,
) )
else: else:
part_size = min( if request.value_offset > len(value):
connection.att_mtu - 1, len(value) - request.value_offset response = ATT_Error_Response(
) request_opcode_in_error=request.op_code,
response = ATT_Read_Blob_Response( attribute_handle_in_error=request.attribute_handle,
part_attribute_value=value[ error_code=ATT_INVALID_OFFSET_ERROR,
request.value_offset : request.value_offset + part_size )
] elif len(value) <= connection.att_mtu - 1:
) response = ATT_Error_Response(
request_opcode_in_error=request.op_code,
attribute_handle_in_error=request.attribute_handle,
error_code=ATT_ATTRIBUTE_NOT_LONG_ERROR,
)
else:
part_size = min(
connection.att_mtu - 1, len(value) - request.value_offset
)
response = ATT_Read_Blob_Response(
part_attribute_value=value[
request.value_offset : request.value_offset + part_size
]
)
else: else:
response = ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
@@ -743,7 +771,6 @@ class Server(EventEmitter):
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,
GATT_INCLUDE_ATTRIBUTE_TYPE,
): ):
response = ATT_Error_Response( response = ATT_Error_Response(
request_opcode_in_error=request.op_code, request_opcode_in_error=request.op_code,
@@ -763,8 +790,10 @@ class Server(EventEmitter):
and attribute.handle <= request.ending_handle and attribute.handle <= request.ending_handle
and pdu_space_available and pdu_space_available
): ):
# Check the attribute value size # No need to catch permission errors here, since these attributes
# must all be world-readable
attribute_value = attribute.read_value(connection) attribute_value = attribute.read_value(connection)
# Check the attribute value size
max_attribute_size = min(connection.att_mtu - 6, 251) max_attribute_size = min(connection.att_mtu - 6, 251)
if len(attribute_value) > max_attribute_size: if len(attribute_value) > max_attribute_size:
# We need to truncate # We need to truncate

View File

@@ -15,12 +15,14 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import struct import struct
import collections import collections
import logging import logging
import functools import functools
from colors import color from typing import Dict, Type, Union
from .colors import color
from .core import ( from .core import (
BT_BR_EDR_TRANSPORT, BT_BR_EDR_TRANSPORT,
AdvertisingData, AdvertisingData,
@@ -1419,7 +1421,11 @@ class HCI_Constant:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class HCI_Error(ProtocolError): class HCI_Error(ProtocolError):
def __init__(self, error_code): def __init__(self, error_code):
super().__init__(error_code, 'hci', HCI_Constant.error_name(error_code)) super().__init__(
error_code,
error_namespace='hci',
error_name=HCI_Constant.error_name(error_code),
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -1638,8 +1644,8 @@ class HCI_Object:
# Map the value if needed # Map the value if needed
if value_mappers: if value_mappers:
value_mapper = value_mappers.get(key, value_mapper) value_mapper = value_mappers.get(key, value_mapper)
if value_mapper is not None: if value_mapper is not None:
value = value_mapper(value) value = value_mapper(value)
# Get the string representation of the value # Get the string representation of the value
value_str = HCI_Object.format_field_value( value_str = HCI_Object.format_field_value(
@@ -1690,6 +1696,11 @@ class Address:
RANDOM_IDENTITY_ADDRESS: 'RANDOM_IDENTITY_ADDRESS', RANDOM_IDENTITY_ADDRESS: 'RANDOM_IDENTITY_ADDRESS',
} }
# Type declarations
NIL: Address
ANY: Address
ANY_RANDOM: Address
# pylint: disable-next=unnecessary-lambda # pylint: disable-next=unnecessary-lambda
ADDRESS_TYPE_SPEC = {'size': 1, 'mapper': lambda x: Address.address_type_name(x)} ADDRESS_TYPE_SPEC = {'size': 1, 'mapper': lambda x: Address.address_type_name(x)}
@@ -1722,7 +1733,9 @@ class Address:
address_type = data[offset - 1] address_type = data[offset - 1]
return Address.parse_address_with_type(data, offset, address_type) return Address.parse_address_with_type(data, offset, address_type)
def __init__(self, address, address_type=RANDOM_DEVICE_ADDRESS): def __init__(
self, address: Union[bytes, str], address_type: int = RANDOM_DEVICE_ADDRESS
):
''' '''
Initialize an instance. `address` may be a byte array in little-endian Initialize an instance. `address` may be a byte array in little-endian
format, or a hex string in big-endian format (with optional ':' format, or a hex string in big-endian format (with optional ':'
@@ -1807,6 +1820,7 @@ class Address:
# Predefined address values # Predefined address values
Address.NIL = Address(b"\xff\xff\xff\xff\xff\xff", Address.PUBLIC_DEVICE_ADDRESS) Address.NIL = Address(b"\xff\xff\xff\xff\xff\xff", Address.PUBLIC_DEVICE_ADDRESS)
Address.ANY = Address(b"\x00\x00\x00\x00\x00\x00", Address.PUBLIC_DEVICE_ADDRESS) Address.ANY = Address(b"\x00\x00\x00\x00\x00\x00", Address.PUBLIC_DEVICE_ADDRESS)
Address.ANY_RANDOM = Address(b"\x00\x00\x00\x00\x00\x00", Address.RANDOM_DEVICE_ADDRESS)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class OwnAddressType: class OwnAddressType:
@@ -1836,6 +1850,8 @@ class HCI_Packet:
Abstract Base class for HCI packets Abstract Base class for HCI packets
''' '''
hci_packet_type: int
@staticmethod @staticmethod
def from_bytes(packet): def from_bytes(packet):
packet_type = packet[0] packet_type = packet[0]
@@ -1854,6 +1870,9 @@ class HCI_Packet:
def __init__(self, name): def __init__(self, name):
self.name = name self.name = name
def __bytes__(self) -> bytes:
raise NotImplementedError
def __repr__(self) -> str: def __repr__(self) -> str:
return self.name return self.name
@@ -1865,6 +1884,9 @@ class HCI_CustomPacket(HCI_Packet):
self.hci_packet_type = payload[0] self.hci_packet_type = payload[0]
self.payload = payload self.payload = payload
def __bytes__(self) -> bytes:
return self.payload
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class HCI_Command(HCI_Packet): class HCI_Command(HCI_Packet):
@@ -1873,7 +1895,7 @@ class HCI_Command(HCI_Packet):
''' '''
hci_packet_type = HCI_COMMAND_PACKET hci_packet_type = HCI_COMMAND_PACKET
command_classes = {} command_classes: Dict[int, Type[HCI_Command]] = {}
@staticmethod @staticmethod
def command(fields=(), return_parameters_fields=()): def command(fields=(), return_parameters_fields=()):
@@ -3104,6 +3126,16 @@ class HCI_LE_Read_Remote_Features_Command(HCI_Command):
''' '''
# -----------------------------------------------------------------------------
@HCI_Command.command(
return_parameters_fields=[("status", STATUS_SPEC), ("random_number", 8)]
)
class HCI_LE_Rand_Command(HCI_Command):
"""
See Bluetooth spec @ 7.8.23 LE Rand Command
"""
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@HCI_Command.command( @HCI_Command.command(
[ [
@@ -4009,8 +4041,8 @@ class HCI_Event(HCI_Packet):
''' '''
hci_packet_type = HCI_EVENT_PACKET hci_packet_type = HCI_EVENT_PACKET
event_classes = {} event_classes: Dict[int, Type[HCI_Event]] = {}
meta_event_classes = {} meta_event_classes: Dict[int, Type[HCI_LE_Meta_Event]] = {}
@staticmethod @staticmethod
def event(fields=()): def event(fields=()):

View File

@@ -16,8 +16,8 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import logging import logging
from colors import color
from .colors import color
from .att import ATT_CID, ATT_PDU from .att import ATT_CID, ATT_PDU
from .smp import SMP_CID, SMP_Command from .smp import SMP_CID, SMP_Command
from .core import name_or_number from .core import name_or_number

View File

@@ -18,7 +18,8 @@
import logging import logging
import asyncio import asyncio
import collections import collections
from colors import color
from .colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------

View File

@@ -20,9 +20,9 @@ import collections
import logging import logging
import struct import struct
from colors import color from bumble.colors import color
from bumble.l2cap import L2CAP_PDU from bumble.l2cap import L2CAP_PDU
from bumble.snoop import Snooper
from .hci import ( from .hci import (
HCI_ACL_DATA_PACKET, HCI_ACL_DATA_PACKET,
@@ -134,6 +134,7 @@ class Host(AbortableEventEmitter):
self.long_term_key_provider = None self.long_term_key_provider = None
self.link_key_provider = None self.link_key_provider = None
self.pairing_io_capability_provider = None # Classic only self.pairing_io_capability_provider = None # Classic only
self.snooper = None
# Connect to the source and sink if specified # Connect to the source and sink if specified
if controller_source: if controller_source:
@@ -141,7 +142,7 @@ class Host(AbortableEventEmitter):
if controller_sink: if controller_sink:
self.set_packet_sink(controller_sink) self.set_packet_sink(controller_sink)
async def flush(self): async def flush(self) -> None:
# Make sure no command is pending # Make sure no command is pending
await self.command_semaphore.acquire() await self.command_semaphore.acquire()
@@ -274,6 +275,9 @@ class Host(AbortableEventEmitter):
self.hci_sink = sink self.hci_sink = sink
def send_hci_packet(self, packet): def send_hci_packet(self, packet):
if self.snooper:
self.snooper.snoop(bytes(packet), Snooper.Direction.HOST_TO_CONTROLLER)
self.hci_sink.on_packet(packet.to_bytes()) self.hci_sink.on_packet(packet.to_bytes())
async def send_command(self, command, check_result=False): async def send_command(self, command, check_result=False):
@@ -420,6 +424,9 @@ class Host(AbortableEventEmitter):
def on_hci_packet(self, packet): def on_hci_packet(self, packet):
logger.debug(f'{color("### CONTROLLER -> HOST", "green")}: {packet}') logger.debug(f'{color("### CONTROLLER -> HOST", "green")}: {packet}')
if self.snooper:
self.snooper.snoop(bytes(packet), Snooper.Direction.CONTROLLER_TO_HOST)
# If the packet is a command, invoke the handler for this packet # If the packet is a command, invoke the handler for this packet
if packet.hci_packet_type == HCI_COMMAND_PACKET: if packet.hci_packet_type == HCI_COMMAND_PACKET:
self.on_hci_command_packet(packet) self.on_hci_command_packet(packet)
@@ -660,7 +667,7 @@ class Host(AbortableEventEmitter):
connection_handle=event.connection_handle, connection_handle=event.connection_handle,
interval_min=event.interval_min, interval_min=event.interval_min,
interval_max=event.interval_max, interval_max=event.interval_max,
latency=event.latency, max_latency=event.max_latency,
timeout=event.timeout, timeout=event.timeout,
min_ce_length=0, min_ce_length=0,
max_ce_length=0, max_ce_length=0,

View File

@@ -24,8 +24,9 @@ import asyncio
import logging import logging
import os import os
import json import json
from colors import color from typing import Optional
from .colors import color
from .hci import Address from .hci import Address
@@ -129,7 +130,7 @@ class PairingKeys:
for (key_property, key_value) in value.items(): for (key_property, key_value) in value.items():
print(f'{prefix} {color(key_property, "green")}: {key_value}') print(f'{prefix} {color(key_property, "green")}: {key_value}')
else: else:
print(f'{prefix}{color(property, "cyan")}: {value}') print(f'{prefix}{color(container_property, "cyan")}: {value}')
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -216,7 +217,7 @@ class JsonKeyStore(KeyStore):
params = device_config.keystore.split(':', 1)[1:] params = device_config.keystore.split(':', 1)[1:]
namespace = str(device_config.address) namespace = str(device_config.address)
if params: if params:
filename = params[1] filename = params[0]
else: else:
filename = None filename = None
@@ -242,7 +243,7 @@ class JsonKeyStore(KeyStore):
# Atomically replace the previous file # Atomically replace the previous file
os.rename(temp_filename, self.filename) os.rename(temp_filename, self.filename)
async def delete(self, name): async def delete(self, name: str) -> None:
db = await self.load() db = await self.load()
namespace = db.get(self.namespace) namespace = db.get(self.namespace)
@@ -278,7 +279,7 @@ class JsonKeyStore(KeyStore):
await self.save(db) await self.save(db)
async def get(self, name): async def get(self, name: str) -> Optional[PairingKeys]:
db = await self.load() db = await self.load()
namespace = db.get(self.namespace) namespace = db.get(self.namespace)

View File

@@ -15,14 +15,16 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import asyncio import asyncio
import logging import logging
import struct import struct
from collections import deque from collections import deque
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from typing import Dict, Type
from .colors import color
from .core import BT_CENTRAL_ROLE, InvalidStateError, ProtocolError from .core import BT_CENTRAL_ROLE, InvalidStateError, ProtocolError
from .hci import ( from .hci import (
HCI_LE_Connection_Update_Command, HCI_LE_Connection_Update_Command,
@@ -184,7 +186,7 @@ class L2CAP_Control_Frame:
See Bluetooth spec @ Vol 3, Part A - 4 SIGNALING PACKET FORMATS See Bluetooth spec @ Vol 3, Part A - 4 SIGNALING PACKET FORMATS
''' '''
classes = {} classes: Dict[int, Type[L2CAP_Control_Frame]] = {}
code = 0 code = 0
name = None name = None
@@ -383,7 +385,7 @@ class L2CAP_Connection_Response(L2CAP_Control_Frame):
CONNECTION_SUCCESSFUL = 0x0000 CONNECTION_SUCCESSFUL = 0x0000
CONNECTION_PENDING = 0x0001 CONNECTION_PENDING = 0x0001
CONNECTION_REFUSED_LE_PSM_NOT_SUPPORTED = 0x0002 CONNECTION_REFUSED_PSM_NOT_SUPPORTED = 0x0002
CONNECTION_REFUSED_SECURITY_BLOCK = 0x0003 CONNECTION_REFUSED_SECURITY_BLOCK = 0x0003
CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE = 0x0004 CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE = 0x0004
CONNECTION_REFUSED_INVALID_SOURCE_CID = 0x0006 CONNECTION_REFUSED_INVALID_SOURCE_CID = 0x0006
@@ -394,7 +396,7 @@ class L2CAP_Connection_Response(L2CAP_Control_Frame):
RESULT_NAMES = { RESULT_NAMES = {
CONNECTION_SUCCESSFUL: 'CONNECTION_SUCCESSFUL', CONNECTION_SUCCESSFUL: 'CONNECTION_SUCCESSFUL',
CONNECTION_PENDING: 'CONNECTION_PENDING', CONNECTION_PENDING: 'CONNECTION_PENDING',
CONNECTION_REFUSED_LE_PSM_NOT_SUPPORTED: 'CONNECTION_REFUSED_LE_PSM_NOT_SUPPORTED', CONNECTION_REFUSED_PSM_NOT_SUPPORTED: 'CONNECTION_REFUSED_PSM_NOT_SUPPORTED',
CONNECTION_REFUSED_SECURITY_BLOCK: 'CONNECTION_REFUSED_SECURITY_BLOCK', CONNECTION_REFUSED_SECURITY_BLOCK: 'CONNECTION_REFUSED_SECURITY_BLOCK',
CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE: 'CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE', CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE: 'CONNECTION_REFUSED_NO_RESOURCES_AVAILABLE',
CONNECTION_REFUSED_INVALID_SOURCE_CID: 'CONNECTION_REFUSED_INVALID_SOURCE_CID', CONNECTION_REFUSED_INVALID_SOURCE_CID: 'CONNECTION_REFUSED_INVALID_SOURCE_CID',
@@ -1619,7 +1621,7 @@ class ChannelManager:
destination_cid=request.source_cid, destination_cid=request.source_cid,
source_cid=0, source_cid=0,
# pylint: disable=line-too-long # pylint: disable=line-too-long
result=L2CAP_Connection_Response.CONNECTION_REFUSED_LE_PSM_NOT_SUPPORTED, result=L2CAP_Connection_Response.CONNECTION_REFUSED_PSM_NOT_SUPPORTED,
status=0x0000, status=0x0000,
), ),
) )

View File

@@ -19,9 +19,7 @@ import logging
import asyncio import asyncio
from functools import partial from functools import partial
from colors import color from bumble.colors import color
import websockets
from bumble.hci import ( from bumble.hci import (
Address, Address,
HCI_SUCCESS, HCI_SUCCESS,
@@ -220,6 +218,8 @@ class RemoteLink:
) )
async def run_connection(self): async def run_connection(self):
import websockets # lazy import
# Connect to the relay # Connect to the relay
logger.debug(f'connecting to {self.uri}') logger.debug(f'connecting to {self.uri}')
# pylint: disable-next=no-member # pylint: disable-next=no-member

View File

@@ -31,6 +31,7 @@ from ..gatt import (
Characteristic, Characteristic,
CharacteristicValue, CharacteristicValue,
) )
from ..device import Device
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -50,9 +51,13 @@ class AshaService(TemplateService):
SUPPORTED_CODEC_ID = [0x02, 0x01] # Codec IDs [G.722 at 16 kHz] SUPPORTED_CODEC_ID = [0x02, 0x01] # Codec IDs [G.722 at 16 kHz]
RENDER_DELAY = [00, 00] RENDER_DELAY = [00, 00]
def __init__(self, capability: int, hisyncid: List[int]): def __init__(self, capability: int, hisyncid: List[int], device: Device, psm=0):
self.hisyncid = hisyncid self.hisyncid = hisyncid
self.capability = capability # Device Capabilities [Left, Monaural] self.capability = capability # Device Capabilities [Left, Monaural]
self.device = device
self.emitted_data_name = 'ASHA_data_' + str(self.capability)
self.audio_out_data = b''
self.psm = psm # a non-zero psm is mainly for testing purpose
# Handler for volume control # Handler for volume control
def on_volume_write(_connection, value): def on_volume_write(_connection, value):
@@ -116,9 +121,18 @@ class AshaService(TemplateService):
CharacteristicValue(write=on_volume_write), CharacteristicValue(write=on_volume_write),
) )
# TODO add real psm value # Register an L2CAP CoC server
self.psm = 0x0080 def on_coc(channel):
# self.psm = device.register_l2cap_channel_server(0, on_coc, 8) def on_data(data):
logging.debug(f'<<< data received:{data}')
self.emit(self.emitted_data_name, data)
self.audio_out_data += data
channel.sink = on_data
# let the server find a free PSM
self.psm = self.device.register_l2cap_channel_server(self.psm, on_coc, 8)
self.le_psm_out_characteristic = Characteristic( self.le_psm_out_characteristic = Characteristic(
GATT_ASHA_LE_PSM_OUT_CHARACTERISTIC, GATT_ASHA_LE_PSM_OUT_CHARACTERISTIC,
Characteristic.READ, Characteristic.READ,

View File

@@ -17,7 +17,7 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
import struct import struct
from typing import Tuple from typing import Optional, Tuple
from ..gatt_client import ProfileServiceProxy from ..gatt_client import ProfileServiceProxy
from ..gatt import ( from ..gatt import (
@@ -52,14 +52,14 @@ class DeviceInformationService(TemplateService):
def __init__( def __init__(
self, self,
manufacturer_name: str = None, manufacturer_name: Optional[str] = None,
model_number: str = None, model_number: Optional[str] = None,
serial_number: str = None, serial_number: Optional[str] = None,
hardware_revision: str = None, hardware_revision: Optional[str] = None,
firmware_revision: str = None, firmware_revision: Optional[str] = None,
software_revision: str = None, software_revision: Optional[str] = None,
system_id: Tuple[int, int] = None, # (OUI, Manufacturer ID) system_id: Optional[Tuple[int, int]] = None, # (OUI, Manufacturer ID)
ieee_regulatory_certification_data_list: bytes = None ieee_regulatory_certification_data_list: Optional[bytes] = None
# TODO: pnp_id # TODO: pnp_id
): ):
characteristics = [ characteristics = [

0
bumble/profiles/py.typed Normal file
View File

0
bumble/py.typed Normal file
View File

View File

@@ -18,10 +18,10 @@
import logging import logging
import asyncio import asyncio
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from . import core from . import core
from .colors import color
from .core import BT_BR_EDR_TRANSPORT, InvalidStateError, ProtocolError from .core import BT_BR_EDR_TRANSPORT, InvalidStateError, ProtocolError
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------

View File

@@ -15,12 +15,13 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import logging import logging
import struct import struct
from colors import color from typing import Dict, List, Type
import colors
from . import core from . import core
from .colors import color
from .core import InvalidStateError from .core import InvalidStateError
from .hci import HCI_Object, name_or_number, key_with_value from .hci import HCI_Object, name_or_number, key_with_value
@@ -181,63 +182,63 @@ class DataElement:
raise ValueError('integer types must have a value size specified') raise ValueError('integer types must have a value size specified')
@staticmethod @staticmethod
def nil(): def nil() -> DataElement:
return DataElement(DataElement.NIL, None) return DataElement(DataElement.NIL, None)
@staticmethod @staticmethod
def unsigned_integer(value, value_size): def unsigned_integer(value: int, value_size: int) -> DataElement:
return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size) return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size)
@staticmethod @staticmethod
def unsigned_integer_8(value): def unsigned_integer_8(value: int) -> DataElement:
return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=1) return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=1)
@staticmethod @staticmethod
def unsigned_integer_16(value): def unsigned_integer_16(value: int) -> DataElement:
return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=2) return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=2)
@staticmethod @staticmethod
def unsigned_integer_32(value): def unsigned_integer_32(value: int) -> DataElement:
return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=4) return DataElement(DataElement.UNSIGNED_INTEGER, value, value_size=4)
@staticmethod @staticmethod
def signed_integer(value, value_size): def signed_integer(value: int, value_size: int) -> DataElement:
return DataElement(DataElement.SIGNED_INTEGER, value, value_size) return DataElement(DataElement.SIGNED_INTEGER, value, value_size)
@staticmethod @staticmethod
def signed_integer_8(value): def signed_integer_8(value: int) -> DataElement:
return DataElement(DataElement.SIGNED_INTEGER, value, value_size=1) return DataElement(DataElement.SIGNED_INTEGER, value, value_size=1)
@staticmethod @staticmethod
def signed_integer_16(value): def signed_integer_16(value: int) -> DataElement:
return DataElement(DataElement.SIGNED_INTEGER, value, value_size=2) return DataElement(DataElement.SIGNED_INTEGER, value, value_size=2)
@staticmethod @staticmethod
def signed_integer_32(value): def signed_integer_32(value: int) -> DataElement:
return DataElement(DataElement.SIGNED_INTEGER, value, value_size=4) return DataElement(DataElement.SIGNED_INTEGER, value, value_size=4)
@staticmethod @staticmethod
def uuid(value): def uuid(value: core.UUID) -> DataElement:
return DataElement(DataElement.UUID, value) return DataElement(DataElement.UUID, value)
@staticmethod @staticmethod
def text_string(value): def text_string(value: str) -> DataElement:
return DataElement(DataElement.TEXT_STRING, value) return DataElement(DataElement.TEXT_STRING, value)
@staticmethod @staticmethod
def boolean(value): def boolean(value: bool) -> DataElement:
return DataElement(DataElement.BOOLEAN, value) return DataElement(DataElement.BOOLEAN, value)
@staticmethod @staticmethod
def sequence(value): def sequence(value: List[DataElement]) -> DataElement:
return DataElement(DataElement.SEQUENCE, value) return DataElement(DataElement.SEQUENCE, value)
@staticmethod @staticmethod
def alternative(value): def alternative(value: List[DataElement]) -> DataElement:
return DataElement(DataElement.ALTERNATIVE, value) return DataElement(DataElement.ALTERNATIVE, value)
@staticmethod @staticmethod
def url(value): def url(value: str) -> DataElement:
return DataElement(DataElement.URL, value) return DataElement(DataElement.URL, value)
@staticmethod @staticmethod
@@ -456,7 +457,7 @@ class DataElement:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class ServiceAttribute: class ServiceAttribute:
def __init__(self, attribute_id, value): def __init__(self, attribute_id: int, value: DataElement) -> None:
self.id = attribute_id self.id = attribute_id
self.value = value self.value = value
@@ -504,7 +505,7 @@ class ServiceAttribute:
def to_string(self, with_colors=False): def to_string(self, with_colors=False):
if with_colors: if with_colors:
return ( return (
f'Attribute(id={colors.color(self.id_name(self.id),"magenta")},' f'Attribute(id={color(self.id_name(self.id),"magenta")},'
f'value={self.value})' f'value={self.value})'
) )
@@ -520,7 +521,7 @@ class SDP_PDU:
See Bluetooth spec @ Vol 3, Part B - 4.2 PROTOCOL DATA UNIT FORMAT See Bluetooth spec @ Vol 3, Part B - 4.2 PROTOCOL DATA UNIT FORMAT
''' '''
sdp_pdu_classes = {} sdp_pdu_classes: Dict[int, Type[SDP_PDU]] = {}
name = None name = None
pdu_id = 0 pdu_id = 0

View File

@@ -22,12 +22,15 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import logging import logging
import asyncio import asyncio
import secrets import secrets
from pyee import EventEmitter from typing import Dict, Optional, Type
from colors import color
from pyee import EventEmitter
from .colors import color
from .hci import Address, HCI_LE_Enable_Encryption_Command, HCI_Object, key_with_value from .hci import Address, HCI_LE_Enable_Encryption_Command, HCI_Object, key_with_value
from .core import ( from .core import (
BT_BR_EDR_TRANSPORT, BT_BR_EDR_TRANSPORT,
@@ -184,7 +187,7 @@ class SMP_Command:
See Bluetooth spec @ Vol 3, Part H - 3 SECURITY MANAGER PROTOCOL See Bluetooth spec @ Vol 3, Part H - 3 SECURITY MANAGER PROTOCOL
''' '''
smp_classes = {} smp_classes: Dict[int, Type[SMP_Command]] = {}
code = 0 code = 0
name = '' name = ''
@@ -495,33 +498,35 @@ class PairingDelegate:
DISPLAY_OUTPUT_ONLY = SMP_DISPLAY_ONLY_IO_CAPABILITY DISPLAY_OUTPUT_ONLY = SMP_DISPLAY_ONLY_IO_CAPABILITY
DISPLAY_OUTPUT_AND_YES_NO_INPUT = SMP_DISPLAY_YES_NO_IO_CAPABILITY DISPLAY_OUTPUT_AND_YES_NO_INPUT = SMP_DISPLAY_YES_NO_IO_CAPABILITY
DISPLAY_OUTPUT_AND_KEYBOARD_INPUT = SMP_KEYBOARD_DISPLAY_IO_CAPABILITY DISPLAY_OUTPUT_AND_KEYBOARD_INPUT = SMP_KEYBOARD_DISPLAY_IO_CAPABILITY
DEFAULT_KEY_DISTRIBUTION = ( DEFAULT_KEY_DISTRIBUTION: int = (
SMP_ENC_KEY_DISTRIBUTION_FLAG | SMP_ID_KEY_DISTRIBUTION_FLAG SMP_ENC_KEY_DISTRIBUTION_FLAG | SMP_ID_KEY_DISTRIBUTION_FLAG
) )
def __init__( def __init__(
self, self,
io_capability=NO_OUTPUT_NO_INPUT, io_capability: int = NO_OUTPUT_NO_INPUT,
local_initiator_key_distribution=DEFAULT_KEY_DISTRIBUTION, local_initiator_key_distribution: int = DEFAULT_KEY_DISTRIBUTION,
local_responder_key_distribution=DEFAULT_KEY_DISTRIBUTION, local_responder_key_distribution: int = DEFAULT_KEY_DISTRIBUTION,
): ) -> None:
self.io_capability = io_capability self.io_capability = io_capability
self.local_initiator_key_distribution = local_initiator_key_distribution self.local_initiator_key_distribution = local_initiator_key_distribution
self.local_responder_key_distribution = local_responder_key_distribution self.local_responder_key_distribution = local_responder_key_distribution
async def accept(self): async def accept(self) -> bool:
return True return True
async def confirm(self): async def confirm(self) -> bool:
return True return True
async def compare_numbers(self, _number, _digits=6): # pylint: disable-next=unused-argument
async def compare_numbers(self, number: int, digits: int) -> bool:
return True return True
async def get_number(self): async def get_number(self) -> int:
return 0 return 0
async def display_number(self, _number, _digits=6): # pylint: disable-next=unused-argument
async def display_number(self, number: int, digits: int) -> None:
pass pass
async def key_distribution_response( async def key_distribution_response(
@@ -535,7 +540,13 @@ class PairingDelegate:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class PairingConfig: class PairingConfig:
def __init__(self, sc=True, mitm=True, bonding=True, delegate=None): def __init__(
self,
sc: bool = True,
mitm: bool = True,
bonding: bool = True,
delegate: Optional[PairingDelegate] = None,
) -> None:
self.sc = sc self.sc = sc
self.mitm = mitm self.mitm = mitm
self.bonding = bonding self.bonding = bonding
@@ -652,7 +663,8 @@ class Session:
self.peer_expected_distributions = [] self.peer_expected_distributions = []
self.dh_key = None self.dh_key = None
self.confirm_value = None self.confirm_value = None
self.passkey = 0 self.passkey = None
self.passkey_ready = asyncio.Event()
self.passkey_step = 0 self.passkey_step = 0
self.passkey_display = False self.passkey_display = False
self.pairing_method = 0 self.pairing_method = 0
@@ -830,6 +842,7 @@ class Session:
# Generate random Passkey/PIN code # Generate random Passkey/PIN code
self.passkey = secrets.randbelow(1000000) self.passkey = secrets.randbelow(1000000)
logger.debug(f'Pairing PIN CODE: {self.passkey:06}') logger.debug(f'Pairing PIN CODE: {self.passkey:06}')
self.passkey_ready.set()
# The value of TK is computed from the PIN code # The value of TK is computed from the PIN code
if not self.sc: if not self.sc:
@@ -850,6 +863,8 @@ class Session:
self.tk = passkey.to_bytes(16, byteorder='little') self.tk = passkey.to_bytes(16, byteorder='little')
logger.debug(f'TK from passkey = {self.tk.hex()}') logger.debug(f'TK from passkey = {self.tk.hex()}')
self.passkey_ready.set()
if next_steps is not None: if next_steps is not None:
next_steps() next_steps()
@@ -901,17 +916,29 @@ class Session:
logger.debug(f'generated random: {self.r.hex()}') logger.debug(f'generated random: {self.r.hex()}')
if self.sc: if self.sc:
if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON):
z = 0
elif self.pairing_method == self.PASSKEY:
z = 0x80 + ((self.passkey >> self.passkey_step) & 1)
else:
return
if self.is_initiator: async def next_steps():
confirm_value = crypto.f4(self.pka, self.pkb, self.r, bytes([z])) if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON):
else: z = 0
confirm_value = crypto.f4(self.pkb, self.pka, self.r, bytes([z])) elif self.pairing_method == self.PASSKEY:
# We need a passkey
await self.passkey_ready.wait()
z = 0x80 + ((self.passkey >> self.passkey_step) & 1)
else:
return
if self.is_initiator:
confirm_value = crypto.f4(self.pka, self.pkb, self.r, bytes([z]))
else:
confirm_value = crypto.f4(self.pkb, self.pka, self.r, bytes([z]))
self.send_command(
SMP_Pairing_Confirm_Command(confirm_value=confirm_value)
)
# Perform the next steps asynchronously in case we need to wait for input
self.connection.abort_on('disconnection', next_steps())
else: else:
confirm_value = crypto.c1( confirm_value = crypto.c1(
self.tk, self.tk,
@@ -924,7 +951,7 @@ class Session:
self.ra, self.ra,
) )
self.send_command(SMP_Pairing_Confirm_Command(confirm_value=confirm_value)) self.send_command(SMP_Pairing_Confirm_Command(confirm_value=confirm_value))
def send_pairing_random_command(self): def send_pairing_random_command(self):
self.send_command(SMP_Pairing_Random_Command(random_value=self.r)) self.send_command(SMP_Pairing_Random_Command(random_value=self.r))
@@ -1355,8 +1382,8 @@ class Session:
# Start phase 2 # Start phase 2
if self.sc: if self.sc:
if self.pairing_method == self.PASSKEY and self.passkey_display: if self.pairing_method == self.PASSKEY:
self.display_passkey() self.display_or_input_passkey()
self.send_public_key_command() self.send_public_key_command()
else: else:
@@ -1417,18 +1444,22 @@ class Session:
else: else:
srand = self.r srand = self.r
mrand = command.random_value mrand = command.random_value
stk = crypto.s1(self.tk, srand, mrand) self.stk = crypto.s1(self.tk, srand, mrand)
logger.debug(f'STK = {stk.hex()}') logger.debug(f'STK = {self.stk.hex()}')
# Generate LTK # Generate LTK
self.ltk = crypto.r() self.ltk = crypto.r()
if self.is_initiator: if self.is_initiator:
self.start_encryption(stk) self.start_encryption(self.stk)
else: else:
self.send_pairing_random_command() self.send_pairing_random_command()
def on_smp_pairing_random_command_secure_connections(self, command): def on_smp_pairing_random_command_secure_connections(self, command):
if self.pairing_method == self.PASSKEY and self.passkey is None:
logger.warning('no passkey entered, ignoring command')
return
# pylint: disable=too-many-return-statements # pylint: disable=too-many-return-statements
if self.is_initiator: if self.is_initiator:
if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON): if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON):
@@ -1556,17 +1587,13 @@ class Session:
logger.debug(f'DH key: {self.dh_key.hex()}') logger.debug(f'DH key: {self.dh_key.hex()}')
if self.is_initiator: if self.is_initiator:
if self.pairing_method == self.PASSKEY: self.send_pairing_confirm_command()
if self.passkey_display:
self.send_pairing_confirm_command()
else:
self.input_passkey(self.send_pairing_confirm_command)
else: else:
# Send our public key back to the initiator
if self.pairing_method == self.PASSKEY: if self.pairing_method == self.PASSKEY:
self.display_or_input_passkey(self.send_public_key_command) self.display_or_input_passkey()
else:
self.send_public_key_command() # Send our public key back to the initiator
self.send_public_key_command()
if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON): if self.pairing_method in (self.JUST_WORKS, self.NUMERIC_COMPARISON):
# We can now send the confirmation value # We can now send the confirmation value

170
bumble/snoop.py Normal file
View File

@@ -0,0 +1,170 @@
# Copyright 2021-2023 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
# -----------------------------------------------------------------------------
from contextlib import contextmanager
from enum import IntEnum
import logging
import struct
import datetime
from typing import BinaryIO, Generator
import os
from bumble.hci import HCI_COMMAND_PACKET, HCI_EVENT_PACKET
# -----------------------------------------------------------------------------
# Logging
# -----------------------------------------------------------------------------
logger = logging.getLogger(__name__)
# -----------------------------------------------------------------------------
# Classes
# -----------------------------------------------------------------------------
class Snooper:
"""
Base class for snooper implementations.
A snooper is an object that will be provided with HCI packets as they are
exchanged between a host and a controller.
"""
class Direction(IntEnum):
HOST_TO_CONTROLLER = 0
CONTROLLER_TO_HOST = 1
class DataLinkType(IntEnum):
H1 = 1001
H4 = 1002
HCI_BSCP = 1003
H5 = 1004
def snoop(self, hci_packet: bytes, direction: Direction) -> None:
"""Snoop on an HCI packet."""
# -----------------------------------------------------------------------------
class BtSnooper(Snooper):
"""
Snooper that saves HCI packets using the BTSnoop format, based on RFC 1761.
"""
IDENTIFICATION_PATTERN = b'btsnoop\0'
TIMESTAMP_ANCHOR = datetime.datetime(2000, 1, 1)
TIMESTAMP_DELTA = 0x00E03AB44A676000
ONE_MS = datetime.timedelta(microseconds=1)
def __init__(self, output: BinaryIO):
self.output = output
# Write the header
self.output.write(
self.IDENTIFICATION_PATTERN + struct.pack('>LL', 1, self.DataLinkType.H4)
)
def snoop(self, hci_packet: bytes, direction: Snooper.Direction) -> None:
flags = int(direction)
packet_type = hci_packet[0]
if packet_type in (HCI_EVENT_PACKET, HCI_COMMAND_PACKET):
flags |= 0x10
# Compute the current timestamp
timestamp = (
int((datetime.datetime.utcnow() - self.TIMESTAMP_ANCHOR) / self.ONE_MS)
+ self.TIMESTAMP_DELTA
)
# Emit the record
self.output.write(
struct.pack(
'>IIIIQ',
len(hci_packet), # Original Length
len(hci_packet), # Included Length
flags, # Packet Flags
0, # Cumulative Drops
timestamp, # Timestamp
)
+ hci_packet
)
# -----------------------------------------------------------------------------
_SNOOPER_INSTANCE_COUNT = 0
@contextmanager
def create_snooper(spec: str) -> Generator[Snooper, None, None]:
"""
Create a snooper given a specification string.
The general syntax for the specification string is:
<snooper-type>:<type-specific-arguments>
Supported snooper types are:
btsnoop
The syntax for the type-specific arguments for this type is:
<io-type>:<io-type-specific-arguments>
Supported I/O types are:
file
The type-specific arguments for this I/O type is a string that is converted
to a file path using the python `str.format()` string formatting. The log
records will be written to that file if it can be opened/created.
The keyword args that may be referenced by the string pattern are:
now: the value of `datetime.now()`
utcnow: the value of `datetime.utcnow()`
pid: the current process ID.
instance: the instance ID in the current process.
Examples:
btsnoop:file:my_btsnoop.log
btsnoop:file:/tmp/bumble_{now:%Y-%m-%d-%H:%M:%S}_{pid}.log
"""
if ':' not in spec:
raise ValueError('snooper type prefix missing')
snooper_type, snooper_args = spec.split(':', maxsplit=1)
if snooper_type == 'btsnoop':
if ':' not in snooper_args:
raise ValueError('I/O type for btsnoop snooper type missing')
io_type, io_name = snooper_args.split(':', maxsplit=1)
if io_type == 'file':
# Process the file name string pattern.
global _SNOOPER_INSTANCE_COUNT
file_path = io_name.format(
now=datetime.datetime.now(),
utcnow=datetime.datetime.utcnow(),
pid=os.getpid(),
instance=_SNOOPER_INSTANCE_COUNT,
)
# Open the file
logger.debug(f'Snoop file: {file_path}')
with open(file_path, 'wb') as snoop_file:
_SNOOPER_INSTANCE_COUNT += 1
yield BtSnooper(snoop_file)
_SNOOPER_INSTANCE_COUNT -= 1
return
raise ValueError(f'I/O type {io_type} not supported')
raise ValueError(f'snooper type {snooper_type} not found')

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.
@@ -15,11 +15,13 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from contextlib import asynccontextmanager
import logging import logging
import os
from .common import Transport, AsyncPipeSink from .common import Transport, AsyncPipeSink, SnoopingTransport
from ..link import RemoteLink
from ..controller import Controller from ..controller import Controller
from ..snoop import create_snooper
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -28,13 +30,52 @@ logger = logging.getLogger(__name__)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def open_transport(name): def _wrap_transport(transport: Transport) -> Transport:
''' """
Automatically wrap a Transport instance when a wrapping class can be inferred
from the environment.
If no wrapping class is applicable, the transport argument is returned as-is.
"""
# If BUMBLE_SNOOPER is set, try to automatically create a snooper.
if snooper_spec := os.getenv('BUMBLE_SNOOPER'):
try:
return SnoopingTransport.create_with(
transport, create_snooper(snooper_spec)
)
except Exception as exc:
logger.warning(f'Exception while creating snooper: {exc}')
return transport
# -----------------------------------------------------------------------------
async def open_transport(name: str) -> Transport:
"""
Open a transport by name. Open a transport by name.
The name must be <type>:<parameters> The name must be <type>:<parameters>
Where <parameters> depend on the type (and may be empty for some types). Where <parameters> depend on the type (and may be empty for some types).
The supported types are: serial,udp,tcp,pty,usb The supported types are:
''' * serial
* udp
* tcp-client
* tcp-server
* ws-client
* ws-server
* pty
* file
* vhci
* hci-socket
* usb
* pyusb
* android-emulator
"""
return _wrap_transport(await _open_transport(name))
# -----------------------------------------------------------------------------
async def _open_transport(name: str) -> Transport:
# pylint: disable=import-outside-toplevel # pylint: disable=import-outside-toplevel
# pylint: disable=too-many-return-statements # pylint: disable=too-many-return-statements
@@ -108,8 +149,21 @@ async def open_transport(name):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
async def open_transport_or_link(name): async def open_transport_or_link(name: str) -> Transport:
"""
Open a transport or a link relay.
Args:
name:
Name of the transport or link relay to open.
When the name starts with "link-relay:", open a link relay (see RemoteLink
for details on what the arguments are).
For other namespaces, see `open_transport`.
"""
if name.startswith('link-relay:'): if name.startswith('link-relay:'):
from ..link import RemoteLink # lazy import
link = RemoteLink(name[11:]) link = RemoteLink(name[11:])
await link.wait_until_connected() await link.wait_until_connected()
controller = Controller('remote', link=link) controller = Controller('remote', link=link)
@@ -118,6 +172,6 @@ async def open_transport_or_link(name):
async def close(self): async def close(self):
link.close() link.close()
return LinkTransport(controller, AsyncPipeSink(controller)) return _wrap_transport(LinkTransport(controller, AsyncPipeSink(controller)))
return await open_transport(name) return await open_transport(name)

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.
@@ -20,9 +20,11 @@ import grpc
from .common import PumpedTransport, PumpedPacketSource, PumpedPacketSink from .common import PumpedTransport, PumpedPacketSource, PumpedPacketSink
from .emulated_bluetooth_pb2_grpc import EmulatedBluetoothServiceStub from .emulated_bluetooth_pb2_grpc import EmulatedBluetoothServiceStub
from .emulated_bluetooth_packets_pb2 import HCIPacket
from .emulated_bluetooth_vhci_pb2_grpc import VhciForwardingServiceStub from .emulated_bluetooth_vhci_pb2_grpc import VhciForwardingServiceStub
# pylint: disable-next=no-name-in-module
from .emulated_bluetooth_packets_pb2 import HCIPacket
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging

View File

@@ -15,12 +15,16 @@
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from __future__ import annotations
import contextlib
import struct import struct
import asyncio import asyncio
import logging import logging
from colors import color from typing import ContextManager
from .. import hci from .. import hci
from ..colors import color
from ..snoop import Snooper
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -246,6 +250,20 @@ class StreamPacketSink:
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
class Transport: class Transport:
"""
Base class for all transports.
A Transport represents a source and a sink together.
An instance must be closed by calling close() when no longer used. Instances
implement the ContextManager protocol so that they may be used in a `async with`
statement.
An instance is iterable. The iterator yields, in order, its source and sink, so
that it may be used with a convenient call syntax like:
async with create_transport() as (source, sink):
...
"""
def __init__(self, source, sink): def __init__(self, source, sink):
self.source = source self.source = source
self.sink = sink self.sink = sink
@@ -259,7 +277,7 @@ class Transport:
def __iter__(self): def __iter__(self):
return iter((self.source, self.sink)) return iter((self.source, self.sink))
async def close(self): async def close(self) -> None:
self.source.close() self.source.close()
self.sink.close() self.sink.close()
@@ -335,3 +353,60 @@ class PumpedTransport(Transport):
async def close(self): async def close(self):
await super().close() await super().close()
await self.close_function() await self.close_function()
# -----------------------------------------------------------------------------
class SnoopingTransport(Transport):
"""Transport wrapper that snoops on packets to/from a wrapped transport."""
@staticmethod
def create_with(
transport: Transport, snooper: ContextManager[Snooper]
) -> SnoopingTransport:
"""
Create an instance given a snooper that works as as context manager.
The returned instance will exit the snooper context when it is closed.
"""
with contextlib.ExitStack() as exit_stack:
return SnoopingTransport(
transport, exit_stack.enter_context(snooper), exit_stack.pop_all().close
)
raise RuntimeError('unexpected code path') # Satisfy the type checker
class Source:
def __init__(self, source, snooper):
self.source = source
self.snooper = snooper
self.sink = None
def set_packet_sink(self, sink):
self.sink = sink
self.source.set_packet_sink(self)
def on_packet(self, packet):
self.snooper.snoop(packet, Snooper.Direction.CONTROLLER_TO_HOST)
if self.sink:
self.sink.on_packet(packet)
class Sink:
def __init__(self, sink, snooper):
self.sink = sink
self.snooper = snooper
def on_packet(self, packet):
self.snooper.snoop(packet, Snooper.Direction.HOST_TO_CONTROLLER)
if self.sink:
self.sink.on_packet(packet)
def __init__(self, transport, snooper, close_snooper=None):
super().__init__(
self.Source(transport.source, snooper), self.Sink(transport.sink, snooper)
)
self.transport = transport
self.close_snooper = close_snooper
async def close(self):
await self.transport.close()
if self.close_snooper:
self.close_snooper()

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.
@@ -16,10 +16,9 @@
# Generated by the protocol buffer compiler. DO NOT EDIT! # Generated by the protocol buffer compiler. DO NOT EDIT!
# source: emulated_bluetooth_packets.proto # source: emulated_bluetooth_packets.proto
"""Generated protocol buffer code.""" """Generated protocol buffer code."""
from google.protobuf.internal import builder as _builder
from google.protobuf import descriptor as _descriptor from google.protobuf import descriptor as _descriptor
from google.protobuf import descriptor_pool as _descriptor_pool from google.protobuf import descriptor_pool as _descriptor_pool
from google.protobuf import message as _message
from google.protobuf import reflection as _reflection
from google.protobuf import symbol_database as _symbol_database from google.protobuf import symbol_database as _symbol_database
# @@protoc_insertion_point(imports) # @@protoc_insertion_point(imports)
@@ -31,20 +30,10 @@ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
b'\n emulated_bluetooth_packets.proto\x12\x1b\x61ndroid.emulation.bluetooth\"\xfb\x01\n\tHCIPacket\x12?\n\x04type\x18\x01 \x01(\x0e\x32\x31.android.emulation.bluetooth.HCIPacket.PacketType\x12\x0e\n\x06packet\x18\x02 \x01(\x0c\"\x9c\x01\n\nPacketType\x12\x1b\n\x17PACKET_TYPE_UNSPECIFIED\x10\x00\x12\x1b\n\x17PACKET_TYPE_HCI_COMMAND\x10\x01\x12\x13\n\x0fPACKET_TYPE_ACL\x10\x02\x12\x13\n\x0fPACKET_TYPE_SCO\x10\x03\x12\x15\n\x11PACKET_TYPE_EVENT\x10\x04\x12\x13\n\x0fPACKET_TYPE_ISO\x10\x05\x42J\n\x1f\x63om.android.emulation.bluetoothP\x01\xf8\x01\x01\xa2\x02\x03\x41\x45\x42\xaa\x02\x1b\x41ndroid.Emulation.Bluetoothb\x06proto3' b'\n emulated_bluetooth_packets.proto\x12\x1b\x61ndroid.emulation.bluetooth\"\xfb\x01\n\tHCIPacket\x12?\n\x04type\x18\x01 \x01(\x0e\x32\x31.android.emulation.bluetooth.HCIPacket.PacketType\x12\x0e\n\x06packet\x18\x02 \x01(\x0c\"\x9c\x01\n\nPacketType\x12\x1b\n\x17PACKET_TYPE_UNSPECIFIED\x10\x00\x12\x1b\n\x17PACKET_TYPE_HCI_COMMAND\x10\x01\x12\x13\n\x0fPACKET_TYPE_ACL\x10\x02\x12\x13\n\x0fPACKET_TYPE_SCO\x10\x03\x12\x15\n\x11PACKET_TYPE_EVENT\x10\x04\x12\x13\n\x0fPACKET_TYPE_ISO\x10\x05\x42J\n\x1f\x63om.android.emulation.bluetoothP\x01\xf8\x01\x01\xa2\x02\x03\x41\x45\x42\xaa\x02\x1b\x41ndroid.Emulation.Bluetoothb\x06proto3'
) )
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
_HCIPACKET = DESCRIPTOR.message_types_by_name['HCIPacket'] _builder.BuildTopDescriptorsAndMessages(
_HCIPACKET_PACKETTYPE = _HCIPACKET.enum_types_by_name['PacketType'] DESCRIPTOR, 'emulated_bluetooth_packets_pb2', globals()
HCIPacket = _reflection.GeneratedProtocolMessageType(
'HCIPacket',
(_message.Message,),
{
'DESCRIPTOR': _HCIPACKET,
'__module__': 'emulated_bluetooth_packets_pb2'
# @@protoc_insertion_point(class_scope:android.emulation.bluetooth.HCIPacket)
},
) )
_sym_db.RegisterMessage(HCIPacket)
if _descriptor._USE_C_DESCRIPTORS == False: if _descriptor._USE_C_DESCRIPTORS == False:
DESCRIPTOR._options = None DESCRIPTOR._options = None

View File

@@ -0,0 +1,41 @@
# Copyright 2021-2023 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 google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
from google.protobuf import descriptor as _descriptor
from google.protobuf import message as _message
from typing import ClassVar as _ClassVar, Optional as _Optional, Union as _Union
DESCRIPTOR: _descriptor.FileDescriptor
class HCIPacket(_message.Message):
__slots__ = ["packet", "type"]
class PacketType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = []
PACKET_FIELD_NUMBER: _ClassVar[int]
PACKET_TYPE_ACL: HCIPacket.PacketType
PACKET_TYPE_EVENT: HCIPacket.PacketType
PACKET_TYPE_HCI_COMMAND: HCIPacket.PacketType
PACKET_TYPE_ISO: HCIPacket.PacketType
PACKET_TYPE_SCO: HCIPacket.PacketType
PACKET_TYPE_UNSPECIFIED: HCIPacket.PacketType
TYPE_FIELD_NUMBER: _ClassVar[int]
packet: bytes
type: HCIPacket.PacketType
def __init__(
self,
type: _Optional[_Union[HCIPacket.PacketType, str]] = ...,
packet: _Optional[bytes] = ...,
) -> None: ...

View File

@@ -0,0 +1,17 @@
# Copyright 2021-2023 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.
# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
"""Client and server classes corresponding to protobuf-defined services."""
import grpc

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.
@@ -16,10 +16,9 @@
# Generated by the protocol buffer compiler. DO NOT EDIT! # Generated by the protocol buffer compiler. DO NOT EDIT!
# source: emulated_bluetooth.proto # source: emulated_bluetooth.proto
"""Generated protocol buffer code.""" """Generated protocol buffer code."""
from google.protobuf.internal import builder as _builder
from google.protobuf import descriptor as _descriptor from google.protobuf import descriptor as _descriptor
from google.protobuf import descriptor_pool as _descriptor_pool from google.protobuf import descriptor_pool as _descriptor_pool
from google.protobuf import message as _message
from google.protobuf import reflection as _reflection
from google.protobuf import symbol_database as _symbol_database from google.protobuf import symbol_database as _symbol_database
# @@protoc_insertion_point(imports) # @@protoc_insertion_point(imports)
@@ -34,20 +33,8 @@ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
b'\n\x18\x65mulated_bluetooth.proto\x12\x1b\x61ndroid.emulation.bluetooth\x1a emulated_bluetooth_packets.proto\"\x19\n\x07RawData\x12\x0e\n\x06packet\x18\x01 \x01(\x0c\x32\xcb\x02\n\x18\x45mulatedBluetoothService\x12\x64\n\x12registerClassicPhy\x12$.android.emulation.bluetooth.RawData\x1a$.android.emulation.bluetooth.RawData(\x01\x30\x01\x12`\n\x0eregisterBlePhy\x12$.android.emulation.bluetooth.RawData\x1a$.android.emulation.bluetooth.RawData(\x01\x30\x01\x12g\n\x11registerHCIDevice\x12&.android.emulation.bluetooth.HCIPacket\x1a&.android.emulation.bluetooth.HCIPacket(\x01\x30\x01\x42\"\n\x1e\x63om.android.emulator.bluetoothP\x01\x62\x06proto3' b'\n\x18\x65mulated_bluetooth.proto\x12\x1b\x61ndroid.emulation.bluetooth\x1a emulated_bluetooth_packets.proto\"\x19\n\x07RawData\x12\x0e\n\x06packet\x18\x01 \x01(\x0c\x32\xcb\x02\n\x18\x45mulatedBluetoothService\x12\x64\n\x12registerClassicPhy\x12$.android.emulation.bluetooth.RawData\x1a$.android.emulation.bluetooth.RawData(\x01\x30\x01\x12`\n\x0eregisterBlePhy\x12$.android.emulation.bluetooth.RawData\x1a$.android.emulation.bluetooth.RawData(\x01\x30\x01\x12g\n\x11registerHCIDevice\x12&.android.emulation.bluetooth.HCIPacket\x1a&.android.emulation.bluetooth.HCIPacket(\x01\x30\x01\x42\"\n\x1e\x63om.android.emulator.bluetoothP\x01\x62\x06proto3'
) )
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
_RAWDATA = DESCRIPTOR.message_types_by_name['RawData'] _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'emulated_bluetooth_pb2', globals())
RawData = _reflection.GeneratedProtocolMessageType(
'RawData',
(_message.Message,),
{
'DESCRIPTOR': _RAWDATA,
'__module__': 'emulated_bluetooth_pb2'
# @@protoc_insertion_point(class_scope:android.emulation.bluetooth.RawData)
},
)
_sym_db.RegisterMessage(RawData)
_EMULATEDBLUETOOTHSERVICE = DESCRIPTOR.services_by_name['EmulatedBluetoothService']
if _descriptor._USE_C_DESCRIPTORS == False: if _descriptor._USE_C_DESCRIPTORS == False:
DESCRIPTOR._options = None DESCRIPTOR._options = None

View File

@@ -0,0 +1,26 @@
# Copyright 2021-2023 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.
import emulated_bluetooth_packets_pb2 as _emulated_bluetooth_packets_pb2
from google.protobuf import descriptor as _descriptor
from google.protobuf import message as _message
from typing import ClassVar as _ClassVar, Optional as _Optional
DESCRIPTOR: _descriptor.FileDescriptor
class RawData(_message.Message):
__slots__ = ["packet"]
PACKET_FIELD_NUMBER: _ClassVar[int]
packet: bytes
def __init__(self, packet: _Optional[bytes] = ...) -> None: ...

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.
@@ -16,10 +16,9 @@
# Generated by the protocol buffer compiler. DO NOT EDIT! # Generated by the protocol buffer compiler. DO NOT EDIT!
# source: emulated_bluetooth_vhci.proto # source: emulated_bluetooth_vhci.proto
"""Generated protocol buffer code.""" """Generated protocol buffer code."""
from google.protobuf.internal import builder as _builder
from google.protobuf import descriptor as _descriptor from google.protobuf import descriptor as _descriptor
from google.protobuf import descriptor_pool as _descriptor_pool from google.protobuf import descriptor_pool as _descriptor_pool
from google.protobuf import message as _message
from google.protobuf import reflection as _reflection
from google.protobuf import symbol_database as _symbol_database from google.protobuf import symbol_database as _symbol_database
# @@protoc_insertion_point(imports) # @@protoc_insertion_point(imports)
@@ -27,15 +26,17 @@ from google.protobuf import symbol_database as _symbol_database
_sym_db = _symbol_database.Default() _sym_db = _symbol_database.Default()
import emulated_bluetooth_packets_pb2 as emulated__bluetooth__packets__pb2 from . import emulated_bluetooth_packets_pb2 as emulated__bluetooth__packets__pb2
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile( DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
b'\n\x1d\x65mulated_bluetooth_vhci.proto\x12\x1b\x61ndroid.emulation.bluetooth\x1a emulated_bluetooth_packets.proto2y\n\x15VhciForwardingService\x12`\n\nattachVhci\x12&.android.emulation.bluetooth.HCIPacket\x1a&.android.emulation.bluetooth.HCIPacket(\x01\x30\x01\x42J\n\x1f\x63om.android.emulation.bluetoothP\x01\xf8\x01\x01\xa2\x02\x03\x41\x45\x42\xaa\x02\x1b\x41ndroid.Emulation.Bluetoothb\x06proto3' b'\n\x1d\x65mulated_bluetooth_vhci.proto\x12\x1b\x61ndroid.emulation.bluetooth\x1a emulated_bluetooth_packets.proto2y\n\x15VhciForwardingService\x12`\n\nattachVhci\x12&.android.emulation.bluetooth.HCIPacket\x1a&.android.emulation.bluetooth.HCIPacket(\x01\x30\x01\x42J\n\x1f\x63om.android.emulation.bluetoothP\x01\xf8\x01\x01\xa2\x02\x03\x41\x45\x42\xaa\x02\x1b\x41ndroid.Emulation.Bluetoothb\x06proto3'
) )
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
_VHCIFORWARDINGSERVICE = DESCRIPTOR.services_by_name['VhciForwardingService'] _builder.BuildTopDescriptorsAndMessages(
DESCRIPTOR, 'emulated_bluetooth_vhci_pb2', globals()
)
if _descriptor._USE_C_DESCRIPTORS == False: if _descriptor._USE_C_DESCRIPTORS == False:
DESCRIPTOR._options = None DESCRIPTOR._options = None

View File

@@ -0,0 +1,19 @@
# Copyright 2021-2023 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.
import emulated_bluetooth_packets_pb2 as _emulated_bluetooth_packets_pb2
from google.protobuf import descriptor as _descriptor
from typing import ClassVar as _ClassVar
DESCRIPTOR: _descriptor.FileDescriptor

View File

@@ -1,4 +1,4 @@
# Copyright 2021-2022 Google LLC # Copyright 2021-2023 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.

View File

@@ -97,7 +97,7 @@ async def open_hci_socket_transport(spec):
super().__init__() super().__init__()
self.socket = hci_socket self.socket = hci_socket
asyncio.get_running_loop().add_reader( asyncio.get_running_loop().add_reader(
socket.fileno(), self.recv_until_would_block self.socket.fileno(), self.recv_until_would_block
) )
def recv_until_would_block(self): def recv_until_would_block(self):
@@ -140,7 +140,7 @@ async def open_hci_socket_transport(spec):
if not self.writer_added: if not self.writer_added:
asyncio.get_running_loop().add_writer( asyncio.get_running_loop().add_writer(
# pylint: disable=no-member # pylint: disable=no-member
socket.fileno(), self.socket.fileno(),
self.send_until_would_block, self.send_until_would_block,
) )
self.writer_added = True self.writer_added = True

View File

View File

@@ -20,13 +20,12 @@ import logging
import threading import threading
import time import time
import libusb_package
import usb.core import usb.core
import usb.util import usb.util
from colors import color
from .common import Transport, ParserSource from .common import Transport, ParserSource
from .. import hci from .. import hci
from ..colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -205,16 +204,22 @@ async def open_pyusb_transport(spec):
await self.sink.stop() await self.sink.stop()
usb.util.release_interface(self.device, 0) usb.util.release_interface(self.device, 0)
usb_find = usb.core.find
try:
import libusb_package
except ImportError:
logger.debug('libusb_package is not available')
else:
usb_find = libusb_package.find
# Find the device according to the spec moniker # Find the device according to the spec moniker
if ':' in spec: if ':' in spec:
vendor_id, product_id = spec.split(':') vendor_id, product_id = spec.split(':')
device = libusb_package.find( device = usb_find(idVendor=int(vendor_id, 16), idProduct=int(product_id, 16))
idVendor=int(vendor_id, 16), idProduct=int(product_id, 16)
)
else: else:
device_index = int(spec) device_index = int(spec)
devices = list( devices = list(
libusb_package.find( usb_find(
find_all=1, find_all=1,
bDeviceClass=USB_DEVICE_CLASS_WIRELESS_CONTROLLER, bDeviceClass=USB_DEVICE_CLASS_WIRELESS_CONTROLLER,
bDeviceSubClass=USB_DEVICE_SUBCLASS_RF_CONTROLLER, bDeviceSubClass=USB_DEVICE_SUBCLASS_RF_CONTROLLER,

View File

@@ -22,12 +22,11 @@ import collections
import ctypes import ctypes
import platform import platform
import libusb_package
import usb1 import usb1
from colors import color
from .common import Transport, ParserSource from .common import Transport, ParserSource
from .. import hci from .. import hci
from ..colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -45,11 +44,20 @@ def load_libusb():
If the library does not exists, do nothing and usb1 will search default system paths If the library does not exists, do nothing and usb1 will search default system paths
when usb1.USBContext is created. when usb1.USBContext is created.
''' '''
if libusb_path := libusb_package.get_library_path(): try:
logger.debug(f'loading libusb library at {libusb_path}') import libusb_package
dll_loader = ctypes.WinDLL if platform.system() == 'Windows' else ctypes.CDLL except ImportError:
libusb_dll = dll_loader(str(libusb_path), use_errno=True, use_last_error=True) logger.debug('libusb_package is not available')
usb1.loadLibrary(libusb_dll) else:
if libusb_path := libusb_package.get_library_path():
logger.debug(f'loading libusb library at {libusb_path}')
dll_loader = (
ctypes.WinDLL if platform.system() == 'Windows' else ctypes.CDLL
)
libusb_dll = dll_loader(
str(libusb_path), use_errno=True, use_last_error=True
)
usb1.loadLibrary(libusb_dll)
async def open_usb_transport(spec): async def open_usb_transport(spec):

View File

@@ -20,11 +20,11 @@ import logging
import traceback import traceback
import collections import collections
import sys import sys
from typing import Awaitable from typing import Awaitable, TypeVar
from functools import wraps from functools import wraps
from colors import color
from pyee import EventEmitter from pyee import EventEmitter
from .colors import color
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# Logging # Logging
@@ -65,8 +65,11 @@ def composite_listener(cls):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
_T = TypeVar('_T')
class AbortableEventEmitter(EventEmitter): class AbortableEventEmitter(EventEmitter):
def abort_on(self, event: str, awaitable: Awaitable): def abort_on(self, event: str, awaitable: Awaitable[_T]) -> Awaitable[_T]:
""" """
Set a coroutine or future to abort when an event occur. Set a coroutine or future to abort when an event occur.
""" """
@@ -75,6 +78,8 @@ class AbortableEventEmitter(EventEmitter):
return future return future
def on_event(*_): def on_event(*_):
if future.done():
return
msg = f'abort: {event} event occurred.' msg = f'abort: {event} event occurred.'
if isinstance(future, asyncio.Task): if isinstance(future, asyncio.Task):
# python < 3.9 does not support passing a message on `Task.cancel` # python < 3.9 does not support passing a message on `Task.cancel`

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport from bumble.transport import open_transport
from bumble.profiles.battery_service import BatteryServiceProxy from bumble.profiles.battery_service import BatteryServiceProxy

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device, Peer from bumble.device import Device, Peer
from bumble.profiles.device_information_service import DeviceInformationServiceProxy from bumble.profiles.device_information_service import DeviceInformationServiceProxy
from bumble.transport import open_transport from bumble.transport import open_transport

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport from bumble.transport import open_transport
from bumble.profiles.heart_rate_service import HeartRateServiceProxy from bumble.profiles.heart_rate_service import HeartRateServiceProxy

View File

@@ -22,7 +22,7 @@ import logging
import struct import struct
import json import json
import websockets import websockets
from colors import color from bumble.colors import color
from bumble.core import AdvertisingData from bumble.core import AdvertisingData
from bumble.device import Device, Connection, Peer from bumble.device import Device, Connection, Peer

View File

@@ -20,7 +20,7 @@ import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.core import ( from bumble.core import (

View File

@@ -20,7 +20,7 @@ import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link
from bumble.core import BT_BR_EDR_TRANSPORT from bumble.core import BT_BR_EDR_TRANSPORT

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link

View File

@@ -19,7 +19,7 @@ import logging
import asyncio import asyncio
import sys import sys
import os import os
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.controller import Controller from bumble.controller import Controller

View File

@@ -0,0 +1,51 @@
# Copyright 2021-2023 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 asyncio
import sys
import os
import logging
from bumble.colors import color
from bumble.device import Device
from bumble.transport import open_transport_or_link
from bumble.snoop import BtSnooper
# -----------------------------------------------------------------------------
async def main():
if len(sys.argv) != 3:
print('Usage: run_device_with_snooper.py <transport-spec> <snoop-file>')
print('example: run_device_with_snooper.py usb:0 btsnoop.log')
return
print('<<< connecting to HCI...')
async with await open_transport_or_link(sys.argv[1]) as (hci_source, hci_sink):
print('<<< connected')
device = Device.with_hci('Bumble', 'F0:F1:F2:F3:F4:F5', hci_source, hci_sink)
with open(sys.argv[2], "wb") as snoop_file:
device.host.snooper = BtSnooper(snoop_file)
await device.power_on()
await device.start_scanning()
await hci_source.wait_for_termination()
# -----------------------------------------------------------------------------
logging.basicConfig(level=os.environ.get('BUMBLE_LOGLEVEL', 'DEBUG').upper())
asyncio.run(main())

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.core import ProtocolError from bumble.core import ProtocolError
from bumble.device import Device, Peer from bumble.device import Device, Peer

View File

@@ -18,7 +18,7 @@
import asyncio import asyncio
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.core import ProtocolError from bumble.core import ProtocolError
from bumble.controller import Controller from bumble.controller import Controller

View File

@@ -20,7 +20,7 @@ import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
import bumble.core import bumble.core
from bumble.device import Device from bumble.device import Device

View File

@@ -20,7 +20,7 @@ import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
import bumble.core import bumble.core
from bumble.device import Device from bumble.device import Device

View File

@@ -19,7 +19,7 @@ import asyncio
import sys import sys
import os import os
import logging import logging
from colors import color from bumble.colors import color
from bumble.device import Device from bumble.device import Device
from bumble.transport import open_transport_or_link from bumble.transport import open_transport_or_link

View File

@@ -50,3 +50,44 @@ signature-mutators="AsyncRunner.run_in_task"
[tool.black] [tool.black]
skip-string-normalization = true skip-string-normalization = true
[[tool.mypy.overrides]]
module = "bumble.transport.emulated_bluetooth_pb2_grpc"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "bumble.transport.emulated_bluetooth_packets_pb2"
ignore_errors = true
[[tool.mypy.overrides]]
module = "aioconsole.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "colors.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "construct.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "emulated_bluetooth_packets_pb2.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "grpc.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "serial_asyncio.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "usb.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "usb1.*"
ignore_missing_imports = true

View File

@@ -0,0 +1,27 @@
# Invoke this script with an argument pointing to where the Android emulator .proto files are.
# The .proto files should be slightly modified from their original version (as distributed with
# the Android emulator):
# --> Remove unused types/methods from emulated_bluetooth.proto
PROTOC_OUT=bumble/transport
LICENSE_FILE_INPUT=bumble/transport/android_emulator.py
proto_files=(emulated_bluetooth.proto emulated_bluetooth_vhci.proto emulated_bluetooth_packets.proto)
for proto_file in "${proto_files[@]}"
do
python -m grpc_tools.protoc -I$1 --proto_path=bumble/transport --python_out=$PROTOC_OUT --pyi_out=$PROTOC_OUT --grpc_python_out=$PROTOC_OUT $1/$proto_file
done
python_files=(emulated_bluetooth_pb2.py emulated_bluetooth_pb2_grpc.py emulated_bluetooth_packets_pb2.py emulated_bluetooth_packets_pb2_grpc.py emulated_bluetooth_vhci_pb2_grpc.py emulated_bluetooth_vhci_pb2.py)
for python_file in "${python_files[@]}"
do
sed -i '' 's/^import .*_pb2 as/from . &/' $PROTOC_OUT/$python_file
done
stub_files=(emulated_bluetooth_pb2.pyi emulated_bluetooth_packets_pb2.pyi emulated_bluetooth_vhci_pb2.pyi)
for source_file in "${python_files[@]}" "${stub_files[@]}"
do
head -14 $LICENSE_FILE_INPUT > $PROTOC_OUT/${source_file}.lic
cat $PROTOC_OUT/$source_file >> $PROTOC_OUT/${source_file}.lic
mv $PROTOC_OUT/${source_file}.lic $PROTOC_OUT/$source_file
done

View File

@@ -28,16 +28,14 @@ packages = bumble, bumble.transport, bumble.profiles, bumble.apps, bumble.apps.l
package_dir = package_dir =
bumble = bumble bumble = bumble
bumble.apps = apps bumble.apps = apps
include-package-data = True
install_requires = install_requires =
aioconsole >= 0.4.1
ansicolors >= 1.1
appdirs >= 1.4 appdirs >= 1.4
bitstruct >= 8.12
click >= 7.1.2; platform_system!='Emscripten' click >= 7.1.2; platform_system!='Emscripten'
cryptography == 35; platform_system!='Emscripten' cryptography == 35; platform_system!='Emscripten'
grpcio >= 1.46; platform_system!='Emscripten' grpcio >= 1.46; platform_system!='Emscripten'
libusb1 >= 2.0.1; platform_system!='Emscripten' libusb1 >= 2.0.1; platform_system!='Emscripten'
libusb-package == 1.0.26.0; platform_system!='Emscripten' libusb-package == 1.0.26.1; platform_system!='Emscripten'
prompt_toolkit >= 3.0.16; platform_system!='Emscripten' prompt_toolkit >= 3.0.16; platform_system!='Emscripten'
protobuf >= 3.12.4 protobuf >= 3.12.4
pyee >= 8.2.2 pyee >= 8.2.2
@@ -60,6 +58,9 @@ console_scripts =
bumble-usb-probe = bumble.apps.usb_probe:main bumble-usb-probe = bumble.apps.usb_probe:main
bumble-link-relay = bumble.apps.link_relay.link_relay:main bumble-link-relay = bumble.apps.link_relay.link_relay:main
[options.package_data]
* = py.typed, *.pyi
[options.extras_require] [options.extras_require]
build = build =
build >= 0.7 build >= 0.7
@@ -69,10 +70,14 @@ test =
pytest-html >= 3.2.0 pytest-html >= 3.2.0
coverage >= 6.4 coverage >= 6.4
development = development =
black >= 22.10 black == 22.10
invoke >= 1.7.3 invoke >= 1.7.3
mypy == 1.1.1
nox >= 2022 nox >= 2022
pylint >= 2.15.8 pylint == 2.15.8
types-appdirs >= 1.4.3
types-invoke >= 1.7.3
types-protobuf >= 4.21.0
documentation = documentation =
mkdocs >= 1.4.0 mkdocs >= 1.4.0
mkdocs-material >= 8.5.6 mkdocs-material >= 8.5.6

View File

@@ -22,7 +22,7 @@ Invoke tasks
import os import os
from invoke import task, call, Collection from invoke import task, call, Collection
from invoke.exceptions import UnexpectedExit from invoke.exceptions import Exit, UnexpectedExit
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -126,9 +126,9 @@ def lint(ctx, disable='C,R', errors_only=False):
try: try:
ctx.run(f"pylint {' '.join(options)} bumble apps examples tasks.py") ctx.run(f"pylint {' '.join(options)} bumble apps examples tasks.py")
print("The linter is happy. ✅ 😊 🐝'") print("The linter is happy. ✅ 😊 🐝'")
except UnexpectedExit: except UnexpectedExit as exc:
print("Please check your code against the linter messages. ❌") print("Please check your code against the linter messages. ❌")
print(">>> Linter done.") raise Exit(code=1) from exc
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@@ -143,13 +143,31 @@ def format_code(ctx, check=False, diff=False):
print(">>> Running the formatter...") print(">>> Running the formatter...")
try: try:
ctx.run(f"black -S {' '.join(options)} .") ctx.run(f"black -S {' '.join(options)} .")
except UnexpectedExit: except UnexpectedExit as exc:
print("Please run 'invoke project.format' or 'black .' to format the code. ❌") print("Please run 'invoke project.format' or 'black .' to format the code. ❌")
print(">>> formatter done.") raise Exit(code=1) from exc
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@task(pre=[call(format_code, check=True), call(lint, errors_only=True), test]) @task
def check_types(ctx):
checklist = ["apps", "bumble", "examples", "tests", "tasks.py"]
try:
ctx.run(f"mypy {' '.join(checklist)}")
except UnexpectedExit as exc:
print("Please check your code against the mypy messages.")
raise Exit(code=1) from exc
# -----------------------------------------------------------------------------
@task(
pre=[
call(format_code, check=True),
call(lint, errors_only=True),
call(check_types),
test,
]
)
def pre_commit(_ctx): def pre_commit(_ctx):
print("All good!") print("All good!")
@@ -157,4 +175,5 @@ def pre_commit(_ctx):
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
project_tasks.add_task(lint) project_tasks.add_task(lint)
project_tasks.add_task(format_code, name="format") project_tasks.add_task(format_code, name="format")
project_tasks.add_task(check_types, name="check-types")
project_tasks.add_task(pre_commit) project_tasks.add_task(pre_commit)

View File

@@ -25,10 +25,8 @@ def test_ad_data():
assert data == ad_bytes assert data == ad_bytes
assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) is None assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) is None
assert ad.get(AdvertisingData.TX_POWER_LEVEL, raw=True) == bytes([123]) assert ad.get(AdvertisingData.TX_POWER_LEVEL, raw=True) == bytes([123])
assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, return_all=True, raw=True) == [] assert ad.get_all(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) == []
assert ad.get(AdvertisingData.TX_POWER_LEVEL, return_all=True, raw=True) == [ assert ad.get_all(AdvertisingData.TX_POWER_LEVEL, raw=True) == [bytes([123])]
bytes([123])
]
data2 = bytes([2, AdvertisingData.TX_POWER_LEVEL, 234]) data2 = bytes([2, AdvertisingData.TX_POWER_LEVEL, 234])
ad.append(data2) ad.append(data2)
@@ -36,8 +34,8 @@ def test_ad_data():
assert ad_bytes == data + data2 assert ad_bytes == data + data2
assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) is None assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) is None
assert ad.get(AdvertisingData.TX_POWER_LEVEL, raw=True) == bytes([123]) assert ad.get(AdvertisingData.TX_POWER_LEVEL, raw=True) == bytes([123])
assert ad.get(AdvertisingData.COMPLETE_LOCAL_NAME, return_all=True, raw=True) == [] assert ad.get_all(AdvertisingData.COMPLETE_LOCAL_NAME, raw=True) == []
assert ad.get(AdvertisingData.TX_POWER_LEVEL, return_all=True, raw=True) == [ assert ad.get_all(AdvertisingData.TX_POWER_LEVEL, raw=True) == [
bytes([123]), bytes([123]),
bytes([234]), bytes([234]),
] ]

View File

@@ -197,7 +197,7 @@ async def test_device_connect_parallel():
d1.host.set_packet_sink(Sink(d1_flow())) d1.host.set_packet_sink(Sink(d1_flow()))
d2.host.set_packet_sink(Sink(d2_flow())) d2.host.set_packet_sink(Sink(d2_flow()))
[c01, c02, a10, a20, a01] = await asyncio.gather( [c01, c02, a10, a20] = await asyncio.gather(
*[ *[
asyncio.create_task( asyncio.create_task(
d0.connect(d1.public_address, transport=BT_BR_EDR_TRANSPORT) d0.connect(d1.public_address, transport=BT_BR_EDR_TRANSPORT)
@@ -207,7 +207,6 @@ async def test_device_connect_parallel():
), ),
asyncio.create_task(d1.accept(peer_address=d0.public_address)), asyncio.create_task(d1.accept(peer_address=d0.public_address)),
asyncio.create_task(d2.accept()), asyncio.create_task(d2.accept()),
asyncio.create_task(d0.accept(peer_address=d1.public_address)),
] ]
) )
@@ -215,11 +214,9 @@ async def test_device_connect_parallel():
assert type(c02) == Connection assert type(c02) == Connection
assert type(a10) == Connection assert type(a10) == Connection
assert type(a20) == Connection assert type(a20) == Connection
assert type(a01) == Connection
assert c01.handle == a10.handle and c01.handle == 0x100 assert c01.handle == a10.handle and c01.handle == 0x100
assert c02.handle == a20.handle and c02.handle == 0x101 assert c02.handle == a20.handle and c02.handle == 0x101
assert a01 == c01
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------

View File

@@ -32,7 +32,6 @@ from bumble.smp import (
PairingDelegate, PairingDelegate,
SMP_PAIRING_NOT_SUPPORTED_ERROR, SMP_PAIRING_NOT_SUPPORTED_ERROR,
SMP_CONFIRM_VALUE_FAILED_ERROR, SMP_CONFIRM_VALUE_FAILED_ERROR,
SMP_ID_KEY_DISTRIBUTION_FLAG,
) )
from bumble.core import ProtocolError from bumble.core import ProtocolError
@@ -273,9 +272,15 @@ KEY_DIST = range(16)
@pytest.mark.asyncio @pytest.mark.asyncio
@pytest.mark.parametrize( @pytest.mark.parametrize(
'io_cap, sc, mitm, key_dist', itertools.product(IO_CAP, SC, MITM, KEY_DIST) 'io_caps, sc, mitm, key_dist',
itertools.chain(
itertools.product([IO_CAP], SC, MITM, [15]),
itertools.product(
[[PairingDelegate.DISPLAY_OUTPUT_AND_KEYBOARD_INPUT]], SC, MITM, KEY_DIST
),
),
) )
async def test_self_smp(io_cap, sc, mitm, key_dist): async def test_self_smp(io_caps, sc, mitm, key_dist):
class Delegate(PairingDelegate): class Delegate(PairingDelegate):
def __init__( def __init__(
self, self,
@@ -296,6 +301,7 @@ async def test_self_smp(io_cap, sc, mitm, key_dist):
self.peer_delegate = None self.peer_delegate = None
self.number = asyncio.get_running_loop().create_future() self.number = asyncio.get_running_loop().create_future()
# pylint: disable-next=unused-argument
async def compare_numbers(self, number, digits): async def compare_numbers(self, number, digits):
if self.peer_delegate is None: if self.peer_delegate is None:
logger.warning(f'[{self.name}] no peer delegate') logger.warning(f'[{self.name}] no peer delegate')
@@ -331,8 +337,9 @@ async def test_self_smp(io_cap, sc, mitm, key_dist):
pairing_config_sets = [('Initiator', [None]), ('Responder', [None])] pairing_config_sets = [('Initiator', [None]), ('Responder', [None])]
for pairing_config_set in pairing_config_sets: for pairing_config_set in pairing_config_sets:
delegate = Delegate(pairing_config_set[0], io_cap, key_dist, key_dist) for io_cap in io_caps:
pairing_config_set[1].append(PairingConfig(sc, mitm, True, delegate)) delegate = Delegate(pairing_config_set[0], io_cap, key_dist, key_dist)
pairing_config_set[1].append(PairingConfig(sc, mitm, True, delegate))
for pairing_config1 in pairing_config_sets[0][1]: for pairing_config1 in pairing_config_sets[0][1]:
for pairing_config2 in pairing_config_sets[1][1]: for pairing_config2 in pairing_config_sets[1][1]:

View File

@@ -72,5 +72,6 @@ def test_parser_extensions():
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
test_parser() if __name__ == '__main__':
test_parser_extensions() test_parser()
test_parser_extensions()

View File

@@ -16,7 +16,7 @@
# Imports # Imports
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
from bumble.device import Device from bumble.device import Device
from bumble.transport import PacketParser from bumble.transport.common import PacketParser
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------