Skip to main content
https://img.shields.io/pypi/v/python-hue-client.svg https://img.shields.io/pypi/dm/python-hue-client.svg https://img.shields.io/github/license/adamcharnock/python-hue-client.svg

A full-featured Python client for the Philips Hue lighting system.

Installation

Installation using pip (recommended):

pip install python-hue-client

Installation using easy_install:

easy_install python-hue-client

Documentation

Documentation can be found at http://python-hue-client.readthedocs.org

Quick Start

This library is modelled roughly on concepts borrowed from Django’s ORM. There are some examples available in GitHub, but let’s dive in with an example that list all the available lights:

from pprint import pprint
from hueclient.api import hue_api
from hueclient.models.light import Light

if __name__ == '__main__':
    hue_api.authenticate_interactive(app_name='List Lights Example')

    for light in Light.objects.all():
        print(
            "Light {id} is named '{name}' and is {onoff} (brightness: {brightness})".format(
                id=light.id,
                name=light.name,
                onoff='on' if light.state.on else 'off',
                brightness=light.state.brightness,
            )
        )

Here is an example which blinks a specific light:

from time import sleep
from hueclient.api import hue_api
from hueclient.models.light import Light

# examples/blink_light.py
if __name__ == '__main__':
    # Make sure we are authenticated with the hue bridge.
    # You will be prompted if no username is found in ~/.python_hue
    hue_api.authenticate_interactive(app_name='Blink Light Example')

    # Get light ID 1
    light = Light.objects.get(id=1)

    # Loop forever
    while True:
        # Flip the on state from on -> off / off -> on
        light.state.on = not light.state.on

        # Save the state back to the bridge
        # (Note: required in order for your changes to take effect)

        light.state.save()

        # Pause here for a couple of seconds to create a slow blink
        # (Note: It is important to sleep here at least a little to
        # avoid overloading the bridge with API requests)
        sleep(2)

For more information see the full documentation.

Credits

Developed by Adam Charnock, contributions very welcome!

python-hue-client is packaged using seed.

Release files for python-hue-client 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-hue-client 0.1.0
File Size Uploaded
python-hue-client-0.1.0.tar.gz 917.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for python-hue-client 0.1.0
File Interpreter ABI Platform
python_hue_client-0.1.0-cp27-none-macosx_10_10_x86_64.whl CPython 2.7 none macOS 10.10+ x86-64 Details

Total release size: 921.5 kB

Release files / python-hue-client-0.1.0.tar.gz

Download URL python-hue-client-0.1.0.tar.gz
Size 917.0 kB
Tags Source
SHA-256 checksum
How to use checksums
16d7de2fe0ca1594d56bb06f06eed3a5f627eb6f45dcfdb19e7422a6af0a7e1b
BLAKE2b-256 checksum
How to use checksums
be9a1e6438910cbba3f0a320b475eff74d28aa738eb49887cab006f20764605b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / python_hue_client-0.1.0-cp27-none-macosx_10_10_x86_64.whl

Download URL python_hue_client-0.1.0-cp27-none-macosx_10_10_x86_64.whl
Size 4.6 kB
Tags CPython 2.7 macOS 10.10+ x86-64
SHA-256 checksum
How to use checksums
0aa4ed069ad61864e4e5cd33a4e1dc0af9e347fdbe9f57394f6e982df88734f5
BLAKE2b-256 checksum
How to use checksums
a0e2e838bee8de038456d5377e7cc9c739e5d509b9e28458f833df63278eb902
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page