https://github.com/adafruit/adafruit_circuitpython_ble
Bluetooth Low Energy (BLE) library for CircuitPython
https://github.com/adafruit/adafruit_circuitpython_ble
hacktoberfest
Last synced: about 1 year ago
JSON representation
Bluetooth Low Energy (BLE) library for CircuitPython
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_ble
- Owner: adafruit
- License: mit
- Created: 2018-12-31T19:05:01.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-05-15T21:01:53.000Z (about 1 year ago)
- Last Synced: 2025-05-15T21:07:07.223Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Python
- Homepage:
- Size: 466 KB
- Stars: 133
- Watchers: 19
- Forks: 57
- Open Issues: 33
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ble/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_ble/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_ble/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This module provides higher-level BLE (Bluetooth Low Energy) functionality,
building on the native `_bleio` module.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_.
Installing from PyPI
====================
Warning: Linux support is **very** limited. See `Adafruit Blinka _bleio
`_ for details.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ble
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ble
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ble
Usage Example
=============
.. code-block:: python
from adafruit_ble import BLERadio
radio = BLERadio()
print("scanning")
found = set()
for entry in radio.start_scan(timeout=60, minimum_rssi=-80):
addr = entry.address
if addr not in found:
print(entry)
found.add(addr)
print("scan done")
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
For information on building library documentation, please check out `this guide `_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.