Skip to main content

CircuitPython helper library for the Philips Hue

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

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_hue-1.2.7.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_hue-1.2.7.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-1.2.7.tar.gz
Algorithm Hash digest
SHA256 bab3e86680c0227a361a0da487c87ea17cbbac5c234fe09653816210edd79d8b
MD5 321af7bed69edd19be7f4e99255a7740
BLAKE2b-256 9afd7ec2c51454deebff0c5046354b131d4c3525f4a295c37e3ecbdc6a65212c

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_hue-1.2.7-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 acb48639176b46ec76dcbe31dfabb947d2381e514177e76a3d1d2e2c7e7fdc75
MD5 1389dd958b725af8c253ef6926efd933
BLAKE2b-256 74735845e3376231d7e03697d30f7237354733baa18a4b26297097602a5a27c5

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