Skip to main content

Simple byte and string based inter-device communication via BLE.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

This library provides simple byte and string based inter-device communication via BLE.

It works like a walkie-talkie: configure your device to use a certain channel (numbered 0-255, default being 42) and it will broadcast on that channel and receive any messages from other devices using that channel.

Dependencies

This library depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

All the functionality is exposed via the very simple Radio class:

from adafruit_ble_radio import Radio


# A radio instance listens/broadcasts on a numbered channel.
r = Radio(channel=7)

# Update radio instance settings.
r.configure(channel=9)

# Broadcast a simple string message.
r.send("Hello")

# Broadcast raw bytes.
r.send_bytes(b"Hello")

# A loop to listen for incoming string based messages...
while True:
    msg = r.receive()
    if msg:
        print(msg)

# Alternatively, to get the raw bytes and other details...
while True:
    msg = r.receive_full()
    if msg:
        msg_bytes = msg[0]
        msg_strength = msg[1]
        msg_time = msg[2]
        print("Recieved {} (strength {}, at time {})".format(
              msg_bytes,
              msg_strength,
              msg_time))

Unit Tests

To run the test suite you should have pytest and pytest-coverage installed (pip install pytest pytest-coverage).

Run the unit tests with the following command:

$ pytest --cov-report term-missing --cov=adafruit_ble_radio tests/

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_radio-0.5.14.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ble_radio-0.5.14.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_radio-0.5.14.tar.gz
Algorithm Hash digest
SHA256 7c6e7ba92bb4fed9c6c2ecb9bb9b3bbe346469c2eae4cd8893d62d21ea4b12c8
MD5 39a277afc9650047e0d9c8fbcf2bf296
BLAKE2b-256 ef50f86114f2678216997e36c6cd18087510537cfe358cd3987d793302789755

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ble_radio-0.5.14-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ble_radio-0.5.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6a4aa3f7e47e1f8c9359546542803d4e3b7e2f888989a3c660385d6a6ac4287b
MD5 412dd865eeffdf6da5bd3fe990265c8e
BLAKE2b-256 5ecac5f590742b268447f29d9e35c0a45ae44a2a4bbf0e6081445a94a816d82b

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