RS232 Commands
Ref ere n ce g ui de
For CL M R1 0+
R59770203/01
04/01/2008
Barco nv Media & Entertainment Division
Noordlaan 5, B-8520 Kuurne
Phone: +32 56.36.89.70
Fax: +32 56.36.883.86
E-mail: [email protected]
Visit us at the web: www.barco.com
Printed in Belgium
Copyright ©
All rights reserved. No part of this document may be copied, reproduced or translated. It shall not otherwise be recorded, transmitted or
stored in a retrieval system without the prior written consent of Barco.
Trademarks
Brand and product names mentioned in this manual may be trademarks, registered trademarks or copyrights of their respective holders.
All brand and product names mentioned in this manual serve as comments or examples and are not to be understood as advertising for
the products or their manufactures.
Table of contents
TABLE OF CON TENTS
1. Serial communication basics .................................................................................... 3
1.1 Communication Protocol ............................................................................................................. 3
1.2 Datawords............................................................................................................................ 4
1.3 Communication settings.............................................................................................................. 5
1.4 Hardware ............................................................................................................................. 5
1.5 Serial comms commands ............................................................................................................ 7
1.6 Syntax................................................................................................................................. 7
2. RS232 commande .................................................................................................. 9
2.1 acknowledge.......................................................................................................................... 9
2.2 actuallamppower,read(CLM) ...................................................................................................... 9
2.3 aftercoolstatus,read................................................................................................................. 9
2.4 answer...............................................................................................................................10
2.5 auto image, write ....................................................................................................................10
2.6 blankingbottom,read ...............................................................................................................11
2.7 blankingbottom,write...............................................................................................................11
2.8 blankingleft,read....................................................................................................................12
2.9 blankingleft,write ...................................................................................................................12
2.10 blankingright,read..................................................................................................................12
2.11 blankingright,write..................................................................................................................13
2.12 blankingtop,read ...................................................................................................................13
2.13 clampdelay,read....................................................................................................................14
2.14 clampdelay,write....................................................................................................................14
2.15 colorbalance,read..................................................................................................................14
2.16 colorbalance,write..................................................................................................................15
2.17 color temperature, write .............................................................................................................15
2.18 directory, write to profile.............................................................................................................15
2.19 extended source selection, read ....................................................................................................16
2.20 extended source selection, write....................................................................................................17
2.21 fieldpolarity,read....................................................................................................................18
2.22 fieldpolarity,write....................................................................................................................18
2.23 gamma,read(1).....................................................................................................................18
2.24 gamma,read(2).....................................................................................................................19
2.25 gamma, read extended..............................................................................................................19
2.26 gamma,write ........................................................................................................................20
2.27 horizontal keystone, read ...........................................................................................................20
2.28 image load, read method............................................................................................................21
2.29 image load, write method............................................................................................................21
2.30 input black balance, read............................................................................................................21
2.31 input black balance, write ...........................................................................................................22
2.32 input locking, read ...................................................................................................................22
2.33 input locking, write...................................................................................................................23
2.34 input selection, read .................................................................................................................24
2.35 input selection, write.................................................................................................................24
2.36 input white balance, read............................................................................................................24
2.37 input white balance, write ...........................................................................................................25
2.38 internalpattern,write................................................................................................................25
2.39 key configuration,read..............................................................................................................26
2.40 key configuration,write..............................................................................................................27
2.41 lampdimming,read .................................................................................................................28
2.42 lampdimming,write.................................................................................................................28
2.43 lampmaxruntime,read.............................................................................................................28
2.44 lampon,read........................................................................................................................28
2.45 lampruntime,read...................................................................................................................29
2.46 lampstatus,read....................................................................................................................29
2.47 lampstatus,write....................................................................................................................29
2.48 lampstrikes,read....................................................................................................................30
2.49 layoutwindowselection.............................................................................................................30
2.50 layout,load...........................................................................................................................31
2.51 layout, read active file...............................................................................................................31
2.52 layout, save to file ...................................................................................................................31
2.53 layout, write active file ..............................................................................................................31
2.54 lenscenter,write.....................................................................................................................32
2.55 lensfocus,write .....................................................................................................................32
2.56 lensshift,write.......................................................................................................................32
2.57 lenszoom,write.....................................................................................................................33
2.58 lpsactualpower,read(CLM)........................................................................................................33
2.59 minimumdelay,read ................................................................................................................34
2.60 minimumdelay,write................................................................................................................34
2.61 noacknowledge .....................................................................................................................34
2.62 no signal color, read.................................................................................................................35
2.63 no signal color, write.................................................................................................................35
R59770203 RS232 COMMANDS 04/01/2008
1
Table of contents
2.64 no signal shutdown, read status ....................................................................................................36
2.65 no signal shutdown, read time ......................................................................................................36
2.66 no signal shutdown, write status....................................................................................................36
2.67 no signal shutdown, write time......................................................................................................37
2.68 noise reduction, decrement .........................................................................................................37
2.69 noise reduction, increment ..........................................................................................................38
2.70 noise reduction, read ................................................................................................................38
2.71 noise reduction, write................................................................................................................38
2.72 opticaldimming,read................................................................................................................38
2.73 opticaldimming,write ...............................................................................................................39
2.74 p7status,read.......................................................................................................................39
2.75 p7status,write.......................................................................................................................40
2.76 profile,readentry....................................................................................................................40
2.77 profile, read entry count .............................................................................................................40
2.78 projector, read address..............................................................................................................41
2.79 projector,readcustomerid..........................................................................................................41
2.80 shutter,writeclose...................................................................................................................41
2.81 shutter, write open...................................................................................................................42
2.82 soft edge black level, read ..........................................................................................................42
2.83 soft edge black level, write ..........................................................................................................43
2.84 soft edge size, read..................................................................................................................43
2.85 soft edge size, write .................................................................................................................43
2.86 soft edge, read status ...............................................................................................................44
2.87 soft edge, write status ...............................................................................................................44
2.88 transitioneffect,read................................................................................................................44
2.89 transitioneffect,write................................................................................................................45
2.90 UDP broadcast discovery ...........................................................................................................45
2.91 white peaking, read..................................................................................................................46
2.92 white peaking, write .................................................................................................................46
2.93 window, read selection ..............................................................................................................46
Index......................................................................................................................47
2 R59770203 RS232 COMMANDS 04/01/2008
1. Serial communication basics
1. SERIAL COMMUNICATION BASICS
Overview
• Communication Protocol
• Data words
• Communication settings
• Hardware
• Serial comms commands
•Syntax
1.1 Communication Protocol
Communication protocol summary
Like every communication method the serial communication uses a particular protocol (ANSI) which must be respected in order to
allow communication to take place, following table gives a summary of the predefined communication terms.
Start byte \xfe
Projector address
Command byte(s)
Data bytes
1
Checksum byte
Stop byte \xff
ANSI
American National standards Institute
Start byte
The “Start byte” informs the projector (in case of transmission) or the computer (in case of reception) that a new data transfer will
take place
Projector address
The “projector address” defines the address of the computer the projector wants to talk to (in case of transmission) or the address
of the projector that answers (in case of reception).
The maximum numb er of projectors that can be addressed by one com puter is 256.
Command byte(s)
There is at least one command byte to define the action to be performed. Commands that are not often used or complex commands
can take more than one byte. All command bytes that are sent by the computer to get information out of the projector are repeated
in the answer-data-transfer of the projector.
Data bytes (optional)
Whether the command bytes are followed by one or more data bytes depends on the contents of the command bytes.
Data which contains more than one byte is called a word and can also be signed or unsigned.see "Data words", page 4
Some commands do not require a data field(s)
1. optional
R59770203 RS232 COMMANDS 04/01/2008 3
1. Serial communication basics
Checksum byte
The “Checksum byte” is used to detect errors during transmission or reception
Checksum byte = (projectoraddress + command bytes + Data bytes) Modulo \x100
Stop byte
The“Stopbyte” informsthe projector(incaseof transmission)or the computer(incaseof reception)that thedata transferiscomplete
and that the interpretation of the command and data bytes can start.
Acknowledge (ACK)
If the communication link and if the sent commands can be interpreted by the projector an “ACK” command is sent back. In case the
commands cannot be interpreted a “NACK” command is sent back.
End of process (EOP)
When the end of process command is activated, an EOP is send after the ACK command to signify the completion of the process.
for more information abou t this, see the EO P comm and.
Note
Any com mand byte, data byte or ch ecksum byte that eq uals \x80, \xfe, \xff hastobeconverted!
1. Transmission
- instead of \x80, send \x80 followed by \x00
- instead of \xfe, send \x80 followed by \x7e
- instead of \xff, send \x80 followed by \x7f
2. Reception
- replace \x80 followed by \x00 with \x80
- replace \x80 followed by \x7e with \xfe
- replace \x80 followed by \x7f with \xff
1.2 Data w ords
msb
The most significant byte, is the byte with the greatest weight (value).
lsb
The less s ignificant byte, is the byte with the smallest weight (value).
Description
A word contains more than one byte, the first byte is the msb, the last byte is the lsb.
Examples of data words
• The projector runtime parameter is described using an unsigned double word where 2 bytes (msb ...lsb) represent the value of
the runtime in seconds.
How to calculate the value of a word ?
Lets take the example of a double word returned by the “projector runtime, read” commando.
returned data = Data[0]....Data[3]
value = Data[0]*256
3
+ Data[1]*256
2
+ Data[2]*256 + Data[3].
4
R59770203 RS232 COMMANDS 04/01/2008
1. Serial communication basics
1.3 Communication settings
Baud rate
Defines the speed of the data transfer. The baud rate can be set using the menu structure.
Consult the Owner ’s manual of the projector on how to change the baud rate setting.
Data Bits
Eight data bits are used for each character of the data transfer.
Parity
There is no parity bit used to perform error checking.
Stop Bits
One stop bit is used to define the end of a character.
1.4 Hardware
Overview
• Female D9–pin connector labelled “RS232 IN” used to connect the projector with the computer.
Pin out of the D9 connector:
Pin Name Full Name
1
CD Carrier Detect
2 RxD Received Data
3 TxD Transmitted Data
4 DTR Data Terminal Ready
5
GND Signal Ground
6
DSR Data Set Ready
7
RTS Request To Send
8
CTS Clear To Send
9 RI Ring Indicator
• Standard serial Cable
- order number R9827560 (cable length = 15m )
- order number R9827570 (cable length = 30m )
R59770203 RS232 COMMANDS 04/01/2008
5
1. Serial communication basics
1
CD
2
RxD
3
TxD
4
DTR
5
GND
6
DSR
7
RTS
8
CTS
9
RI
1
CD
2
RxD
3
TxD
4
DTR
5
GND
6
DSR
7
RTS
8
CTS
9
RI
D9
female
D9
male
Image 1-1
connection: IBM PC or compatible → projector
1
HSKo
2
HSKi
3
TxD-
4
GND
5
RXD-
6
TXD+
7
n.c.
8
RXD+
4
DTR
8
CTS
3
TxD
5
GND
2
RxD
DIN
mini 8
D9
male
Image 1-2
connection: MAC → projector
Signal levels
Following table gives the signal levels corresponding to the different states:
State Voltage
Off = 1 -9V
On = 0 +9V
6 R59770203 RS232 COMMANDS 04/01/2008
1. Serial communication basics
1.5 Serial comms commands
Basic Commands
Basic commands are the commands used to control the basic parameters of the projector.
The Contrast increment command is a basic command.
Advanced Commands
Advanced commands are used to control advanced parameters of the projector.
The Piploopfocusis an advanced parameter
This manual is divided in two parts, the first part co ntains the basic (elemen tary) co mm and s w h ile the se cond
part g ives an overview of the available adv anced command s.
Some co mmands are illustrated with an example.
1.6 Syntax
Characters
In this manual, all characters are expressed using the C- language syntax:
decimal values ddd
2
hexadecimal values \xhh
3
The ch aracters that can b e used are
For text fields: "ABCDEFGHIJKLMNO PQR STUVW X YZ012345678 9+-/&@#_:;abcdefghijklmnopqrstuvwxyz”
For filenames: "?*ABCDEFGHIJKLMNOP QRSTUVW XYZabcdefghijklmnopqrstuvwxyz0123456789_ -"
Negative values /numbers
The 2s complement number system is used to express negative numbers
Pascal- language string
A Pascal-language string consists of one or more characters. The first character of the string contains the length of the string.
Therefore, a Pascal-language string is limited to 255 characters.
Pascal string ’Hello world”
length
\x0b
’h’
\x68
’e’
\x65
’l’
\x6c
’l’
\x6c
’o’
\x6f
”
\x20
’w’
\x77
’o’
\x6f
’r’
\x72
’l’
\x6c
’d’
\x64
C-language string
A C-language string consists of one or mo
re characters. The last character of the string is always the NULL character \x00. There-
fore, the length of a C-language string is determined by the position of the NULL character.
2. ddd=0...255
3. hh=00...ff
R59770203 RS232 COMMANDS 04/01/2008 7
1. Serial communication basics
Cstring’Helloworld”
’h’
\x68
’e’
\x65
’l’
\x6c
’l’
\x6c
’o’
\x6f
”
\x20
’w’
\x77
’o’
\x6f
’r’
\x72
’l’
\x6c
’d’
\x64
NULL
\x00
Image files
The image files are described as ASCII text in XML format i.e. a header and the different elements and their value placed between
tags :
<?xml version="1.0" encoding="UTF-8" ?>
<ImageFile>
<FileSelection>
<InputLayer />
<SourceType />
<LineDuration Discrepancy="427" Unit="ns">20677</LineDuration>
<TotalLines Discrepancy="0">806</TotalLines>
<Interlaced>no</Interlaced>
</FileSelection>
<ImageDefinition>
<TotalPixels>1344</TotalPixels>
<ActivePixels>1024</ActivePixels>
<PixelStart>135</PixelStart>
<ActiveLines>768</ActiveLines>
<LineStart>29</LineStart>
<AspectRatio>4:3</AspectRatio>
</ImageDefinition>
</ImageFile>
Since the XML file is parsed internally in the projector it will return a NACK if the data is not valid (does not respect the XML com-
pleteness rules).
Desktop error strings
The operating system (Windows
TM
) uses a yellow notification arrea to display errors and messages. These messages appear in the
lower right corner of the desktop.
The acknowledge bytes are followed by a character string representing the actual message or error displayed.
An example is the error “No image file found” that can be generated when selecting a inactive (not present) source.
The character string sent is the following :
\x2b\x00\xff\xff\xff\xf1\x00\x4e\x00\x6f\x00\x20\x00\x49\x00\x6d\x00\x61\x00\x67\x00\x65\x00\x66\x00\x69\x0
0
Note that each character is followed by the \x00, the string being also ended with \x00.
8 R59770203 RS232 COMMANDS 04/01/2008
2. RS232 commande
2. RS232 COMMANDE
2.1 acknowledge
Description
When the format of a received command is correct, and the command is a valid command, the projector w
ill send back an acknowl-
edge back to the requestor before executing the actual command.
See also the no-acknowledge command
Command
Command [0]
0x00
Command [1]
0x06
Data
No data bytes.No data bytes.
Return value
This command does not require an answer.
2.2 actual lamp power, read (CLM)
Description
Reads the actual lamp power, as programmed in the lamp info module.
The difference between this command and the \’actual lps power, read\’, is that this command reads the power from the lamp info
module whereas the other command reads/measures the actual power f
rom the LPS.
Command
Command [0]
0x76
Command [1]
0x8F
Command [2]
lampnr
Data
The parameter is part of the command: the 3th byte indicates the lamp number.
Return value
2.3 aftercool status, read
Description
Reads the remaining aftercool status.
When a CLM projector has been switched off, the lamps should cool down before they can be started again. This period of cooling
down is called ’aftercool’.
With this command, you can read the status of this aftercool period.
Command
Command [0]
0x76
Command [1]
0xA0
R59770203 RS232 COMMANDS 04/01/2008 9
2. RS232 commande
Data
Return value
data[0]
status (byte)
values:
• 0x00 = no aftercool period active
• 0x01 = aftercool period active
data[1..2]
time remaining in seconds (word). Is 0 if aftercool is not active.
2.4 answer
Description
Each command can be preceded with the answer command. This will be ignored when the command is a read operation (read
operations always return an answer).
Command
Command [0]
0x00
Command [1]
0x03
Data
Data[0]
bit0 =0
bit1 =1
return with success after the command
has been executed
bit2 =0
bit3 =0
bit4 =0
bit5 =0
bit6 =0
bit7 =0
Return value
Return data for success:
Command[0]
0x00
Command[1]
0x03
Data[0] 0x01
Return data for no success:
Command[0] 0x00
Command[1] 0x03
Data[0] 0x00
2.5 auto image, write
Description
Execute specified auto image functionality.
10
R59770203 RS232 COMMANDS 04/01/2008
2. RS232 commande
Command
Command [0]
0x20
Command [1]
0x9e
Data
Data[0]: Auto image functionality
Value Description
0x00 alignment
0x01 contrast/brightness
0x02 phase
Return value
2.6 blanking bottom, read
Description
Read the actual value of blanking bottom.
Command
Command [0]
0x21
Command [1]
0x4d
Data
Return value
Data[0..1] = value of blanking bottom.
Data[0] MSB of value
Data[1] LSB of value
On error, only the command bytes will be returned.
2.7 blanking bottom, write
Description
Write a new value for blanking bottom.
Command
Command [0]
0x20
Command [1]
0x4d
Data
Data[0..1] = value of blanking bottom.
Data[0]
MSB of value
Data[1]
LSB of value
R59770203 RS232 COMMANDS 04/01/2008 11
2. RS232 commande
Return value
2.8 blanking left, read
Description
Read the actual value of blanking left.
Command
Command [0]
0x21
Command [1]
0x4e
Data
Return value
Data[0..1] = value of blanking left.
Data[0] MSB of value
Data[1] LSB of value
On error, only the command bytes will be returned.
2.9 blanking left, write
Description
Write a new value for blanking left.
Command
Command [0]
0x20
Command [1]
0x4e
Data
Data[0..1] = value of blanking left.
Data[0] MSB of value
Data[1] LSB of value
Data[0..1] = value of blanking left.
Return value
2.10 blanking right, read
Description
Read the actual value of blanking right.
Command
Command [0]
0x21
Command [1]
0x4f
12 R59770203 RS232 COMMANDS 04/01/2008
2. RS232 commande
Data
Return value
Data[0..1] = value of blanking right.
Data[0] MSB of value
Data[1] LSB of value
On error, only the command bytes will be returned.
Data[0..1] = value of blanking right.
2.11 blanking right, write
Description
Write a new value for blanking right.
Command
Command [0]
0x20
Command [1]
0x4f
Data
Data[0..1] = value of blanking right.
Data[0]
MSB of value
Data[1]
LSB of value
Data[0..1] = value of blanking right.
Return value
2.12 blanking top, read
Description
Read the actual value of blanking top.
Command
Command [0]
0x21
Command [1]
0x4c
Data
Return value
Data[0..1] = value of blanking top.
Data[0] MSB of value
Data[1] LSB of value
On error, only the command bytes will be returned.
Data[0..1] = value of blanking top.
R59770203 RS232 COMMANDS 04/01/2008
13
2. RS232 commande
2.13 clamp delay, read
Description
Read the actual value of the clamp delay.
Command
Command [0]
0x21
Command [1]
0x67
Data
Return value
Command[0]
0x21
Command[1]
0x67
Data[0..1]
value of the clamp delay as WORD
On error, only the command bytes will be returned.
2.14 clamp delay, write
Description
Writeanewvaluefortheclampdelay.
Command
Command [0]
0x20
Command [1]
0x67
Data
Data[0..1] = value of the clamp delay as WORD.
Return value
2.15 color balance, read
Description
Read the actual color balance value.
Command
Command [0]
0x21
Command [1]
color
Data
Return value
Command[0] 0x21
Command[1] color
Data[0] value of color balance multiplied by 100
On error, only the command bytes will be returned.
14
R59770203 RS232 COMMANDS 04/01/2008
2. RS232 commande
2.16 color balance, write
Description
Write a new value for the color balanceWrite a new value for the color balance
Command
Command [0]
0x20
Command [1]
color
Data
Data[0] = value of the color balance multiplied by 100.
Return value
2.17 color temperature, write
Description
Write the color temperature.
Command
Command [0]
0x20
Command [1]
0x45
Data
Data = C-language string containing the name of a color temperature file.
On error, only the command bytes will be returned.
Valid color temperature file names are:
• "custom"
• "3200"
• "5400"
• "6500"
• "9300"
• "projector-white"
Return value
-
2.18 directory, write to profile
Description
Writes the contents of a directory to a profile. Once the profile is filled with the contents, you can retrieve that contents using the
"profile, read entry count", page 40 and "profile, read entry", page 40 command.
Command
Command [0]
0xbd
Command [1]
0xc0
R59770203 RS232 COMMANDS 04/01/2008 15
2. RS232 commande
Data
Directory
path
The directory to load. Available directory paths for CLM:
• $SHBIMAGES: image files.
• $SHBLAYOUTS: layout files
• $SHBPATTERNS: internal patterns
• $SHBCOLORTEMPERATURES: color temperatures
• $SHBCOLORSTANDARDS: color standards
• $SHBASPECTRATIOS: aspect ratios
• $SHBEFFECTS: transition effects
(C-language string)
Directory
filter
The filter to use (empty if not applicable) (C-language string)
Profile
path
Path of the file where the profile should be created. The file must reside in the
tmp folder of the projector (/tmp) and the file can be named as you want.
Example of a profile path: /tmp/myprofiles
(C-language string)
Profile
section
name
The section within the profi le where the data needs to stored. The name of the
section can be chosen freely, but it should be enclosed in square brackets.
Example: [MY_LAYOUTS].
(C-language string)
File per-
missions
(OP-
TIONAL)
Permissions of the files to include (C-language string)
Extra
(OP-
TIONAL)
Extra options
(C-language string)
Return value
None.
The result of this command should be retrieved using the "profile, read entry", page 40 command.
2.19 extended source selection, read
Description
Reads the current source selection of the active window. The appropriate module configuration is also added. Also possibility to
request for module type.
Command
Command [0]
0x34
Data
Data[0]=2 And Data[1]=2 ask for module configuration (input mode) and module type
Return value
Command[0] = 0x34
Command[1] = optional
Command[2] = optional
Data[0] = source selection for active window
Data[1] = module configuration depending on the module type
HBW
5-CABLE HDSDI
DVI
0
RGBHSVSCS RGBHSVSCS
INPUT 1
EQ value
1
RGB SOG RGB CV
INPUT 2
2
YUVHSVSCS RGBSOG PRIORITY1
3
YUVSOY YUVHSVSCS PRIORITY2
16 R59770203 RS232 COMMANDS 04/01/2008
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
-
1
-
2
-
3
-
4
-
5
-
6
-
7
-
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
Barco CLM HD8 User guide
- Category
- Projectors
- Type
- User guide
Ask a question and I''ll find the answer in the document
Finding information in a document is now easier with AI
Related papers
Other documents
-
Sony PFM-42V1 Protocol Manual
-
-
-
-
-
Projectiondesign F3 SX+3 Supplementary Manual
-
ViewSonic LS700HD User guide
-
ViewSonic LS625W-S User manual
-
ViewSonic LS700-4K User guide
-
ViewSonic LS900WU-S User manual