Introduction
CircuitPython helper library for Philips Hue Lights.
Dependencies
This driver depends on:
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-hue
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-hue
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-hue
Usage Example
Load bridge username and IP Address from secrets.py file:
username = secrets['hue_username']
bridge_ip = secrets['bridge_ip']
my_bridge = Bridge(wifi, bridge_ip, username)
Enumerate all lights on the bridge
lights = my_bridge.get_lights()
Turn on a light
my_bridge.set_light(1, on=True)
Turn off a light
my_bridge.set_light(1, on=False)
Set a light to the color yellow (RGB)
color = my_bridge.rgb_to_hsb([255, 255, 0])
my_bridge.set_light(1, hue=int(color[0]), sat=int(color[1]), bri=int(color[2]))
Set a group of lights to a predefined scene
my_bridge.set_group(1, scene='AB34EF5')
Set a group of lights to a predefined color
my_bridge.set_group(1, color)
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.
Table of Contents
Examples
API Reference