Simple byte and string based inter-device communication via BLE.
Project description
Introduction
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-ble-radio-0.5.0.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-ble-radio-0.5.0.tar.gz
- Upload date:
- Size: 31.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f14b102aaef6e0ea96542b3e69eaa83f5f8d2908b67c7a920f58999e688c6b9 |
|
| MD5 | 4c5e2432add6761c8a44c881ff98214f |
|
| BLAKE2b-256 | dcd81dab1eb98816ef0c7feb565a08afe836e0a8567c8e3b7010a60aee837c70 |
