Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bluefruitconnect/badge/?version=latest
:target: https://docs.circuitpython.org/projects/bluefruitconnect/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This module helps you to communicate with the Adafruit Bluefruit Connect app or use its protocols.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-bluefruitconnect/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bluefruitconnect
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bluefruitconnect
To install in a virtual environment in your current project:
.. code-block:: shell
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
<https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect>`_
library
(``adafruit_bluefruit_connect``). The included examples use that library.
Below is a simple standalone example.
.. code-block:: python
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 <https://docs.circuitpython.org/projects/bluefruitconnect/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-bluefruitconnect",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,ble,bluefruit,bluetooth,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/00/7a/965c8b4eb461ef4924a7f3b72a9deca4f6c1c1ea21ad3f47fe6efc68b435/adafruit-circuitpython-bluefruitconnect-1.2.13.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bluefruitconnect/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/bluefruitconnect/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis module helps you to communicate with the Adafruit Bluefruit Connect app or use its protocols.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-bluefruitconnect/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-bluefruitconnect\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-bluefruitconnect\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-bluefruitconnect\n\nUsage Example\n=============\n\nNormally this library is used with the\n`Adafruit_CircuitPython_BluefruitConnect\n<https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect>`_\nlibrary\n(``adafruit_bluefruit_connect``). The included examples use that library.\nBelow is a simple standalone example.\n\n.. code-block:: python\n\n from adafruit_bluefruit_connect.color_packet import ColorPacket\n from adafruit_bluefruit_connect.gyro_packet import GyroPacket\n\n # [uart setup omitted]\n\n color_packet = ColorPacket((70,75,80))\n gyro_packet = GyroPacket.from_bytes(packet_buf)\n uart.write(gyro_packet.to_bytes())\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bluefruitconnect/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for use with the Adafruit Bluefruit Connect apps.",
"version": "1.2.13",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect"
},
"split_keywords": [
"adafruit",
"ble",
"bluefruit",
"bluetooth",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d587203d224e32007e91f7babcd7c86b18bb030d8d013654dafb6c41ef163fd5",
"md5": "6d926294678da0cc6f4b8fe7865cba28",
"sha256": "4b5cfd048861e036df5672e1b1349f93c41b16a693e0728db488948beadb3150"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bluefruitconnect-1.2.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d926294678da0cc6f4b8fe7865cba28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14908,
"upload_time": "2023-12-09T17:43:32",
"upload_time_iso_8601": "2023-12-09T17:43:32.766912Z",
"url": "https://files.pythonhosted.org/packages/d5/87/203d224e32007e91f7babcd7c86b18bb030d8d013654dafb6c41ef163fd5/adafruit_circuitpython_bluefruitconnect-1.2.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "007a965c8b4eb461ef4924a7f3b72a9deca4f6c1c1ea21ad3f47fe6efc68b435",
"md5": "e396477eaa49576bb2f35b17c216ec66",
"sha256": "363b7e7fbf607aef69c0c07cfc83151b11fae6b218d2060eef4a9399f9ef864c"
},
"downloads": -1,
"filename": "adafruit-circuitpython-bluefruitconnect-1.2.13.tar.gz",
"has_sig": false,
"md5_digest": "e396477eaa49576bb2f35b17c216ec66",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32827,
"upload_time": "2023-12-09T17:43:34",
"upload_time_iso_8601": "2023-12-09T17:43:34.608029Z",
"url": "https://files.pythonhosted.org/packages/00/7a/965c8b4eb461ef4924a7f3b72a9deca4f6c1c1ea21ad3f47fe6efc68b435/adafruit-circuitpython-bluefruitconnect-1.2.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:43:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BluefruitConnect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-bluefruitconnect"
}
JSON
