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.2.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-hue-1.2.2.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-hue-1.2.2.tar.gz
Algorithm Hash digest
SHA256 1030aff1e9d8d7167d009d6252e7939b492ec83c188c6431d74437be517deb68
MD5 2fa8df87dd7522997f1ed50630cc1f3c
BLAKE2b-256 42263814e3b512ea43e0a60c6cfce85811d5c5d060d753d025edbe8b10952c84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0cdc918ed16f17f82448509fbf86e09b5f828239cd744f0c57c4797fb05b8f45
MD5 daa742036326733c736f12c82ee89ee8
BLAKE2b-256 f0eb18cfbf191d7734d13127a0ff4db18559d3e1c3cd82137546c365383fd403

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