James: 1 revision

2021-01-13T17:25:00Z

1 revision

Jitterjames at 15:04, 21 February 2016

2016-02-21T15:04:59Z

New page

Go to the main '''[[Plugins]]''' page.

Go to the complete '''[[Plugin List]]'''.

=Plugin Description=

Communicate with Philips Hue Bridge.

Lights and groups can be sent strings to control them.
Example: "on":true, "hue":5000, "bri":40%

"on" can be true or false
"sat" (saturation) can be a value from 0-254
"bri" (brightness) can be a value from 0-254 or a value from 0-100 if you add a % symbol to the end of the number.

For more info see: http://www.developers.meethue.com/documentation/core-concepts

"hue" can be a value from 0 (red) to 65280 (red).

=Actions for the Hue plugin=
==Light==
[[Hue.Light]] 
Sends a command string to a single Hue light. Example action string: "on":true, "hue":5000, "bri":40% See: http://voxcommando.com/mediawiki/index.php?title=Plugin_Hue

* Parameters: 2
#ID : Light ID [''integer'']
#Command : Command String [''string'']
==Group==
[[Hue.Group]] 
Sends a command string to a group of Hue lights. Use special group ID 0 for all lights. Example action string: "on":true, "hue":5000, "bri":40% See: http://voxcommando.com/mediawiki/index.php?title=Plugin_Hue

* Parameters: 2
#ID : Group ID [''integer'']
#Action : see example [''string'']
==Raw==
See: http://www.developers.meethue.com/philips-hue-api and find examples in the default VC Hue configuration
===Get===
[[Hue.Raw.Get]] 
Example to get data on all existing scenes stored on bridge: Hue.Raw.Get scenes See: http://www.developers.meethue.com/philips-hue-api and find examples in the default VC Hue configuration

* Parameters: 1
#URL : [''string'']
===Put===
[[Hue.Raw.Put]] 
See: http://www.developers.meethue.com/philips-hue-api and find examples in the default VC Hue configuration

* Parameters: 2
#URL : [''string'']
#Data : [''string'']
===Post===
[[Hue.Raw.Post]] 
Example to schedule all lights on in 1 minute: Hue.Raw.Post schedules "name": "timer","description": "VcTimer","command": {"address": "/api/voxcommando/groups/0/action","method": "PUT","body": {"on": true}},"time": "PT00:01:00","autodelete": true See: http://www.developers.meethue.com/philips-hue-api and find examples in the default VC Hue configuration

* Parameters: 2
#URL : [''string'']
#Data : [''string'']
===Delete===
[[Hue.Raw.Delete]] 
Example to delete the 3rd schedule: Hue.Raw.Delete schedules/3 See: http://www.developers.meethue.com/philips-hue-api and find examples in the default VC Hue configuration

* Parameters: 2
#URL : [''string'']
#Data : [''string'']
==Restore==
[[Hue.Restore]] 
Restore the state of all lights as stored by the "Hue.Store" action
==Scene==
[[Hue.Scene]] 

===Load===
[[Hue.Scene.Load]] 
Loads a stored scene using the alphanumeric <SceneID>.

* Parameters: 1
#SceneID : [''string'']
===Create===
[[Hue.Scene.Create]] 
Create a new scene on the bridge using with ID <SceneID> and name <SceneName>. Assign the lights listed in <Lights> to the scene. If <Lights> is omitted then all lights will be assigned.

* Parameters: 2-3
#SceneID : Max 12 characters [''string'']
#SceneName : Max 12 characters [''string'']
#Lights : Comma separated list of light IDs [''string'']
==Store==
[[Hue.Store]] 
Store the state of all lights, which can later be restored using the "Hue.Restore" action. Specific lights can be stored by using the <Lights> parameter to list light IDs as follows: 1,3,4,6 If no lights are specified then the state of all lights will be stored.

* Parameters: 0-1
#Lights : Comma separated list of light IDs [''string'']
==RotateLeft==
[[Hue.RotateLeft]] 
Rotates light colours (hue and saturation only) among a list of lights. <LightIDs> should be a list of integers separated by commas, which specify the IDs of the lights you want to use. Example: 2,1,4 <TransitionTime> controls the duration of the fade from the old colour to the new. Rotate left means the first light will take on the color of the second and so on. Rotate right means the second light will take on the color of the first and so on. 

* Parameters: 2
#LightIDs : example: 1,3,4 [''string'']
#TransitionTime : Duration of fade [''integer'']
==RotateRight==
[[Hue.RotateRight]] 
Rotates light colours (hue and saturation only) among a list of lights. <Light IDs> should be a list of integers separated by commands, which specify the IDs of the lights you want to use. Example: 2,1,4 <TransitionTime> controls the duration of the fade from the old colour to the new. Rotate left means the first light will take on the color of the second and so on. Rotate right means the second light will take on the color of the first and so on.

* Parameters: 2
#LightIDs : example: 1,3,4 [''string'']
#TransitionTime : Duration of fade [''integer'']
==GenXML==
[[Hue.GenXML]] 
Generates payloadXML files for Groups and Scenes stored on the bridge
==GenMaps==
[[Hue.GenMaps]] 
Generates [[maps]] for Groups and Scenes stored on the bridge

← Older revision	Revision as of 17:25, 13 January 2021
(No difference)

Plugin Hue - Revision history

James: 1 revision

Jitterjames at 15:04, 21 February 2016