Barco HDX-W12 User guide

Command C atalog

1011000110100100101100101001010101010010100101

1010011001010100100100100100111010100101000101

0110110001001010011001100101010010010010101010

1011000110100100101100101001010101001001001010

1010011001010100100100100100111010100100101010

0110110001001010011001100101010010100101001010

1011000110100100101100101001010101110101100101

1010011001010100100100100100111011001001010101

0110110001001010011001100101010010100100110101

1011000110100100101100101001010101010010100101

1010011001010100100100100100111010100101000101

1011000110100100101100101001010101001001001010

1010011001010100100100100100111010100100101010

0110110001001010011001100101010010100101001010

1011000110100100101100101001010101110101100101

1010011001010100100100100100111011001001010101

Reference manua l

For HDX W12/W14/ W18

R5905447/03

08/06/2015

Barco NV

Noordlaan 5, B-8520 Kuurne

Phone: +32 56.36.82.11

Fax: +32 56.36.883.86

Support: www.barco.com/en/support

Visit us at the web: www.barco.com

Printed in Belgium

stored in a retrieval system without the prior written consent of Barco.

Changes

Barco provides this manual ’as is’ without warranty of any kind, either expressed or implied, including but not limited to the implied war-

ranties or m erchantability and ﬁtness for a particular purpose. Barco may make improvements and/or changes to the product(s) and/or the

program(s) desc ribed in this publication at any time w ithout n otice.

This pub lication c ould contain technical inaccuracies or typographical errors. Changes are periodic

ally m ade to the information in this

publication; these changes are incorporated in new editions of this publication.

The latest edition of Barco manua ls c an be downloaded from the Bar co web site w

ww.bar co.com or from the secured B arco web site

h

ttps://www.barco.com/en/signin.

Trademarks

Brand and product names m entioned in this manual m ay be trademarks, registered trademarks or copyrights of their respective holders.

All brand and product names mentioned in this manual serve as commen ts or examples and are not to be understood as advertising for

the products or their manufacturers.

Table of contents
TABLE OF CON TENTS
Introduction ......................................................................................................... 7
1 About this document.................................................................................................................. 8
The Barco Projection Protocol................................................................................... 9
1 The Barco Projection Protocol explained...........................................................................................10
2 Ethernet communication ............................................................................................................13
3 RS232/RS422/USB-B commun ication..............................................................................................15
4 The command representation in this manual .......................................................................................16
Commands .........................................................................................................17
1 3D dark time adjustment, read......................................................................................................19
2 3D dark time adjustment, write......................................................................................................20
3 3D Double/Tripple Flash limit, read .................................................................................................21
4 3D Double/Tripple Flash limit, write .................................................................................................22
5 3D ﬁeld dominance, read . . ..........................................................................................................23
6 3D ﬁeld dominance, write . . .........................................................................................................24
7 3D L/R Output Reference Delay, read..............................................................................................25
8 3D L/R Output Reference Delay, write..............................................................................................26
9 3D mode, read.......................................................................................................................27
10 3D mode, write....................................................................................................................... 28
11 3D status, read ...................................................................................................................... 29
12 3D status, write ......................................................................................................................30
13 3D Sync Loop status, read..........................................................................................................31
14 3D Sync Loop status, write..........................................................................................................32
15 brightness possible, read............................................................................................................33
16 clear test pattern, write .............................................................................................................. 34
17 contrast possible, read ..............................................................................................................35
18 decrement blanking bottom, write. ..................................................................................................36
19 decrement blanking left, write ....................................................................................................... 37
20 decrement blanking right, write . ....................................................................................................38
21 decrement blanking top, write ....................................................................................................... 39
22 decrement brightness, write.........................................................................................................40
23 decrement color balance b lue green ratio, write....................................................................................41
24 decrement color balance r ed green ratio, write. ....................................................................................42
25 decrement contrast, w rite . ..........................................................................................................43
26 decrement dimming value, write . ...................................................................................................44
27 decrement gamma, write .. ..........................................................................................................45
28 decrement input black balance , write ..............................................................................................46
29 decrement input white balance , write .............................................................................................. 47
30 decrement phase, write .............................................................................................................48
31 decrement saturation, write ......................................................................................................... 49
32 decrement sharpness, write......................................................................................................... 50
33 decrement shutter, write.............................................................................................................51
34 decrement tint, w rite ................................................................................................................. 52
35 freeze, write..........................................................................................................................53
36 function read electronic convergence, read ........................................................................................54
37 function read input balance pattern status, read ...................................................................................55
38 function write electronic convergence , write ....................................................................................... 56
39 get aspect ratio ﬁle, read ............................................................................................................57
40 get aspect ratio height, read ........................................................................................................58
41 get aspect ratio width, read .........................................................................................................59
42 get baudrate, read . . .................................................................................................................60
43 get blanking bottom, read ........................................................................................................... 61
44 get blanking left, read ............................................................................................................... 62
45 get blanking right, read..............................................................................................................63
46 get blanking top, read ............................................................................................................... 64
47 get brightness, read .................................................................................................................65
48 get clamp delay, read................................................................................................................ 66
49 get clamp width, read................................................................................................................67
50 get color balance blue green ratio, read ............................................................................................68
51 get color balance red green ratio, read .............................................................................................69
52 get color temper ature, read .........................................................................................................70
53 get common address, read..........................................................................................................71
54 get contrast, read....................................................................................................................72
55 get contrast enhanc ement, read ....................................................................................................73
56 get dimming, read ................................................................................................................... 74
57 get ext contrast, read................................................................................................................ 75
58 get ext contrast enhancement , read ...............................................................................................76
59 get ext gamma, read ................................................................................................................ 77
60 get ext phase, read ..................................................................................................................78
61 get ext sharpness, read .............................................................................................................79
62 get freeze status, read............................................................................................................... 80
63 get gamma, read ....................................................................................................................81
R5905447 COMMAND CATALOG 08/06/2015
1

Table of contents
64 get gamma (text value), read........................................................................................................82
65 get input blac k balance, read .......................................................................................................83
66 get input white balance, read .......................................................................................................84
67 get intensity, read.................................................................................................................... 85
68 get ir hold off conﬁguration, read....................................................................................................86
69 get lamp status, read ................................................................................................................87
70 get lamp status, read ................................................................................................................88
71 get layout, read ......................................................................................................................89
72 get lcd backlight level, read .........................................................................................................90
73 get lcd time out, read ................................................................................................................91
74 get lock, read ........................................................................................................................92
75 get no signal color logo, read .......................................................................................................93
76 get no signal shutdown delay, read .................................................................................................94
77 get no signal shutdown status, read ................................................................................................ 95
78 get output window native resolution status, read ...................................................................................96
79 get output window param eters, read................................................................................................97
80 get output window status, read......................................................................................................98
81 get P7 TCGD blue X, read ..........................................................................................................99
82 get P7 TCGD blue Y, read..........................................................................................................100
83 get P7 TCGD cyan X, read.........................................................................................................101
84 get P7 TCGD cyan Y, read .........................................................................................................102
85 get P7 TCGD green Y, read........................................................................................................103
86 get P7 TCGD magenta X, read . . ..................................................................................................104
87 get P7 TCGD magenta Y, read.....................................................................................................105
88 get P7 TCGD red X, read ..........................................................................................................106
89 get P7 TCGD red Y, read...........................................................................................................107
90 get P7 TCGD selection, read.......................................................................................................108
91 get P7 TCGD white X, read ........................................................................................................109
92 get P7 TCGD white Y, read ........................................................................................................110
93 get P7 TCGD yellow X, read .......................................................................................................111
94 get P7 TCGD yellow Y, read .......................................................................................................112
95 get phase, read .....................................................................................................................113
96 get projector address, read . ........................................................................................................114
97 get same lens settings status, read................................................................................................115
98 get saturation, read.................................................................................................................116
99 get scan/orientation conﬁguration , read...........................................................................................117
100 get sharpness, read ................................................................................................................118
101 get shutter status, read.............................................................................................................119
102 get soft edge black level, read .....................................................................................................120
103 get soft edge size black level bottom, read . .......................................................................................121
104 get soft edge size black level left, read . ... . .......................................................................................122
105 get soft edge size black level right, read . ..........................................................................................123
106 get soft edge size black level top, read . . .. . .......................................................................................124
107 get soft edge size bottom, read . . ..................................................................................................125
108 get soft edge size left, read ........................................................................................................126
109 get soft edge size right, read .......................................................................................................127
110 get soft edge size top, read ........................................................................................................128
111 get soft edge status, read .. ........................................................................................................129
112 get source, read ....................................................................................................................130
113 get source extended, read .
........................................................................................................131
114 get text on, read ....................................................................................................................134
115 get tint, read ........................................................................................................................135
116 get warp axis position, read ........................................................................................................136
117 get warp ﬁle, read ..................................................................................................................137
118 get warp grid size, read ............................................................................................................138
119 get warp hierarchic keystone in X direction, read .................................................................................139
120 get warp hierarchic keystone in Y direction, read .................................................................................140
121 get warp hierarchic linearity in X direction, read. ..................................................................................141
122 get warp hierarchic linearity in Y direction, read. ..................................................................................142
123 get warp hierarchic point shift, read................................................................................................143
124 get warp keystone horizontal. Deprecated from version 1.6, read ...............................................................144
125 get warp keystone vertical. Deprecated from version 1.6, read ..................................................................145
126 get warp line shift horizontal. Deprecated from version 1.6, read ................................................................146
127 get warp line shift vertical. Deprecated from version 1.6, read ...................................................................147
128 get warp linearity horizontal. Deprecated from version 1.6, read.................................................................148
129 get warp linearity vertical. Deprecated from version 1.6, read . ...................................................................149
130 get warp pin barrel horizontal. Deprecated from version 1.6, read...............................................................150
131 get warp pin barrel vertical. Deprecated from version 1.6, read..................................................................151
132 get warp point shift. Deprecated from version 1.6, read ..........................................................................152
133 get warp rotation, read .............................................................................................................153
134 get warp scale horizontal., read....................................................................................................154
135 get warp scale vertical., read.......................................................................................................155
136 get warp shift horizontal, read......................................................................................................156
137 get warp shift vertical, read.........................................................................................................157
138 get warp status, read...............................................................................................................158
139 get warp X1. Deprecated from version 1.6, read..................................................................................159
2
R5905447 COMMAND CATALOG 08/06/2015

Table of contents
140 get warp X2. Deprecated from version 1.6, read..................................................................................160
141 get warp X3. Deprecated from version 1.6, read..................................................................................161
142 get warp X4. Deprecated from version 1.6, read..................................................................................162
143 get warp Y1. Deprecated from version 1.6, read..................................................................................163
144 get warp Y2. Deprecated from version 1.6, read..................................................................................164
145 get warp Y3. Deprecated from version 1.6, read..................................................................................165
146 get warp Y4. Deprecated from version 1.6, read..................................................................................166
147 get window selection, read .........................................................................................................167
148 increment blanking bottom, write ..................................................................................................168
149 increment blanking left, write.......................................................................................................169
150 increment blanking right, write .....................................................................................................170
151 increment blanking top, write.......................................................................................................171
152 increment brightness, write.........................................................................................................172
153 increment color balance b lue green, write. . .......................................................................................173
154 increment color balance red green, write .. . .......................................................................................174
155 increment contrast, write ...........................................................................................................175
156 increment dimming value, write....................................................................................................176
157 increment gamma, write............................................................................................................177
158 increment input black balanc e, write...............................................................................................178
159 increment input white balance, write...............................................................................................179
160 increment phase, write .............................................................................................................180
161 increment saturation, write .........................................................................................................181
162 increment sharpness, write . ........................................................................................................182
163 increment shutter, write.............................................................................................................183
164 increment tint, write.................................................................................................................184
165 input format hor izontal total po ssible, read . .......................................................................................185
166 phase possible, read ...............................................................................................................186
167 read auto picture alignment conﬁguration, read...................................................................................187
168 read barscale position, read........................................................................................................188
169 read customer id, read .............................................................................................................189
170 read date time, read................................................................................................................190
171 read DMX address, read ...........................................................................................................191
172 read DMX mode, read..............................................................................................................192
173 read DMX universe, read...........................................................................................................193
174 read gateway conﬁguration, read ..................................................................................................194
175 read global so ftware version, read.................................................................................................195
176 read image load method, read .....................................................................................................196
177 read infrared ports, read............................................................................................................197
178 read lamp CLO status, read........................................................................................................198
179 read lamp CLO target lumens, read ...............................................................................................199
180 read lamp runtime, read............................................................................................................200
181 read language, read ................................................................................................................201
182 read menu position, read . ..........................................................................................................202
183 read network conﬁguration, read...................................................................................................203
184 read panel s ize, read ...............................................................................................................204
185 read projector runtime, read........................................................................................................205
186 read projector serial number, read .................................................................................................206
187 read projector status, read .........................................................................................................207
188 read wiﬁ
conﬁguration, read........................................................................................................208
189 read wiﬁ key Mgmt, read ...........................................................................................................209
190 read wiﬁ scan, read.................................................................................................................210
191 read wiﬁ SSID, read ................................................................................................................211
192 read wiﬁ status, read ...............................................................................................................212
193 RS interface selection , read .......................................................................................................213
194 RS interface selection , write.......................................................................................................214
195 saturation possible, read ...........................................................................................................215
196 save current adjustm ents to a ﬁle, write ...........................................................................................216
197 save custom settings, write ........................................................................................................217
198 save image settings, write..........................................................................................................218
199 select main window as preﬁx, write................................................................................................219
200 se lect P IP window as pre ﬁx, write .................................................................................................220
201 select source 1 as preﬁ x, write.....................................................................................................221
202 select source 2 as preﬁ x, write.....................................................................................................222
203 select source 3 as preﬁ x, write.....................................................................................................223
204 select source 4 as preﬁ x, write.....................................................................................................224
205 select window, write ................................................................................................................225
206 set aspect ratio ﬁle, write...........................................................................................................226
207 set aspect ratio height, write .......................................................................................................227
208 set aspect ratio width, write ........................................................................................................228
209 set blanking bottom, write ..........................................................................................................229
210 set blanking left, write ..............................................................................................................230
211 set blanking right, write.............................................................................................................231
212 set blanking top , write..............................................................................................................232
213 set brightness, write ................................................................................................................233
214 set clamp delay , write..............................................................................................................234
215 set clamp width, write ..............................................................................................................235
R5905447 COMMAND CATALOG 08/06/2015
3

Table of contents
216 set color balance blue green ratio, write...........................................................................................236
217 set color balance red green ratio, write............................................................................................237
218 set color tempe rature, write ........................................................................................................238
219 set contrast, write...................................................................................................................239
220 set contrast enhancement, write . ..................................................................................................240
221 set dimming, write ..................................................................................................................241
222 set gamma, write ...................................................................................................................242
223 set input black balance, write ......................................................................................................243
224 set input white balance, write ......................................................................................................244
225 set intensity, write...................................................................................................................245
226 set lamp status, write...............................................................................................................246
227 set layout , write ....................................................................................................................247
228 set lcd backlight level, write ........................................................................................................248
229 set lcd time out, write...............................................................................................................249
230 set lens focus, write ................................................................................................................250
231 set lens shift, write..................................................................................................................251
232 set lens zoom, write ................................................................................................................252
233 set lock, write .......................................................................................................................253
234 set no signal color logo, write ......................................................................................................254
235 set no signal shutdown delay, write ................................................................................................255
236 set no signal shutdown status, write ...............................................................................................256
237 set output window in native resolution, write ......................................................................................257
238 set output window param eters, write ..............................................................................................258
239 set output window status, write . . ..................................................................................................259
240 set P7 TCGD blue X, write .........................................................................................................260
241 set P7 TCGD blue Y, write .........................................................................................................261
242 set P7 TCGD cyan X, write.........................................................................................................262
243 set P7 TCGD cyan Y, write.........................................................................................................263
244 set P7 TCGD green X, write ...................................................................................................... .264
245 set P7 TCGD green Y, write........................................................................................................265
246 set P7 T CGD magenta X, write .. ..................................................................................................266
247 set P7 T CG D magen ta Y, write . . ..................................................................................................267
248 set P7 TCGD red X , write..........................................................................................................268
249 set P7 TCGD red Y, write...........................................................................................................269
250 set P7 TCGD selection, write ......................................................................................................270
251 set P7 TCGD white X, write........................................................................................................271
252 set P7 TCGD white Y, write ........................................................................................................272
253 set P7 TCGD yellow X, write.......................................................................................................273
254 set P7 TCGD yellow Y, write .......................................................................................................274
255 set phase, write .....................................................................................................................275
256 set same lens settings status, write................................................................................................276
257 set saturation, write.................................................................................................................277
258 set scan/orientation conﬁguration, write ...........................................................................................278
259 set sharpness, write ................................................................................................................279
260 set shutter position, write...........................................................................................................280
261 set soft edge black level, write .....................................................................................................281
262 set soft edge size black level bottom, write. .......................................................................................282
263 set soft edge size black level left, write .... . .......................................................................................283
264 set soft edge size black level right, write .. . .......................................................................................284
265 set soft edge size black level top, write .. ... .......................................................................................285
266 set soft edge size bottom, write .. . .................................................................................................286
267 set soft edge size left, w rite ........................................................................................................287
268 set soft edge size right , w rite ......................................................................................................288
269 set soft edge size top , write .......................................................................................................289
270 set soft edge status, write . . ........................................................................................................290
271 set source , write ...................................................................................................................291
272 set source extended, write .........................................................................................................292
273 set test pattern by name, write.....................................................................................................294
274 set test pattern convergence, write ................................................................................................295
275 set test pattern convergence green blue, write....................................................................................296
276 set test pattern convergence red blue, write.......................................................................................297
277 set test pattern convergence red green blue, write................................................................................298
278 set tint, write ........................................................................................................................299
279 set warp axis position, write........................................................................................................300
280 set warp ﬁle, write ..................................................................................................................301
281 set warp grid size, write ............................................................................................................302
282 set warp hierarchic keystone in X direction, write .................................................................................303
283 set warp hierarchic keystone in Y direction, write .................................................................................304
284 set warp hierarchic linearity in X direction, write ..................................................................................305
285 set warp hierarchic linearity in Y direction, write ..................................................................................306
286 set warp hierarchic point shift, write ...............................................................................................307
287 set warp keystone horizontal. Deprecated from version 1.6, write ...............................................................308
288 set warp keystone vertical. Deprecated from version 1.6, write ..................................................................309
289 set warp line shift horizontal. Deprecated from version 1.6, write ................................................................310
290 set warp line shift vertical. Deprecated from version 1.6, write...................................................................311
291 set warp linearity horizontal. D eprecated from version 1.6, write.................................................................312
4
R5905447 COMMAND CATALOG 08/06/2015

Table of contents
292 set warp linearity vertical. Deprecated from version 1.6, w rite ...................................................................313
293 set warp pin barrel horizontal. Deprecated from version 1.6, write...............................................................314
294 set warp pin barrel vertical. Deprecated from version 1.6, write..................................................................315
295 set warp point shift. Deprecated from version 1.6, write..........................................................................316
296 set warp rotation, write .............................................................................................................317
297 set warp scale horizontal, write ....................................................................................................318
298 set warp scale vertical , write ......................................................................................................319
299 set warp shift horizontal, write......................................................................................................320
300 set warp shift vertical, write ........................................................................................................321
301 set warp status, write...............................................................................................................322
302 set warp X1. Deprecated from version 1.6, write..................................................................................323
303 set warp X2. Deprecated from version 1.6, write..................................................................................324
304 set warp X3. Deprecated from version 1.6, write..................................................................................325
305 set warp X4. Deprecated from version 1.6, write..................................................................................326
306 set warp Y1. Deprecated from version 1.6, write..................................................................................327
307 set warp Y2. Deprecated from version 1.6, write..................................................................................328
308 set warp Y3. Deprecated from version 1.6, write..................................................................................329
309 set warp Y4. Deprecated from version 1.6, write..................................................................................330
310 sharpness possible, read...........................................................................................................331
311 text off, write ........................................................................................................................332
312 text on, write ........................................................................................................................333
313 tint possible, read...................................................................................................................334
314 unfreeze, write......................................................................................................................335
315 warp ﬁle delete, write...............................................................................................................336
316 warp ﬁle rename, write .............................................................................................................337
317 write auto pic ture alignment conﬁguration, write ..................................................................................338
318 write barscale position, write.......................................................................................................339
319 write customer id, write.............................................................................................................340
320 write DMX address, write...........................................................................................................341
321 write DMX mode, write .............................................................................................................342
322 write DMX universe, write ..........................................................................................................343
323 write gateway conﬁguration, write..................................................................................................344
324 write infrared ports status, write....................................................................................................345
325 write lamp CLO status, write .......................................................................................................346
326 write lamp CLO target lumens, write...............................................................................................347
327 write language, w rite ...............................................................................................................348
328 write menu position, write ..........................................................................................................349
329 write network conﬁguration, write ..................................................................................................350
330 write projector off, write.............................................................................................................351
331 write projector on, write.............................................................................................................352
332 write wiﬁ conﬁguration, write .......................................................................................................353
333 write wiﬁ key mgmt, write...........................................................................................................354
334 write wiﬁ scan, write ................................................................................................................355
335 write wiﬁ SSID , write...............................................................................................................356
336 write wiﬁ status, write...............................................................................................................357
Index.................................................................................................................... 359
R5905447 COMMAND CATALOG 08/06/2015 5

Table of contents

6 R5905447 COMMAND CATALOG 08/06/2015

1. Introduction

1. INTRODUCTION

R5905447 COMMAND CATALOG 08/06/2015 7

1. Introduction

1.1 About this document

What is the purpose of this document?

This document is applicable for the B arco device m entioned on the front page of this document and can thus not be us ed on any

other equipment.

It ex plains how the commu nication with the device is accomplished. In order to be able t o communicate with this Barco device, the

Barco Projection Protocol, which is explained in detail in the following chapter, must be strictly followed.

Audience & prerequisites

This document is intended for software programmers and system integrators who want to be able to control

a Barco device from

their own application. This document expects a basic knowledge of binary math, networking technology and pr ogram ming.

8 R5905447 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2. THE BARCO PROJECTION PROTOCOL

Overview

• T h e Barco Projection Prot oco l expla in ed

• Ethernet communication

• RS232/RS422/USB -B communication

• The command representation in this manual

R5905447 COMMAND CATALOG 08/06/2015

9

2. The Barco Projection Protocol

2.1 The Barco Projection Protocol explained

Usage

The Barco Projection Protocol is used for the serial comm unication with a Barco device. This can be done by the following ways:

• Ethernet

• RS 232

• RS 422

•USB-B

Structure

Each command is built up from a start byte, device address, request/response, checksum and stop byte (image 2-1).

Start byte Device address

Request /

Response

Checksum Stop byte

1 byte (0xFE) 1 byte

1..n bytes

1 byte 1 byte (0xFF)

Image 2-1

Command structure

• St art byte: used to let the receiver know that a command will follow.

• Device ad dress: when m ultiple devices (maximum 256) are connected on the same physical connection, the device address

is used to specify the device (only for RS232 connections). In case of an Ethernet connection, this should be set to 0.

• Req uest/Response: the actual comm and bytes.

• Ch ecksum: used to detect if any errors occurred during transmission or reception of the command.

• Stop byte : used to let the receiver know that the end of a command has been reached.

How is the checksum calculated?

The checksum calculation is based on modular arithmetic:

Checksum =(Device address + Request/Response) modulo 0x100 (or 256)

Bytes conversion

Some bytes cannot be used in a comman d. If they do appear in the request/response or checksum, they must be converted. The

table below gives an ov erview.

Byte

After conv ersion

0x80 0x80 0x00

0xFE 0x80 0x7E

0xFF 0x80 0x7F

When a byte sequence from the after conversion column is received, that sequence must be converted to the

corresponding byte.

Characters and character strings

Each c haracter is sent as a byte, using the ANSI encoding method.

Character strings can be formatted in two ways:

• C-style format

An array of o ne or more characters which is terminated by a NULL character (0x00) . The position of the N ULL character

determines the length of the s tring.

Example: ’f ’ ’o’ ’o’ ’ ’ ’b’ ’a’ ’r’ 0x00

• Pascal-style format

An array of one or more characters which is started (the ﬁrst byte) with the length of the string. T herefore, Pascal-style strings

are limited to 255 characters.

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

ANSI

American National S tandards Institute

10 R5905447 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

Data words

A data word is a value which consists of m ultiple bytes. Data word s are formatted in big endian.

How to calculate the value of a data w ord?

Example of a 4-byte value: 0x01 0x20 0x50 0x30

=(0x01 * 256^3) + (0x20 * 256^2) + (0x50 * 256^ 1) + (0x30 * 256^0)

= (1 * 167 77216) + ( 32 * 65536) + (80 * 256) + (48 * 1)

= 16777216 + 2 097152 + 20480 + 48

= 18894896

msb

The most signiﬁcant byte, is the byte with the greatest weight (v alue).

lsb

The less signiﬁcant byte, is the byte with the smallest weight (value).

Big endian

When the ﬁrstbyteofadatawordisthemsb and the last byte is the lsb, the data word is in big endian.

Negative values

The two’s complement (2-complement) system is used for the representation of negative values.

Acknowledgement (ACK and NACK)

If a command is received, the receiver will check the validity and correctness of the command before pr ocessing it. If the co mm and

is understood, the receiver will ﬁrst acknowledge the command before doing the actual processing of the command. An ACK (AC-

Knowledge) is sent when these conditions are me t:

• The command format is correct

• The command and its parameters are valid

• The checksum is correct

When these conditions are not met, a NACK (No t ACKnowledge) is s ent.

ACK NACK

Byte 1 0x00 0x00

Byte 2 0x06 0x15

When the sender receives a NACK message, it is up the sender to decide what should happen next: retry sending the comm and or

discard the command.

Acknowledgements are not used in m ulticast co mmu nication.

Sending and receiving a c ommand

A command which is sent to the device will consist of a request. A c omm and which is received by the client will consist of a res ponse.

Requests must be sent in the B arco Projection Protocol format: each request needs to be structured in the correct way before it is

sent to the device. Responses are also sent in the Barco Pr ojection Protocol forma t.

Keep in mind that:

• For Ethernet communication, the Device add ress must be set t

o0.

• A correct Checksum m ust be generated for the c omm and.

After a request has been sent to the device, the acknowledgement of the request m ust be read ﬁrst. After the request has been

acknowledged, the response from the device (if applicable) can be expected.

Example 1: The client wants to know the type of the device. It sends the following command: projector type, read. T he device will

acknowledge (ACK) the r equest and then send the response whic h c ontains the dev ice type.

R5905447 COMMAND CATALOG 08/06/2015

11

2. The Barco Projection Protocol

Client

Device

(1) projector type, read - request

(2) ACK

(3) projector type, read - response

Image 2-2

Example 1

Example 2: The client sends an unknown comma nd. The devic e doesn’t recognize the command and sends a NACK .

Client

Device

(1) unknown command

(2) NACK

Image 2-3

Example 2

How to handle failing communication?

When a sender fails to s end a c omm and, or a receiver fails to return the expected response (ACK, NACK or response), some steps

must be followed to hand le this failing communication.

There are 2 possible f ailures:

• Co mm unication link problems: if the sending of the commands itself doesn’t work, it will be because the c omm unication is

broken (e.g. the receiver is disconnected from the network).

• An swer back problems: when commands can be sent out but no response is sent back, it means that the commu nication link

is O K 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, device down, … ), the user

must be notiﬁed and must be asked for his feedback. In most cases t

here will be a user intervention needed to correct t his problem

(connect the cable, reboot the hub, restart the device, …).

The actual implem entation of this should be described in the speciﬁcations of the application.

Handling answer b ack problems

Answer back problems sh ould 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 im plement some sim ple mechanisms to avoid problems when this occurs:

1. Timeout waiting: the application should wait for a l

imited amount of time for an answer (e.g. max 10 seconds ). This ensures

that the application can react when a command do esn’t get answered in time.

2. Retry waiting: if the timeout expires, one can retry waiting for the answer. B y doing this, the user has the opportunity to cancel

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

3. Retry sending: w hen a comm and doe s not ge t answered after the timout waiting and retry waiting, the command is cons idered

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

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

sending. If all of these steps fail, there might be a major problem with the receiver. In this case the user should be notiﬁed of these

problems so that he can check the status of the receiver.

12

R5905447 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2.2 Ethernet communication

Introduction

The communication follows a c lient/server model where the dev ice is the server. This means that the device responds on requests

that are sent by a client. The device will not s end out messages on its own initiative.

The communication is blocking which mean s that when a request is sent to the device, no other requests can be sent until the device

has responded on the ﬁr st reques t. The communication bloc ks for each request.

The connector used for the Ethernet ports are of rugged Neutrik EtherCon RJ45 type, which is compatible with

standard R J45 cable connector. Straight (most comm on) as well as cross linked network cables can be used.

10/100 Base-T — RJ45 port

Pin Description

1TXD+

2TXD-

3RXD+

4

—

5

—

6RXD-

7

—

8

—

Making connection w ith the de vice

The device is listening on TCP port 0xAAA0 (43680) for incoming connections. The IP address can be retrieved using the local user

interface or on the O SD menu of the de vice.

Device discovery

It is pos sible to discover all the devices on the network u sing a UDP br oadcast. A UDP broadcast on ly w orks on IP networks and

requires a special socket c onnection: the datagram connection.

Client

LAN

Device 1

Device 2

Device n

Image 2-4

To discover the devices, send a datagram packet to the broadcast address 255.255.255.255 on port 0xA001.

The packet should contain 1 byte: 0x3F, which represents the character ‘?’.

All the devices that support UDP broadcast discovery, will answer on the request by sending an array of (C-language) s trings on the

same socket. Each string represents a key-value pair with speciﬁc information about the device that has been discovered.

R5905447 COMMAND CATALOG 08/06/2015

13

2. The Barco Projection Protocol

Typically, the following s trings will be returned:

• h ostname=value; the hostname of the device

• ip-address=value; the IP addr ess of the device

• m ac-address=value; the M AC address of the NIC on the device

• type=value; the device type (not for D P90/DP100 projectors)

Remarks:

• The broadcast does no t follow the typical Barco Projection P rotocol formatting: the request is just one byte (not ma rked up

as Barco Projection Protocol command) a nd the de vices a nswer back without s ending an A CK and without formatting their

response in the Barco P rojection Protocol format.

• The size of the array is undetermined, but in most cases it w ill contain 4 s trings. However, this is open to future expansion, s o

more strings can be added later.

• The strings normally appear in this order: hostname, ip-address, mac-address and type, but this cannot be guaranteed.

The used broadcast is a limited bro adcast. This means that the b roadcast message is transmitted to all NIC’s

which are on the same IP seg men t as the client. Th is type of broadcast is not forwarded by routers so it will

not detec t devices which are o n another seg me nt.

NIC

Network Interface Card

14 R5905447 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2.3 RS232/RS422/USB-B communication

RS232

An Electronic Industries Assoc iation (EIA) serial digital interface standard specifying the characteristics of the commu-

nication path between tw o devices using either D-SUB 9 pins or D-SUB 25 pins connectors. This standard is used for

relatively s hort-range communications and do es no t specify balanced control lines. RS-232 is a se rial control standard

with a set number of conductors, data rate, word length and type of connector to be used. The standard speciﬁes com-

ponent connection standards with regard to computer interface. It is also called RS-232-C, which is t

he third version

of the RS-232 standard, and is functionally identical to the CCITT V.24 standard. Logical ’0’ is > + 3V, Logical ’1’ is < -

3V. The ran ge between -3V and +3V is the transition zone.

RS422

An E IA serial digital interface standard that s peciﬁes the electrical characteristics of balanced (differential) voltage,

digital interface circuits. This standard is usable over longer distances than RS-232. T his signal governs the asyn-

chronous transmission of computer data at speeds of up to 920,000 bits per second. It is also used as the serial port

standard for Macintosh computers. When the difference between the 2 lines is < - 0.2V that equals with a logical ’0’.

When the difference is > +0.2V that equals to a logical ’1’..

Settings

Baud rate:Deﬁn es the speed of the data transfer. The baud rate can be set using the local user interface on the dev ice. Consult

the user manual of the devic e for more detailed information.

Data bits: Eight (8) data bits a re used for each character of the d ata transfer.

Parity: T here is no parity bit used to perform error checking.

Stop bit: O ne (1) stop bit is used to d eﬁne the end of a character.

Hardware

RS232/422 input (Sub-D) port

Pin Description

1

DCD : Data Carrier Detect

2RXD-:ReceiveData

3 TXD- : Transmitted Data

4

DTR : Data Terminal Ready [RS232]

TXD+ : Transmitted Data [RS422]

5

GND : Ground

6

DSR : Data Set Ready [RS232]

RXD+ : R eceived Data [RS422]

7

— (not connected) —

8 CTS : Clear To Send

9 RI : Ring Indicator

R5905447 COMMAND CATALOG 08/06/2015

15

2. The Barco Projection Protocol

2.4 The command representation in this manual

About the command representation in this manual

• Titl e : T he title of a command is built up from its function (e.g. network se ttings), followed by its type (e.g. read).

• Description: A general description of the comm and is given in the A bout this comm and section.

• Req uest/Response table: Each row in the request/response table re presents a dataﬁeld. A dataﬁeld contains 1 or more values.

a) Pos: The position o f the dataﬁeld. W hen the siz e of the dataﬁeld is greater than 1, the dataﬁeld will take more than 1 position.

b) Size: The number of values the dataﬁeld must contain. This c an be different from the total number of av ailable values,

dependent on the value groups.

c) Name: The name of the d ataﬁeld.

d) Description: The desc ription of the dataﬁeld.

e) Content: T he value(s) of the d ataﬁeld. This column consists of the value itself, and a value description. Every value is

displayed in a separate row. A dataﬁeld can have different value groups.

Different value groups can b e distinguished as follows:

- If consecutive rows have different background colors, the values belong to another group.

- If they have the same b ackground color, the values belong to the same group.

Only 1 value gro up per dataﬁeld may be choosen to be used in the command. All the values of a value group m ust appear

together and in the same order.

Example: the dataﬁeld below contains 2 IP addresses. Only 1 of the 2 IP-addresses may be choosen in the command. The va lues

of the IP-addresses must stay in the same order.

Pos Size Name Description Content

192

IP-address 1, value 1 (dec)

168

IP-address 1, value 2 (dec)

1

IP-address 1, value 3 (dec)

1

IP-address 1, value 4 (dec)

192

IP-address 2, value 1 (dec)

168

IP-address 2, value 2 (dec)

1

IP-address 2, value 3 (dec)

0-3 4 IP-address This is the IP-address dataﬁeld.

2

IP-address 2, value 4 (dec)

Tabl e 2 - 5

Example

16 R5905447 COMMAND CATALOG 08/06/2015

Page is loading ...

Barco HDX-W12, HDX-W14, HDX-W18, HDX-W20 FLEX User guide

Related papers

Other documents