Register / log-in to add to your Hammerwall Collection.
Manual Location

The Search Results for the Search Section to the left will appear here.

Upload a pic of this item

Page: 1

Protocol Description CompactLink Protocol  2005 3D perception AS All rights reserved . The copyright of this document is the property of 3D perception AS . The document is supplied on the express terms that it is to be treated as confidential . No part of this document may be reproduced or transmitted in any form or by any means , electronic or mechanical for any purpose , without the express written permission of 3D perception AS . The information in this document is subject to change without notice and is provided ‘ AS IS ’ .
Page: 2

3D perception Protocol description Revision 5 CompactLink Protocol DOCUMENT STATUS Revision Month Year Paragraph ( s ) Prepared by Description of Change August 2000 All Knut Krogstad Preliminary 1 January 2001 All Knut Krogstad Added more commands 2 January 2001 Knut Krogstad Serial protocol , more commands 3 February 2003 5.3.1 Rolf Erik Leistad Error : Mode - Bytes 4 June 2003 All JJ Added Signal Source command . Added , “ � as a legal delimiter in the projector list where applicable . Added Lamp hours to the Projector Alive status message . Added description of registry parameter for setting message interval . 5 October 2005 All JJ Added Input Source Status message . Added “ Disable Adjustment � and “ Output Control � commands . Updated description of registry parameters to reflect current application version . Updated description of “ Projector Alive � message . ii
Page: 3

3D perception Protocol description Revision 5 CompactLink Protocol TABLE OF CONTENTS 1 . INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.1 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 How to use this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 System architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 PROTOCOL BASICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 . UDP 2.1 UDP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2.2 Transmission strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2.3 Message encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2.4 Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.4.1 Addressing by IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.4.2 Addressing by Port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3 . SERIAL LINE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4 . TEST PATTERN PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.2 IP Address and port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.3 Message datagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.4 Defined test patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.5 Implementation notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 ONTROL PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5 . C 5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.2 IP Address and port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.3 Message datagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.3.1 Power On message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.3.2 Light Level message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 5.3.3 Load Configuration Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 5.3.4 Auto Setup Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 5.3.5 Update Projectors Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 5.3.6 Signal Source Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 5.3.7 Disable Adjustment Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 5.3.8 Output Control Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 iii
Page: 4

3D perception Protocol description Revision 5 CompactLink Protocol 6 . STATUS PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.2 IP Address and port number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.3 Message datagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.3.1 Projector Alive Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.3.2 System Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 6.3.3 Input Source Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 iv
Page: 5

3D perception Protocol description Revision 5 CompactLink Protocol 1 . INTRODUCTION 1.1 Scope This document describes a set of open interfaces between CompactDesigner and CompactControl software packages and an OEM application . The document is intended for system and software engineers integrating CompactView projection systems with image sources . 1.2 How to use this document The main sections of this document are : Protocol basics ( chapter 2 ) and the protocol definitions ( chapters 3 , 4 , and 5 ) . Each of the protocol definition chapters has an introductory section that describes what can be achieved using the protocol , as well as detailed descriptions of the protocol formats . 1.3 System architecture A system using CompactView projectors and the CompactLink protocol can take many different forms . The following diagram shows a typical architecture : For the CompactLink protocol to operate , either CompactControl or CompactDesigner must be running on a computer in the system . This may be connected directly to the projectors using a serial line , or the projectors may be connected to a different LAN node in the system . 1
Page: 6

3D perception Protocol description Revision 5 CompactLink Protocol 2 . UDP PROTOCOL BASICS 2.1 UDP Protocol The CompactLink protocols are based on IP networks , using UDP datagram protocols . Any physical medium capable of routing UDP / IP messages can be used . The CompactLink protocols are based on UDP datagram protocols . Details on UDP can be found in most basic textbook on Local Area Networks . 2.2 Transmission strategy The UDP protocol can be used for either one - to - one , or one - to - many ( broadcast ) communication . There is , however , no guarantee that a UDP message reaches its destination . To keep the implementation as simple as possible , the protocol is based on periodically transmitting all messages , so that a lost message will only lead to a short delay in executing a command , for example . This implies that the common state of all modules communicating using CompactLink is always transmitted over the network , and a new device that is connected to an existing network will receive the state by listening to the traffic on the network for some time . The other implication of this strategy is that no single - event commands can be transmitted over the network ; all messages convey state information only ( for example , the value of a variable ) . On the receiver side , all receivers must be able to handle repeated messages with unchanged state with low overhead . No assumptions can be made regarding message order , or the previous / next state of a state variable . All CompactLink messages are short , and with the recommended transmission interval of 1 second , the network traffic generated is negligible . 2.3 Message encoding To avoid potential compatibility problems , big endian vs . little - endian etc . , all messages are ASCII coded . Allowed characters are in the range 20h - 7fh , and 00h . No control characters , line feeds , carriage returns etc . may be used . All message records and fields are fixed size , so there is no need for message delimiters . Unused character positions are padded with 00h . Note that the underlying system may pack multiple messages into one physical network message . When reading messages , multiple messages may be received back - to - back . 2
Page: 7

3D perception Protocol description Revision 5 CompactLink Protocol 2.4 Addressing UDP messages are addressed by IP address and Port number . Although 3D perception recommends a range of ports to be used for CompactLink protocol , the user is free to use any port number . IP addresses are normally dictated by the network configuration . Addressing can be done using one of two schemes : 2.4.1 Addressing by IP address If the system is configured using fixed IP addresses , the most efficient way to set up the system is by assigning a fixed IP address to each receiver , and specifying that address to each sender in the system . All senders and receivers will then use the same fixed port number for the same protocol . If more than one protocol is in use in the network , it is recommended that each protocol use a separate port . It is also recommended to use different ports if multiple systems ( e.g . multiple simulator cubicles ) share the same network , to guarantee that no “ cross talk � occurs between different systems . 2.4.2 Addressing by Port number Many networks use DHCP addressing , where each node on the network is assigned an IP address at start - up . In such a network configuration , it is impossible to know in advance the IP addresses of each computer , and therefore , fixed IP addresses cannot be set . Instead , all senders can be configured for broadcast , using different ports for each receiver . 3
Page: 8

3D perception Protocol description Revision 5 CompactLink Protocol 3 . SERIAL LINE PROTOCOL The CompactLink protocol can be used over an RS232 serial line , using a slightly different command form . UDP messages have fixed size fields , whereas the serial line version of the protocol uses comma - separated fields , and a CR - LF pair for termination . For example , in the UDP datagram form , the “ * ON � co mmand uses 4 characters for command and up to 16 characters for specifying on / off state : O ‘ ’ N ‘ ’ 00 1 ‘ ’ 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 * ‘ ’ In the serial form of the protocol this command would be formatted as the following ASCII string : * ON , 1 < cr > < lf > 4
Page: 9

3D perception Protocol description Revision 5 CompactLink Protocol 4 . TEST PATTERN PROTOCOL 4.1 Introduction This protocol is used by CompactDesigner and CompactControl to define test patterns that are to be generated by the image source . Protocol data is transmitted from CompactDesigner CompactControl to a test pattern generator . The test pattern generator is a software module that runs on the image generator hardware . Although the projector has a capability to generate test patterns , calibration of colour and black level cannot be done without considering the analogue signal path , including the D / A converters of an image generator , signal cables , any buffer amplifiers , etc . It is therefore important that the test pattern is generated through the same path as the final images . The test pattern protocol messages are generated by CompactDesigner and / or CompactControl , and sent to the image generator ( s ) . Messages are decoded by an application running on the image generator . The test pattern protocol can only be used with UDP . There is no RS232 version of the test pattern protocol . 4.2 IP Address and port number The test pattern protocol addressing is defined in CompactControl for each projector , to allow each projector to address a different image source . Under the C ‘ ommunication ’ tab , the I ‘ mage source communication address ’ field specifies an IP address . If no address is specified , messages will be broadcast at the default port Default IP address : 255.255.255.255 ( broadcast ) Default port : 56340 Examples of specifying different IP addresses : Use specified IP address , at default port . 192.13.14.21 Use specified IP address at port 12345 192.13.14.21 : 12345 Broadcast at port 12345 255.255.255.255 : 12345 5
Page: 10

3D perception Protocol description Revision 5 CompactLink Protocol 4.3 Message datagrams The following datagrams can be sent over the protocol : Field Bytes Description Command 4 Character string “ * TP � ( hex 2A , 54 , 50 , 0 0 ) Pattern 32 Name of test pattern , padded with zeros Transparent 2 ASCII “ T � ( transparent ) or “ O � ( opaqu e ) followed by zero If the message is transmitted with the Pattern field left blank , no test pattern will be displayed ( normal of operation of the image generator ) . In this case , the transparent field can be ignored . For test patterns that have transparency defined , the value of the Transparent field defines whether the test pattern shall be displayed with transparency enabled , or the transparent regions set to black . 4.4 Defined test patterns The following test pattern names are defined : Name Description Transparent BLACKLEVEL Black with low - level grey scale NO COARSEGRID Coarse grid YES EDGE Outer edges , including circles in corner and centre YES FINEGRID Fine grid YES GAMMA Gamma test pattern YES GRAYH Horizontal stripes of grey NO GRAYV Vertical stripes of grey NO PINSTRIPE Vertical pinstripe pattern NO RGBSCALE RGB Colour bars YES WHITE10 10 % white NO WHITE50 50 % white NO WHITE90 90 % white NO WHITELEVEL White with high level grey scale NO 6
Page: 11

3D perception Protocol description Revision 5 CompactLink Protocol 4.5 Implementation notes The reference implementation includes bitmaps defined using alpha transparency . If an implementation does not support alpha transparency , the test patterns should be regenerated with on / off transparency . The test pattern bitmaps are defined in 1024x768 format . An implementation may choose to stretch the test patterns to the actual screen resolution , or the bitmaps may be regenerated manually 7
Page: 12

3D perception Protocol description Revision 5 CompactLink Protocol 5 . CONTROL PROTOCOL 5.1 Introduction This protocol is used by CompactControl , to enable applications to control the devices directly . Device control messages are sent from a system host computer to CompactControl . Source code for an example implementation of a control application can be obtained from 3D perception . 5.2 IP Address and port number The Control protocol addressing is defined in the registry settings for CompactControl , under the following keys : HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ LocalPort HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ LocalIP < Version number > indicates the current SW version , i.e . “ 4.10 . � This defines the port ( IP ) where CompactControl will listen for Control messages . In a system with multiple CompactControl machines to be controlled separately , the port number should be specified differently for each machine , or alternatively , each CompactControl machine can be addressed based on IP address using the same port number . Default port : 56341 5.3 Message datagrams The following datagrams can be sent over the protocol : 5.3.1 Power On message The Power On message switches the projectors between on and off ( standby ) . Field Bytes Description Command 4 Character string “ * ON � ( hex 2A , 4F , 4E , 0 0 ) Mode 2 ASCII “ 1 � ( on ) or “ 0 � ( off ) Projectors 1024 List of projector names , separated by ; or , ( empty = all ) The Projectors field is optional , and can be left blank or omitted to specify all projectors . 8
Page: 13

3D perception Protocol description Revision 5 CompactLink Protocol 5.3.2 Light Level message The light level message selects a setting based on light level . When CompactControl receives this , the projectors will select ( contrast , brightness , colour ) settings based on the defined light level : Field Bytes Description Command 4 Character string “ * LL � ( hex 2A , 4C , 4C , 0 0 ) Light level 16 ASCII Light level ( 0.0 - 100.0 ) The light level is encoded as a numeric value , where 0.0 means total darkness , and 100.0 is maximum daylight . The number of decimals to use is up to the application . For this to have an effect , the projection theatre must have been calibrated with settings for different light levels . If CompactControl receives any values other than those defined , the actual settings will be interpolated between the defined settings . 5.3.3 Load Configuration Message The load configuration message loads a complete configuration file ( CompactControl document ) from disk . This is equivalent to manually opening a file from the CompactDesigner / CompactControl menu . All parameters related to projectors defined in the file will be subsequently transferred to the projectors . Field Bytes Description Command 4 Character string “ * LC � ( hex 2A , 4C , 43 , 0 0 ) FileName 256 File name with relative or absolute path Note that the file name is encoded as seen from the machine running CompactControl ; any relative paths , or files without a path specification , will be relative to the working directory of CompactControl receiving the message . Absolute paths and drive letters will be as seen from the machine running CompactControl . To avoid confusion , file names can be specified using Universal Naming Code ( UNC ) format , i.e . in the form \ ‘ \ ServerName \ directory \ file.ext . ’ If no extension is specified , . ‘ cvd ’ is assumed by default . 5.3.4 Auto Setup Message The Auto Setup message sends an “ Auto Setup � comman d to the projectors ( devices ) . The projectors ( devices ) will try to re - sync to the input signal . 9
Page: 14

3D perception Protocol description Revision 5 CompactLink Protocol Field Bytes Description Command 4 Character string “ * AS � ( hex 2A , 41 , 53 , 0 0 ) Projectors 1024 List of projector ( device ) names , separated by ; or , ( empty = all ) 5.3.5 Update Device Message The Update Projectors message sends an “ Update Devi ce � command to the application . This will cause the CompactControl application to send all its state data of the current document to the projectors ( devices ) . Use this command after a Load Configuration command , to ensure that the projectors ( devices ) are updated when the new file is activated . The Projectors field is optional , and can be left blank or omitted to specify all projectors ( devices ) . Field Bytes Description Command 4 Character string “ * UP � ( hex 2A , 55 , 50 , 0 0 ) Projectors 1024 List of projector ( device ) names , separated by ; or , ( empty = all ) 5.3.6 Signal Source Message The Signal Source message sends a “ Signal Source � c ommand to the application . This will cause the CompactControl application to force the specified projectors ( devices ) to select the specified signal source . The Projectors field is optional , and can be left blank or omitted to specify all projectors ( devices ) . Field Bytes Description Command 4 Character string “ * SO � ( hex 2A , 53 , 4E , 0 0 ) Source 2 ASCII “ 1 � or “ 2 � or “ 3 , � etc . Projectors 1024 List of projector ( device ) names , separated by ; or , ( empty = all ) 10
Page: 15

3D perception Protocol description Revision 5 CompactLink Protocol 5.3.7 Disable Adjustment Message This message sends a “ Disable Adjustment � command t o the application . This will cause the CompactControl application to force the specified projectors ( devices ) to toggle the enabled / disabled state of the specified adjustment . The Projectors field is optional , and can be left blank or omitted to specify all projectors ( devices ) . Field Bytes Description Command 4 Character string “ * SO � ( hex 2A , 53 , 4E , 0 0 ) Adjustment 32 ASCII name of adjustment , the following are valid names : " EDGE " , " GAMMA " , " GEOMETRY " , " HOTSPOT " , " COLOR " , " BLANKING " , " DITHER " , " YUVMODE " , " SCALING " , " STEREO " , " MASK " State 2 Not used Projectors 1024 List of projector ( device ) names , separated by ; or , ( empty = all ) 5.3.8 Output Control Message This message sends an “ Output Control � command to t he application . This will cause the CompactControl application to force the specified devices to enable / disable the various output signals . The Projectors field is optional , and can be left blank or omitted to specify all projectors ( devices ) . Field Bytes Description Command 4 Character string “ * SO � ( hex 2A , 53 , 4E , 0 0 ) Sync enabled 2 ASCII “ 0 � or “ 1 � followed by “ \ 0 , � 0 = disabled , 1 = enabled Data enabled 2 ASCII “ 0 � or “ 1 � followed by “ \ 0 � , 0 = disabled , 1 = enabled DDC5V 2 ASCII “ 0 � or “ 1 � followed by “ \ 0 � , 0 = disabled , enabled 1 = enabled Projectors 1024 List of projector ( device ) names , separated by ; or , ( empty = all ) 11
Page: 16

3D perception Protocol description Revision 5 CompactLink Protocol 6 . STATUS PROTOCOL 6.1 Introduction This protocol is used by both CompactDesigner and CompactControl to enable an external system to monitor the status of various items such as the system itself , projectors and input sources . States such as lamp failure , loss of communication , loss of signal etc . can be detected . Messages are transmitted from one of these programs to a system host or management program . Status messages are sent either via serial line or via UDP , depending on system configuration . The messages are sent periodically , typically once each second . However , the period can be changed by setting any of the following registry parameter : SYSTEM STATUS : HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ Status Update Period ( ms ) PROJECTOR STATUS : HKEY_LOCAL_MACHINE \ . SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ Projector Status Update Period ( ms ) INPUT SOURCE STATUS : HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ Source Info Update Period ( ms ) < Version number > indicates the current SW version , i.e . “ 4.10 . � 6.2 IP Address and port number The Status protocol addressing is defined in the registry settings for CompactControl , under the following keys : HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ RemotePort HKEY_LOCAL_MACHINE \ SOFTWARE \ 3D perception \ CompactDesigner \ < Version number > \ LinkManager \ RemoteIP < Version number > indicates the current SW version , i.e . “ 4.10 . � This defines the IP / port where CompactControl will send Status messages . In a system with multiple CompactControl machines to be controlled separately , the port number should be specified differently for each machine , or alternatively , the receiver of projector status messages must look at the senders ’ IP address to de termine the source of the message . 12
Page: 17

3D perception Protocol description Revision 5 CompactLink Protocol Default port : 56342 Default IP address : 255.255.255.255 ( broadcast ) 6.3 Message datagrams The following datagrams can be sent over the protocol : 6.3.1 Projector Alive Message The Projector Alive message signals power on status and lamp hours cyclically . | Field Bytes Description Command 4 Character string “ * PA � ( hex 2A , 50 , 41 , 0 0 ) Projector 32 Address ( serial number ) of projector Name 128 Defined name of projector Status 128 Contains one of two , either info / warning / error message or power / lamp state . The Status field is further described below . The Status field of the Projector Alive message has two purposes , one is to provide info / warning / error information when there is something to report , and the other is to provide power / lamp state if there isnt ’ any info / warning / er ror message present . 1 - Info / warning / error message contents : When there is an info / warning / error message the Status field will have the following format : < Message type > : < actual message > Where < Message type > can be one of the following : • INFO • WARNING • ERROR Below is shown some examples : “ INFO : No address has been set for this projector . � “ ERROR : Projector has stopped responding . Check co nnection . � 2 - State information contents : When the Status field contains state information the field will have the following format : “ Projector < power state > , Lamp < lamp state > , Lamp h ours : 123 � Where < power state > can have one of the following values : 13
Page: 18

3D perception Protocol description Revision 5 CompactLink Protocol • OFF • ON • UNKNOWN STATE If < power state > is equal to ON , the < lamp state > can have one of the following values : • OFF • WARMUP • LIT • COOLING Below is shown examples of the Status field when the projector is off / on : “ Projector OFF , Lamp hours : 123 � “ Projector ON , Lamp LIT , Lamp hours : 123 � The message is sent cyclically , typically every 1 second . 6.3.2 System Status Message The System Status message signals status of the projection system cyclically . Field Bytes Description Command 4 Character string “ * SS � ( hex 2A , 53 , 53 , 0 0 ) Configuration 32 Active configuration Status 128 Text : “ OK � , “ NO COMMUNICATION � , “ ERROR : xxx � The message is sent cyclically , typically every 1 second . Configuration is the name of the CompactDesigner document currently loaded ( document name excluding path name ) . 14
Page: 19

3D perception Protocol description Revision 5 CompactLink Protocol 6.3.3 Input Source Status Message This message signals status information for input sources cyclically . Field Bytes Description Command 4 Character string “ * IS � ( hex 2A , 50 , 41 , 0 0 ) Address 32 Address ( serial number ) of the resource ( projector , UTM , MCM ) Owner name 128 Defined name of resource that owns the input source ( projector , UTM , MCM ) Source name 128 Defined name of the input source Active 2 Flag indicating whether the source is active or not , ASCII “ 0 � or “ 1 � followed by “ \ 0 � Type 2 Input type , ASCII “ 0 , � 1 “ � , “ 2 � or “ 3 � follo wed by “ \ 0 � 0 = NO INPUT , 1 = DVI , 2 = RGB , 3 = MCM Configuration 4 Identification of the current configuration , ASCII formatted integer followed by “ \ 0 � 0 = UNDEFINED , 16 = SYSTEM , 32 = CHANNEL1 , 64 = CHANNEL2 , 128 = CHANNELB Source 4 Identification of the current source , ASCII formatted integer followed by “ \ 0 � 0 = No source , 1 = DVI , 2 = RGB1 , 3 = RGB2 , 4 = SVIDEO1 , 5 = VIDEO1 , 6 = COMPOSITE VIDEO , 7 = DVI_RGB1 , 8 = MCM , 9 = ADDON_RGB1 , 10 = ADDON_RGB2 , 11 = DVI_RGB2 Horizontal 8 Horizontal resolution ( pixels ) , ASCII formatted integer i.e . resolution “ 1280 � followed by “ \ 0 � Vertical 8 Vertical resolution ( lines ) , ASCII formatted integer i.e . “ 1024 � resolution followed by “ \ 0 � Horizontal 8 Horizontal frequency ( kHz ) , ASCII formatted floating point frequency i.e . “ 1234.5 � followed by “ \ 0 � Vertical 8 Vertical frequency ( Hz ) , ASCII formatted floating point i.e . frequency “ 12345.6 � followed by “ \ 0 � Sync type 2 Sync type , ASCII “ 0 � , “ 1 , � “ 2 � or “ 3 � f ollowed by “ \ 0 � 0 = SEPARATE , 1 = COMPOSITE , 2 = SYNC ON GREEN , 3 = AUTO Sync polarity 2 Input type , ASCII formatted bit field followed by “ \ 0 � Bit0 is 1 if VSYNC has positive polarity 15
Page: 20

3D perception Protocol description Revision 5 CompactLink Protocol Bit1 is 1 if HSYNC has positive polarity The message is sent cyclically , typically every 1 second . 16