User`s guide

X10CONFIG(5) X10CONFIG(5)
SCENE dim_all dim A1-3 8; dim B2 8; dim c7 8
SCENE night_lights offporch_light; on garage_light; dim hall 8
Issuing the command ´heyu dim_all´ would result in each of the commands defined in that scene to be
executed in turn.
Scenes can also be defined with positional parameters which are replaced by actual parameters when they
are executed. The positional parameters are designated by a ´$´ sign followed by a number 1 to N option-
ally enclosed in curly brackets, e.g., ´$2´, ´${7}´. The number represents the position of the parameter in
the argument list supplied when the scene is executed.. A positional parameter can be used as part or all of
either a device address or a dim level, but not as part of a scene label or a Heyu command
Examples:
SCENE blinker on $1; off$1; on $2; off$2
SCENE Dim_all dim A1-3 $1; dim B2 $1; dim c7 $1
These could then be executed by running:
heyu blinker A3 B7
heyu Dim_all 7
Rules for scenes (interpret "scene" as meaning either scene or usersyn):
1. A scene label is a case-sensistive ASCII string (maximum length 32 characters) not beginning with ´-´ or
´_´ and not containing blanks or the ´+´ or ´$´ characters.
2. A scene label may not be the same as a Heyu command or anyofits synonyms. A scene label may not
duplicate a usersyn label and vice-versa. As of the current implementation, a scene label MAYbethe same
as an alias label, and it MAYbethe same as a macro label, but these feature may be restricted in future
releases if too much user confusion results.
3. Only "direct" and CM17A commands can be used in scenes - "administrative"commands like´help´,
´info´, etc., are invalid in scenes, as are commands identified as "legacy"commands from Heyu version 1.
(Running ´heyu help´ will identify each of these types of commands.)
4. A command in a scene may not be another scene.
5. Commands in scenes are checked for syntax when the configuration file is read, but there is no checking
of anyparameter containing a positional parameter until the scene is actually executed or specified in a
macro. The syntax checking is performed as if the scene is to be executed at the command line, so if a
scene contains a command which is invalid for an uploaded macro, that error won´t be flagged until the
´heyu upload [check]´ command is run.
6.There is no restriction on howapositional parameter is used within a parameter so long as the result is
valid when the scene is executed. Use the optional curly brackets if the result could otherwise be ambigu-
ous. The positional parameter is first replaced by the actual parameter,then the result is checked against
the list of aliases.
7. The number of positional parameters supplied when a scene is executed must agree exactly with the
number specified in the scene definition. Thus if ´$4´ is the highest numbered positional parameter speci-
fied in a scene, then 4 and only 4 parameters must be supplied when the scene is executed.
8. If more than one scene is used in a macro, or if scenes are intermixed with regular macro commands,
theymust be separated by semicolons.
9. Memory for scenes is dynamically allocated so there is no fixed size limit for scenes intended for execu-
tion from the command line. Bear in mind howeverthe limited (1024 byte) EEPROM space in the CM11A
when scenes are expanded in macros, although most common X10 commands occupyonly 3 or 4 bytes
when converted to binary.
10. The highest numbered positional parameter in a scene is by default limited to 8. (In most cases anything
local 10