12.4 Gateway Commands
Kaleido supports the following commands through the Gateway access. Most of these apply to K2 and Alto/Quad, but some only apply to one platform, as indicated in the list. Furthermore, there may be differences in the use or syntax of some commands depending on the platform being used. All of these points are clarified in the list below, and in the detailed description of each command that follows.
In particular, note that all commands sent to a Kaleido-K2 must end with \n (line feed) or \r (carriage return). Kaleido Alto/Quad does not require these to be sent, and will ignore them if present..
12.4.1 Command description
Please note that:
- the syntax must be exactly replicated when sending a command
- every command sent to a Kaleido-K2 must end with a line feed (\n) or Carriage return (\r) - these are not shown in the descriptions below
- Kaleido Alto/Quad does not require the line feed or carriage return, and will ignore it if it is present
openID K2 AQ
This command opens a session with the specified Kaleido .
Please note that it is not necessary to open a session every time you want to send a command to the Gateway. Since opening a session takes a few seconds, it is recommended that you keep a session open as long as commands need to be sent.
<openID>IP_ADDRESS_0_4_0_0</openID>
Where:
Gateway response:
closeID K2 AQ
This command closes a session with the specified Kaleido-K2
<closeID>IP_ADDRESS_0_4_0_0</closeID>
Where:
Gateway response:
Note that this command closes the current connection to the client via port 13000, so this connection must be re-established before another session can be opened. If you are using Hyperterminal, it will automatically re-establish the previous connection if you begin typing new commands, but other clients may require you to manually reconnect.
getKCurrentLayout K2 AQ
This command retrieves the name of the current layout.
<getKCurrentLayout/>
Gateway response:
where CurrentLayout.kg2 is the name of the Layout currently in use by the Kaleido-K2. For Kaleido-Alto/Quad, the layout suffix is .xml instead of .kg2
setKCurrentLayout K2 AQ
This command loads the specified layout.
<setKCurrentLayout>set LayoutToLoad.kg2</setKCurrentLayout>
Where:
- LayoutToLoad is the name of the Layout to load. This Layout must have been exported to the Kaleido-K2 prior to executing this command. Note that you can use the getKLayoutList command to retrieve the available layouts before sending this command. For Kaleido-Alto/Quad, the layout suffix is .xml instead of .kg2
Gateway response:
getKLayoutList K2 AQ
This command returns the list of Layouts that can be used on the Kaleido-K2.
<getKLayoutList/>
Gateway response:
Where:
setKStatusMessage K2 AQ
This command associates an Alarm state with an id. The Kaleido-K2 can be configured to listen to this id using an Alarm Monitor, and thus report the state. This is a convenient way of reporting Alarms to the Kaleido-K2.
<setKStatusMessage>set id="AnId" status="status" message="TheMessage"</setKStatusMessage>
Where:
Gateway response:
setKChannel K2 AQ
This command is used to assign a Channel to the specified Monitor in the current Layout.
<setKChannel>set channelname="ChannelName" monitor="MonitorNumber" </setKChannel>
Where:
Note: to get the identifier of Monitors of your current Layout press the tab key of the Kaleido-K2's keyboard or the select key of the RCP.
Gateway response:
setKDynamicText K2 AQ
This command is used to set the text of a UMD or Text Label Component that is configured to use Dynamic Text. Note that the Service ID for this component must be set to "Gateway" when the layout is created in KEdit in order for this command to work.
<setKDynamicText>set address="Address" text="NewText" </setKDynamicText>
Where:
Gateway response:
setKTimer K2 AQ
This command is used to configure the specified Count Down Timer Component.
<setKTimer>set id="TimerID" preset="hh:mm:ss" direction="Direction" loop="Loop" </setKTimer>
Where:
Gateway response:
setKTimer2 K2 AQ
This command is used to configure a Timer in the Kaleido system
<setKTimer2>set TimerName="NAME" StartTime="HH:MM:SS:FF" PresetTime="HH:MM:SS:FF" TimerMode="UP" EndMode="STOP" </setKTimer2>
Where:
- NAME is the name assigned to the Timer in the Timer Configuration panel accessed from the Timer Browser.
- StartTime may be one of the following:
- HH:MM:SS:FF - time in hours:minutes:seconds:frames at which this Timer will start its count, depending on its configuration and presence of triggers. Note that if the HOURS is 00, the start time is deemed to be the previous midnight, whereas if HOURS is 24, it is considered to be the next midnight. This allows the timer to decide whether it should be counting or waiting to start when it compares the start time to the current time. (Note: the present implementation allows the user to send "Frames" information, but it is not used by the timer, which will start on the exact second)
- NOW - the Timer will start counting immediately upon receiving the command
- WAIT - the Timer will not start until it receives a setKTimerTrigger gateway command with the argument START
- PresetTime may be one of the following:
- Count duration (hours:minutes:seconds:frames) for Count Up and Count Down modes,
- End time (hours:minutes:seconds:frames) for the Remaining Time mode.
- Note: the present implementation allows the user to send "Frames" information, but it is not used by the timer, which will use count durations or end times based on seconds.
- Time Mode is the operating mode of the timer. Possible values are: UP, DOWN, REMAINING
- EndMode defines what is to happen when the Timer reaches the end of its count. Possible vales are: LOOP, STOP, OVERRUN
Gateway response:
setKTimerTrigger K2 AQ
This command is used to control the specified Count Down Timer Component. The Count Down Timer can be started, stopped or reset.
<setKTimerTrigger>set id="TimerID" trigger="Trigger"</setKTimerTrigger>
Where:
Gateway response:
setKFireAction K2 AQ
This command is used to fire the specified Action.
<setKFireAction>set name="NameOfTheActionToFire"</setKFireAction>
Where:
Gateway response:
setKEnableAlarmGroup K2
Note: this command is not supported by Kaleido-Alto/Quad
This command enables the specified Alarm Group.
<setKEnableAlarmGroup>set name="NameOfTheGroupToEnable"</setKEnableAlarmGroup>
Where:
Gateway response:
setKDisableAlarmGroup K2
Note: this command is not supported by Kaleido-Alto/Quad
This command is used to disable the specified Alarm Group.
<setKDisableAlarmGroup>set name="NameOfTheGroupToDisable"</setKDisableAlarmGroup>
Where:
Gateway response:
setKSaveLayout K2 AQ
This command allows the user to save the currently displayed layout to a file.
Where:
NOTE: do not specify an extension to the file name, as the file extension "kg2" is hardcoded for the Kaleido-K2 Layouts.
Gateway response:
getKAudioOut K2 AQ
This command allows the user to get the selected Audio Monitoring Output
Returned value can be any of:
DETAILS will vary depending on the type of audio output detected.
When no audio output is currently being monitored:
When the format is STREAMING, the returned value indicates the IP address and the Feed ID of the source using the following syntax:
Where:
999.999.999.999 is the IP of the machine from where the stream occurs.
XX is the identifier of the feed to use.
When the format is an AUDIO CARD, the returned value indicates which audio card input is being monitored:
Where:
999 indicates the input from the card.
When the format is EMBEDDED, the returned value will contain the video input, the group and the AES used. The syntax will be:
Where:
AAA indicates the video input.
BB indicates the group. Valid values range from 1 to 4.
X indicates the AES. Valid value can be either 1 or 2.
setKAudioOut K2 AQ
The user can select the audio to be monitored by using this Gateway command. The syntax of the command will differ if the user indicates to monitor audio coming from a stream (Note - streaming sources are not supported by Kaleido Alto/Quad), from an audio card, from an embedded source or no audio at all. In general, you can select any audio source to be monitored, even if this source is not represented in an audiometer on the current layout.
<setKAudioOut>DETAILS</setKAudioOut>
DETAILS will differ depending on the type of audio source being selected for monitoring, as shown below.
Gateway response:
DETAILS:
To select a STREAMING source (Kaleido-K2 only), format the command as follows:
Where:
999.999.999.999 is the IP of the machine from where the stream occurs.
XX is the identifier of the feed to use.
To select an AUDIO CARD source, format the command as follows:
Where:
999 indicates the input from the card.
To select an EMBEDDED source, format the command as follows:
Where:
AAA indicates the video input.
BB indicates the group. Valid values range from 1 to 4.
X indicates the AES. Valid value can be either 1 or 2.
To STOP audio monitoring and MUTE the audio output:
You may select any audio for monitoring, independent of whether it is being metered in the current Layout, with the exception that STREAMING sources must be part of the current layout.
getKAudioOutVolume K2 AQ
This command retrieves the Audio Monitoring Volume currently used:
The returned value will have the form:
Where:
XX The value, expressed in dB, at which the Audio Monitoring volume is set. This value ranges between -90dB and 0.
setKAudioOutVolume K2 AQ
This command sets the Audio Monitoring Volume:
Where:
XX Value expressed in dB at which the volume will be set.
Valid values range from -90dB to 0dB.
Returned value will be one of:
Note that if the audio is muted, then it shall be un-muted after this command.
getKAudioOutMode K2 AQ
This command retrieves the Audio Monitoring Mode currently used:
Returned value will have the form:
Where: XXXXX is the mode, which can be any of NORMAL, MUTE or -20dB.
setKAudioOutMode K2 AQ
To set the Audio Monitoring Mode the following command will be used:
Where:
XXXXX is the value at which the mode must be set. Valid values are NORMAL, MUTE and -20dB.
Returned value will be any of:
setKVerticalOffset AQ
This command is used to offset the graphic vertically on the display
Where offset is the number of lines to offset, 0 to 175.
setKIcontrolMode AQ
This command is used to enable the Alto/Quad to key the detected mouse colors on video.
Where:
Mode = 0, Color not keyed, Mode = 1, color key enabled.
setKMouseColorA AQ
This command is used to set a color to key.
mouseColorA is defined as FFBBGGRR
BB: the blue component.
GG: the green component.
RR: the red component.
setKMouseColorB AQ
This command is used to set a color to key.
mouseColorB is defined as FFBBGGRR
BB: the blue component.
GG: the green component.
RR: the red component.
setKMouseColorC AQ
This command is used to set a color to key.
mouseColorC is defined as FFBBGGRR
BB: the blue component.
GG: the green component.
RR: the red component.
Americas
Technical Support
Telephone (9:00-17:00 EST)
+1-800-224-7882
Fax: +1-514-335-1614
|
Asia
Technical Support
Telephone (9:00-17:00 JST)
+81-3-5730-2987
Fax: +81-3-5730-2973
|
Europe,Middle East, Africa, UK
Technical Support
Telephone(9:00-18:00 GMT)
+44 (0) 1491 820222
24 Hour Reply +44 (0) 8700 660295 Fax: +44 (0) 1491 820002 |
France
Technical Support
+33 1 55 86 87 88
Fax: +33 1 55 86 00 29 |