Skip to main content

CircuitPython library for use with the Adafruit Bluefruit Connect apps.

Project description

Introduction

Documentation Status Discord Build Status

This module helps you to communicate with the Adafruit Bluefruit Connect app or use its protocols.

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.

Usage Example

Normally this library is used with the Adafruit_CircuitPython_BluefruitConnect library (adafruit_bluefruit_connect). The included examples use that library. Below is a simple standalone example.

from adafruit_bluefruit_connect.color_packet import ColorPacket
from adafruit_bluefruit_connect.gyro_packet import GyroPacket

# [uart setup omitted]

color_packet = ColorPacket((70,75,80))
gyro_packet = GyroPacket.from_bytes(packet_buf)
uart.write(gyro_packet.to_bytes())

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bluefruitconnect --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

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

File details

Details for the file adafruit-circuitpython-bluefruitconnect-1.0.9.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-bluefruitconnect-1.0.9.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for adafruit-circuitpython-bluefruitconnect-1.0.9.tar.gz
Algorithm Hash digest
SHA256 a2c67f1e9120b223c23e45f1624c6c6a8c4be18cc46efcfb1b6fd119d3204f0b
MD5 a06859ef23953149ad671d59a47b1c50
BLAKE2b-256 afc4fad5b61030aba882377d98903322cf7940a2d136a7f85dc9fff7e9787e59

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