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.12.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ble-eddystone-1.0.12.tar.gz
Algorithm Hash digest
SHA256 4e212f743427940e51dd8ac38bf01c8eb3f895f2dc666afaaea34391e381cfa6
MD5 c52b168aec7a64d4a6bb8d78d340c726
BLAKE2b-256 13f38a905737863863b721666899afba2eab427de3c447de6fa9eb03241ba55f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_eddystone-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 325e4c2d556da5d4cfc373aa6bd10d322147782d1f4da5eec1b83392327fa93a
MD5 e004fcd1aff0a05e26a2c6c5bcfe053b
BLAKE2b-256 4628036f65daf75420f30b55587c65d21ff292766a99e4fe9302cff67ec707d2

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