User`s guide
X10CONFIG(5) X10CONFIG(5)
NAME
x10config -Configuration file format for HEYU, an X-10 CM11A serial interface control program
DESCRIPTION
Heyu is a program for controlling an X-10 "CM11A" home control device. See the heyu(1) man page for
usage information.
The configuration file contains several critical pieces of information that the heyu program needs in order to
function, plus a number of user options. These are all specified by keywords known as directives which
are explained below. Ingeneral, directivesmay appear in anyorder in the configuration file, howeversee
the exception to this rule under the heading for the ALIAS directive.
The configuration file, named x10config, is normally stored in the (hidden) subdirectory .heyu under your
home directory,i.e., $HOME/.heyu/x10config
Forsystem-wide use, the configuration file may alternatively be stored as file x10.conf in the directory
/etc/heyu (or as otherwise defined in Configure for your operating system).
The configuration file may be located in an additional subdirectory levelunder either of the directories
above.The additional subdirectory levelcan have a name of your choice, for example "mysub". In this
case you must specify the name of the subdirectory with the HEYUSUB environment variable in order for
Heyu to find it, for example HEYUSUB=mysub.Somewhat more convenient howeveristolocate the con-
figuration file in a subdirectory named simply /0 ... /9, e.g. $HOME/.heyu/3/x10config, in which case Heyu
can be instucted to use the appropriate directory with the command line option ´-0´ ... ´-9´.
Finally,the configuration file may be stored in anyarbitrary location on your hard drive with anyarbitrary
filename, but the full pathname will have tobespecified either with the ´-c´ Heyu command line option or
with the X10CONFIG environment variable.
If the HEYUSUB environment variable is NOTset or the ´-0´ ... ´-9´ not specified, then the search will start
with $HOME/.heyu/x10config and continue with /etc/heyu/x10.conf, stopping with the first one it finds. If
not found, Heyu will exit with an error message.
If the HEYUSUB environment variable IS set or the ´-0´ ... ´-9´ is specified, the search for the configuration
file will start with $HOME/.heyu/<subdirectory>/x10config, then, if not found, will continue looking for
/etc/heyu/<subdirectory>/x10.conf. Examples:
$HOME/.heyu/mysub/x10config
/etc/heyu/mysub/x10.conf
/etc/heyu/4/x10.conf
If not found under either of these places, Heyu will exit with an error message.
(The main reason for implementing the subdirectory feature is to enable Heyu to be used for more than one
CM11A interface, with separate configuration and other files for each. If you have only one CM11A inter-
face, you probably won´t find a need to bother with it.)
The directory in which the configuration file is located MUST be writable by Heyu.
Case sensistivity:
The following entities ARE case-sensitive:Filenames; Pathspecs; Serial ports (and the keyword "dummy"
used when there is no CM11A connected);
Heyu and shell commands; Alias, Scene, Usersyn, Script, and Launcher labels.
The following entities are NOTcase sensitive:Names of directivesand values of directivesother than
those listed above;Housecode letters.
TTY directive
The TTY directive isthe most important. Syntax is simply the word TTY,aspace and then the full path
name for the serial port to which the CM11A is attached. /dev/ttyS0 would be the first serial port (corre-
sponding to COM1 under MS-DOS). /dev/cua0 will also work.
Examples:
local 1