Special Scripts

Xtension allows you to create 'special-named' scripts. Simply creating a Global Script with these names causes XTension to execute them at their appointed times, or whenever certain system level events occur. The names of these scripts are specific, but not case sensitive. (no name in XTension is case sensitive) in addition to just typing them you can also select from a popup list of them in the New Global Script dialog when it's asking you for a name.

These Script Names are RESERVED for their respective intrinsic functions:

Startup Script/Shutdown Script

On starting up, XTension will automatically execute the Startup Script, and conversly, the Shutdown Script is executed anytime that you quit nicely out of XTension.

Obviously you might want to always check things out or set up units into some known state on startup.

On shutdown you might want to 'safe' some units or transfer control to another system.

These two scripts must be created as 'global' scripts. They ,ust be named precisely as above.

Idle Script

This name is reserved for the IDLER. If you create a global script of this name XTension will execute it every MINUTE.

It can be useful for monitoring certain functions, however you should be careful about not putting things in it that would cause a lot of processing every minute.

Global Scripts can also be executed via Scheduled Events.
See also the Start Idler verb.

Sunrise/Sunset

These script names are reserved for suntime events. See also Suntimes.

Errors Script

This script is called whenever a significant error occurs.

Before it is called, XTension sets a global variable which can be tested by the Errors Script: Last Error

AUXRemote

This script is called whenever a command comes in via the MR26 or other receiver that is encoded as a “MP3 remote” type of command.

This is particularly useful with the X-10 “MP3” wireless remote (UR51A) which sends over 50 unique button commands.

Whenever XTension detects a “MP3” type command from the receiver it will look for a global script named “AUXRemote”.

If you have created such a script it will be executed. Before calling the script XTension sets the special variable command to the button number from the UR51A.

You can serve any of those buttons with commands and ignore any that you dont need.

This is a great way to add up to 50 macros to your remote control system without having to dedicate database units and X-10 addresses!

Power Fail

This script is called whenever it is known that a power fail has occurred. This script originated with the Lynx interface as it would send a specific message when it lost power. This interface is no longer available but when XTension notices that an interface is not responding it will guess that the power has gone out to that interface and run this script. With interfaces other than the Lynx though it may take some time for XTension to be able to be sure the interface is offline and you will not be able to get a reading on short outages. You can get much better reliability here if you have a Mac compatible UPS by using the UPS Monitor Plugin

DoAll.X

In order to catch all lights on, all lights/units off commands from X10 receivers you need to create a global script with the name DoAll. and the letter of the housecode you wish to catch. DoAll.A for housecode A for instance. That script will be run when that housecode all units command is received. You can then check the ThisInterface value to see from which interface it was received and also the “command” verb to see exactly which command it was that was received.

xtension_manual/specialscripts.txt · Last modified: 2014/01/29 10:53 by James Sentman
CC Attribution-No Derivative Works 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0