Skip to main content

CircuitPython helper library for the Philips Hue

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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 settings.toml file:

username = os.getenv("hue_username")
bridge_ip = os.getenv("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-2.0.3.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_hue-2.0.3-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-2.0.3.tar.gz
Algorithm Hash digest
SHA256 328bd331717d46344f85007f8fcabc605f7044a0fdedfc0c2bfa5f5b19c4abca
MD5 9c5ebb39e064b56e81ce840395e978ad
BLAKE2b-256 a42fd242d07d1bb527f2b3c8bc59c6498cf7d6deba027def984ae3daf884c255

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_hue-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9564f4ea3abbcc34bdc213fac77504163eead2c0ca1a43ddcfe669e323aacc9d
MD5 27f02e4bcfb7717cb8f4bf377bf53f13
BLAKE2b-256 8b2f5e4b8087a5683ec17b0fc51f5da98f9bc6b44b00acafa2efd85cad8bcb14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page