/Adafruit_CircuitPython_BluefruitConnect

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

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

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-bluefruitconnect

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-bluefruitconnect

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-bluefruitconnect

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())

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.