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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-hue-1.2.1.tar.gz
Algorithm Hash digest
SHA256 839008fd780cb97e832a06d6838a145415c487ae02a97e9a90a03b3a1e772bf8
MD5 fcea3df57b1f257c76fb1cd7cefc9e3b
BLAKE2b-256 dbf2792b7fa3fbb11f8e4abfd0a2d83bddf677d04a38e664d8b328945f00f0c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87f1e0200f41cc621a6b01db5657e42dcc4b030936f7359855dfb9baca6399ce
MD5 825ff73cdd6c683cfd938edd28c3a3bd
BLAKE2b-256 9e46a58bf4c8a84365f5fd1fb39adc04ac46ff71d3d44b3b380947f98a4c92a5

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