Grass Valley Kaleido Remote Control Protocol Gateway May.2011 - Manual (Page 22)

USER’S GUIDE
18 | Kaleido Remote Control Protocol (Gateway)
setKFireAction KX K2 AQ
This command is used to fire the specified Action (for example, by an external third-party system
that is unable to use the GPI in as a trigger).
<setKFireAction>set name="NameOfTheActionToFire"</setKFireAction>
Where NameOfTheActionToFire is the Friendly name of the Action to be executed.
Notes:

For a Kaleido-X series multi-viewer, the Friendly name is specified under the Properties
tab in XEdit.

The Action must have been exported to the multi-viewer in order to be executed.

On a Kaleido-X series multi-viewer, background actions listed in the
On Change/Gateway
column under XEdit’s Actions tab will be executed when the
action is fired by the Gateway command.
Gateway response:
 <ack/>: The command was recognized by the Gateway.
 <nack/>: The Gateway was not able to recognize the command, or the command could
not be executed.
Note: On a Kaleido-X series multi-viewer, an action that consists of multiple action items will
stop as soon as one of the action items cannot be executed. The Gateway would then
return <nack/>.
getKActionList KX
This command is used to obtain the list of actions known to your multi-viewer system.
<getKActionList/>
Gateway response:
 <kActionList><action>Action1</action><action>Action2</action>
<action>Action3</action></kActionList>
 <nack/>: The Gateway was not able to recognize the command.
setKEnableAlarmGroup KX K2
This command enables the specified alarm group or virtual alarm.
<setKEnableAlarmGroup>set
name="NameOfTheGroupToEnable"</setKEnableAlarmGroup>
Where NameOfTheGroupToEnable is the name of the alarm group (for a Kaleido-K2 multi-
viewer), or virtual alarm (for a Kaleido-X Series multi-viewer model) you wish to enable.
Note: In the case of a Kaleido-X Series multi-viewer model, this parameter can be the
path/friendlyName of the virtual alarm or its URI.