User`s guide

X10CONFIG(5) X10CONFIG(5)

ALIAS livingroom_lamp H7 SL2LM ONLEVEL 20

It is advisable to deﬁne single-unit aliases for all housecode|units in addition to anymultiple-unit aliases

which may be convenient for use in Scenes/Usersyns/Macros, and to deﬁne a Module_type only for single-

unit aliases.

(Once a Module_type is deﬁned, it applies to that same housecode|unit howeverused, e.g., in the above

example Heyu will understand that D1 is a WS467 dimmer when either ´heyu turn porch_light on´ or ´heyu

turn D1 on´ is executed, or if D1 is also included in a multiple-unit alias likeD1,2-5,7)

Modules not deﬁned for a Housecode|unit in an ALIAS directive are assigned to be the default module,

which is a standard X-10 lamp module. This can be changed with the DEFAULT_MODULE directive.

Note: Versions of Heyu prior to 2 used a different format for aliases: No ALIAS directive was used and the

Housecode letter and Units were separated by whitespace, e.g., simply ´hall_light B7´. For compatibility,

Heyu version 2 will still accept this format, howeverits use is discouraged and deprecated. (Module type

cannot be speciﬁed with this format.)

DEFAULT_MODULE directive

Sets the module attributes of all Housecode|Units which are not deﬁned in an alias directive.Ifnot other-

wise speciﬁed by this directive,the default module is the standard X-10 plug-in lamp module (StdLM).

START_ENGINE directive

ManyofHeyu´s features require the Heyu state engine daemon heyu_engine to be running. This directive

instructs Heyu howheyu_engine is to be started. With the default value of MANUAL, the engine must be

started by entering ´heyu engine´ at the command line. With the value AUTO, the engine will be started

automatically along with Heyu´s other background processes when ´heyu start´ is run. Example:

START_ENGINE AUTO

LOG_DIR directive

Use this directive tospecify the directory in which the Heyu state engine daemon should write its log ﬁle

´heyu.log.<tty>´. The keyword ´NONE´ (which is the default) instructs Heyu to not write a log ﬁle.

Example:

LOG_DIR /var/log/heyu/

The log ﬁle will contain entries likeappear in the Heyu monitor,and in addition, an entry wheneverascript

(excluding heyuhelper) is launched. It will also collect the text output of a launched script, if that output

isn’tredirected to a different ﬁle.

Tw o or more instances of Heyu running on the same computer can share a common log ﬁle by appending

the keyword "COMMON". If each instance of Heyu is started with the base subdirectory switch (-0

through -9), each entry in the log ﬁle ´heyu.log.common´ will display the subdirectory number (0 through

9) from whence the signal originated.

Example:

LOG_DIR /var/log/heyu common

Note that the log ﬁle will continue to grow. Manually delete or trim it from time to time, or conﬁgure a

Unix utility like´logrotate´ to manage it.

DATE_FORMATdirective

Speciﬁes howanumeric date is displayed. The syntax for this directive is:

DATE_FORMAT<order> [<separator>]

where <order> is

YMD => Year/Month/Day (Default)

DMY => Day/Month/Year

local 8