Features

Installation

Using distutils

sudo easy_install phue

pip install phue

Manually

Examples

Basic usage

#!/usr/bin/pythonfromphueimportBridgeb=Bridge('ip_of_your_bridge')# If the app is not registered and the button is not pressed, press the button and call connect() (this only needs to be run a single time)b.connect()# Get the bridge state (This returns the full dictionary that you can explore)b.get_api()# Prints if light 1 is on or notb.get_light(1,'on')# Set brightness of lamp 1 to maxb.set_light(1,'bri',254)# Set brightness of lamp 2 to 50%b.set_light(2,'bri',127)# Turn lamp 2 onb.set_light(2,'on',True)# You can also control multiple lamps by sending a list as lamp_idb.set_light( [1,2],'on',True)# Get the name of a lampb.get_light(1,'name')# You can also use light names instead of the idb.get_light('Kitchen')b.set_light('Kitchen','bri',254)# Also works with listsb.set_light(['Bathroom','Garage'],'on',False)# The set_light method can also take a dictionary as the second argument to do more fancy stuff# This will turn light 1 on with a transition time of 30 secondscommand=  {'transitiontime' :300,'on' :True,'bri' :254}b.set_light(1,command)

Light Objects

Get a flat list of light objects

lights=b.lights# Print light namesforlinlights:print(l.name)# Set brightness of each light to 127forlinlights:l.brightness=127

Get Light objects as dictionaries

# Get a dictionary with the light id as the keylights=b.get_light_objects('id')# Get the name of light 1, set the brightness to 127lights[1].namelights[1].brightness=127# Get a dictionary with the light name as the keylight_names=b.get_light_objects('name')# Set the birghtness of the bulb named "Kitchen"light_names["Kitchen"].brightness=254# Set lights using name as keyforlightin ['Kitchen','Bedroom','Garage']light_names[light].on=Truelight_names[light].hue=15000light_names[light].saturation=120# Get a flat list of the light objects (same as calling b.lights)lights_list=b.get_light_objects('list')forlightinlights_list:light.on=Truelight.brightness=127

Setting Transition Times

# Set brightness of lamp 1 to max, rapidlyb.set_light(1,'bri',254,transitiontime=1)

light=light_names['Kitchen']light.transitiontime=2# this next transition will happen rapidlylight.brightness=20

Groups

# List groupsb.get_group()# List group 1b.get_group(1)# Get name of group 1b.get_group(1,'name')# Get lights in group 1b.get_group(1,'lights')# Create a group with lights 1 and 3b.create_group('Kitchen', [1,3])# Rename group with id 1b.set_group(1,'name','New Group Name')# Change lights within group 1b.set_group(1,'lights', [3,4])# Turn group 1 offb.set_group(1,'on',False)# Delete group 2b.delete_group(1)

Schedules

# Get the list of different schedulesb.get_schedule()# Get the data of a particular schedulesb.get_schedule(1)# Create a schedule for a light, arguments are name, time, light_id, data (as a dictionary) and optional descriptiondata= {'on':False,'transitiontime':600}b.create_schedule('My schedule','2012-11-12T22:34:00',1,data,'Bedtime' )# Create a schedule for a group, same as above but with a group_id instead of light_iddata= {'on':False,'transitiontime':600}b.create_group_schedule('My schedule','2012-11-12T22:34:00',0,data,'Bedtime' )# Delete a scheduleb.delete_schedule(1)

Using phue with Max/MSP via Jython

Using phue on iOS via Pythonista

Acknowledgments

License