#phue: A Python library for the Philips Hue system.
##Introduction
This is a Python library to control the Philips Hue system.
Huge thanks to http://rsmck.co.uk/hue for hacking the protocol !
I decided to keep it as simple as possible and not rely on external libraries like requests so it's easily portable to any system.
It will automatically get the md5 username for you, if the button is not pressed it will prompt you to press it, use the connect() method to register. Once pressed it will get the username and store in your home directory in a file called .python_hue
##Installation
phue consists of a single file (phue.py) that you can put in your python search path or in site-packages (or dist-packages depending on the platform) You can also simply run it by putting it in the same directory as you main script file or start a python interpreter in the same directory. phue works with Python 2.6.x and 2.7.x
##Examples
###Basic usage
Using the set_light and get_light methods you can control pretty much all the parameters :
#!/usr/bin/python
from phue import Bridge
b = 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 not
b.get_light(1, 'on')
# Set brightness of lamp 1 to max
b.set_light(1, 'bri', 254)
# Set brightness of lamp 2 to 50%
b.set_light(2, 'bri', 127)
# Turn lamp 2 on
b.set_light(2,'on', True)
# You can also control multiple lamps by sending a list as lamp_id
b.set_light( [1,2], 'on', True)
# Get the name of a lamp
b.get_light(1, 'name')
# 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 seconds
command = {'transitiontime' : 300, 'on' : True, 'bri' : 254}
b.set_light(1, command)###Light Objects
If you want to work in a more object-oriented way, you can get Light objects using the get_light_objects method. You can use 'id', 'name' or 'list' as argument, it will return a list with no arguments:
# Get a dictionary with the light ids as the key
lights = b.get_light_objects('id')
# Get the name of bulb 1, set the brightness to 127
lights[1].name
lights[1].brightness = 127
# Get a dictionary with the light name as the key
light_names = b.get_light_objects('name')
# Set the birghtness of the bulb named "Kitchen"
light_names["Kitchen"].brightness = 254
# Get lights by name
for light in ['Kitchen', 'Bedroom', 'Garage']
light_names[light].on = True
light_names[light].hue = 15000
light_names[light].saturation = 120
# Get a flat list of the light objects
lights_list = b.get_light_objects('list')
for light in lights_list:
light.on = True
light.brightness = 127###Groups
You can also work with the groups functionality of the Bridge. If groups aren't working, try re-setting the bridge by unpluging it and plugging it back again.
# List groups
b.get_group()
# List group 1
b.get_group(1)
# Get name of group 1
b.get_group(1, 'name')
# Get lights in group 1
b.get_group(1,'lights')
# Create a group with lights 1 and 3
b.create_group('Kitchen', [1,3])
# Rename group with id 1
b.set_group(1, 'name', 'New Group Name')
# Change lights within group 1
b.set_group(1, 'lights', [3,4])
# Turn group 1 off
b.set_group(1, 'on', False)
# Delete group 2
b.delete_group(1)###Schedules
You can view, create and delete schedules using the following methods. Note that the time of the bridge is in UTC so you will need to offset with your timezone.
# Get the list of different schedules
b.get_schedule()
# Get the data of a particular schedules
b.get_schedule(1)
# Create a schedule for a light, arguments are name, time, light_id, data (as a dictionary) and optional description
data = {'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_id
data = {'on': False, 'transitiontime': 600}
b.create_group_schedule('My schedule', '2012-11-12T22:34:00', 0, data, 'Bedtime' )
# Delete a schedule
b.delete_schedule(1)##Using phue with Max/MSP via Jython
You can use the phue library within Max/MSP by using Nick Rothwell's Jython objects. He recently updated the version to support Jython 2.7 which is required for phue to work.
Download it here: https://github.com/cassiel/net.loadbang.jython
##Using phue on iOS via Pythonista
You can use phue on your iOS device via the Pythonista app. This is a great way to build quick prototypes on iOS as you don't need to compile anything, you can code directly from the device itself.
See this little example: