Skip to content

Commit

Permalink
GitHub #35 - Document increment attributes for light and group objects
Browse files Browse the repository at this point in the history
  • Loading branch information
sqmk committed Dec 21, 2015
1 parent ecab762 commit 02c708e
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,14 @@ The following `Light` state is available:
* `alert` - Configurable alert effect (e.g. none, select, lselect)
* `effect` - Configurable effect (e.g. none, colorloop)

There are additional `Light` state attributes available for incrementing and
decrementing values:
* `incrementBrightness` - Increment or decrement brightness value
* `incrementHue` - Increment or decrement hue value
* `incrementSaturation` - Increment or decrement saturation value
* `incrementXy` - Increment or decrement xy values
* `incrementColorTemp` - Increment or decrement color temperature value

Huejay is the only Node.js client that maintains a list of Philips Hue supported
models. The `Light` `model` attribute returns a `LightModel` object which contains
additional details about the model:
Expand Down Expand Up @@ -589,6 +597,11 @@ The following `Light` object attributes and state are configurable:
* `transitionTime`
* `alert`
* `effect`
* `incrementBrightness`
* `incrementHue`
* `incrementSaturation`
* `incrementXy`
* `incrementColorTemp`

*Note: See further above for details on `Light` attributes and state*

Expand Down Expand Up @@ -689,6 +702,14 @@ the lights associated with the group:
* `effect` - Configurable effect (e.g. none, colorloop)
* `scene` - Configurable scene

Like `Light` objects, `Group` state attributes are available for incrementing and
decrementing values:
* `incrementBrightness` - Increment or decrement brightness value
* `incrementHue` - Increment or decrement hue value
* `incrementSaturation` - Increment or decrement saturation value
* `incrementXy` - Increment or decrement xy values
* `incrementColorTemp` - Increment or decrement color temperature value

Huejay maintains a list of Philips Hue supported luminaire models. The `Group`
`model` attribute returns a `GroupModel` object. This object contains more
information about the model:
Expand Down Expand Up @@ -808,6 +829,11 @@ The following `Group` object attributes and state are configurable:
* `transitionTime`
* `alert`
* `effect`
* `incrementBrightness`
* `incrementHue`
* `incrementSaturation`
* `incrementXy`
* `incrementColorTemp`

#### client.groups.delete - Delete a group

Expand Down

0 comments on commit 02c708e

Please sign in to comment.