Skip to main content

CircuitPython BLE library for Google's open 'physical web' Eddystone.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython BLE library for Google’s open “physical web” Eddystone.

Dependencies

This driver depends on:

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

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ble-eddystone

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ble-eddystone

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ble-eddystone

Usage Example

"""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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ble_eddystone-1.10.22.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ble_eddystone-1.10.22.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_eddystone-1.10.22.tar.gz
Algorithm Hash digest
SHA256 33954714784e39f1c08f47d7b409d307843e543d97937c0827ed9092b42c297f
MD5 ca20dc45fb879f09c925dcd92db4d76f
BLAKE2b-256 3583ae5d12455708996749f1ec164130aefbeb7d4561d385f9674c2b4b743929

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ble_eddystone-1.10.22-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_eddystone-1.10.22-py3-none-any.whl
Algorithm Hash digest
SHA256 5e871850ff2878a3a1e550cb0ead9500d0bc8855bd0820d9e1107cf2ceba0029
MD5 72d15bc7fe427d0e25dc752ba95cc710
BLAKE2b-256 9745773e471ba70ccf98d81da230c25c9a18f300e7a43d56883f8abb9e58b1a2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page