Skip to main content

LIFX Smart Lighting API Helper

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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 .venv
source .venv/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-2.0.4.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_lifx-2.0.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_lifx-2.0.4.tar.gz
Algorithm Hash digest
SHA256 1de0edcc832fd9609c98719cb2196029d3cade2da88a8e44c388634311aa7f65
MD5 fd5160dfd7ea477574eaee3fdc20256a
BLAKE2b-256 b0953ae9e08549e696268019f7207b3792ffdd1a2e45c5816734b038917e7d4c

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_lifx-2.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_lifx-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3b3db5a298fc605c6921591845406e8d8c099e9f444acdab439214ec0c7765a0
MD5 68974628c0db302daaebc493df21c5fe
BLAKE2b-256 eb7fb1c21d7ab91cdafe32d6b9a8e43c4a90d9dc004dbd7d1d9632da22d1febb

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