Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bluefruitspi/badge/?version=latest
:target: https://docs.circuitpython.org/projects/bluefruitspi/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_BluefruitSPI/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI/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
Helper class to work with the Adafruit Bluefruit LE SPI Friend.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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-bluefruitspi/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bluefruitspi
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bluefruitspi
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-bluefruitspi
Usage Example
=============
.. code-block:: python
# A simple echo test for the Feather M0 Bluefruit
# Sets the name, then echo's all RX'd data with a reversed packet
import time
import busio
import board
from digitalio import DigitalInOut
from adafruit_bluefruitspi import BluefruitSPI
spi_bus = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
cs = DigitalInOut(board.D8)
irq = DigitalInOut(board.D7)
rst = DigitalInOut(board.D4)
bluefruit = BluefruitSPI(spi_bus, cs, irq, rst, debug=False)
# Initialize the device and perform a factory reset
print("Initializing the Bluefruit LE SPI Friend module")
bluefruit.init()
bluefruit.command_check_OK(b'AT+FACTORYRESET', delay=1)
# Print the response to 'ATI' (info request) as a string
print(str(bluefruit.command_check_OK(b'ATI'), 'utf-8'))
# Change advertised name
bluefruit.command_check_OK(b'AT+GAPDEVNAME=BlinkaBLE')
while True:
print("Waiting for a connection to Bluefruit LE Connect ...")
# Wait for a connection ...
dotcount = 0
while not bluefruit.connected:
print(".", end="")
dotcount = (dotcount + 1) % 80
if dotcount == 79:
print("")
time.sleep(0.5)
# Once connected, check for incoming BLE UART data
print("\n *Connected!*")
connection_timestamp = time.monotonic()
while True:
# Check our connection status every 3 seconds
if time.monotonic() - connection_timestamp > 3:
connection_timestamp = time.monotonic()
if not bluefruit.connected:
break
# OK we're still connected, see if we have any data waiting
resp = bluefruit.uart_rx()
if not resp:
continue # nothin'
print("Read %d bytes: %s" % (len(resp), resp))
# Now write it!
print("Writing reverse...")
send = []
for i in range(len(resp), 0, -1):
send.append(resp[i-1])
print(bytes(send))
bluefruit.uart_tx(bytes(send))
print("Connection lost.")
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bluefruitspi/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_BluefruitSPI/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-bluefruitspi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, ble, bluetooth, bluefruit, spi, friend, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/7d/84/cfe04addbc7264db5a82906d5c25fd98c2ecc1277beb2defbe7f60d1b705/adafruit_circuitpython_bluefruitspi-1.1.20.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bluefruitspi/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/bluefruitspi/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_BluefruitSPI/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI/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\nHelper class to work with the Adafruit Bluefruit LE SPI Friend.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\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-bluefruitspi/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-bluefruitspi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-bluefruitspi\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-bluefruitspi\n\nUsage Example\n=============\n\n.. code-block:: python\n\n # A simple echo test for the Feather M0 Bluefruit\n # Sets the name, then echo's all RX'd data with a reversed packet\n\n import time\n import busio\n import board\n from digitalio import DigitalInOut\n from adafruit_bluefruitspi import BluefruitSPI\n\n spi_bus = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)\n cs = DigitalInOut(board.D8)\n irq = DigitalInOut(board.D7)\n rst = DigitalInOut(board.D4)\n bluefruit = BluefruitSPI(spi_bus, cs, irq, rst, debug=False)\n\n # Initialize the device and perform a factory reset\n print(\"Initializing the Bluefruit LE SPI Friend module\")\n bluefruit.init()\n bluefruit.command_check_OK(b'AT+FACTORYRESET', delay=1)\n\n # Print the response to 'ATI' (info request) as a string\n print(str(bluefruit.command_check_OK(b'ATI'), 'utf-8'))\n\n # Change advertised name\n bluefruit.command_check_OK(b'AT+GAPDEVNAME=BlinkaBLE')\n\n while True:\n print(\"Waiting for a connection to Bluefruit LE Connect ...\")\n # Wait for a connection ...\n dotcount = 0\n while not bluefruit.connected:\n print(\".\", end=\"\")\n dotcount = (dotcount + 1) % 80\n if dotcount == 79:\n print(\"\")\n time.sleep(0.5)\n\n # Once connected, check for incoming BLE UART data\n print(\"\\n *Connected!*\")\n connection_timestamp = time.monotonic()\n while True:\n # Check our connection status every 3 seconds\n if time.monotonic() - connection_timestamp > 3:\n connection_timestamp = time.monotonic()\n if not bluefruit.connected:\n break\n\n # OK we're still connected, see if we have any data waiting\n resp = bluefruit.uart_rx()\n if not resp:\n continue # nothin'\n print(\"Read %d bytes: %s\" % (len(resp), resp))\n # Now write it!\n print(\"Writing reverse...\")\n send = []\n for i in range(len(resp), 0, -1):\n send.append(resp[i-1])\n print(bytes(send))\n bluefruit.uart_tx(bytes(send))\n\n print(\"Connection lost.\")\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bluefruitspi/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_BluefruitSPI/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper class to work with the Adafruit Bluefruit LE SPI Friend.",
"version": "1.1.20",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI"
},
"split_keywords": [
"adafruit",
" ble",
" bluetooth",
" bluefruit",
" spi",
" friend",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02ae363c3081841d05fd41dfab5cbd1fa50cc1495a58d947fa543d3273595a2f",
"md5": "2c114d9efc0b4d8a98cd2dda28d8871e",
"sha256": "a9fd029f93804e209f14afb99c1608bb21af535981e171a7016af77ddb81b75d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bluefruitspi-1.1.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c114d9efc0b4d8a98cd2dda28d8871e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8597,
"upload_time": "2024-10-07T21:38:06",
"upload_time_iso_8601": "2024-10-07T21:38:06.370515Z",
"url": "https://files.pythonhosted.org/packages/02/ae/363c3081841d05fd41dfab5cbd1fa50cc1495a58d947fa543d3273595a2f/adafruit_circuitpython_bluefruitspi-1.1.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d84cfe04addbc7264db5a82906d5c25fd98c2ecc1277beb2defbe7f60d1b705",
"md5": "50d11716c4d12ae9b4f39477ed50263c",
"sha256": "294585d41ac61c1394f5207d2eb939511522af58de6aef767d24118b2b392dfd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bluefruitspi-1.1.20.tar.gz",
"has_sig": false,
"md5_digest": "50d11716c4d12ae9b4f39477ed50263c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31402,
"upload_time": "2024-10-07T21:38:08",
"upload_time_iso_8601": "2024-10-07T21:38:08.345973Z",
"url": "https://files.pythonhosted.org/packages/7d/84/cfe04addbc7264db5a82906d5c25fd98c2ecc1277beb2defbe7f60d1b705/adafruit_circuitpython_bluefruitspi-1.1.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:38:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BluefruitSPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-bluefruitspi"
}
JSON
