HEYU(1)

NAME
heyuhelper - a program called by heyu to execute external commands based on X10 events

SYNOPSIS
heyuhelper unit-specifier-and-state

DESCRIPTION
Heyuhelper is a shell script meant to be edited by the heyu user. it provides an easy way to execute external programs based on an X10 event such as A1 On. The script provided initially is very a very simple program (a few case statements) that branch based on the the first parameter passed to the program by heyu.

Heyu will call this script with either a macro name or a unit-specifier combined with a state. A macro is passed if a timmer or trigger generates the event. The unit-specifier is passed if the X10 signal was received on the powerline.

Heyuhelper is called by heyu only if you are using version 1.35 and only if you are using the "new format" output. Additionally, it is only called by heyu when in monitor mode.

ARGUMENTS
The only required arguement is a macro name or a unit-specifier and state.

macro name
    The macro name would be generated when setting up the X10 schedule. See x10sched(5)

unit-specifier-state
    This is a combination of the house code, the unit number and the state. it will look like g4Off. The possible states are On, Off, Dim and Bright. They are case sensitive.

EXAMPLES

heyuhelper livinroom_on
     This was a macro. The associated monitor mode output would be
     7/19 at 16:44:56 Timer executed : livinroom_on, address 967

heyuhelper e2On
     This was an "on" command for unit 2 on housecode E

ENVIRONMENT
The invoking command's environment is used.

FILES
 .x10macroxref - the cross reference for the eeprom macros.

BUGS
The script should not attempt to send information to standard out, as that's likely to be a file.

AUTHORS
Written by Daniel B. Suthers (dbs@tanj.com) based on a suggestion from chuck@liderbug.com.

SEE ALSO
heyu(1), x10config(5), x10sched(5)