• Home
Name Date Size #Lines LOC

..--

README.mdD03-May-20244 KiB8560

a2dp_sink1.jsonD03-May-202497 65

async_runner.pyD03-May-20242.6 KiB8644

battery_client.pyD03-May-20242.7 KiB7337

battery_server.pyD03-May-20242.5 KiB6733

classic1.jsonD03-May-202489 65

classic2.jsonD03-May-202454 54

device1.jsonD03-May-2024174 87

device2.jsonD03-May-2024263 98

device3.jsonD03-May-202462 54

device_information_client.pyD03-May-20244 KiB8146

device_information_server.pyD03-May-20242.5 KiB6736

hfp_gateway.jsonD03-May-202463 54

hfp_handsfree.htmlD03-May-20242.4 KiB7969

hfp_handsfree.jsonD03-May-202468 54

keyboard.htmlD03-May-20242.3 KiB6156

keyboard.jsonD03-May-2024103 65

keyboard.pyD03-May-202414.4 KiB360275

run_a2dp_info.pyD03-May-20247.3 KiB189124

run_a2dp_sink.pyD03-May-20245.7 KiB164103

run_a2dp_source.pyD03-May-20246.6 KiB176108

run_advertiser.pyD03-May-20241.8 KiB4923

run_classic_connect.pyD03-May-20243.5 KiB8244

run_classic_discoverable.pyD03-May-20243.7 KiB10573

run_classic_discovery.pyD03-May-20242.6 KiB6535

run_connect_and_encrypt.pyD03-May-20242.1 KiB5929

run_controller.pyD03-May-20243.2 KiB8847

run_controller_with_scanner.pyD03-May-20242.8 KiB7537

run_gatt_client.pyD03-May-20243.6 KiB9958

run_gatt_client_and_server.pyD03-May-20244 KiB11571

run_gatt_server.pyD03-May-20245.2 KiB14899

run_hfp_gateway.pyD03-May-20249.1 KiB210152

run_hfp_handsfree.pyD03-May-20245.6 KiB166108

run_notifier.pyD03-May-20244.4 KiB12178

run_rfcomm_client.pyD03-May-20248.4 KiB202138

run_rfcomm_server.pyD03-May-20244.2 KiB11970

run_scanner.pyD03-May-20242.7 KiB7040

README.md

1Bumble Examples
2===============
3
4NOTE:
5To run python scripts from this directory when the Bumble package isn't installed in your environment,
6put .. in your PYTHONPATH: `export PYTHONPATH=..`
7
8# `run_controller.py`
9Run two virtual controllers, one connected to a soft device written in python with a simple GATT server, and the other connected to an external host.
10
11## Running `run_controller.py` with a BlueZ host running on Linux.
12
13In this configuration, a BlueZ stack running on a Linux host is connected to a Bumble virtual
14controller, attached to a local link bus to a second, in-process, virtual controller, itself
15used by a virtual device with a GATT server.
16
17### Running with two separate hosts (ex: a mac laptop and a Linux VM)
18In this setup, the virtual controllers and host run on a mac desktop, and the BlueZ stack on a Linux VM. A UDP socket communicates HCI packets between the macOS host and the Linux guest.
19
20#### Linux setup
21In a terminal, run `socat` to bridge a UDP socket to a local PTY.
22The PTY is used a virtual HCI UART.
23(in this example, the mac's IP address seen from the Linux VM is `172.16.104.1`, replace it with
24the appropriate address for your environment. (you may also use a port number other than `22333` used here)
25```
26socat -d -d -x PTY,link=./hci_pty,rawer UDP-SENDTO:172.16.104.1:22333,bind=:22333
27```
28
29In the local directory, `socat` creates a symbolic link named `hci_pty` that points to the PTY.
30
31In a second terminal, run
32```
33sudo btattach -P h4 -B hci_pty
34```
35
36This tells BlueZ to use the PTY as an HCI UART controller.
37
38(optional) In a third terminal, run `sudo btmon`. This monitors the HCI traffic with BlueZ, which is great to see what's going on.
39
40In a fourth terminal, run `sudo bluetoothctl` to interact with BlueZ as a client. From there, you can scan, advertise, connect, etc.
41
42#### Mac setup
43In a macOS terminal, run
44```
45python run_controller.py device1.json udp:0.0.0.0:22333,172.16.104.161:22333
46```
47
48This configures one of the virtual controllers to use a UDP socket as its HCI transport. In this example, the ip address of the Linux VM is `172.16.104.161`, replace it with the appropriate
49address for your environment.
50
51Once both the Linux and macOS processes are started, you should be able to interact with the
52`bluetoothctl` tool on the Linux side and scan/connect/discover the virtual device running on
53the macOS side. Relevant log output in each of the terminal consoles should show what it going on.
54
55### Running with a single Linux host
56In setup, both the BlueZ stack and tools as well as the Bumble virtual stack are running on the same
57host.
58
59In a terminal, run the example as
60```
61python run_controller.py device1.json pty:hci_pty
62```
63
64In the local directory, a symbolic link named `hci_pty` that points to the PTY is created.
65
66From this point, run the same steps as in the previous example to attach the PTY to BlueZ and use
67`bluetoothctl` to interact with the virtual controller.
68
69
70# `run_gatt_client.py`
71Run a host application connected to a 'real' BLE controller over a UART HCI to a dev board running Zephyr in HCI mode (could be any other UART BLE controller, or BlueZ over a virtual UART). The application connects to a Bluetooth peer specified as an argument.
72Once connected, the application hosts a GATT client that discovers all services and all attributes of the peer and displays them.
73
74# `run_gatt_server.py`
75Run a host application connected to a 'real' BLE controller over a UART HCI to a dev board running Zephyr in HCI mode (could be any other UART BLE controller, or BlueZ over a virtual UART). The application connects to a Bluetooth peer specified as an argument.
76The application hosts a simple GATT server with basic
77services and characteristics.
78
79# `run_gatt_client_and_server.py`
80
81# `run_advertiser.py`
82
83# `run_scanner.py`
84Run a host application connected to a 'real' BLE controller over a UART HCI to a dev board running Zephyr in HCI mode (could be any other UART BLE controller, or BlueZ over a virtual UART), that starts scanning and prints out the scan results.
85