x10.config(5) · carta

NAME

x10.config - Configuration file format for the X10 heyuA serial interface control program

DESCRIPTION

heyu is a little program for controlling a X10 "heyuA" home control device. See the heyu(1) man page for usage information.

The x10config file is normally in your home directory under the file name .x10config. It contains several different pieces of information that the heyu program needs in order to function. There are directives (special keywords the program uses) and aliases.

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 heyua is attached. /dev/ttyS0 would be the first serial port. /dev/cua0 will also work. Example:

TTY /dev/cua2

HOUSECODE directive

The housecode directive tells the heyuA 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.

LATITUDE and LONGITUDE directives.

These are used to allow the scheduling function to determine dawn and dusk for your particular location. As of version 1.10a, it was not being used yet.

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.

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:
name housecode device

Name can be any contiguous ascii string.
Housecode is an upper case letter from A to P.
Device can be 3 things:

: 1. A single number (example 1)

: 2. A group of numbers separated by commas (example 1,2,14,15)

: 3. A range separated by a dash (example 1-8)

ENVIRONMENT

X10CONFIG - Points to a fully qualified file name of your configuration file. If unset, the file $HOME/.x10config will be used.

FILES

x10.config - X10 unit description file

AUTHORS

Re-written to use the heyuA interface by Daniel B. Suthers ([email protected]). Some of the features are still under development, most especially reading the eeprom, changing it and uploading it back to the heyuA.

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 ([email protected])