Christie Christi Eprojector Mirage S+22k J Technical Manual

							J Series Serial Commands Technical Reference Information1 of 90020-100796-01 Rev. 1 (10-2011)
 
J Series Serial Commands
Technical Reference Information
INTRODUCTION
This document describes the serial protocol, consisting of ASCII text messages, used to control an J Series 
projector remotely. 
CONNECTION AND USE:
Once you have connected your computer to either the RS232 IN or RS422 IN port (depending on which 
standard is supported by your computer) or to the ETHERNET port on a projector, you can remotely access 
projector controls and image setups, issue commands or queries, and receive replies. Use these bi-directional 
messages to: 
• Control multiple projectors 
• Obtain a projector’s status report 
• Diagnose performance problems 
NOTES:
 1) Refer to the User Manual provided with the projector for all cable requirements and other 
connection details.
 2) Some commands are operational only when projector is powered up.
UNDERSTANDING MESSAGE FORMAT
Messages can be one of three types:
•Set - A command to set a projector parameter at a specific level, such as changing to a certain channel. 
•Request - A request for information, such as what channel is currently in use.
•Reply - The projector returns the data in response to a request or as confirmation of a command.
All “remote control” information passes in and out of the projector as a simple text message consisting of a 
three letter command code, an optional four letter subcode and any related data. When a parameter for a 
specific source is being accessed, the four letter subcode will be added on to the command code. A number of 
optional features (message acknowledges, checksums, and network addressing) can be included. 
Generally, most commands include 0 or 1 data fields or parameters. Where applicable, a message may expand 
to include additional parameters of related details. 
						

							2 of 90J Series Serial Commands Technical Reference Information020-100796-01 Rev. 1 (10-2011)
The smallest step size for any parameter is always 1. For some controls (i.e. Size) the value displayed on the 
screen has a decimal point. (e.g. 0.200 to 4.000) In this case, the values used for the serial communications is 
an integer value (e.g. 200 to 4000), not the decimal value seen on the screen.
Regardless of message type or origin, all messages use the same basic format and code. Opening and closing 
round brackets (parentheses) surround each message, see Table 1 - Message Formats. 
Table 1 - Message Formats
BASIC MESSAGE STRUCTURE
The following component fields comprise a standard ASCII message. Optional fields, such as extra characters 
for special modes, restrictions or added functionality, are shown in italics, with the exception of Notes. 
•START AND END OF MESSAGE: Every message begins with the left “(“character and ends with the 
right “)“character. NOTE: If the start character is received before an end character of the previous message, 
the partial (previous) message is discarded. 
•PREFIX CHARACTERS (OPTIONAL): For acknowledgement that the projector has responded, and/or 
to maximize message integrity, insert one or two special characters before the 3-character function code: 
$ - Simple Acknowledgment, which will cause a ‘$’ character to be sent back from the projector when it 
has finished processing the message, see 
 Maximizing Message Integrity. 
# - Full Acknowledgment, which will cause an echo of the message as a reply to be sent back from the 
projector when it has finished processing the message, see 
 Maximizing Message Integrity.
& - Checksum, which will allow a checksum to be put as the last parameter in the message for verification 
at the projector, see 
 Maximizing Message Integrity. 
•PROJECTOR NUMBERS (OPTIONAL): To control a selected projector or controller within a group, 
include its assigned number or address just before the three-character ASCII function code, see
 Network 
Operation.
•FUNCTION CODE: The projector function you wish to work with, such as channel selection or gamma, is 
represented by a three-character ASCII code (A-Z, upper or lower case). This function code appears immedi-
ately after the leading “(“that starts the message. In messages sent to the projector that do not have a subcode, 
a space between the function code and the first parameter (or special character) is optional. 
SOURCE MESSAGE FORMAT FUNCTION EXAMPLES
From Controller(Code Data) SET (set contrast of main image to 
500)(CON500) or (CON 500)
(Code+Subcode Data) SET (set contrast of PIP image to 
500)(CON+PIIP500) or (CON +PIIP 500)
From Controller(Code ?) REQUEST (what is current con-
trast?)(CON?) or (CON ?)
(Code+Subcode ?) REQUEST (what is contrast of PIP 
image?)(CON+PIIP?) or (CON+PIIP ?)
From Projector(Code Data) REPLY (contrast is 500) (CON!500)
(Code+Subcode Data) REPLY (PIP contrast is 500) (CON+PIIP!500) 
						

							J Series Serial Commands Technical Reference Information3 of 90020-100796-01 Rev. 1 (10-2011)
•+SUBCODE: The projector function you wish to work with may have one or more subcodes that will allow 
you to select a specific source, image, channel or subfunction. The subcode is represented by a four-character 
ASCII code (A-Z, upper or lower case, and 0-9). This subcode appears immediately after the function code, 
with a “+” character to separate the code and subcode. If there is no subcode, the “+” is also omitted. In mes-
sages sent to the projector that do have a subcode, a space between the subcode and the first parameter (or 
special character) is optional. 
•REQUEST/REPLY SYMBOLS: If the controller is requesting information from the projector, a “?” ques-
tion mark appears directly after the function code. If the projector is replying, a “!” exclamation mark 
appears directly after the function code. For set messages to the projector, neither of these characters appear 
— data directly follows the code and subcode.
•OTHER SPECIAL FUNCTIONS (OPTIONAL): To add functionality to the current message, include one 
or more of the following special characters between the function code/subcode and the first parameter. If 
more than one, add them in any order, see 
 Flow Control .
C    Control Class Inquiry
D    Default value/Text
E     Enable Control Inquiry. 
G    Access Group Inquiry. 
H    Return the Help text for a control. 
L     Return a list of options for ‘list’ controls. 
M    Find min/max adjustments (i.e., range). 
N     Return the name of the control. 
T     Return the type of control (i.e. Slidebar etc.). 
•DATA: The value for a given projector state, such as “on” or “off”, appears in ASCII-decimal format 
directly after the request/reply symbol. You can add an optional space after the symbol—i.e., before the 
data—in a set message, but data in replies follow the “!” symbol without a space. Other details to remember 
about data: 
• All values returned by the projector (reply messages) have a fixed length, regardless of the actual value. 
For a specific parameter the length will always be the same (e.g. contrast is always returned as 3 charac-
ters, projector number is always returned as 5 characters). The minimum parameter size is 3 characters. 
Values that are less than the predefined size will be padded with leading zeros as needed. Parameters 
which have negative signs are zero padded after the negative sign, and will have one less digit to make 
space for the sign.
• If entering a negative number, there must be a space between the code/subcode and the value e.g. 
(CRM3) and (CRM 3) can both be used when the number is positive. (CRM -2) is acceptable, but (CRM-
2) is not.
• Data in set messages to the projector do not require padding with zeros. 
• Within each message, multiple parameters of data must be separated by one “space” character. 
• Text parameters such as channel names are enclosed in double quotes following the data, as in “Name”. 
•TEXT PARAMETERS: Most data is simply a numerical value, however some messages also require text. 
For example, a channel naming message typically includes a text-based name - enclose this text in double 
quotation marks, as in “Tilt the Wagon”. Use all characters as desired except for the following special char-
acters shown in the left column below—these require a 2-character combination, see 
Table 2 - Special Char-
acters for Text.  
						

							4 of 90J Series Serial Commands Technical Reference Information020-100796-01 Rev. 1 (10-2011)
Table 2 - Special Characters for Text
SAMPLE MESSAGES AND THEIR MEANING
Table 3 - Sample Messages and Their Meaning
If you want this... Enter this... Description
\ \\ Backslash
”\”Quote
( \( Left Bracket
) \) Right Bracket
0x0A 
 New line - if the text can be displayed on 
more than one line, this will set the line 
break.
\h## Sends one arbitrary code defined by the 2 
hexadecimal digits ##
For a Single Projector
Message Format Function Example
(Code Data) SET (set contrast of main image to 500) (CON500)
(Code+Subcode Data) SET (set contrast of PIP image to 500) (CON+PIIP500) 
(Code?) REQUEST (what is current contrast?) (CON?) 
(Code+Subcode?) REQUEST (what is contrast of PIP image?) (CON+PIIP?)
(Code!Data) REPLY (contrast is 64) (CON!64)
(Code+Subcode!Data) REPLY (PIP contrast is 64) (CON+PIIP!64)
($Code Data) SET AND ACKNOWLEDGE MESSAGE (mes-
sage processed?)($CON64)
(&Code+Subcode Data   Checksum) SET WITH CHECKSUM (&CON64 240)
For a Specific Projector within a Network with 1 Controller present
Message Format Function Example
(Dest Addr Code Data) SET (turn projector #5 on) (5pwr1)
($Dest Addr Code Data) SET AND ACKNOWLEDGE MESSAGE 
(message processed?ffr55)($5pwr1)
For a Specific Projector within a Network with Multiple Controllers present
Message Format Function Example
(Dest Addr   Src Code?) REQUEST (get contrast from projector #5 to 
controller #2)(5  2con?) 
						

							J Series Serial Commands Technical Reference Information5 of 90020-100796-01 Rev. 1 (10-2011)
WHAT IS ACTUALLY SENT IN A MESSAGE 
Although you will send and read messages as strings of ASCII characters, the actual message travels as a 
sequence of bytes. Each character in this sequence requires 1 byte. See example below, which illustrates a 
“lamp limit is 2000 hours” reply from the projector. 
MAXIMIZING MESSAGE INTEGRITY
For additional reassurance and/or maximum message integrity, you can insert one or two special characters:
ACKNOWLEDGMENTS: If you want assurance from the projector (or group of projectors) that a set 
message has been processed, request an acknowledgement. The acknowledgement is returned after the 
message has been received and fully executed by the projector (i.e. in the case of a source switch it is not sent 
until the switch is complete). If the message is not able to execute for some reason (i.e. invalid parameters, 
time-out, etc) a NAK is returned instead (not-acknowledge). Note that requesting an acknowledgement serves 
no purpose when included in a request message, since the acknowledgement will be redundant to the actual 
reply from the projector. However, if requested, the “$” acknowledgement from the projector will follow the 
reply.
There are two types of acknowledgements:
•SIMPLE ACKNOWLEDGEMENTS: Insert a “$” character just after the start code “(“. This will only 
return a ‘$’. This will only return a $ on success, or a ^ on failure (NAK).
•FULL ACKNOWLEDGEMENTS: Insert a “#” character just after the start code “(“. This will return 
the message sent, as a reply.
This is a quick way to confirm success with set messages, and is particularly useful with long-distance 
communication links or where the projectors and/or images are not visible from the controller. Acknowledge-
ments can also be a type of flow control. 
For a Specific Projector within a Network with Multiple Controllers present 
Message Format Function Example
($Dest Addr   Src Code Data) SET AND ACKNOWLEDGE MESSAGE (is 
message from controller #2 processed by pro-
jector #5)($5  2con?)
(Dest Addr   Src Code!Data) REPLY (from projector #5 to controller #2: 
contrast is 64)(002 005con!064)
ASCII = ( L P L !2000)
HEX = 0x28 0x4 0x50 0x28 0x21 0x32 0x30 0x30 0x30 0x29 
						

							6 of 90J Series Serial Commands Technical Reference Information020-100796-01 Rev. 1 (10-2011)
•CHECKSUMS: For maximum message integrity, add a checksum character “&” just after the start code “(“. 
You must then also include the correct checksum total (0-255) just before the “)” end code. Make sure to add 
a space before the calculated checksum to separate it from the last data parameter: 
The checksum is the low byte of the sum of the ASCII values of all characters between the “(“and the 
beginning of the checksum, but not including either. It does include the space in front of the checksum. 
Calculate the checksum for the above “set contrast to 64” command as follows: 
CHECKSUM EXAMPLE = & + c + o + n + 6 + 4 + ‘space’ 
= 26h+63h +6Fh +6E h +36h +$34h +$20h 
= 01F0h
= F0h when only the low byte is used 
= 240
The projector collects all of the message bytes as defined in the first byte of the message, then creates its own 
checksum value for comparison with the checksum included in the controller’s message. If the values match, 
the message is considered to have been correctly received—otherwise the message is discarded. 
NOTES: 1) ‘h’ indicates a hex number. 2) If a “request” message has a checksum so will the reply. 3) If using 
both “acknowledge” and “checksum”, either character can occur first. 
MESSAGE ERRORS
If a command cannot be performed (e.g. syntax error), you will receive a descriptive error indicating the 
problem. For example: (ITP)
(65535 00000 ERR00005 ITP: Too Few Parameters)
For more examples of a descriptive error, see 
Table 4 - Descriptive Error.
Table 4  - Descriptive Error
Error Code Error Description Error Code Error Description
3 Invalid Parameter 107 Exceeded List Size
4 Too Many Parameters 108 Exceeded Text Size
5 Too Few Parameters 109 Invalid Pointer
6 Channel not found 110 Communication Timeout
7 Command not executed 111 Communications Failure
8 Checksum error 112 Failed to set Hardware
9 Unknown request 113 Bad File
10 Error receiving serial data 114 Memory Failure
101 Control Not Found 115 Not Implemented
102 Subcontrol Not Found 116 Invalid Security Token
103 Wrong Control Type 117 Invalid Access Group
104 Invalid Value 118 System Busy - Try Again Later
105 Disabled Control ?? Unknown Error
106 Invalid Language 
						

							J Series Serial Commands Technical Reference Information7 of 90020-100796-01 Rev. 1 (10-2011)
ACCESSING SPECIFIC CHANNELS OR INPUTS 
For several commands (for example, ASR, Auto Channel Select) you can direct the message to particular 
channel, input or image. To do this, include a subcode after the function code. 
Example: 
(ASR 1)Enable Auto Channel Select for the channel being used by the Main image
(ASR+MAIN 1)Enable Auto Channel Select for the channel being used by the Main image
(ASR+PIIP 1)Enable Auto Channel Select for the channel being used by the PIP image
(ASR+SECD 1)Enable Auto Channel Select for the channel being used by the Secondary image
(ASR+C003 1)Enable Auto Channel Select for channel 3
(BBL+IN12 30)Set the bottom blanking value on slot 1 input 2 to value 30
It is only possible to set parameters from a specific channel or input if that parameter is stored separately for 
each channel or input. This function cannot be used for parameters that are specified for the projector as a 
whole such as projector address. The serial commands listed in the document specify which subcodes are 
applicable to each function.
The PIP and Secondary images both refer to the image on the secondary image path. Depending on your 
projector model type, either PIP or secondary commands will be applicable to this image. However, for serial 
commands, PIIP and SECD can be used interchangeably as shown within this document.
FLOW CONTROL 
Normally messages can be sent to the projector before processing of earlier messages is complete—the 
projector will just store messages in a buffer until ready to process. However, if a series of messages is sent it is 
possible that the projector may not be able to process them as fast as they arrive and the buffer will become 
full. If this happens, the projector will send the 13h (Xoff) code to instruct the controller (or any devices 
preparing to transmit) to cease transmission. At this point, the controller must respond immediately and send 
no more than 10 extra characters or they may be lost (i.e., the projector is able to accommodate the receipt of 
up to 10 more bytes after it sends 13h (Xoff)). When the buffer is once again available, the projector will send 
a 11h (Xon) command to resume transmission. 
NOTE: Xon and Xoff controls apply to both directions of communication. The projector will not send more 
than 3 characters after it has received a 13h (Xoff) code. 
NETWORK OPERATION
Up to 1000 projectors can be linked together in a chain with the ‘OUT’ port on one connected to the ‘IN’ port 
on the next. A controller connected to the ‘IN’ port on the first projector can control them all, either by 
broadcasting messages which have no address and are thus seen by all projectors, or by directing messages to 
specific projector addresses. 
To work with a specific projector in a group, the projectors must first be assigned a unique I.D.—either a 
projector number or an Ethernet IP address. Insert the number of the target projector between the starting ‘(’ 
and the 3-character ASCII code. 
						

							8 of 90J Series Serial Commands Technical Reference Information020-100796-01 Rev. 1 (10-2011)
Table 5 - Message for Specific Projector
Each projector compares the message address with its own address and, if matching, responds and processes 
the message. If the address does not match, the message is passed on until it reaches the intended projector. 
Although messages without an address are always broadcast, you can also broadcast by including the reply 
destination address 65535. This ensures that replies go to a specific controller address rather than being 
broadcast. The projector will also include its address. 
Table 6 - Message for Projector from a Specific Controller
If you have more than one controller on a network, ensure to include both a source address and a destination 
address. With a single controller on the network, its address is never required. Place the source address 
between the destination address and 3-character code, including a space before and after as shown. NOTE: 
Replies from a projector do not contain an address unless the request message includes both a destination 
address and a source address—i.e., a reply to a request having only a destination address will not have any 
source address. 
Table 7 - Message for Specific Projector from a Specific Controller
  ( Addr Code Data )
         ( Dest    Src Code Data )
         ( Dest Src Code Data )
Examples
Command Message from Controller Reply from Projector
Turn Projector #5 on. (5pwr1) {none}
What is the contrast level in Projector 30? (30con?) (CON!127)
Return Contrast from Projector #30 to Controller #2. (30 2con?) (00002 00030con!127) 
						

							J Series Serial Commands Technical Reference Information9 of 90020-100796-01 Rev. 1 (10-2011)
DESCRIPTION OF CONTROL TYPES
SUBCLASSES
•Power Down Controls - These controls are accessible when the projector is in Standby power mode (i.e. 
power off) as well as when powered on.
•Power Up Controls - These controls are only accessible when the system electronics are fully powered (not 
necessarily lamp on).
CONTROL GROUPS
•Unsaved Controls - These controls are not saved to flash. The settings are not maintained between power 
sessions.
•Saved Controls - These controls are saved to flash. The settings are persistent between power sessions.
•Preference Controls - These controls are transferable from one projector to another. Example: NET+SUB0 
(projector subnet).
•Configuration Controls - These controls are projector specific settings. They are non-transferable between 
projectors. Example: NET+ETH0 (projector IP address).
•Channel Controls - These settings are specific to a particular input signal. Example: BRT (signal bright-
ness).
•Option Card Controls - These settings are specific to a particular option card type / slot combination.
ACCESS LEVELS
•Operator - Command is available at the operator level log in.
•Advanced - Command is available at the advanced operator level log in.
•Admin - Command is available at the administrator level log in.
•Service - Command is available at the service level log in. 
						

							10 of 90J Series Serial Commands Technical Reference Information020-100796-01 Rev. 1 (10-2011)
SUMMARY LIST OF SERIAL COMMANDS
 (ACE) Auto Color Enable  (BRT) Brightness  (FAS) Fan Assist Switch
 (ACO) Adaptive Contrast  (BRU) Brightness Uniformity  (FCS) Focus Lens Position Adjust-
ment
 (ACT) Active Window  (CCD) Output Color Default  (FIL) Filter
 (ADR) Address  (CCI) Interpolated Color  (FLE) Frame Lock Enable
 (AGC) Automatic Gain Control  (CCS) Select Output Color  (FLW) Serial Flow Control
 (AIC) Auto Input Cycling  (CHA) Channel  (FMD) Film Mode Detect
 (AIL) Auto Input Level  (CLE) Color Enable  (FRD) Frame Delay
 (ALT) Active Loop-Through  (CLP) Clamping  (FRF) Free Run Frequency
 (APJ) Active Projector  (CLR) Color  (FRZ) Freeze Image
 (APR) Aperture  (CON) Contrast  (FTB) Fade to Black
 (APW) Auto Power Up  (CRM) Chroma/Luma Delay  (GAM) Gamma Correction
 (ARO) Aspect Ratio Overlay  (CSP) Color Space  (GIA) Analog BNC Grounded Input 
Selection
 (ASH) Auto Shutdown  (DED) Dual DVI EDID Type 
Selection (GID) Video Decoder Grounded 
Input Selection
 (ASR) Auto Channel Select  (DEF) Defaults  (GIO) General Purpose Input/Output
 (ASU) Auto Setup  (DLG) Data Logging  (GMS) VDIC Grouped-Inputs Mode
 (BBL) Bottom Blanking  (DMX) DMX/ArtNet  (GNB) Green Black Level
 (BDR) Baud Rate  (DRK) 3D Dark interval  (GND) Green Drive
 (BGC) Base Gamma Curve  (DTL) Detail  (GOG) Green Odd Pixel Gain
 (BGF) Base Gamma Function  (DTO) Detail Overshoot  (GOO) Green Odd Pixel Offset
 (BGS) Base Gamma Slope  (DTT) Detail Threshold  (HDC) DHDIC Dual-Link Configu-
ration
 (BKY) Broadcast Key Mode  (EBB) Blacklevel Blending  (HIS) Lamp History
 (BLB) Blue Black Level  (EBL) Edge Blending  (HLP) Serial Help
 (BLD) Blue Drive  (EME) Error Message Enable  (HLT) Projector Health
 (BOG) Blue Odd Pixel Gain  (ESC) Edit Secondary Channel Set-
ting (HOR) Horizontal Position
 (BOO) Blue Odd Pixel Offset  (FAD) Fade Time  (ILS) Intelligent Lens System