.TH HEYU 1 local
.SH NAME
.B heyuhelper\^
- a program called by heyu to execute external commands based on X10 events
.SH SYNOPSIS
.B heyuhelper \fIunit-specifier-and-state\fP
.br
.SH DESCRIPTION
.I 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.
.PP
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.
.PP
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.
.PP
.SH ARGUMENTS
The only required arguement is a macro name or a unit-specifier and state.
.TP 5
\fImacro name\fP
The macro name would be generated when setting up the X10 schedule.  See
\fBx10sched(5)\fR
.TP 5
\fIunit-specifier-state\fP
This is a combination of the house code, the unit number and the state.
it will look like \fBg4Off\fR.  The possible states are On, Off, Dim and 
Bright.  They are case sensitive.
.SH EXAMPLES
.TP 5
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
.TP 5
heyuhelper e2On
 This was an "on" command for unit 2 on housecode E
.PP
.SH ENVIRONMENT
.br
The invoking command's environment is used.

.SH FILES
.br
 .x10macroxref - the cross reference for the eeprom macros.
.br
.SH BUGS
The script should not attempt to send information to standard out,
as that's likely to be a file.

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

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