Miranda KMV-3901 User Manual
  1. Manuals
  2. Brands
  3. Miranda Manuals
  4. Media Converter
  5. KMV-3901
  6. User manual

Miranda KMV-3901 User Manual

Kaleido series multi-image display processor remote control protocol (gateway)
Hide thumbs
Table of Contents

Advertisement

Quick Links

Kaleido Remote Control
Protocol (Gateway)
User's Guide
M770-0900-115
Copyright 2011 Miranda Technologies Inc.
Speci cations may be subject to change
Printed in Canada
Miranda
Technologies Inc.
3499 Douglas-B.-Floreani
St-Laurent, Québec, Canada H4S 2C6
Tel. 514-333-1772
Fax. 514-333-9828
www.miranda.com
Multi-Image
Display
Processor
Nov. 2011

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the KMV-3901 and is the answer not in the manual?

Questions and answers

Related Manuals for Miranda KMV-3901

Summary of Contents for Miranda KMV-3901

  • Page 1 Multi-Image Display Kaleido Remote Control Processor Protocol (Gateway) User’s Guide M770-0900-115 Copyright 2011 Miranda Technologies Inc. Speci cations may be subject to change Printed in Canada Nov. 2011 Miranda Technologies Inc. 3499 Douglas-B.-Floreani St-Laurent, Québec, Canada H4S 2C6 Tel. 514-333-1772 Fax.

  • Page 3: Table Of Contents

    USER’S GUIDE Table of Contents Introduction ............................1 Software Versions ........................1 Remote Operation of the Kaleido-X Series or Kaleido-Alto/Quad/Quad-Dual Multi-Viewers ..1 Gateway Options for the Kaleido-K2 ................... 1 1.3.1 Internal Gateway ......................... 2 1.3.2 MT-Gateway ........................2 Remote Operation of the Kaleido-K2 via the Gateway ..............3 Gateway Commands ..........................

  • Page 5: Introduction

    In this document, the term Kaleido is used to describe features common to the Kaleido-K2, Kaleido- Alto/Quad/Quad-Dual, and Kaleido-X series of multi-viewers. The term Kaleido-X series refers to the Kaleido-X, Kaleido-X16, KMV-3901/3911, and Kaleido-IP multi-viewer models. Features exclusive to any one of these products will be described using the full product name (e.g. Kaleido-K2, Kaleido- Alto/Quad/Quad-Dual, Kaleido-X, Kaleido-X16, KMV-3901/3911, or Kaleido-IP).

  • Page 6: Internal Gateway

    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.

  • Page 7: Remote Operation Of The Kaleido-K2 Via The Gateway

    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 Kaleido- K2 is booted. 3. Right-click MT_Gateway and then click Properties on the shortcut menu. 4.

  • Page 8: Gateway Commands

    2.1 Index of Gateway Commands The applicable Kaleido systems are indicated as follows: Code System Multi-Viewer Models Kaleido-X Software Kaleido-X, Kaleido-X16, KMV-3901/3911, Kaleido-IP Kaleido-K2 Software Kaleido-K2 Kaleido-Alto/Quad/Quad-Dual Kaleido-Alto, Kaleido-Quad, Kaleido-Quad-Dual The star () symbol indicates a new command, or a command with new parameters.
  • Page 9 USER’S GUIDE Command Applies to Description Page setKChannel Associates a source (channel) to the specified monitor setKDynamicText Sends text to the specified layout element getKDynamicText Retrieves text from the specified layout element getKMetaData Gets metadata from a MultiData component setKTimer Configures the specified countdown timer setKTimer2 Configures the specified timer...

  • Page 10: Document Conventions

    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.
  • Page 11 USER’S GUIDE OR to open a session with user privilege validation without MD5 password hash: <openID>mirandagateway://USERNAME:CLEAR_PASSWORD @SYSTEM_NAME/ROOM_NAME</openID> Where: IP_ADDRESS is the IP address of your destination Kaleido frame. ROOM_NAME is the room context for the session (see getKCurrentLayout, setKCurrentLayout and getKLayoutList). USERNAME is the username that will be used to validate permissions.
  • Page 12 USER’S GUIDE  <nack/>: 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.
  • Page 13 USER’S GUIDE  <kCurrentLayout>name="CurrentLayout.kg2"</kCurrentLayout>  <nack/>: 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”.
  • Page 14 Gateway response:  The response is the specified room exactly as it is stored in the database but without the XML header. Example: <room UUID="4afa6407-a753-11dc-9fb9-e3bbad2712e5" beanType="monako.data.rooms" createdTime="1197313709663" currentLayoutUrl="miranda.data.access:MultiHeadLayoutBean/d8b14b99- 8321-11dd-8648-49f166ea7203" friendlyName="Room1" lastModifiedTime="1228233770264" path="/" readOnly="false" version="824" xmlVersion="273114"> <defaultRoomPreferences> <preferences> <preference editable="true" editablePerUser="true" type="audioOut"...
  • Page 15 USER’S GUIDE <preference editable="true" editablePerUser="true" type="Preset" uid="MultiHeadLayoutBean.9" value="miranda.data.access:MultiHeadLayoutBean/5a475f81-df1b-11dc- a920-9d4ecc32cf8e"/> </preferences> </defaultRoomPreferences> <heads> <head allowDashboard="true" frameName="Cougar-X" friendlyName="Default Display" headID="23" headNumber="1" id="Cougar-X.23" logicalID="2" resolutionSettingsUuid="8af91a81- 0af1-11dd-a25a-f534b3d6b0d3" rotated="false" rotation="normal" slotNumber="11"> <dimension x="1398" y="874"/> <position x="4408" y="32"/> <resolution height="1200" width="1920"/> <rotDimension x="1398" y="874"/> <rotResolution height="1200" width="1920"/>...
  • Page 16 USER’S GUIDE getKRoomList This command is used to obtain the list of rooms known to your multi-viewer system. <getKRoomList/> Gateway response:  <kRoomList><room>Room A</room><room>Room B</room></kRoomList>  <nack/>: The Gateway was not able to recognize the command. setKStatusMessage KX K2 AQ This command associates an Alarm state with an ID.
  • Page 17  <nack/>: The Gateway was not able to recognize the command. Examples: <setKUnlatch>set channelName="/Input A/Channel 01"</setKUnlatch> <setKUnlatch>set uri="miranda.monako.daq://local/data/master/3/card/av1/DTVCCData#dt vccService1Presence"</setKUnlatch> <setKUnlatch>set id="my_gateway_alarm_1"</setKUnlatch> getKChannel Note: This command is currently supported on the Kaleido-IP multi-viewer models only. This command is used to obtain the logical source (channel) currently assigned to the specified monitor in the current layout.
  • Page 18 USER’S GUIDE Where ChannelName is the full path to the source (channel) currently assigned to the specified monitor. Ex.: /Input A/Channel 1.  <nack/>: The Gateway was not able to recognize the command, or a parameter could not be resolved. setKChannel KX K2 AQ This command is used to assign a logical source (channel) to the specified monitor in the current...
  • Page 19 USER’S GUIDE  <ack/>: The command was recognized by the Gateway.  <nack/>: The Gateway was not able to recognize the command. getKDynamicText This command is used to retrieve dynamic text previously sent to a multi-viewer by a third-party device. <getKDynamicText>set address=Address</getKDynamicText>...

  • Page 20: Configures The Specified Countdown Timer

    USER’S GUIDE The data legends will be mapped to valid XML attribute names, all of which are listed here: inputFormat scansys AFD3Bits AFDANC programConfig dialogLevel networkName stationID channelNumber TSID programName programType vChipRating programDescription programLength elapsedTime programID timeOfDay timeZone The value field is escaped as defined in the XML protocol for an attribute value. For instance, ABC"DEF\GHI<JKL>MNO/PQR&STU;VWX'YZ becomes ABC&quot;DEF\GHI&lt;JKL&gt;MNO/PQR&amp;STU;VWX&apos;YZ The attributes order is not guaranteed and may change for two consecutives calls to the...
  • Page 21 USER’S GUIDE Loop indicates if the counter must count continuously. This value can be either Gateway response:  <ack/>: The command was recognized by the Gateway.  <nack/>: The Gateway was not able to recognize the command. setKTimer2 KX K2 This command is used to configure a timer in a Kaleido-K2 or Kaleido-X series multi-viewer system.

  • Page 22: Fires The Specified Action

    USER’S GUIDE setKTimerTrigger KX K2 AQ This command is used to control the specified countdown timer component. The countdown timer can be started, stopped or reset. <setKTimerTrigger>set id="TimerID" trigger="Trigger"</setKTimerTrigger> Where: TimerID is the ID of the countdown timer component to control. Trigger is the action that the countdown timer must do.
  • Page 23 USER’S GUIDE 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.
  • Page 24 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 and Kaleido-IP models. Returned value can be any of: ...

  • Page 25: Selects The Audio To Be Monitored

    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 and Kaleido-IP models.  Streaming sources are not supported on the Kaleido-Alto/Quad/Quad-Dual.
  • Page 26 KX K2 AQ Note: This command is currently not supported on the KMV-3901/3911 and Kaleido-IP models. This command retrieves the audio monitoring volume currently used. <getKAudioOutVolume/> The returned value will have the form: ...
  • Page 27 <nack/>: The command was not executed, due to a spelling error or invalid parameter. The volume remains unchanged. getKAudioOutMode KX K2 AQ Note: This command is currently not supported on the KMV-3901/3911 and Kaleido-IP models. This command retrieves the audio monitoring mode currently used. <getKAudioOutMode/> Returned value will have the form: ...
  • Page 28 USER’S GUIDE setKVerticalOffset This command is used to position the CPU’s graphic output vertically within the final DVI output on the display. The Kaleido-Alto/Quad’s CPU includes up to 1024 lines, whereas the final output includes up to 1200 lines. <setKVerticalOffset>set offset="NN"</setKVerticalOffset> Where NN is the number of lines (between 0 and 175) by which to offset the CPU’s graphic output, from the top of the final DVI output.
  • Page 29 USER’S GUIDE  <ack/>: The command was recognized by the Gateway.  <nack/>: The Gateway was not able to recognize the command. setKMouseColorB This command is used to set a color to key. <setKMouseColorB>set mouseColorB="FFBBGGRR"</setKMouseColorB> Where FFBBGGRR is the hexadecimal triplet for mouseColorB prefixed with the hexadecimal value “FF”.
  • Page 30 USER’S GUIDE NOTE: All gateway commands must be followed by a carriage return. In scripts, add \n at the end of each gateway command. 26 | Kaleido Remote Control Protocol (Gateway)

  • Page 31: Typical Session

    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).  If your environment includes a Miranda iControl Application Server, see the Application Server’s manual for a discussion of appropriate network configurations. Open the HyperTerminal software on another computer: 1.
  • Page 32 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.
  • Page 33 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.
  • Page 34 USER’S GUIDE To end the communication session, click the Disconnect button on the toolbar. 30 | Kaleido Remote Control Protocol (Gateway)

  • Page 35: 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 Kaleido-IP openID 1.00 4.10 5.00 6.00 closeID 1.00...
  • Page 36 USER’S GUIDE Command Kaleido-X Kaleido-X16 KMV-3901/3911 Kaleido-IP setKSaveLayout N.A. N.A. N.A. N.A. — — 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...
  • Page 37 Miranda Technical Support For technical assistance, please contact the Miranda Technical Support center nearest you: Americas Asia 9:00 a.m. – 9:00 p.m. (EST) 9:00 a.m. – 5:00 p.m. (GMT+8) Office hours: Office hours: Telephone: 1-800-224-7882 Telephone: +852 2539 6987 Fax:...

This manual is also suitable for:

Kaleido-ipKaleido-xKmv-3911Kaleido-x16Kaleido quadKaleido alto ... Show all

Table of Contents