Metadata-Version: 2.5
Name: jumpstarter-driver-bt-peer
Version: 0.10.0.dev80+g370ee8177
Summary: Bluetooth peer driver powered by bumble
Project-URL: Homepage, https://jumpstarter.dev
Project-URL: source_archive, https://github.com/jumpstarter-dev/jumpstarter/archive/370ee81778e4e7c1d781fa6ea0d7b77b7b540c45.zip
Author-email: Benny Zlotnik <bzlotnik@redhat.com>
License-Expression: Apache-2.0
Requires-Python: >=3.11
Requires-Dist: anyio>=4.10.0
Requires-Dist: bumble>=0.0.233
Requires-Dist: jumpstarter==0.10.0.dev80+g370ee8177
Description-Content-Type: text/markdown

# BtPeer Driver

`jumpstarter-driver-bt-peer` provides a Bluetooth peer device powered by
[bumble](https://github.com/google/bumble). It can pair, connect, and stream
A2DP audio to a DUT over BR/EDR.

## Installation

```shell
pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-bt-peer
```

## Configuration

Example configuration:

```yaml
export:
  bt_peer:
    type: jumpstarter_driver_bt_peer.driver.BtPeer
    config:
      transport: "tcp-client:127.0.0.1:7300"  # bumble transport string
```

## Usage

Start the peer, pair with a DUT, and verify the connection:

```bash
j bt_peer start '{"name": "Bumble-Phone"}'
j bt_peer address
j bt_peer wait-connection --timeout 60
j bt_peer connections
j bt_peer pair --handle 0
j bt_peer stop
```

The `transport` config accepts any bumble transport string:
- `tcp-client:host:port` - rootcanal / netsim
- `usb:0` — USB HCI dongle
- `serial:/dev/ttyUSB0` - serial UART

## API Reference

```{eval-rst}
.. autoclass:: jumpstarter_driver_bt_peer.driver.BtPeer()
```
