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 <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
Warning: Linux support is **very** limited. See `Adafruit Blinka _bleio
<https://github.com/adafruit/Adafruit_Blinka_bleio>`_ for details.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ble/>`_. 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 <https://docs.circuitpython.org/projects/ble/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_ble/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ble",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ble, bluetooth",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/d9/b6404df47f6d4036ffc984a20c71862e5edef781565603d9a2704157fe63/adafruit_circuitpython_ble-10.0.10.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ble/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_ble/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ble/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis module provides higher-level BLE (Bluetooth Low Energy) functionality,\nbuilding on the native `_bleio` module.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nWarning: Linux support is **very** limited. See `Adafruit Blinka _bleio\n<https://github.com/adafruit/Adafruit_Blinka_bleio>`_ for details.\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ble/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ble\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ble\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-ble\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from adafruit_ble import BLERadio\n\n radio = BLERadio()\n print(\"scanning\")\n found = set()\n for entry in radio.start_scan(timeout=60, minimum_rssi=-80):\n addr = entry.address\n if addr not in found:\n print(entry)\n found.add(addr)\n\n print(\"scan done\")\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_ble/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bluetooth Low Energy (BLE) library for CircuitPython",
"version": "10.0.10",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BLE"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ble",
" bluetooth"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa611980b3adea7f4134c7c3edf33518f1b8585a8a68df272504d50b2758bd83",
"md5": "796e997672df7349fa7132001f3d4ecc",
"sha256": "3411238568d23e880e169b5be35223bbe65cb8d8c505d2723bc034bdbb350fcc"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ble-10.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "796e997672df7349fa7132001f3d4ecc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37520,
"upload_time": "2024-11-18T15:25:16",
"upload_time_iso_8601": "2024-11-18T15:25:16.661869Z",
"url": "https://files.pythonhosted.org/packages/fa/61/1980b3adea7f4134c7c3edf33518f1b8585a8a68df272504d50b2758bd83/adafruit_circuitpython_ble-10.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4fd9b6404df47f6d4036ffc984a20c71862e5edef781565603d9a2704157fe63",
"md5": "3cd86befe2c419042df0643f0c5b66e5",
"sha256": "dda2eb78b978180b0fa3255c95f7e5a948a90e6b6d205517e090dce2a7fa8c22"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ble-10.0.10.tar.gz",
"has_sig": false,
"md5_digest": "3cd86befe2c419042df0643f0c5b66e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56341,
"upload_time": "2024-11-18T15:25:17",
"upload_time_iso_8601": "2024-11-18T15:25:17.826373Z",
"url": "https://files.pythonhosted.org/packages/4f/d9/b6404df47f6d4036ffc984a20c71862e5edef781565603d9a2704157fe63/adafruit_circuitpython_ble-10.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 15:25:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BLE",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-blinka-bleio",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": []
},
{
"name": "typing-extensions",
"specs": [
[
"~=",
"4.0.0"
]
]
}
],
"lcname": "adafruit-circuitpython-ble"
}
JSON
