Skip to main content

LIFX Smart Lighting API Helper

Project description

Introduction

Documentation Status Discord Build Status

Control LIFX devices over the internet using CircuitPython.

Dependencies

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

Usage Example

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:

lifx.toggle_light(lifx_light)

Set the brightness of a LIFX device to 50%:

lifx.set_brightness(lifx_light, 0.5)

Set the color of a LIFX device to blue and the brightness to 100%:

lifx.set_color(lifx_light, 'on', 'blue', brightness=1.0)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-lifx-1.10.5.tar.gz (28.9 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-lifx-1.10.5.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-lifx-1.10.5.tar.gz
Algorithm Hash digest
SHA256 4abeed8fef060c7153f4ddc889647f49199573449470e89fbe6ff74c539f51af
MD5 ce72f727f4cd3b92820067a64b28aec8
BLAKE2b-256 7529d1b869895b90033ca4cfaf52e09d8e828117a0072b2ceae64570e69497ec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page