Sce - AMX Modero G5 Instruction Manual

Programming - Send Commands
Button Commands (Cont.)

^SCE

74
Subpage Custom Event Command.
Configures subpage custom events.
This command can be used to enable or disable the transmission of custom events to the master whenever
certain operations occur. For example, the system programmer may want to be notified whenever a subpage
enters the anchor position.
The notification mechanism is a custom event. The ^SCE command takes the form of a vt addr range
specifying one or more subpage viewer buttons followed by a comma separated list of custom event numbers.
If the number is 0 or blank for a given event type then no custom event will be transmitted when that event
occurs. If a number is specified, then it is used as the EVENTID value for the custom event. The range of
32001 to 65535 has been reserved in the panel for user custom event numbers. A different value could be
used but might collide with other AMX event numbers. Event configuration is not permanent and all event
numbers revert to the default of 0 when the panel restarts.
Syntax:
"'^SCE-<vt addr range>,<optional anchor event num>,<optional onscreen event num>,
<optional offscreen event num>,<optional reorder event num>'"
Variables:
variable text address range = 1 - 4000.
Anchor event number = 0 for no event or a value from 32001 to 65535.
Onscreen event number = 0 for no event or a value from 32001 to 65535.
Offscreen event number = 0 for no event or a value from 32001 to 65535.
Reorder event number = 0 for no event or a value from 32001 to 65535.
The events are:
Anchor - a new subpage has docked in the anchor position.
Onscreen - a docking operation has been completed and the subpages in the list are now onscreen. This list
will include the anchor along with any subpages that may be partially onscreen.
Offscreen - a docking operation has been completed and the subpages in the list are now offscreen.
Reorder - the user has reordered the subpages in the set and the list contains all subpages in the new order
without regard to onscreen or offscreen state.
In response to any or all of the above events, the panel will create a string which is a list of subpage names
separated by a pipe (|) character. The string for the anchor event is a single subpage name. If this string is too
long to be transmitted in a single custom event, then multiple custom events will be created and transmitted.
If defined, the events are sent in this order when a docking operation completes on a given viewer button:
anchor, onscreen, offscreen.
If reorder is defined and occurs, it is sent first: reorder, anchor, onscreen, offscreen.
The format of the custom event transmitted to the master is as follows:
CUSTOM.TYPE = EVENTID = the non-zero event number in the ^SCE command
CUSTOM.ID = ADDRESS = the address of the viewer button which generated the event
CUSTOM.FLAG = 0
CUSTOM.VALUE1 = which one of possible multiple events this is (1 based)
CUSTOM.VALUE2 = total number of events needed to send the entire string
CUSTOM.VALUE3 = the total size of the original string in bytes
CUSTOM.TEXT = pipe character separated list of subpage names
Example:
SEND_COMMAND Panel, "'^SCE-200,32001,0,0,0'"
If the subpage named TV_Favorite_SyFy enters the anchor position on a subpage viewer button with an
address of 200, the following event would be transmitted to the master when the user had sent this command
to the panel:
CUSTOM.TYPE = EVENTID = 32001
CUSTOM.ID = ADDRESS = 200
CUSTOM.FLAG = 0
CUSTOM.VALUE1 = 1
CUSTOM.VALUE2 = 1
CUSTOM.VALUE3 = 16
CUSTOM.TEXT = TV_Favorite_SyFy
Modero G5 Touch Panels - Configuration and Programming