Marshall Pierce
0e2fc80509
Further adventures in porting tools to Rust to flesh out the supported API. These tools didn't feel like `example`s, so I made a top level `bumble` CLI tool that hosts them all as subcommands. I also moved the usb probe not-really-an-`example` into it as well. I'm open to suggestions on how best to organize the subcommands to make them intuitive to explore with `--help`, and how to leave room for other future tools. I also adopted the per-OS project data dir for a default firmware location so that users can download once and then use those .bin files from anywhere without having to sprinkle .bin files in project directories or reaching inside the python package dir hierarchy.
_ _ _
| | | | | |
| |__ _ _ ____ | |__ | | _____
| _ \| | | | \| _ \| || ___ |
| |_) ) |_| | | | | |_) ) || ____|
|____/|____/|_|_|_|____/ \_)_____)
Bluetooth Stack for Apps, Emulation, Test and Experimentation
Bumble is a full-featured Bluetooth stack written entirely in Python. It supports most of the common Bluetooth Low Energy (BLE) and Bluetooth Classic (BR/EDR) protocols and profiles, including GAP, L2CAP, ATT, GATT, SMP, SDP, RFCOMM, HFP, HID and A2DP. The stack can be used with physical radios via HCI over USB, UART, or the Linux VHCI, as well as virtual radios, including the virtual Bluetooth support of the Android emulator.
Documentation
Browse the pre-built Online Documentation,
or see the documentation source under docs/mkdocs/src, or build the static HTML site from the markdown text with:
mkdocs build -f docs/mkdocs/mkdocs.yml
Usage
Getting Started
For a quick start to using Bumble, see the Getting Started guide.
Dependencies
To install package dependencies needed to run the bumble examples, execute the following commands:
python -m pip install --upgrade pip
python -m pip install ".[test,development,documentation]"
Examples
Refer to the Examples Documentation for details on the included example scripts and how to run them.
The complete list of Examples, and what they are designed to do is here.
There are also a set of Apps and Tools that show the utility of Bumble.
Using Bumble With a USB Dongle
Bumble is easiest to use with a dedicated USB dongle.
This is because internal Bluetooth interfaces tend to be locked down by the operating system.
You can use the usb_probe tool (all platforms) or lsusb (Linux or macOS) to list the available USB devices on your system.
See the USB Transport page for details on how to refer to USB devices. Also, if your are on a mac, see these instructions.
License
Licensed under the Apache 2.0 License.
Disclaimer
This is not an official Google product.
This library is in alpha and will be going through a lot of breaking changes. While releases will be stable enough for prototyping, experimentation and research, we do not recommend using it in any production environment yet. Expect bugs and sharp edges. Please help by trying it out, reporting bugs, and letting us know what you think!