Google Git
Sign in
android / platform / external / python / bumble / c407ec9a8ded30ce8c578fc1a459324873d30bff
commitc407ec9a8ded30ce8c578fc1a459324873d30bff[log] [tgz]
authorXin Li <[email protected]>Fri Oct 18 21:12:49 2024 +0000
committerAutomerger Merge Worker <[email protected]>Fri Oct 18 21:12:49 2024 +0000
tree5153ce343695e49f7a3080ec9da8b766564bf6e4
parent7abf3d4b6f31cdbc09f607e18eab1aaedb02f9ba [diff]
parentcf4072a7b0d7e13d5c24510ec1a7f2614ea4841c [diff]
[automerger skipped] Mark 24Q4 as merged in aosp-main-future am: cf4072a7b0 -s ours

am skip reason: Merged-In I1e055d59be78d3042c011775056c6f627a542b2e with SHA-1 7abf3d4b6f is already in history

Original change: https://googleplex-android-review.googlesource.com/c/platform/external/python/bumble/+/29934164

Change-Id: Ia538e901cb6704f0c85f7ae5c56f421c34aa548f
Signed-off-by: Automerger Merge Worker <[email protected]>
tree: 5153ce343695e49f7a3080ec9da8b766564bf6e4
  1. .devcontainer/
  2. .github/
  3. .vscode/
  4. apps/
  5. bumble/
  6. docs/
  7. examples/
  8. extras/
  9. rust/
  10. scripts/
  11. tests/
  12. tools/
  13. web/
  14. .git-blame-ignore-revs
  15. .gitignore
  16. Android.bp
  17. CONTRIBUTING.md
  18. environment.yml
  19. LICENSE
  20. METADATA
  21. MODULE_LICENSE_APACHE2
  22. noxfile.py
  23. OWNERS
  24. pyproject.toml
  25. README.md
  26. setup.cfg
  27. setup.py
  28. tasks.py
README.md
 _                 _     _
| |               | |   | |
| |__  _   _ ____ | |__ | | _____
|  _ \| | | |    \|  _ \| || ___ |
| |_) ) |_| | | | | |_) ) || ____|
|____/|____/|_|_|_|____/ \_)_____)

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!