Barco CLM-HD6 Reference guide

1

Revisions

REV

Descriptions

DATE

A01

Initial release from BARCO’s Generated_Doc_RS_Commands_CLM_R10+ projector

2010/02/22

A02

1. Pick up RS commands for CLM W6.

2. Added “vertical keystone”, ”Tint”, “shutter”, “Text”, “sharpness”, “phase”, “video

standard” and “frame rate” commands.

2010/03/10

A03

1. Correct the parameter of “Gamma” command.

2010/03/18

A04

1. Added “Brightness” command.

2010/03/25

A05

1. Added “H/V keystone warping” and “BarrelPinchusion” commands.

2010/04/09

A06

1. Correct the parameter of “Lamp dimming” command for data transfer limitation.

2. Correct the parameter of “tcgd” command for color gamut limitation.

3. Recovered P7 mcgd (measured values) for P7 default settings.

4. Added “Query” and “Set” commands for network module.

5. Added flash utility command to flash DDP302x flash ROM.

6. Correct the parameter of “Sharpness”, “Phase”, “Input white/black balance”, “H/V

keystone”, “H/V pincushion” and “BarrelPinchusion” commands for the negative number

indication.

7. Added “Set serial no.” command for barcode machine using.

2010/05/12

A07

1. Added X, Y and Luminance of A, B, C, D in P7 mcgd (measured values) for P7 settings.

Only CLM W6 (DDP3020F) has this function.

2. Add White RGB, A, B, C, D pattern in Internal pattern for P7 default settings.

Only CLM W6 (DDP3020F) has this function.

3. Add “Query serial no” command for barcode machine using.

4. Correct the parameter of “Lamp dimming” command to one byte data transfer.

2010/05/20

A08

1. Added 10 IR commands for remote controller.

2. Correct the command byte and data byte error of “Versions”.

3. Correct the data byte error of “Diagnosis”.

4. Adjust the data parameters of “Frame rate”.

5. Adjust the data parameters of “Query for 'About' page”.

6. Adjust the data parameters of “Query for ‘general’ page”.

7. Adjust the data parameters of “Query for 'Geometry Adjust' page”.

8. Adjust the data parameters of “Query for 'Advanced Control' page”.

9. Adjust the data parameters of “Query for 'Diagnostics' page”.

10. Change the parameters of “Aspect ratio”, “P7 tcgd, write (1)” and “Color temperature”

from “C-string” to “value”.

11. Delete the commands of “Gamma” and “Internal pattern”, due to the “C-string”.

12. Delete the commands of “No signal shutdown”, due to the time of “shutdown” is fixed.

13. Change the parameters of “P7 tcgd, read (1)” for typing error.

2010/06/25

2

A09

1. Modified the order of Aspect ratio from “16:9, 16:10” to “16:10, 16:9”,same as OSD.

2. Increased new data parameters of “Query for 'Advanced Control' page”.

3. Added remote control commands (IR commands).

2010/07/09

A10

1. Increased “Internal pattern read” command.

2. Delete the items of “EBU” and “SMPTE” in “P7 tcgd, write”.

2010/07/12

A11

1. Change the range of Phase from “-127~+127” to “-32~+32”.

2. Change the parameters of “Color temperature” from “9300” to “8800”.

3. Change some special function to “Reserve”

2010/07/15

A12

1. Increased a new data parameter (Data [7]: Color Flag) of “Query for ' Image Setting '

page”.

2. Added remote control commands (Pause and Text IR commands).

3. Added a column for “Standby available”.

4. Changed Text ON/OFF condition.

5. Delete the command, “Set TCP/IP (Network module using)”.

2010/08/03

A13

1. Updated the definition of command “Writes lamp selection”.

2. Updated P7 status write command (Color space setting write command) form “0x20,

0x97, 0x00, 0x00” to & “0x20, 0x97, 0x04”.

3. Added P7 status read command (Color space setting read command) “0x21, 0x97, 0x04”.

4. Added “Lamp setting write/read” command.

5. Added a command for FW upgraded used.

2010/08/09

A14

1. Added “Auto power on”, “Auto power off” and “A image adjust” write/read command.

2. Added “H total”, “H start” and “V start” write/read command.

3. Added “Film mode”, “Format” and “Display mode” write/read command.

4. Added “Main zoom in/out” and “PIP enable/select/size/position” write/read command.

5. Added “High Altitude” write/read command.

6. Added “Rear”, “Ceiling” and “Auto keystone” write/read command.

7. Added “Reset warp” command.

8. Added “IR address”, “Auto source” and “Menu position” write/read command.

9. Added P7 tcgd write(1) and write(3) command.

2010/08/12

A15

1. Updated keystone spec. +/- 60.

2. Increased a new data parameter (Data [8]: Tint Flag) of “Query for ' Image Setting ' page”.

2010/08/23

A16

1. Auto keystone function is deleted

2. Added “Set TCP/IP” Function

2010/09/10

A17

1. Added “OSD on”and “OSD off” write/read command.

2. Added “HDMI only on”and “HDMI only off” write/read command.

3. Added “BARCO name on”and “BARCO name off” write/read command.

4. Added “Powerkey only on”and “Powerkey only off” write/read command.

2011/10/17

A18

1. Added “Chroma Boost” write/read command.

2011/11/29

3

The Barco CLM W6 / HD6 Protocol Basics

Command basics

Command baud rate

Baud Rate

115200 (default)/ 19200 / 9600 (OSD setting)

Data Bits

8

Parity

None

Stop Bits

1

Flow Control

None

UART16550 FIFO

Disable

Command structure

Each command is packaged in this structure:

0xFE

0x00

PREFIX

CMD

DATA

CHK

0xFF

Start byte

(1 byte)

Device address

(1 byte)

Prefix (0..n

bytes)

Command

(1..n bytes)

Data (0..n

bytes)

Checksum

(1 byte)

Stop byte

(1 byte)

Explanation:

The start and stop byte are used to let te receiver know that a command is starting or has stopped.

Device address is used when multiple devices are connected on the same physical connection. This is

typically used with serial connections. In case of Ethernet connections this is either ignored, or should be set

to a fixed value, depending on the protocol.

4

Prefix bytes: for some special commands it is possible to use prefix bytes before the actual command bytes.

It depends on the actual protocol implementation which prefixes are available and when they can be used.

Command bytes: there will be at least one byte per command. The command bytes actually tell the device

what to do.

Data bytes: this is optional and depends on the command that will be sent. See also “Data byte” chapter.

Checksum byte: this byte is used to detect errors in the transmission or reception of the command. For more

information, see the “Checksum” chapter.

IMPORTANT NOTE

Any comm Any command byte, data byte or checksum byte that equals 0x80, 0xFE or 0xFF, has

to be marked up with a leading 0x80:

Byte to send: Actual mark up of the byte to send:

Byte to send

Actual mark-up of

the byte to send

0x80

0x80 0x00

0xFE

0x80 0x7E

0xFF

0x80 0x7F

Data bytes

Characters: we will be using ANSI coding for characters (1 byte per character).

Strings: strings can be formatted in two ways:

o C-style format: an array of one or more characters which is terminated by a NULL character (0x00). The

position of the NULL character determines the length of the string.

Exmaple: 'f' 'o' 'o' ' ' 'b' 'a' 'r' 0x00

o Pascal-style format: an array of one or more characters. The first byte of the string indicates the length of the

string. Therefore pascal-style strings are limited to 255 characters.

Example: 0x07 'f' 'o' 'o' ' ' 'b' 'a' r'

5

Multi-byte values: a multi-byte value consists of more than one byte. The first byte is the Most Significant

Byte (MSB).

Example of a 4-byte value: 0x01 0x20 0x50 0x30 = 0x01 * 2563 + 0x20 * 2562 + 0x50 * 256 + 0x30 =

536956976.

Checksum

The checksum value for a command is calculated by doing a modulo 256 on the sum of the byet values of all

bytes between start of the command and the checksum byte

Checksum calculation

Checksum byte = (Device address + Prefix bytes + Command bytes + Data bytes) mod 256

Acknowledgement

ACK and NACK

When a command is received, the command format and checksum should be checked. For our application, the

device address should be ignored. If there's an error in the command bytes or the checksum, the command

should be ignored.

If the command is a valid command, the receiver should answer back with an acknowledgement before starting

the processing of the command. If the command is not valid, the receiver should answer with a no acknowledge.

ACK (ACKnowledge)

Command[0]

0x00

Command[1]

0x06

An ACK is sent in these cases:

6

The command bytes are correct (checksum is OK)

The command and its parameters are valid

If one of these fail, an NACK will be returned.

NACK (Not ACKnowledge)

Command[0]

0x00

Command[1]

0x15

Example

Start byte

0xFE

Device

address:

0x00

Command[0]

0x00

Command[1]

0x15

Checksum

0x15

Stop byte

0xFF

Handling of no acknowldge (NACK)

When a command doesn't get acknowledged, it is up to the sender to decide what should happen with the

command: retry sending the command again or discard the command. The decision is mainly based on the type

of command and the situation it is used.

IMPORTANT NOTE

In a unicast communication, an acknowledge must always be returned by the receiver for each correct and valid

command it receives, before processing the command and replying on the command.

An acknowledge does not count as a reply on the execution of the command.

For multicast communication, acknowledgments are not used

7

Command responses

Replying commands

A lot of commands that can be send out, do not only return a ACK or NACK, but may also return a reponse or

reply. This reply will be sent after processing the command. The answer will have the same command bytes as

the request, but typically the data bytes will contain the response information. It depends on the protocol

implementation whether a command requires a reply or not. This will be defined per command in the protocol.

Example:

When requesting a projector's type, you should use the command 0x6b (projector, read type). In answer, the

projector will return a string containing the actual type of the device:

Request:

Start byte

0xFE

Device

address:

0x00

Command[0]

0x6b

Checksum

0x6b

Stop byte

0xFF

Acknowledge:

Start byte

0xFE

8

Device

address:

0x00

Command[0]

0x00

Command[1]

0x06

Checksum

0x06

Stop byte

0xFF

Reply:

Start byte

0xFE

Device

address:

0x00

Command[0]

0x6b

Data[0]

0x42 = 'B'

Data[1]

0x41 = 'A'

Data[2]

0x52 = 'R'

Data[3]

0x43 = 'C'

Data[4]

0x4f = 'O'

Data[5]

0x20 = ' '

Data[6]

0x46 = 'F'

Data[7]

0x4c = 'L'

Data[8]

0x4d = 'M'

Data[9]

0x20 = ' '

Data[10]

0x48 = 'H'

Data[11]

0x31 = '1'

Data[12]

0x38 = '8'

Data[13]

0x00

Checksum

0x03

Stop byte

0xFF

9

Handling of failing responses

When a receiver fails to return the expected response (acknowledge or reply) on a command, we need to follow

some steps to handle this failing communication.

There are 2 possible failures:

1. Communication link problems: If the sending of the commands itself doesn't work, it will be because the

communication is broken (f.i. the receiver as disconnected from the network).

2. Answer back problems: when commands can be sent out but no response is sent back, it means that the

communication link is OK but the receiver is unable to answer back.

Each type of failure needs another way of handling.

Handling communication link problems

As communication link problems will most likely have a physical reason (cable disconnected, hub down,

projector down, …), we need to notify the user and ask him for his feedback. In most cases there will be a user

intervention needed to correct this problem (connect the cable, reboot the hub, restart the projector, …).

The actual implementation of this, should be described in the specifications of the application.

Handling answer back problems

Answer back problems should be addressed in another way. When a receiver fails to answer back it might be

that it is currently too busy to answer back. The application software should implement some simple

mechanisms to avoid problems when this occurs:

1. Timeout waiting: the application should wait for a limited amount of time for an answer (f.i. max 10

seconds). This ensures that the application can react when a command doesn't get answered in time.

2. Retry waiting: if the timeout expires, we can retry waiting for the answer. By doing this, the user has the

opportunity to cancel the action. If needed, the retry can even be repeated several times.

3. Retry sending: when a command does not get answered after the timout waiting and retry waiting, the

command is considered to be lost in action and the application should send the command again.

10

This mechanism follows the sequence of the steps: first the timeout waiting is used, then the retry waiting and

finally the retry sending. If all of these steps fail, there might be a major problem with the receiver in in this

case we should notify the user of these problems so that he can check the status of the receiver.

11

Table of contents

Standby

Available

Function

Command (exclude Start

byte, Device address,

Checksum and Stop byte)

Return

Note

V

Answer

0x00, 0x03, Data[0]

0x00, 0x03,

Data[1]

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

Data[1]:

0x01 for success

0x00 for no success

V

Acknowledge

0x00, 0x06

V

No acknowledge

0x00, 0x15

12

X

P7 mcgd, Read

0x00, 0xC2

0x00, 0xC2,

Data[0..n]

Data[0]

RedX MSB

Data[1]

RedX LSB

Data[2]

RedY MSB

Data[3]

RedY LSB

Data[4]

GreenX MSB

Data[5]

GreenX LSB

Data[6]

GreenY MSB

Data[7]

GreenY LSB

Data[8]

BlueX MSB

Data[9]

BlueX LSB

Data[10]

BlueY MSB

Data[11]

BlueY LSB

Data[12]

WhiteX MSB

Data[13]

WhiteX LSB

Data[14]

WhiteY MSB

Data[15]

WhiteY LSB

Data[16]

BlackX MSB

Data[17]

BlackX LSB

Data[18]

BlackY MSB

Data[19]

BlackY LSB

Data[20]

Contrast MSB

Data[21]

Contrast LSB

Data[22]

Red Y Luminance MSB

Data[23]

Red Y Luminance LSB

Data[24]

Green Y Luminance MSB

Data[25]

Green Y Luminance LSB

Data[26]

Blue Y Luminance MSB

Data[27]

Blue Y Luminance LSB

Data[28]

White Y Luminance MSB

Data[29]

White Y Luminance LSB

X

P7 mcgd, write

0x00, 0xC2, Data[0..n]

13

Data[30]

AX MSB (for DDP3020F)

Data[31]

AX LSB (for DDP3020F)

Data[32]

AY MSB (for DDP3020F)

Data[33]

AY LSB (for DDP3020F)

Data[34]

BX MSB (for DDP3020F)

Data[35]

BX LSB (for DDP3020F)

Data[36]

BY MSB (for DDP3020F)

Data[37]

BY LSB (for DDP3020F)

Data[38]

CX MSB (for DDP3020F)

Data[39]

CX LSB (for DDP3020F)

Data[40]

CY MSB (for DDP3020F)

Data[41]

CY LSB (for DDP3020F)

Data[42]

DX MSB (for DDP3020F)

Data[43]

DX LSB (for DDP3020F)

Data[44]

DY MSB (for DDP3020F)

Data[45]

DY LSB (for DDP3020F)

Data[46]

A Y Luminance MSB (for

DDP3020F)

Data[47]

A Y Luminance LSB

(for DDP3020F)

Data[48]

B Y Luminance MSB

(for DDP3020F)

Data[49]

B Y Luminance LSB

(for DDP3020F)

Data[50]

C Y Luminance MSB

(for DDP3020F)

Data[51]

C Y Luminance LSB

(for DDP3020F)

Data[52]

D Y Luminance MSB

(for DDP3020F)

Data[53]

D Y Luminance LSB

(for DDP3020F)

14

Note for all values except contrast:

These are floating point values sent as

words.

Word value = floating point value *

10000.

Example: Real RedX = 0.1234; Word

to send for RedX = 1234

X

OSD, write to on

0x05

X

OSD, write to off

0x06

X

HDMIonly, write

to on

0x07

X

HDMI only, write

to off

0x08

X

BARCO name,

write to on

0x09

X

BARCO name,

write to off

0x0a

X

Powerkey onlye,

write to on

0x0b

X

Powerkey onlye,

write to off

0x0c

X

Text, write to on

0x0d

X

Text, write to off

0x0e

X

Contrast, write

0x20, 0x01, Data[0]

Data [0] = Contrast value.

X

Contrast, read

0x21,0x01

0x21, 0x01,

Data[0]

X

Brightness, write

0x20, 0x02, Data[0]

Data [0] = Brightness value.

X

Brightness, read

0x21,0x02

0x21, 0x02,

Data[0]

X

Saturation, write

0x20, 0x03, Data[0]

Data [0] = Saturation value.

X

Saturation, read

0x21,0x03

0x21, 0x03,

Data[0]

X

Tint, write

0x20, 0x04, Data[0]

Data [0] = Tint value.

15

X

Tint, read

0x21, 0x04

0x21, 0x04,

Data[0]

X

Sharpness, write

0x20, 0x05, Data[0]

Data [0] = Sharpness value.

OSD range: -7 ~ +8 mapping to

Data [0] range: 0 ~ 15.

X

Sharpness, read

0x21, 0x05

0x21, 0x05,

Data[0]

X

Phase, write

0x20, 0x06, Data[0]

Data [0] = Phase value.

OSD range: -32 ~ +32 mapping to

Data [0] range: 0 ~ 64.

X

Phase, read

0x21, 0x06

0x21, 0x06,

Data[0]

X

Aspect ratio, write

0x20, 0x0b, 0xc0, Data[0]

Data [0]: Aspect Ratio

0x00: 5:4

0x01: 4:3

0x02: 16:10

0x03: 16:9

0x04: 1.88

0x05: 2.35

0x06: Native

0x07: Unscaled

X

Aspect ratio, read

0x21, 0x0b, 0xc0

0x21, 0x0b,

0xc0, Data[0]

X

Aspect ratio width,

read

0x21, 0x0b, 0xc1

0x21, 0x0b,

0xc1, Data[0..3]

Data[0..3] aspect ratio width as a

DWORD

X

Aspect ratio height,

read

0x21, 0x0b, 0xc2

0x21, 0x0b,

0xc2, Data[0..3]

Data[0..3] aspect ratio height as a

DWORD

X

Lamp dimming,

write

0x20, 0x0d, Data[0]

Data[0]:

0x00

85%

0x01

87.5%

0x02

90%

0x03

92.5%

0x04

95%

0x05

97.5%

0x06

100%

X

Lamp dimming,

read

0x21, 0x0d

0x21, 0x0d,

Data[0]

X

H Total, write

0x20, 0x10, Data[0]

Data [0] = H Total.

OSD range: -127 ~ +127 mapping to

Data [0] range: 0 ~ 254.

X

H Total, read

0x21, 0x10

0x21, 0x10,

Data[0]

16

X

H Start, write

0x20, 0x11, Data[0]

Data [0] = H Start

OSD range: -127 ~ +127 mapping to

Data [0] range: 0 ~ 254.

X

H Start, read

0x21, 0x11,

Data[0]

X

V Start, write

0x20, 0x12, Data[0]

Data [0] = V Start

OSD range: -127 ~ +127 mapping to

Data [0] range: 0 ~ 254.

X

V Start, read

0x21, 0x12,

Data[0]

X

Film mode, write

0x20, 0x13, Data[0]

Data[0]: Film mode

0x00: OFF

0x01: ON

X

Film mode, read

0x21, 0x13

0x21, 0x13,

Data[0]

X

Format, write

0x20, 0x14, Data[0]

Data[0]: Format

0x00: YUV

0x01: RGB

0x02: AUTO

X

Format, read

0x21, 0x14

0x21, 0x14,

Data[0]

X

Display mode,

write

0x20, 0x15, Data[0]

Data[0]: Display mode

0x00: Presentation

0x01: Video

0x02: Bright

X

Display mode, read

0x21, 0x15

0x21, 0x15,

Data[0]

X

Chroma boost,

write

0x20, 0x16, Data[0]

Data[0]: Chroma boost

0x00: off

0x01: Mid

0x02: High

X

Chroma boost, read

0x21, 0x16

0x21, 0x16,

Data[0]

X

Shutter (pause),

read

0x21, 0x42

0x21, 0x42,

Data[0]

Data [0] = 0 for open and 1 for close.

X

Shutter (pause),

write to open

0x22, 0x42, 0x00

X

Shutter (pause),

write to close

0x23, 0x42, 0x00

X

Color temperature,

write

0x20, 0x45, Data[0]

Data [0]: Color Temp.

0x00: 3200.

0x01: 5400.

0x02: 6500.

0x03: 8800.

0x04: Native.

X

Color temperature,

read

0x21, 0x45

0x21, 0x45,

Data[0]

17

X

Input black

balance, write

0x20, 0x6e, Color, Data[0]

Color: 0x00 for red

0x01 for green

0x02 for blue

Data [0] = value as BYTE.

OSD range: -127 ~ +127 mapping to

Data [0] range: 0 ~ 254.

X

Input black

balance, read

0x21, 0x6e, Color

0x21, 0x6e,

Color, Data[0]

X

Input white

balance, write

0x20, 0x6f, Color, Data[0]

X

Input white

balance, read

0x21, 0x6f, Color

0x21, 0x6f,

Color, Data[0]

X

Gamma, write

0x20, 0x70, Data[0]

Data [0] = gamma value as BYTE.

0x00

1.3

0x01

1.6

0x02

1.8

0x03

2.0

0x04

2.2

0x05

2.4

0x06

2.6

0x07

2.8

X

Gamma, read

0x21, 0x70

0x21, 0x70,

Data[0]

X

Noise reduction,

write

0x20, 0x73, Data[0]

Data [0] = noise reduction value.

(ranges from 0 to 32)

X

Noise reduction,

read

0x21, 0x73

0x21, 0x73,

Data[0]

X

Noise reduction,

increment

0x22, 0x73

X

Noise reduction,

decrement

0x23, 0x73

X

No signal color,

write

0x20, 0x7b, Data[0]

Data[0]: background color

0x01 for logo,

0x02 for blue,

0x03 for black,

0x04 for white,

0x05 for snapshot

X

No signal color,

read

0x21, 0x7b

0x21, 0x7b,

Data[0]

X

P7 status, write

0x20, 0x97, 0x04, Data[0]

Data [0]: Color Space.

18

0x00: Native.

0x01: Custom.

X

P7 tcgd, read (1)

0x21, 0x97, 0x00, 0x00

0x21, 0x97,

0x00, 0x00,

Data[0..n]

Data[0]

0x00

Data[1]

RedX MSB

Data[2]

RedX LSB

Data[3]

RedY MSB

Data[4]

RedY LSB

Data[5]

0

Data[6]

0

Data[7]

GreenX MSB

Data[8]

GreenX LSB

Data[9]

GreenY MSB

Data[10]

GreenY LSB

Data[11]

0

Data[12]

0

Data[13]

BlueX MSB

Data[14]

BlueX LSB

Data[15]

BlueY MSB

Data[16]

BlueY LSB

Data[17]

0

Data[18]

0

Data[19]

MagentaX

MSB

Data[20]

MagentaX LSB

Data[21]

MagentaY

MSB

Data[22]

MagentaY LSB

Data[23]

0

Data[24]

0

Data[25]

CyanX MSB

Data[26]

CyanX LSB

19

Data[27]

CyanY MSB

Data[28]

CyanY LSB

Data[29]

0

Data[30]

0

Data[31]

YellowX MSB

Data[32]

YellowX LSB

Data[33]

YellowY MSB

Data[34]

YellowY LSB

Data[35]

0

Data[36]

0

Data[37]

WhiteX MSB

Data[38]

WhiteX LSB

Data[39]

WhiteY MSB

Data[40]

WhiteY LSB

These are floating point values read as

words.

Word value = floating point value *

10000.

Example: Real RedX = 0.1234; Word

read for RedX = 1234

20

X

P7 tcgd, write (1)

0x20, 0x97, 0x00, 0x00,

Data[0..n]

Data[0]

RedX MSB

Data[1]

RedX LSB

Data[2]

RedY MSB

Data[3]

RedY LSB

Data[4]

0

Data[5]

0

Data[6]

GreenX MSB

Data[7]

GreenX LSB

Data[8]

GreenY MSB

Data[9]

GreenY LSB

Data[10]

0

Data[11]

0

Data[12]

BlueX MSB

Data[13]

BlueX LSB

Data[14]

BlueY MSB

Data[15]

BlueY LSB

Data[16]

0

Data[17]

0

Data[18]

WhiteX MSB

Data[19]

WhiteX LSB

Data[20]

WhiteY MSB

Data[21]

WhiteY LSB

These are floating point values read as

words.

Word value = floating point value *

10000.

Example: Real RedX = 0.1234; Word

read for RedX = 1234

Page is loading ...

Barco CLM-HD6 Reference guide

Barco CLM-HD6 Reference guide

Related papers

Other documents