Mac Home Automation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====Dim or Brighten====

Set an analog/dimmable device to a level between 0 and 100

===Usage:===
**dim** "name of the unit or group”
**brighten** "name of the unit or group”\\

===Optional Parameters:===
  * **to** (number) the value you wish to set the unit to. While this accepts a decimal most device types will not accept a fractional dim level. For most devices this should be a value between 0 and 100. If the device requires different value ranges the min/max values for that unit may be set in the Advanced tab of the Edit Unit Dialog. You must specify either the **to** parameter or the **by** parameter.
  * **by** (integer) change the current value by this amount. Can be positive or negative. You must specify either the **to** or **by** param.
  * **in** (integer: seconds) If specified an event is created that will apply the new values in this number of seconds.
  * **at** (date) Like the **in** param but a specific date at which the event will be created.
  * **for** (integer: seconds) If specified an event will be created to return the unit to it’s current settings after this many seconds.
  * **until** (date) Like the **for** param but a specific date at which to return to the current settings.
  * **with no script** Will not run the unit’s on or off script.
  * **with no transmit** The XTension database will be updated with the new value but no command will be sent.

===Color Support===

  * **rgb color** (text: html color)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. This is the normal way to set the color of a bulb. “FF0000” would be full red, “0000FF” would be full blue.
  * **color temperature** (integer) The Mired color temperature you wish to display. The available range is specific to the device but will be in the range of 2000 to 50000. 2700 would be a “warm” white. 3500 would be a “bright” or halogen white. 5000 to 6000 would be a “daylight” white. Not all devices support a color temperature setting.
  * **hue/saturation** (number) An alternative method of setting the color. You must specify both the **hue** and **saturation** the value is taken from the level of the unit. 
  * **xvalue/yvalue** (number) Another alternative method of setting the color. You must specify both the **xvalue** and **yvalue** the z value or level is taken from the level of the unit. 
  * **color preset** (number, 1-8) sets the color or color temperature to the preset indicated that you have saved in the Edit Unit Dialog.

===Examples:===
<code applescript>
dim "foyer light" to 45
</code>

<code applescript>
dim "foyer light" to 45 in 30
</code>

<code applescript>
brighten "foyer light" by 25 in (5 * minutes) for (30 * minutes)
</code>

===Notes:===
**dim** and **brighten** are interchangeable. Either verb can perform either action. You dont have to know the value of the light and figure out if you're actually going to dim or brighten it and issue the proper command. If the light is at 50% and you say **dim "myLight" to 100** that will work just as well as saying **brighten "MyLight" to 100**.\\
\\
If the unit is blocked and you issue a dim or brighten command no scripts will run and no commands will be sent.\\
\\
You may use either the "to" clause or the "by" clause, but not both.\\
\\
The "by" clause is intended for "relative" changes.\\
\\
As an aid in preventing limit errors in such "relative" changes, Xtension will limit the range of the command to values between 0 and 100 for real units. If the unit has it’s **use min/max** turned on in the Advanced tab of the Edit Unit window those values will be used instead.
Mac Home Automation

User Tools

Site Tools

Page Tools
