mirror of
https://github.com/google/bumble.git
synced 2026-04-16 00:25:31 +00:00
c2959dadb4
Squashed commits: [cd479ba] formatting and linting automation [7fbfabb] formatting and linting automation [c4f9505] fix after rebase [f506ad4] rename job [441d517] update doc (+7 squashed commits) [2e1b416] fix invoke and github action [6ae5bb4] doc for git blame [44b5461] add GitHub action [b07474f] add docs [4cd9a6f] more linter fixes [db71901] wip [540dc88] wip
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
Bumble Apps
|
|
===========
|
|
|
|
NOTE:
|
|
To run python scripts from this directory when the Bumble package isn't installed in your environment,
|
|
put .. in your PYTHONPATH: `export PYTHONPATH=..`
|
|
|
|
|
|
Apps
|
|
----
|
|
|
|
## `show.py`
|
|
Parse a file with HCI packets and print the details of each packet in a human readable form
|
|
|
|
## `link_relay.py`
|
|
Simple WebSocket relay for virtual RemoteLink instances to communicate with each other through.
|
|
|
|
## `hci_bridge.py`
|
|
This app acts as a simple bridge between two HCI transports, with a host on one side and
|
|
a controller on the other. All the HCI packets bridged between the two are printed on the console
|
|
for logging. This bridge also has the ability to short-circuit some HCI packets (respond to them
|
|
with a fixed response instead of bridging them to the other side), which may be useful when used with
|
|
a host that send custom HCI commands that the controller may not understand.
|
|
|
|
### Usage
|
|
```
|
|
python hci_bridge.py <host-transport-spec> <controller-transport-spec> [command-short-circuit-list]
|
|
```
|
|
|
|
### Examples
|
|
|
|
#### UDP to HCI UART
|
|
```
|
|
python hci_bridge.py udp:0.0.0.0:9000,127.0.0.1:9001 serial:/dev/tty.usbmodem0006839912171,1000000 0x3f:0x0070,0x3f:0x0074,0x3f:0x0077,0x3f:0x0078
|
|
```
|
|
|
|
#### PTY to Link Relay
|
|
```
|
|
python hci_bridge.py serial:emulated_uart_pty,1000000 link-relay:ws://127.0.0.1:10723/test
|
|
```
|
|
|
|
In this example, an emulator that exposes a PTY as an interface to its HCI UART is running as
|
|
a Bluetooth host, and we are connecting it to a virtual controller attached to a link relay
|
|
(through which the communication with other virtual controllers will be mediated).
|
|
|
|
NOTE: this assumes you're running a Link Relay on port `10723`.
|
|
|
|
## `console.py`
|
|
A simple text-based-ui interactive Bluetooth device with GATT client capabilities.
|