User`s manual

162

Using Kaleido-X Control Protocols

Where:

• LayoutToLoad is the name of the Layout to load. This Layout must have been exported to the Kaleido 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

Note for Kaleido-X:

If the session does not have a room context, the layout name must be prefixed with the room name and a

"/".

• Ex: <setKCurrentLayout>set Room1/Layout1.kg2</setKCurrentLayout>

Gateway response:

• <nack/>: the Gateway was not able to recognize the command or the layout could not be found.

• <ack/>: the command was recognized by the Gateway and the layout has been fully loaded.

getKLayoutList

This command returns the list of Layouts that can be used on the Kaleido.

Gateway response:

• <nack/>: the Gateway was not able to recognize the command.

• <kLayoutList> Layout1.kg2 Layout2.kg2 … AnAvailableLayout.kg2</kLayoutList>

Note for Kaleido-X:

If the session does not have a room context, the layout names will be prefixed with the room name and a

"/". If the session has a room context, only layouts for that room will be returned and the layout names

won't be prefixed with the room name (see K2/AQ style response).

• Ex: <kLayoutList>Room1/MAIN.kg2 Room1/BACKUP1.kg2 Room2/MAIN.kg2</kLayoutList>

Where:

• Layout1, Layout2 and AnAvailableLayout are the name of the Layouts that are available on the Kaleido-

K2. For Kaleido-Alto/Quad, the layout suffix is .xml instead of .kg2

setKStatusMessage

This command associates an Alarm state with an id. The Kaleido 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.

<setKStatusMessage>set id="AnId" status="STATUS" message="TheMessage"</setKStatusMessage>

Where:

Kaleido-X User's Manual.book Page 162 Friday, August 24, 2007 4:39 PM