Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Built Distribution

File details

Details for the file adafruit-circuitpython-ble-eddystone-1.0.13.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ble-eddystone-1.0.13.tar.gz
Algorithm Hash digest
SHA256 6eef2ee381fc1319ce2aa797b9b4b067735929f7e1691d374bf34941eefaecdf
MD5 bd5556ff6ba3183ccb0850f2b5b5802d
BLAKE2b-256 8ceb2127ec1e86f9261feb243ec32a65e82ad2ccc82bb155f41942cec3cdf980

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_eddystone-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 85e4654a6e5aa44dc5c1c5d244ef64dd55ce6f76dd384e829f464bd37b4b3228
MD5 cc0785f7ba0d13a767b3e484f69f8035
BLAKE2b-256 94a47daca135ca40e258bb793605bbcedc3ed60619f5157b610242e9a8066b2c

See more details on using hashes here.

Supported by

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