-
Scripting Dictionary
- Scheduled Event Verbs
- Housecode Verbs and Scripts
- Human Interface Verbs
- Getting Lists of Units
- Unit Control Verbs
-
Unit Information
- Add Unit to Group/List
- Change Future Value
- Create Unit/Group
- Delete Unit/Group
- Description Of
- ExCommand Of
- ExData of
- Future Value
- Unit Address Of
- Get Unit Property
- Last Timestamp
- Preset Of
- Query
- Remove Unit from Group/List
- Set Address Of
- Set Description Of
- Set Name Of
- Set Params of
- Set Unit Property
- Set Value Of
- Status Of
- This Unit
- Time Delta
- Value Of
- X10 Specific Commands
- XTension Control Verbs
Dim or Brighten
Set an analog 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 (integer value between 0 and 100)
by (integer value between -100 and 100)
in (integer, create a scheduled event to perform this dim in this many seconds.)
for (integer, create a scheduled event to return the unit to it's current value in this many seconds.)
with no script (dont run the unit script)
with no transmit (update the database and run the script, but dont actually send any commands)
Examples:
dim "foyer light" to 45
dim "foyer light" to 45 in 30
brighten "foyer light" by 25 in (5 * minutes) for (30 * minutes)
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. Thus if you try to dim a lamp below 0 XTension will limit it to zero. Likewise, if you try to brighten a lamp above 100, XTension will limit it to 100.
