Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_eddystone/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ble_eddystone/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_Eddystone/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Eddystone/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
CircuitPython BLE library for Google's open "physical web" Eddystone.
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://circuitpython.org/libraries>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ble_eddystone/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ble-eddystone
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ble-eddystone
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-eddystone
Usage Example
=============
.. code-block:: python
"""This example broadcasts our Mac Address as our Eddystone ID and a link to the Adafruit Discord
server."""
import time
import adafruit_ble
from adafruit_ble_eddystone import uid, url
radio = adafruit_ble.BLERadio()
# Reuse the BLE address as our Eddystone instance id.
eddystone_uid = uid.EddystoneUID(radio.address_bytes)
eddystone_url = url.EddystoneURL("https://adafru.it/discord")
while True:
# Alternate between advertising our ID and our URL.
radio.start_advertising(eddystone_uid)
time.sleep(0.5)
radio.stop_advertising()
radio.start_advertising(eddystone_url)
time.sleep(0.5)
radio.stop_advertising()
time.sleep(4)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble_eddystone/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_Eddystone/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-eddystone",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ble_eddystone, eddystone, ble",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/5f/89/611ccc6318ab92ced5b96ede6b197cd7baeec6ea9e70b54d82eea79c7083/adafruit_circuitpython_ble_eddystone-1.10.20.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_eddystone/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ble_eddystone/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_Eddystone/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Eddystone/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\nCircuitPython BLE library for Google's open \"physical web\" Eddystone.\n\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://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\n=====================\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_eddystone/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ble-eddystone\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-eddystone\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-eddystone\n\nUsage Example\n=============\n\n.. code-block:: python\n\n \"\"\"This example broadcasts our Mac Address as our Eddystone ID and a link to the Adafruit Discord\n server.\"\"\"\n\n import time\n\n import adafruit_ble\n from adafruit_ble_eddystone import uid, url\n\n radio = adafruit_ble.BLERadio()\n\n # Reuse the BLE address as our Eddystone instance id.\n eddystone_uid = uid.EddystoneUID(radio.address_bytes)\n eddystone_url = url.EddystoneURL(\"https://adafru.it/discord\")\n\n while True:\n # Alternate between advertising our ID and our URL.\n radio.start_advertising(eddystone_uid)\n time.sleep(0.5)\n radio.stop_advertising()\n\n radio.start_advertising(eddystone_url)\n time.sleep(0.5)\n radio.stop_advertising()\n\n time.sleep(4)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ble_eddystone/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_Eddystone/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython BLE library for Google's open 'physical web' Eddystone.",
"version": "1.10.20",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BLE_Eddystone"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ble_eddystone",
" eddystone",
" ble"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ccabb053044ae26a22987a895a9949114eed99d57e8d5b5e6a66c2fb92621899",
"md5": "719152b49da893c29189ee92bf3eada0",
"sha256": "0295414423a56de42caabf622a986b363635b01f4f7339418145aaba5d4b5223"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ble_eddystone-1.10.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "719152b49da893c29189ee92bf3eada0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7299,
"upload_time": "2025-01-16T19:29:14",
"upload_time_iso_8601": "2025-01-16T19:29:14.059382Z",
"url": "https://files.pythonhosted.org/packages/cc/ab/b053044ae26a22987a895a9949114eed99d57e8d5b5e6a66c2fb92621899/adafruit_circuitpython_ble_eddystone-1.10.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f89611ccc6318ab92ced5b96ede6b197cd7baeec6ea9e70b54d82eea79c7083",
"md5": "f9491ef54f4121fe2d6b9414ac74c980",
"sha256": "18c8d662aeed53136b83e74ac265cf806bc20ee8d288b2e960d41139b8c8bf39"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ble_eddystone-1.10.20.tar.gz",
"has_sig": false,
"md5_digest": "f9491ef54f4121fe2d6b9414ac74c980",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27172,
"upload_time": "2025-01-16T19:29:14",
"upload_time_iso_8601": "2025-01-16T19:29:14.906677Z",
"url": "https://files.pythonhosted.org/packages/5f/89/611ccc6318ab92ced5b96ede6b197cd7baeec6ea9e70b54d82eea79c7083/adafruit_circuitpython_ble_eddystone-1.10.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 19:29:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BLE_Eddystone",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-ble",
"specs": [
[
">=",
"8.0.0"
]
]
}
],
"lcname": "adafruit-circuitpython-ble-eddystone"
}
JSON
