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..

Command

Applies to

Description

openID

K2

AQ

Opens a session with the specified Kaleido

closeID

K2

AQ

Closes a previously opened session.

getKCurrentLayout

K2

AQ

Gets the name of the current layout

setKCurrentLayout

K2

AQ

Loads a specific Layout.

getKLayoutList

K2

AQ

Gets the list of available Layouts.

setKStatusMessage

K2

AQ

Sets a Gateway Alarm to the specified state.

setKChannel

K2

AQ

Associates a Channel to the specified Monitor.

setKDynamicText

K2

AQ

Configures the text to display for a Dynamic Text.

setKTimer

K2

AQ

Configures the specified Count Down Timer.

setKTimer2

K2

AQ

Configures the specified Timer.

setKTimerTrigger

K2

AQ

Starts, stops or resets a Count Down Timer.

setKFireAction

K2

AQ

Fires the specified Action.

setKEnableAlarmGroup

K2

 

Enables the Alarm Group.

setKDisableAlarmGroup

K2

 

Disables the Alarm Group.

setKSaveLayout

K2

AQ

Saves the current layout

getKAudioOut

K2

AQ

Gets the identity of the current audio output

setKAudioOut

K2

AQ

Selects the audio to be monitored

getKAudioOutVolume

K2

AQ

Get the current audio monitoring output volume

setKAudioOutVolume

K2

AQ

Set the volume of the audio monitoring output

getKAudioOutMode

K2

AQ

Get the current audio monitoring output mode

setKAudioOutMode

K2

AQ

Set the audio monitoring output mode

setKVerticalOffset

 

AQ

Offset the graphic from display

setKIcontrolMode

 

AQ

Enable/Disable mouse color keying over video

setKMouseColorA

 

AQ

Mouse color to be keyed over video

setKMouseColorB

 

AQ

Mouse color to be keyed over video

setKMouseColorC

 

AQ

Mouse color to be keyed over video

12.4.1 Command description

Please note that:

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:

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:

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
techsupp@miranda.com
Asia

Technical Support
Telephone (9:00-17:00 JST)

+81-3-5730-2987
Fax: +81-3-5730-2973
asiatech@miranda.com
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
eurotech@miranda.com
France


Technical Support

+33 1 55 86 87 88
Fax: +33 1 55 86 00 29
eurotech@miranda.com