https://github.com/brentru/adafruit_circuitpython_lifx_api
LIFX Smart Lighting API Helper for CircuitPython
https://github.com/brentru/adafruit_circuitpython_lifx_api
api iot lifx
Last synced: about 1 year ago
JSON representation
LIFX Smart Lighting API Helper for CircuitPython
- Host: GitHub
- URL: https://github.com/brentru/adafruit_circuitpython_lifx_api
- Owner: brentru
- License: mit
- Created: 2019-04-01T18:29:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-07T14:22:41.000Z (over 5 years ago)
- Last Synced: 2025-02-09T11:27:34.931Z (over 1 year ago)
- Topics: api, iot, lifx
- Language: Python
- Size: 32.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lifx/badge/?version=latest
:target: https://circuitpython.readthedocs.io/projects/lifx/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://discord.gg/nBQh6qu
:alt: Discord
.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_lifx.svg?branch=master
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_lifx
:alt: Build Status
Control `LIFX devices `_ over the internet using CircuitPython.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
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.
* SPI: `Adafruit CircuitPython ESP32SPI `_
* UART: `Adafruit CircuitPython ESP_ATcontrol `_
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:
.. code-block:: shell
pip3 install adafruit-circuitpython-lifx
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-lifx
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-lifx
Usage Example
=============
Initialize the LIFX API Client with a WiFiManager object and a
`LIFX Personal Access token `_:
.. code-block:: python
lifx = adafruit_lifx.LIFX(wifi, lifx_token)
Set a `LIFX selector `_ label to identify the LIFX device to communicate with.
.. code-block:: python
lifx_light = 'label:Lamp'
List all connected LIFX devices:
.. code-block:: python
lights = lifx.list_lights()
Toggle the state of a LIFX device:
.. code-block:: python
lifx.toggle_light(lifx_light)
Set the brightness of a LIFX device to 50%:
.. code-block:: python
lifx.set_brightness(lifx_light, 0.5)
Set the color of a LIFX device to blue and the brightness to 100%:
.. code-block:: python
lifx.set_color(lifx_light, 'on', 'blue', brightness=1.0)
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.
Building locally
================
Zip release files
-----------------
To build this library locally you'll need to install the
`circuitpython-build-tools `_ package.
.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
.. code-block:: shell
source .env/bin/activate
Then run the build:
.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lifx --library_location .
Sphinx documentation
-----------------------
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):
.. code-block:: shell
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
.. code-block:: shell
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.