Differences

This shows you the differences between two versions of the page.

--- dictionary:unitcontrol:turnon [2016/03/14 19:12] – external edit 127.0.0.1
+++ dictionary:unitcontrol:turnon [2019/06/09 13:38] – [Color Support] fixed for new plugin color handling James Sentman
@@ Line 9: / Line 9: @@
 ===optional parameters:===
-**in** (integer, number of seconds)\\
+  * **in** (integer: seconds) If specified an event is created to apply your new settings after this number of seconds.
-**at** (date, instead of “in” you can pass a specific date, see below for examples)\\
+  * **at** (date) Instead of the **in** param you may specify a specific date at which to create the event.
-\\
+  * **for** (integer: seconds) returns the unit to it’s current state this many seconds after any **in** or **at** event has run.
-**for** (integer, number of seconds)\\
+  * **until** (date) similar to **for** but pass the specific date at which you wish the unit to return to it’s current state
-**until** (date, instead of “for” you can pass a specific date, see below for examples)\\
+  * **rate** (number: seconds) The number of seconds you wish the transition to take. You may specify a fractional seconds value such as 0.2 or 7.5. Not all devices support a rate param.
-\\
+  * **with no script** Stops the on or off script from running.
-**with no script** (stops the ON or OFF script from running)\\
+  * **with no transmit** Updates the database but doesn't actually send the command.
-**with no transmit** (updates the database but doesn't actually send the command)\\
-**rate** (integer, many devices support sending a ramp rate along with the command to control how fast the new level is reached)\\
 ===Color Support===
-Many color capable bulbs are now available for ZWave and ZigBee via the [[supported_hardware:hue|Phillips Hue]] hub. XTension can also create an “RGB Pseudo” that groups any 3 other units as the red, green and blue channels of a single fixture. Even if your device is not directly supported as an individual color lamp the channels are usually available separately. This is normally the case with ZWave 3 channel controllers. There are several optional parameters to this command for setting color. Some are specific to the hue bulbs, others will work for any color capable device.
+Additional optional params are available for color capable devices:
-**rgb color** (text, a standard HTML color string with each 2 characters being 00 to FF a hex representation of the level of that color in the mix. All color devices support the rgb color command. This is the normal way to set the color of a bulb. “FF0000” would be full red, “0000FF” would be full blue.)\\
+  * **rgb color** (text:html color “RRGGBB") accepts a string the same as an html color definition but without the “#” at the front. “FF0000” would be full red, “00FF00” would be full green and “0000FF” would be full blue.
-**hue/saturation** (integer, if using a Phillips Hue bulb you can set the color by passing the hue and saturation. If using this you must pass both the hue and saturation values.)\\
+  * **color temperature** (integer) The Mired color temperature you wish the bulb to display. The range of available values is dependent on the individual device but would be in the range of 2000 to 50000 with 2700 being a warm white, 3500 being a “bright” or halogen white and 5000 to 6000 being a “daylight” color. Not all devices can display a color temperature.
-**xvalue/yvalue** (number, another method of sending color to a Phillips Hue bulb. If using this you must pass both the x and y coordinate values.)\\
+  * **color preset** (integer: 1-8) go to a color preset by index that you have already saved for the unit in XTension.
-**color temperature** (integer, currently supported only for Phillips Hue bulbs this number corresponds to the color temperature. For the hue bulbs this is not the actual color temperature in kelvin, but a number from 153 to 500 with larger numbers being warmer. As other bulbs become more commonly available that support changes in color temperature support will be added for those.)\\
+  * **hue/saturation** (numbers) An alternative way to specify the color for a device. You must specify both the **hue** and **saturation** params to use this. The value is taken from the current brightness level of the device.
-**color preset** (number, 1-8, all color capable devices can have 8 colors or color temperatures set as presets. You can recall one by passing the color preset number to this parameter.)
+  * **xvalue/yvalue** (numbers) Another alternative way to specify the color for a device. You must specify both the **xvalue** and **yvalue** the z value or brightness is taken from the current brightness level of the device.
 ===Color Handling===