User`s guide

X10CONFIG(5) X10CONFIG(5)
RF_BURSTS directive
Specifies howmanyRFbursts (1-5) are to be transmitted with each actuation of the CM17A commands
fon, foff, fdim, fbright, flightson, flightsoff, falloff, farb, and farw.Some transceivers will repeat some
power line signals more than once when theyreceive the default 5 RF bursts. This is ordinarily not a prob-
lem except possibly when the particular power line signal is used to launch a script, in which event this
directive can be useful.
This directive has the syntax:
´RF_BURSTS <command> <bursts> [<command> <bursts> [...]] ´, e.g.,
RF_BURSTS falloff3flightson 3 fdim 4
Note: Previous releases of Heyu required that each command be entered on a separate RF_BURSTS line
and multiple RF_BURSTS directive lines were allowed.
The default for all CM17A commands is 5 bursts. For commands fdim, fbright, and farb where the total
number of bursts is specified on the command line, the CM17A will be actuated multiple times, with the
maximum number of bursts each time specified by this directive.
The RF_BURSTS directive isnot used for the "fast" ffdim, ffbright, and ffarb commands.
TIMER_LOOPCOUNT directive
Specifies the base countdown for fast timing loops. These are usually needed to actuate the CM17A for the
"fast" ´ffdim´, ´ffbright´, ´ffarb´, and ´ffarw´ commands. The value to use for this directive isobtained by
running ´heyu utility calibrate´.
Forthe CM17A fast commands, the default value of zero instructs Heyu to use a kernel timer instead of a
timing loop, but the resolution of the kernel timers for most Unix/Linux kernels is not fine enough for this
purpose.
CM17A_BIT_DELAYdirective
Specifies the programmed delay in _microseconds_ between bits sent to the CM17A device. X10´s RF
protocol specifies a minimum of 500 microseconds and the default here is 500 microseconds. ForLinux at
least the minimum resolution of the kernel timer is usually much longer than this, typically 10 milliseconds,
so changing the value probably won’taccomplish anything except for the "fast" CM17A commands when a
timing loop is used.
DISPLAY_RF_XMIT directive
Determines whether an entry will appear in the monitor and log file when a CM17A command is executed.
The choices are NO or YES or VERBOSE, with the default being YES. Using VERBOSE is likeYES but
the triplet [XX YY B] is appended to each displayed entry.The XX, YY,and B are respectively the two
hexbytes and decimal bursts which could be sent with the equivalent ´farb XX YY B´ command.
One quirk is that with multiple CM17A commands the RF entries will not necessarily be properly inter-
leavedwith the entries for transceivedpower line signals resulting from the RF command. This is because
the CM11A doesn´t instantly report reception of the power line signals - there can be a delay of a second or
more. The only workaround is to increase the RF_POST_DELAYto2000 or 3000 milliseconds, which
really slows down the RF commands.
RF_NOSWITCH directive
This directive determines whether actuation of the built-in appliance module switch on an X-10 TM751 or
RR501 is to be suppressed when the transceiverreceivesthe fon, foff, or falloffRFsignal on the unit code
for the switch. Setting the parameter of this directive toYES will suppress actuation of the switch with its
accompanying loud audible click. The default is NO.
local 22