This driver depends on:
You’ll also need a library to communicate with an ESP32 as a coprocessor using a WiFiManager object. This library supports connecting an ESP32 using either SPI or UART.
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-lifx
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-lifx
To install in a virtual environment in your current project:
mkdir project-name && cd project-name python3 -m venv .env source .env/bin/activate pip3 install adafruit-circuitpython-lifx
Initialize the LIFX API Client with a WiFiManager object and a LIFX Personal Access token:
lifx = adafruit_lifx.LIFX(wifi, lifx_token)
Set a LIFX selector label to identify the LIFX device to communicate with.
lifx_light = 'label:Lamp'
List all connected LIFX devices:
lights = lifx.list_lights()
Toggle the state of a LIFX device:
Set the brightness of a LIFX device to 50%:
Set the color of a LIFX device to blue and the brightness to 100%:
lifx.set_color(lifx_light, 'on', 'blue', brightness=1.0)
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
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:
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lifx --library_location .
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.