bumble 0.0.222__py3-none-any.whl → 0.0.224__py3-none-any.whl

bumble/snoop.py

@@ -110,6 +110,53 @@ class BtSnooper(Snooper):
         )
 
 
+# -----------------------------------------------------------------------------
+class PcapSnooper(Snooper):
+    """
+    Snooper that saves or streames HCI packets using the PCAP format.
+    """
+
+    PCAP_MAGIC = 0xA1B2C3D4
+    DLT_BLUETOOTH_HCI_H4_WITH_PHDR = 201
+
+    def __init__(self, output: BinaryIO):
+        self.output = output
+
+        # Write the header
+        self.output.write(
+            struct.pack(
+                "<IHHIIII",
+                self.PCAP_MAGIC,
+                2,  # Major PCAP Version
+                4,  # Minor PCAP Version
+                0,  # Reserved 1
+                0,  # Reserved 2
+                65535,  # SnapLen
+                # FCS and f are set to 0 implicitly by the next line
+                self.DLT_BLUETOOTH_HCI_H4_WITH_PHDR,  # The DLT in this PCAP
+            )
+        )
+
+    def snoop(self, hci_packet: bytes, direction: Snooper.Direction):
+        now = datetime.datetime.now(datetime.timezone.utc)
+        sec = int(now.timestamp())
+        usec = now.microsecond
+
+        # Emit the record
+        self.output.write(
+            struct.pack(
+                "<IIII",
+                sec,  # Timestamp (Seconds)
+                usec,  # Timestamp (Microseconds)
+                len(hci_packet) + 4,
+                len(hci_packet) + 4,  # +4 because of the addtional direction info...
+            )
+            + struct.pack(">I", int(direction))  # ...thats being added here
+            + hci_packet
+        )
+        self.output.flush()  # flush after every packet for live logging
+
+
 # -----------------------------------------------------------------------------
 _SNOOPER_INSTANCE_COUNT = 0
 
@@ -140,9 +187,38 @@ def create_snooper(spec: str) -> Generator[Snooper, None, None]:
             pid: the current process ID.
             instance: the instance ID in the current process.
 
+      pcapsnoop
+        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.now(tz=datetime.timezone.utc)`
+            pid: the current process ID.
+            instance: the instance ID in the current process.
+
+        pipe
+          The type-specific arguments for this I/O type is a string that is converted
+          to a path using the python `str.format()` string formatting. The log
+          records will be written to the named pipe referenced by this path
+          if it can be opened. The keyword args that may be referenced by the
+          string pattern are:
+            now: the value of `datetime.now()`
+            utcnow: the value of `datetime.now(tz=datetime.timezone.utc)`
+            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
+      pcapsnoop:pipe:/tmp/bumble-extcap
+
 
     """
     if ':' not in spec:
@@ -150,6 +226,8 @@ def create_snooper(spec: str) -> Generator[Snooper, None, None]:
 
     snooper_type, snooper_args = spec.split(':', maxsplit=1)
 
+    global _SNOOPER_INSTANCE_COUNT
+
     if snooper_type == 'btsnoop':
         if ':' not in snooper_args:
             raise core.InvalidArgumentError('I/O type for btsnoop snooper type missing')
@@ -157,7 +235,6 @@ def create_snooper(spec: str) -> Generator[Snooper, None, None]:
         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.now(tz=datetime.timezone.utc),
@@ -173,6 +250,39 @@ def create_snooper(spec: str) -> Generator[Snooper, None, None]:
                 _SNOOPER_INSTANCE_COUNT -= 1
                 return
 
+    elif snooper_type == 'pcapsnoop':
+        if ':' not in snooper_args:
+            raise core.InvalidArgumentError(
+                'I/O type for pcapsnoop snooper type missing'
+            )
+
+        io_type, io_name = snooper_args.split(':', maxsplit=1)
+        if io_type in {'pipe', 'file'}:
+            # Process the file name string pattern.
+            file_path = io_name.format(
+                now=datetime.datetime.now(),
+                utcnow=datetime.datetime.now(tz=datetime.timezone.utc),
+                pid=os.getpid(),
+                instance=_SNOOPER_INSTANCE_COUNT,
+            )
+
+            # Open a file or pipe
+            logger.debug(f'PCAP file: {file_path}')
+
+            # Pipes we have to open with unbuffered binary I/O
+            # so we pass ``buffering`` for pipes but not for files
+            pcap_file: BinaryIO
+            if io_type == 'pipe':
+                pcap_file = open(file_path, 'wb', buffering=0)
+            else:
+                pcap_file = open(file_path, 'wb')
+
+            with pcap_file:
+                _SNOOPER_INSTANCE_COUNT += 1
+                yield PcapSnooper(pcap_file)
+                _SNOOPER_INSTANCE_COUNT -= 1
+                return
+
         raise core.InvalidArgumentError(f'I/O type {io_type} not supported')
 
     raise core.InvalidArgumentError(f'snooper type {snooper_type} not found')

bumble/transport/android_netsim.py

@@ -194,7 +194,7 @@ async def open_android_netsim_controller_transport(
 
                         # We only accept BLUETOOTH
                         if request.initial_info.chip.kind != ChipKind.BLUETOOTH:
-                            logger.warning('Unsupported chip type')
+                            logger.debug('Request for unsupported chip type')
                             error = PacketResponse(error='Unsupported chip type')
                             await self.context.write(error)
                             # return

bumble/vendor/android/hci.py

@@ -43,44 +43,53 @@ hci.HCI_Command.register_commands(globals())
 
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
 @dataclasses.dataclass
-class HCI_LE_Get_Vendor_Capabilities_Command(hci.HCI_Command):
+class HCI_LE_Get_Vendor_Capabilities_ReturnParameters(hci.HCI_StatusReturnParameters):
+    max_advt_instances: int = field(metadata=hci.metadata(1), default=0)
+    offloaded_resolution_of_private_address: int = field(
+        metadata=hci.metadata(1), default=0
+    )
+    total_scan_results_storage: int = field(metadata=hci.metadata(2), default=0)
+    max_irk_list_sz: int = field(metadata=hci.metadata(1), default=0)
+    filtering_support: int = field(metadata=hci.metadata(1), default=0)
+    max_filter: int = field(metadata=hci.metadata(1), default=0)
+    activity_energy_info_support: int = field(metadata=hci.metadata(1), default=0)
+    version_supported: int = field(metadata=hci.metadata(2), default=0)
+    total_num_of_advt_tracked: int = field(metadata=hci.metadata(2), default=0)
+    extended_scan_support: int = field(metadata=hci.metadata(1), default=0)
+    debug_logging_supported: int = field(metadata=hci.metadata(1), default=0)
+    le_address_generation_offloading_support: int = field(
+        metadata=hci.metadata(1), default=0
+    )
+    a2dp_source_offload_capability_mask: int = field(
+        metadata=hci.metadata(4), default=0
+    )
+    bluetooth_quality_report_support: int = field(metadata=hci.metadata(1), default=0)
+    dynamic_audio_buffer_support: int = field(metadata=hci.metadata(4), default=0)
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_LE_Get_Vendor_Capabilities_ReturnParameters)
+@dataclasses.dataclass
+class HCI_LE_Get_Vendor_Capabilities_Command(
+    hci.HCI_SyncCommand[HCI_LE_Get_Vendor_Capabilities_ReturnParameters]
+):
     # pylint: disable=line-too-long
     '''
     See https://source.android.com/docs/core/connect/bluetooth/hci_requirements#vendor-specific-capabilities
     '''
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('max_advt_instances', 1),
-        ('offloaded_resolution_of_private_address', 1),
-        ('total_scan_results_storage', 2),
-        ('max_irk_list_sz', 1),
-        ('filtering_support', 1),
-        ('max_filter', 1),
-        ('activity_energy_info_support', 1),
-        ('version_supported', 2),
-        ('total_num_of_advt_tracked', 2),
-        ('extended_scan_support', 1),
-        ('debug_logging_supported', 1),
-        ('le_address_generation_offloading_support', 1),
-        ('a2dp_source_offload_capability_mask', 4),
-        ('bluetooth_quality_report_support', 1),
-        ('dynamic_audio_buffer_support', 4),
-    ]
-
     @classmethod
     def parse_return_parameters(cls, parameters):
         # There are many versions of this data structure, so we need to parse until
-        # there are no more bytes to parse, and leave un-signal parameters set to
-        # None (older versions)
-        nones = {field: None for field, _ in cls.return_parameters_fields}
-        return_parameters = hci.HCI_Object(cls.return_parameters_fields, **nones)
+        # there are no more bytes to parse, and leave un-signaled parameters set to
+        # 0
+        return_parameters = HCI_LE_Get_Vendor_Capabilities_ReturnParameters(
+            hci.HCI_ErrorCode.SUCCESS
+        )
 
         try:
             offset = 0
-            for field in cls.return_parameters_fields:
+            for field in cls.return_parameters_class.fields:
                 field_name, field_type = field
                 field_value, field_size = hci.HCI_Object.parse_field(
                     parameters, offset, field_type
@@ -94,9 +103,30 @@ class HCI_LE_Get_Vendor_Capabilities_Command(hci.HCI_Command):
 
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
+# APCF Subcommands
+class LeApcfOpcode(hci.SpecableEnum):
+    ENABLE = 0x00
+    SET_FILTERING_PARAMETERS = 0x01
+    BROADCASTER_ADDRESS = 0x02
+    SERVICE_UUID = 0x03
+    SERVICE_SOLICITATION_UUID = 0x04
+    LOCAL_NAME = 0x05
+    MANUFACTURER_DATA = 0x06
+    SERVICE_DATA = 0x07
+    TRANSPORT_DISCOVERY_SERVICE = 0x08
+    AD_TYPE_FILTER = 0x09
+    READ_EXTENDED_FEATURES = 0xFF
+
+
+@dataclasses.dataclass
+class HCI_LE_APCF_ReturnParameters(hci.HCI_StatusReturnParameters):
+    opcode: int = field(metadata=LeApcfOpcode.type_metadata(1))
+    payload: bytes = field(metadata=hci.metadata('*'))
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_LE_APCF_ReturnParameters)
 @dataclasses.dataclass
-class HCI_LE_APCF_Command(hci.HCI_Command):
+class HCI_LE_APCF_Command(hci.HCI_SyncCommand[HCI_LE_APCF_ReturnParameters]):
     # pylint: disable=line-too-long
     '''
     See https://source.android.com/docs/core/connect/bluetooth/hci_requirements#le_apcf_command
@@ -105,52 +135,52 @@ class HCI_LE_APCF_Command(hci.HCI_Command):
     implementation. A future enhancement may define subcommand-specific data structures.
     '''
 
-    # APCF Subcommands
-    class Opcode(hci.SpecableEnum):
-        ENABLE = 0x00
-        SET_FILTERING_PARAMETERS = 0x01
-        BROADCASTER_ADDRESS = 0x02
-        SERVICE_UUID = 0x03
-        SERVICE_SOLICITATION_UUID = 0x04
-        LOCAL_NAME = 0x05
-        MANUFACTURER_DATA = 0x06
-        SERVICE_DATA = 0x07
-        TRANSPORT_DISCOVERY_SERVICE = 0x08
-        AD_TYPE_FILTER = 0x09
-        READ_EXTENDED_FEATURES = 0xFF
-
-    opcode: int = dataclasses.field(metadata=Opcode.type_metadata(1))
+    opcode: int = dataclasses.field(metadata=LeApcfOpcode.type_metadata(1))
     payload: bytes = dataclasses.field(metadata=hci.metadata("*"))
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('opcode', Opcode.type_spec(1)),
-        ('payload', '*'),
-    ]
-
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
 @dataclasses.dataclass
-class HCI_Get_Controller_Activity_Energy_Info_Command(hci.HCI_Command):
+class HCI_Get_Controller_Activity_Energy_Info_ReturnParameters(
+    hci.HCI_StatusReturnParameters
+):
+    total_tx_time_ms: int = field(metadata=hci.metadata(4))
+    total_rx_time_ms: int = field(metadata=hci.metadata(4))
+    total_idle_time_ms: int = field(metadata=hci.metadata(4))
+    total_energy_used: int = field(metadata=hci.metadata(4))
+
+
+@hci.HCI_SyncCommand.sync_command(
+    HCI_Get_Controller_Activity_Energy_Info_ReturnParameters
+)
+@dataclasses.dataclass
+class HCI_Get_Controller_Activity_Energy_Info_Command(
+    hci.HCI_SyncCommand[HCI_Get_Controller_Activity_Energy_Info_ReturnParameters]
+):
     # pylint: disable=line-too-long
     '''
     See https://source.android.com/docs/core/connect/bluetooth/hci_requirements#le_get_controller_activity_energy_info
     '''
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('total_tx_time_ms', 4),
-        ('total_rx_time_ms', 4),
-        ('total_idle_time_ms', 4),
-        ('total_energy_used', 4),
-    ]
-
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
+# A2DP Hardware Offload Subcommands
+class A2dpHardwareOffloadOpcode(hci.SpecableEnum):
+    START_A2DP_OFFLOAD = 0x01
+    STOP_A2DP_OFFLOAD = 0x02
+
+
+@dataclasses.dataclass
+class HCI_A2DP_Hardware_Offload_ReturnParameters(hci.HCI_StatusReturnParameters):
+    opcode: int = dataclasses.field(metadata=A2dpHardwareOffloadOpcode.type_metadata(1))
+    payload: bytes = dataclasses.field(metadata=hci.metadata("*"))
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_A2DP_Hardware_Offload_ReturnParameters)
 @dataclasses.dataclass
-class HCI_A2DP_Hardware_Offload_Command(hci.HCI_Command):
+class HCI_A2DP_Hardware_Offload_Command(
+    hci.HCI_SyncCommand[HCI_A2DP_Hardware_Offload_ReturnParameters]
+):
     # pylint: disable=line-too-long
     '''
     See https://source.android.com/docs/core/connect/bluetooth/hci_requirements#a2dp-hardware-offload-support
@@ -159,25 +189,27 @@ class HCI_A2DP_Hardware_Offload_Command(hci.HCI_Command):
     implementation. A future enhancement may define subcommand-specific data structures.
     '''
 
-    # A2DP Hardware Offload Subcommands
-    class Opcode(hci.SpecableEnum):
-        START_A2DP_OFFLOAD = 0x01
-        STOP_A2DP_OFFLOAD = 0x02
-
-    opcode: int = dataclasses.field(metadata=Opcode.type_metadata(1))
+    opcode: int = dataclasses.field(metadata=A2dpHardwareOffloadOpcode.type_metadata(1))
     payload: bytes = dataclasses.field(metadata=hci.metadata("*"))
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('opcode', Opcode.type_spec(1)),
-        ('payload', '*'),
-    ]
-
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
+# Dynamic Audio Buffer Subcommands
+class DynamicAudioBufferOpcode(hci.SpecableEnum):
+    GET_AUDIO_BUFFER_TIME_CAPABILITY = 0x01
+
+
 @dataclasses.dataclass
-class HCI_Dynamic_Audio_Buffer_Command(hci.HCI_Command):
+class HCI_Dynamic_Audio_Buffer_ReturnParameters(hci.HCI_StatusReturnParameters):
+    opcode: int = dataclasses.field(metadata=DynamicAudioBufferOpcode.type_metadata(1))
+    payload: bytes = dataclasses.field(metadata=hci.metadata("*"))
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_Dynamic_Audio_Buffer_ReturnParameters)
+@dataclasses.dataclass
+class HCI_Dynamic_Audio_Buffer_Command(
+    hci.HCI_SyncCommand[HCI_Dynamic_Audio_Buffer_ReturnParameters]
+):
     # pylint: disable=line-too-long
     '''
     See https://source.android.com/docs/core/connect/bluetooth/hci_requirements#dynamic-audio-buffer-command
@@ -186,19 +218,9 @@ class HCI_Dynamic_Audio_Buffer_Command(hci.HCI_Command):
     implementation. A future enhancement may define subcommand-specific data structures.
     '''
 
-    # Dynamic Audio Buffer Subcommands
-    class Opcode(hci.SpecableEnum):
-        GET_AUDIO_BUFFER_TIME_CAPABILITY = 0x01
-
-    opcode: int = dataclasses.field(metadata=Opcode.type_metadata(1))
+    opcode: int = dataclasses.field(metadata=DynamicAudioBufferOpcode.type_metadata(1))
     payload: bytes = dataclasses.field(metadata=hci.metadata("*"))
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('opcode', Opcode.type_spec(1)),
-        ('payload', '*'),
-    ]
-
 
 # -----------------------------------------------------------------------------
 class HCI_Android_Vendor_Event(hci.HCI_Extended_Event):

bumble/vendor/zephyr/hci.py

@@ -46,9 +46,19 @@ class TX_Power_Level_Command:
 
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
 @dataclasses.dataclass
-class HCI_Write_Tx_Power_Level_Command(hci.HCI_Command, TX_Power_Level_Command):
+class HCI_Write_Tx_Power_Level_ReturnParameters(hci.HCI_StatusReturnParameters):
+    handle_type: int = hci.field(metadata=hci.metadata(1))
+    connection_handle: int = hci.field(metadata=hci.metadata(2))
+    selected_tx_power_level: int = hci.field(metadata=hci.metadata(-1))
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_Write_Tx_Power_Level_ReturnParameters)
+@dataclasses.dataclass
+class HCI_Write_Tx_Power_Level_Command(
+    hci.HCI_SyncCommand[HCI_Write_Tx_Power_Level_ReturnParameters],
+    TX_Power_Level_Command,
+):
     '''
     Write TX power level. See BT_HCI_OP_VS_WRITE_TX_POWER_LEVEL in
     https://github.com/zephyrproject-rtos/zephyr/blob/main/include/zephyr/bluetooth/hci_vs.h
@@ -61,18 +71,21 @@ class HCI_Write_Tx_Power_Level_Command(hci.HCI_Command, TX_Power_Level_Command):
     connection_handle: int = dataclasses.field(metadata=hci.metadata(2))
     tx_power_level: int = dataclasses.field(metadata=hci.metadata(-1))
 
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('handle_type', 1),
-        ('connection_handle', 2),
-        ('selected_tx_power_level', -1),
-    ]
-
 
 # -----------------------------------------------------------------------------
-@hci.HCI_Command.command
 @dataclasses.dataclass
-class HCI_Read_Tx_Power_Level_Command(hci.HCI_Command, TX_Power_Level_Command):
+class HCI_Read_Tx_Power_Level_ReturnParameters(hci.HCI_StatusReturnParameters):
+    handle_type: int = hci.field(metadata=hci.metadata(1))
+    connection_handle: int = hci.field(metadata=hci.metadata(2))
+    tx_power_level: int = hci.field(metadata=hci.metadata(-1))
+
+
+@hci.HCI_SyncCommand.sync_command(HCI_Read_Tx_Power_Level_ReturnParameters)
+@dataclasses.dataclass
+class HCI_Read_Tx_Power_Level_Command(
+    hci.HCI_SyncCommand[HCI_Read_Tx_Power_Level_ReturnParameters],
+    TX_Power_Level_Command,
+):
     '''
     Read TX power level. See BT_HCI_OP_VS_READ_TX_POWER_LEVEL in
     https://github.com/zephyrproject-rtos/zephyr/blob/main/include/zephyr/bluetooth/hci_vs.h
@@ -83,10 +96,3 @@ class HCI_Read_Tx_Power_Level_Command(hci.HCI_Command, TX_Power_Level_Command):
 
     handle_type: int = dataclasses.field(metadata=hci.metadata(1))
     connection_handle: int = dataclasses.field(metadata=hci.metadata(2))
-
-    return_parameters_fields = [
-        ('status', hci.STATUS_SPEC),
-        ('handle_type', 1),
-        ('connection_handle', 2),
-        ('tx_power_level', -1),
-    ]

{bumble-0.0.222.dist-info → bumble-0.0.224.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bumble
-Version: 0.0.222
+Version: 0.0.224
 Summary: Bluetooth Stack for Apps, Emulation, Test and Experimentation
 Author-email: Google <bumble-dev@google.com>
 License-Expression: Apache-2.0
@@ -11,12 +11,13 @@ License-File: LICENSE
 Requires-Dist: aiohttp~=3.8; platform_system != "Emscripten"
 Requires-Dist: appdirs>=1.4; platform_system != "Emscripten"
 Requires-Dist: click>=8.1.3; platform_system != "Emscripten"
-Requires-Dist: cryptography>=44.0.3; platform_system != "Emscripten"
+Requires-Dist: cryptography>=44.0.3; platform_system != "Emscripten" and platform_system != "Android"
 Requires-Dist: cryptography>=44.0.3; platform_system == "Emscripten"
+Requires-Dist: cryptography>=42.0.8; platform_system == "Android"
 Requires-Dist: grpcio>=1.62.1; platform_system != "Emscripten"
 Requires-Dist: humanize>=4.6.0; platform_system != "Emscripten"
 Requires-Dist: libusb1>=2.0.1; platform_system != "Emscripten"
-Requires-Dist: libusb-package==1.0.26.1; platform_system != "Emscripten"
+Requires-Dist: libusb-package==1.0.26.1; platform_system != "Emscripten" and platform_system != "Android"
 Requires-Dist: platformdirs>=3.10.0; platform_system != "Emscripten"
 Requires-Dist: prompt_toolkit>=3.0.16; platform_system != "Emscripten"
 Requires-Dist: prettytable>=3.6.0; platform_system != "Emscripten"