User`s guide

X10CONFIG(5) X10CONFIG(5)

The following Directivesare applicable when scripts are to be executed by Heyu in response to an X10 sig-

nal. (See ´man x10scripts(2)´ for details.)

===============================================

SCRIPT_MODE directive

The options are HEYUHELPER or SCRIPTS, with the default being SCRIPTS.

If HEYUHELPER is chosen, a shell script named ´heyuhelper´ on the user´s path is executed every time an

X10 function is receivedbyHeyufrom the interface. The argument supplied to the script is of the form

<housecode|last_unit|function>, where:

housecode is the lower case letter a-p associated with the function

which resulted in execution of ´heyuhelper´

last_unit is the last unit code receivedonthat housecode.

function will be one of the following: On, Off, AllOn, AllOff,

Dim, Bright, LightsOn, LightsOff, Preset, Extended, Hail, HailAck,

Status, StatusOn, StatusOff, DataXfer.

Examples of heyuhelper arguments: a1On b3Offc14Preset

Note: The AllOn command in Heyu version 1.xx was interpreted to mean LightsOn (All Lights On). It is

not a native CM11A command. In Heyu version 2, it instead indicates the simple ´On´ function whenever

all units 1-16 are addressed.

Another difference from Heyu version 1.35 is that the heyuhelper script is not launched when an uploaded

macro is executed.

The heyuhelper script is only executed when X10 functions are receivedfrom the interface - not when

addresses or powerfail messages are receivedorwhen functions are sent.

All other script-oriented directiveswith the exception of SCRIPT_SHELL and SCRIPT_CTRL are ignored

with the HEYUHELPER option. Choosing SCRIPTS allows one to use the full features of Heyu scripting

(including execution of an existing ´heyuhelper´ script).

SCRIPT_CTRL directive

Globally enables or disables launching of scripts by Heyu. The default value of ENABLE permits scripts to

be launched; the value DISABLE inhibits them from being launched. This will hopefully be useful when

the conﬁguration ﬁle contains manySCRIPT directivesand it is desired to temporarily disable them with-

out having to delete them or comment them all out. All scripts are affected, including heyuhelper and pow-

erfail or rfﬂood scripts. (This directive may be overridden at the command line by the ´heyu script_ctrl

enable|disable´ command.)

SCRIPT directive

Speciﬁes the Linux/Unix command to be launched and the conditions under which it will be launched. The

conditions for launching the command may also (or additionally) be speciﬁed separately in a LAUNCHER

directive.

The format is as follows:

SCRIPT [-l <label>] <launch conditions> :: [execoptions] <command line>

The script label is optional as long as the all the launch conditions are contained within the SCRIPT line. It

can be anyarbitrary case-sensitive name up to 32 characters in length, not beginning with a ´-´ character.If

no label is speciﬁed, Heyu will create one using the line number where it appears in the conﬁg ﬁle to make

it unique, e.g., ´Script_21´.

If the launch conditions are wholly or in part speciﬁed with a LAUNCHER directive,ascript label is

mandatory,sothat Heyu can match up the script with the assocated launcher.

local 14