Groups API

class hueclient.models.groups.Group(**kwargs)

Bases: hueclient.monitor.MonitorMixin, repose.resources.Resource

id

The ID given to the group by the bridge

name

A unique, editable name given to the group

type

As of 1.4. If not provided upon creation “LightGroup” is used. Can be “LightGroup” or either “Luminiare” or “LightSource” if a Multisource Luminaire is present in the system.

lights

The Light resources contained with this group

class hueclient.models.groups.GroupState(**kwargs)

Bases: hueclient.monitor.MonitorMixin, repose.resources.Resource

GroupState operates in the same way as LightState except that it operates on a group of lights rather than an individual light. This can be a more effective way of controlling multiple lights rather than making API calls for each individual light.

on

On/Off state of the light. On=true, Off=false

brightness

Brightness of the light. This is a scale from the minimum brightness the light is capable of, 1, to the maximum capable brightness, 254.

alert

The alert effect, which is a temporary change to the bulb’s state (none/select/lselect).

effect

The dynamic effect of the light, can either be “none” or “colorloop”.

color_mode

Indicates the color mode in which the light is working, this is the last command type it received. Values are “hs” for Hue and Saturation, “xy” for XY and “ct” for Color Temperature. Note that this will be set automatically upon setting the hue/saturation/xy/colour_temperature properties

reachable

Indicates if a light can be reached by the bridge.

transition_time

The duration of the transition from the light’s current state to the new state. This is given as a multiple of 100ms.

brightness_increment

As of 1.7. Increments or decrements the value of the brightness.

saturation_increment

As of 1.7. Increments or decrements the value of the sat.

hue_increment

As of 1.7. Increments or decrements the value of the hue.

color_temperature_increment

As of 1.7. Increments or decrements the value of the ct.

xy_increment

As of 1.7. Increments or decrements the value of the xy.

set_rgb(red, green, blue)

The red/green/blue color value of the light

This will be converted and set as the xy value

xy

The x and y coordinates of a color in CIE color space.

The first entry is the x coordinate and the second entry is the y coordinate. Both x and y are between 0 and 1.

For more information see: http://www.developers.meethue.com/documentation/core-concepts#color_gets_more_complicated

hue

Hue of the light. This is a wrapping value between 0 and 65535. Both 0 and 65535 are red, 25500 is green and 46920 is blue.

saturation

Saturation of the light. 254 is the most saturated (colored) and 0 is the least saturated (white).

color_temperature

The Mired Color temperature of the light. 2012 connected lights are capable of 153 (6500K) to 500 (2000K).