.TH X10CONFIG 5 local
.SH NAME
.B .x10config\^
- Configuration file format for HEYU, a X10 CM11A serial interface control program
.SH DESCRIPTION
.I Heyu
is a little program for controlling a X10 "CM11A" home control device.
See  the \fIheyu\fP(1) man page for usage information.
.PP
The x10config file is normally in your home directory under the file
name .x10config.  It
contains several different pieces of information
that the \fIheyu\fP program needs in order to function.  There are
\fBdirectives\fP (special keywords the program uses) and \fBaliases\fP.
.PP
You can also put the config file in the /etc directory under the name /etc/x10.conf.
.PP
The search order starts with the $X10CONFIG variable, then .x10config in your home directory,
and finally /etc/x10.conf.  It stops at the first file that's found.
.SH TTY directive
The TTY directive is the most important.  Syntax is simply the word
TTY, a space and then the full path name for the serial port to which
the CM11a is attached.  /dev/ttyS0 would be the first serial port.
/dev/cua0 will also work.  Example:

TTY /dev/ttyS0 or
.br
TTY /dev/cua2
.br
.SH HOUSECODE directive
The housecode directive tells the CM11A which X10 units to remember
when status signals are received.  This means that the cm11 info command will
report what it remembers for the state of all 16 units in the default
housecode.

The ALL units commands (special unit number *) apply only to units with the same housecode.
.br
.SH MACROXREF directive
Heyu can tell you which macros were executed if you have it store the cross
reference at the time that you upload the macros.  The MACROXREF lists the
file name that you want to use.  An example is:
.br
MACROXREF .x10macroxref
.br
.SH NEWFORMAT flag
The word NEWFORMAT will cause some of the output to be in a slightly
more readable format.  The main differences are in the output from the
monitor command.

This is not the default because we don't want to break
scripts that depend on the output.

The NEWFORMAT flag goes on a line by itself.
.br
.SH LATITUDE and LONGITUDE directives.
These are used to allow the makesched script to determine dawn and
dusk for your particular location.  The makesched utility is available with
version 1.30 and higher.

The format of the directive line is the word LATITUDE followed by a space and 
then the degrees, a colon and the minutes. The LONGITUDE directive follows the
same format.
Example:

LATITUDE	W37:41
.br
LONGITUDE	N121:52
.br
.b
.SH ALIASES
The aliases associate a name (frontporch) with an X10 device (A 10)
so that we don't have to remember  that the front porch light is house
code A, device 10.  In other words, we can use mnemonics to represent
the  devices.

The monitor command will display the alias name if the NEWFORMAT flag is
present in the x10config file.

Alias names can refer to one or more X10 devices.  All devices refered
to by a name must have the same housecode.

The format for an alias is:
.br
name  housecode  device

\fBName\fP can be any contiguous ascii string.
.br
\fBHousecode\fP is an upper case letter from A to P.
.br
\fBDevice\fP can be 3 things:
.IP
1. A single number (example 1)
.PP
.IP
2. A group of numbers separated by commas (example 1,2,14,15)
.IP
3. A range separated by a dash (example 1-8)
.PP
.SH ENVIRONMENT
.br
X10CONFIG - Points to a fully qualified file name of your configuration file.  If unset, the file $HOME/.x10config will be used.

.SH FILES
.br
 .x10config - X10 unit description file
.br
.SH AUTHORS
Re-written to use the CM11A interface by Daniel B. Suthers (dbs@tanj.com).

Originally written (Known as X10) by Larry Campbell (maynard!campbell).
System V port, ID file, improved display formats, and other cleanup by
John Chmielewski (rogue!jlc).  Module aliasing, sunset and sunrise
additions by Paul Fox (pgf@foxharp.boston.ma.us)

.SH SEE ALSO
http://www.x10.com/beta/protocol.doc
.br
date(1),  X10(1),  heyu(1), x10sched(5) makesched(1)