-
User’s Guide M770-0900-114 Copyright 2011 Miranda Technologies Inc. Specifications may be subject to change Printed in Canada May 2011 Miranda Technologies Inc. 3499 Douglas-B.-Floreani St-Laurent, Québec, Canada H4S 2C6 Tel. 514-333-1772 Fax. 514-333-9828 www.miranda.
-
-
USER’S GUIDE Table of Contents 1 Introduction ......................................................................................................................................... 1 1.1 Software Versions ........................................................................................................................ 1 1.2 Remote Operation of the Kaleido-X Series or Kaleido-Alto/Quad/Quad-Dual Multi-Viewers ..... 1 1.3 Gateway Options for the Kaleido-K2 .....................................
-
-
USER’S GUIDE Kaleido Remote Control Protocol (Gateway) 1 Introduction Kaleido-K2, Kaleido Alto/Quad/Quad-Dual, Kaleido-X, Kaleido-X16, and KMV-3901/3911 multi-viewers can execute commands received via a gateway, allowing third-party developers and individual users remote access to some functions of the multi-viewer’s operating system. This document describes the Gateway functionality, and defines the commands that are available.
-
USER’S GUIDE The MT-Gateway runs as a Windows service on the Kaleido-K2’s operating system Note: The internal gateway is the preferred gateway, and Miranda strongly recommends that it be used instead of the MT-Gateway, as it is more robust. The MT-Gateway might be used for legacy applications (the internal gateway was not available in early versions of the software), or in specific situations based on design considerations, but its use is deprecated.
-
USER’S GUIDE 2. Double-click the Services icon. The Services management console will appear. You can see if the MT-Gateway service is running, and whether it is configured to start automatically when the KaleidoK2 is booted. 3. Right-click MT_Gateway and then click Properties on the shortcut menu. 4. Select Manual as the startup type, and then click OK. 5. Click the Stop Service button on the toolbar to turn the gateway off. 1.
-
USER’S GUIDE 2 Gateway Commands Kaleido multi-viewers support the following commands through the Gateway access. Most of these apply to all Kaleido multi-viewer models, 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. All of these points are clarified in the detailed description of each command that follows. Note: All gateway commands must be followed by a carriage return.
-
USER’S GUIDE Command Applies to setKDynamicText KX getKDynamicText KX getKMetaData K2 AQ K2 Description Page Sends text to the specified layout element 14 Retrieves text from the specified layout element 14 Gets metadata from a MultiData component 15 Configures the specified countdown timer 16 Configures the specified timer 16 setKTimer KX K2 setKTimer2 KX K2 setKTimerTrigger KX K2 AQ Starts, stops or resets a countdown timer 17 setKFireAction KX K2 AQ Fires the specifi
-
USER’S GUIDE 2.2 Document Conventions Each command in this document is presented in the following format: [Command Name] [Applicable Kaleido Systems] Command description. The proper command syntax with variables. Gateway Response – a list of possible answers: a) For a successful execution of the command b) For an unsuccessful execution of the command Special notes for the command or specific platform. 2.
-
USER’S GUIDE OR to open a session with user privilege validation without MD5 password hash: mirandagateway://USERNAME:CLEAR_PASSWORD @SYSTEM_NAME/ROOM_NAME Where: o IP_ADDRESS is the IP address of your destination Kaleido frame. o ROOM_NAME is the room context for the session (see getKCurrentLayout, setKCurrentLayout and getKLayoutList). o USERNAME is the username that will be used to validate permissions. o PASSWORD_MD5_HASH is the md5 hash of the user password, encoded in base 64.
-
USER’S GUIDE : The Gateway was not able to recognize the command. Note: This command closes the current connection to the client via port 13000. 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.
-
USER’S GUIDE name="CurrentLayout.kg2" : The Gateway was not able to recognize the command. Where CurrentLayout.kg2 is the name of the Layout currently in use by the Kaleido-K2 or Kaleido-X series multi-viewer. For a Kaleido-Alto/Quad/Quad-Dual, the layout suffix is ―.xml‖ instead of ―.kg2‖. Note: On a Kaleido-X series multi-viewer, the session must have a room context for the command to be used.
-
USER’S GUIDE : The Gateway was not able to recognize the command. Notes: For a Kaleido-X series multi-viewer, 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. Example: Room1/MAIN.kg2 Room1/BACKUP1.kg2 Room2/MAIN.
-
USER’S GUIDE ... PAGE 16
USER’S GUIDE getKRoomList KX This command is used to obtain the list of rooms known to your multi-viewer system. Gateway response: Room ARoom B : The Gateway was not able to recognize the command. setKStatusMessage KX K2 AQ This command associates an Alarm state with an ID. The Kaleido can be configured to listen to alarm status messages from the Gateway, and thus report the state it receives.
-
USER’S GUIDE setKUnlatch KX This command is used to acknowledge the global alarm for a given source (channel). It can also be used to acknowledge specific alarms. The command supports three parameter types: channelName, id or uri: o If channelName is specified, the global alarm associated with the specified source (channel) will be acknowledged. o If uri is specified, the alarm with the specified URI will be acknowledged.
-
USER’S GUIDE Room1/composite42. The monitor name is available in the XEdit layout (Properties > Assignments > Name). Note: On the Kaleido-K2, to get the monitors’ identifiers for your current layout press the Tab key on the keyboard, or the SELECT key on the RCP. Gateway response: : The command was recognized by the Gateway. : The Gateway was not able to recognize the command, or a parameter could not be resolved.
-
USER’S GUIDE Note: This command will only return text that was previously set via the command. getKMetaData K2 This command is used to get metadata that is assigned to a MultiData component assigned to a text label in the Kaleido-K2. The Kaleido-K2 will return XDS, Dolby-E and video format data in response to this command. get dataname=MultiDataName Where MultiDataName is the name of the MultiData source, as defined in the MultiData Configuration panel.
-
USER’S GUIDE programID timeOfDay timeZone o The value field is escaped as defined in the XML protocol for an attribute value. o For instance, ABC"DEF\GHIMNO/PQR&STU;VWX'YZ becomes ABC"DEF\GHI<JKL>MNO/PQR&STU;VWX'YZ o The attributes order is not guaranteed and may change for two consecutives calls to the same command. : there is a syntax error in the XML command.
-
USER’S GUIDE o o NAME is the name assigned to the timer in the Timer configuration panel accessed from the Timer Browser window in KEdit, or in the Timer Editor window in XEdit. 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 hour value is ―00‖, the start time is deemed to be the previous midnight, whereas ―24‖ is considered to be the next midnight.
-
USER’S GUIDE 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). set name="NameOfTheActionToFire" 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.
-
USER’S GUIDE Gateway response: : The command was recognized by the Gateway. : The Gateway was not able to recognize the command. setKDisableAlarmGroup KX K2 This command is used to disable the specified alarm group or virtual alarm. set name="NameOfTheGroupToDisable" Where NameOfTheGroupToDisable is the name of the alarm group (for a Kaleido-K2 multiviewer), or virtual alarm (for a Kaleido-X Series multi-viewer model) you wish to disable.
-
USER’S GUIDE Notes: A session with user privileges must first be opened for this command to work on a Kaleido-X or Kaleido-X16 multi-viewer. This command is currently not supported on the KMV-3901/3911 models. Returned value can be any of: DETAILS: The command was executed. DETAILS will vary depending on the type of audio output detected.
-
USER’S GUIDE Notes: A session with user privileges must first be opened for this command to work on a Kaleido-X or Kaleido-X16 multi-viewer. This command is currently not supported on the KMV-3901/3911 models. Streaming sources are not supported on the Kaleido-Alto/Quad/Quad-Dual. DETAILS Where DETAILS will differ depending on the type of audio source being selected for monitoring, as shown below.
-
USER’S GUIDE If the source is not included in the layout, the sound will be routed to the audio monitors, but there will be no indication of the source, in the layout. getKAudioOutVolume KX K2 AQ Note: This command is currently not supported on the KMV-3901/3911 models. This command retrieves the audio monitoring volume currently used.
-
USER’S GUIDE Returned value will have the form: mode="XXXXX" Where XXXXX is the mode, which can be any of NORMAL, MUTE or –20 dB. : The command was not executed, due to a spelling error or invalid parameter. In this case the audio monitoring mode remains unchanged. setKAudioOutMode KX K2 AQ Note: This command is currently not supported on the KMV-3901/3911 models.
-
USER’S GUIDE set mode="N" Where N is either 0 (color not keyed), or 1 (color key enabled). Gateway response: : The command was recognized by the Gateway. : The Gateway was not able to recognize the command. setKMouseColorA AQ This command is used to set a color to key. set mouseColorA="FFBBGGRR" Where FFBBGGRR is the hexadecimal triplet for mouseColorA prefixed with the hexadecimal value ―FF‖.
-
USER’S GUIDE : The command was recognized by the Gateway. : The Gateway was not able to recognize the command. setKMouseColorC AQ This command is used to set a color to key. set mouseColorC="FFBBGGRR" Where FFBBGGRR is the hexadecimal triplet for mouseColorC prefixed with the hexadecimal value ―FF‖. BB represents the blue component. GG represents the green component. RR represents the red component.
-
USER’S GUIDE 3 A Typical Session Here is a description of how to open and close a typical session during which you will use these commands to operate a Kaleido. You can open concurrent sessions with multiple Kaleido frames; each session will have its own window on your desktop. If you are using a Kaleido-K2, make sure the internal gateway is turned ON, and the MT-gateway is turned OFF (see section 1.2).
-
USER’S GUIDE To be able to see the characters you type in the HyperTerminal console: 1. On the File menu, click Properties. The [connection name] Properties window appears. 2. On the Settings tab, click the ASCII Setup button. 3. Select the Echo typed characters locally check box. 4. Click OK to close ASCII Setup window, and then click OK again to close the Properties window. The characters you type will appear in the console.
-
USER’S GUIDE Commands can be sent to the Gateway while a session is open. To send a command, type it in the console and then press the Enter key. There is no limit to the number of commands that can be sent in a session, and it is recommended to keep a session open as long as there are commands to send, since opening a session takes a few seconds. Here is a simplified example of a session: Open a session send command send command … send command Close the session.
-
USER’S GUIDE To end the communication session, click the Disconnect button on the toolbar.
-
USER’S GUIDE 4 Appendix: Kaleido-X Series Support History For each Kaleido Remote Control Protocol (Gateway) command, the following table indicates, for each Kaleido-X Series multi-viewer model, the version number of the Kaleido-X Software that first supported the command. Command Kaleido-X Kaleido-X16 KMV-3901/3911 openID 1.00 4.10 5.00 closeID 1.00 4.10 5.00 getParameterInfo 4.00 4.10 5.00 getKCurrentLayout 1.00 4.10 5.00 setKCurrentLayout 1.00 4.10 5.00 getKLayoutList 1.00 4.
-
USER’S GUIDE Command Kaleido-X Kaleido-X16 KMV-3901/3911 getKAudioOut 2.00 4.10 — setKAudioOut 2.00 4.10 — getKAudioOutVolume 3.00 4.10 — setKAudioOutVolume 3.00 4.10 — getKAudioOutMode 3.00 4.10 — setKAudioOutMode 3.00 4.10 — setKVerticalOffset N.A. N.A. N.A. setKIcontrolMode N.A. N.A. N.A. setKMouseColorA N.A. N.A. N.A. setKMouseColorB N.A. N.A. N.A. setKMouseColorC N.A. N.A. N.A.
-
Miranda Technical Support For technical assistance, please contact the Miranda Technical Support center nearest you: Americas Office hours: Telephone: Fax: E-mail: Asia 9:00 a.m. – 9:00 p.m. (EST) +1-800-224-7882 +1-514-335-1614 support@miranda.com Europe, Middle East, Africa, UK Office hours: Telephone: Fax: E-mail: 9:00 a.m. – 6:00 p.m. (GMT) +44 (0) 1491 820222 +44 (0) 1491 820002 eurotech@miranda.com France Office hours: Telephone: Fax: E-mail: Office hours: Telephone: Fax: E-mail: 9:00 a.m.
