126 lines
4.2 KiB
ReStructuredText
126 lines
4.2 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_magic_light/badge/?version=latest
|
|
:target: https://circuitpython.readthedocs.io/projects/ble_magic_light/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
.. image:: https://img.shields.io/discord/327254708534116352.svg
|
|
:target: https://adafru.it/discord
|
|
:alt: Discord
|
|
|
|
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light/workflows/Build%20CI/badge.svg
|
|
:target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light/actions
|
|
:alt: Build Status
|
|
|
|
BLE service for Magic Light BLE RGB bulbs. Available from Amazon
|
|
`here <https://www.amazon.com/gp/product/B073S1KV4F>`_.
|
|
|
|
|
|
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://circuitpython.org/libraries>`_.
|
|
|
|
Installing from PyPI
|
|
=====================
|
|
.. note:: This library is not available on PyPI yet. Install documentation is included
|
|
as a standard element. Stay tuned for PyPI availability!
|
|
|
|
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
|
|
PyPI <https://pypi.org/project/adafruit-circuitpython-ble_magic_light/>`_. To install for current user:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install adafruit-circuitpython-ble-magic-light
|
|
|
|
To install system-wide (this may be required in some cases):
|
|
|
|
.. code-block:: shell
|
|
|
|
sudo pip3 install adafruit-circuitpython-ble-magic-light
|
|
|
|
To install in a virtual environment in your current project:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir project-name && cd project-name
|
|
python3 -m venv .env
|
|
source .env/bin/activate
|
|
pip3 install adafruit-circuitpython-ble-magic-light
|
|
|
|
Usage Example
|
|
=============
|
|
|
|
.. code:: python
|
|
|
|
"""This demo connects to a magic light and has it do a color wheel."""
|
|
import adafruit_ble
|
|
import _bleio
|
|
|
|
from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
|
|
from adafruit_ble_magic_light import MagicLightService
|
|
|
|
def find_connection():
|
|
for connection in radio.connections:
|
|
if MagicLightService not in connection:
|
|
continue
|
|
return connection, connection[MagicLightService]
|
|
return None, None
|
|
|
|
# Start advertising before messing with the display so that we can connect immediately.
|
|
radio = adafruit_ble.BLERadio()
|
|
|
|
def wheel(pos):
|
|
# Input a value 0 to 255 to get a color value.
|
|
# The colours are a transition r - g - b - back to r.
|
|
if pos < 0 or pos > 255:
|
|
return (0, 0, 0)
|
|
if pos < 85:
|
|
return (255 - pos * 3, pos * 3, 0)
|
|
if pos < 170:
|
|
pos -= 85
|
|
return (0, 255 - pos * 3, pos * 3)
|
|
pos -= 170
|
|
return (pos * 3, 0, 255 - pos * 3)
|
|
|
|
active_connection, pixels = find_connection()
|
|
current_notification = None
|
|
app_icon_file = None
|
|
while True:
|
|
if not active_connection:
|
|
print("Scanning for Magic Light")
|
|
for scan in radio.start_scan(ProvideServicesAdvertisement):
|
|
if MagicLightService in scan.services:
|
|
active_connection = radio.connect(scan)
|
|
try:
|
|
pixels = active_connection[MagicLightService]
|
|
except _bleio.ConnectionError:
|
|
print("disconnected")
|
|
continue
|
|
break
|
|
radio.stop_scan()
|
|
|
|
i = 0
|
|
while active_connection.connected:
|
|
pixels[0] = wheel(i % 256)
|
|
i += 1
|
|
|
|
active_connection = None
|
|
|
|
Contributing
|
|
============
|
|
|
|
Contributions are welcome! Please read our `Code of Conduct
|
|
<https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light/blob/master/CODE_OF_CONDUCT.md>`_
|
|
before contributing to help this project stay welcoming.
|
|
|
|
Documentation
|
|
=============
|
|
|
|
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>`_.
|