Barco HDF-W30 FLEX 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 HD F W26 /W 22

R5905448/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 p rovides this manual ’as is’ w ithout 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 m ay make improvements and/or cha nges to the product(s) and/or the

program(s) described in this publication at any time without notice.

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 name s mentioned in this m anual m ay 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 adv ertising for

the products or their manufacturers.

Table of contents
TABLE OF CON TENTS
Introduction ......................................................................................................... 7
1 About this docu ment.................................................................................................................. 8
The Barco Projection Protocol................................................................................... 9
1 The Barco Projection Protocol explained...........................................................................................10
2 Ethernet communication ............................................................................................................13
3 RS232/RS422/USB-B communication..............................................................................................15
4 The comm and representation in this ma nual ....................................................................................... 16
Commands .........................................................................................................17
1 3D dark time adjustment, read......................................................................................................19
2 3D dark time adjustment, write......................................................................................................20
3 3D D ouble/Tripple F lash 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 b alance b lue green ratio, write....................................................................................41
24 decrement color b alance red green ratio, write.....................................................................................42
25 decrement contrast, write . ..........................................................................................................43
26 decrement dimming value, write . . ..................................................................................................44
27 decrement gamm a, 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, write ................................................................................................................. 52
35 freeze, write..........................................................................................................................53
36 function read electronic convergence, read ........................................................................................ 54
37 function read input balance pattern status, read ...................................................................................55
38 function write elec tronic 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 temperature, read .........................................................................................................70
53 get common address, read..........................................................................................................71
54 get contrast, read....................................................................................................................72
55 get contrast enhancement, read . ................................................................................................... 73
56 get dimming, read ................................................................................................................... 74
57 get ext contrast, read................................................................................................................ 75
58 get ext contrast enhancement , read ...............................................................................................76
59 get ext gamm a, read ................................................................................................................77
60 get ext phase, r ead ..................................................................................................................78
61 get ext sharpness, read .............................................................................................................79
62 get freeze status, read............................................................................................................... 80
63 get gamma, read ....................................................................................................................81
R5905448 COMMAND CATALOG 08/06/2015
1

Table of contents
64 get gamma (text value), read........................................................................................................82
65 get input black b a lance, read ....................................................................................................... 83
66 get input white ba lance, 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 parameters, 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 T CGD magenta X, read ... .................................................................................................104
87 get P7 T CGD 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 s oft edge size top, read ........................................................................................................128
111 get soft edge status, read . . ........................................................................................................129
112 get source, read ....................................................................................................................130
113 get s ource 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. D eprecated 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
R5905448 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, w rite .. . .......................................................................................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 horizontal 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 m ode, rea d ..............................................................................................................192
173 read DMX universe, read...........................................................................................................193
174 read gateway conﬁguration, read ..................................................................................................194
175 read global software 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 language, read ................................................................................................................200
181 read menu position, read . ..........................................................................................................201
182 read network conﬁguration, read...................................................................................................202
183 read panel size, read ...............................................................................................................203
184 read projector runtime, read........................................................................................................204
185 read projector serial number, read .................................................................................................205
186 read projector status, read .........................................................................................................206
187 read wiﬁ con ﬁ
guration, read........................................................................................................207
188 read wiﬁ key Mgmt, read ...........................................................................................................208
189 read wiﬁ scan, read.................................................................................................................209
190 read wiﬁ SSID, read ................................................................................................................210
191 read wiﬁ status, read ...............................................................................................................211
192 RS interface selection , read .......................................................................................................212
193 RS interface selection , write.......................................................................................................213
194 saturation possible, read ...........................................................................................................214
195 save current adjustments to a ﬁle, write ...........................................................................................215
196 save custom settings, write ........................................................................................................216
197 save image settings, write..........................................................................................................217
198 select m a in window as pre ﬁx, write................................................................................................218
199 select PIP wind o w as preﬁx, write .................................................................................................219
200 select s ource 1 as preﬁx, write.....................................................................................................220
201 select s ource 2 as preﬁx, write.....................................................................................................221
202 select s ource 3 as preﬁx, write.....................................................................................................222
203 select s ource 4 as preﬁx, write.....................................................................................................223
204 select window, write ................................................................................................................224
205 set aspect ratio ﬁle, write...........................................................................................................225
206 set aspect ratio height, write .......................................................................................................226
207 set aspect ratio width, write ........................................................................................................227
208 set blanking bottom, write ..........................................................................................................228
209 set blanking left, write ..............................................................................................................229
210 set blanking right, write.............................................................................................................230
211 set blanking top , write..............................................................................................................231
212 set brightness, write ................................................................................................................232
213 set clamp delay , write..............................................................................................................233
214 set clamp width, write ..............................................................................................................234
215 set color balance blue green ratio, write...........................................................................................235
R5905448 COMMAND CATALOG 08/06/2015
3

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

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

Table of contents

6 R5905448 COMMAND CATALOG 08/06/2015

1. Introduction

1. INTRODUCTION

R5905448 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 mentioned on the f ront page of this document and can thus not be used on any

other equipm ent.

It ex plains how the commu nication with the device is accomplished. In order to be able to communicate with this Barco dev ice, 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 programm ers and system integrators wh o want to be able to control

a Barco device from

their own application. This document ex pects a basic knowledge of binary m ath, networking technology and program ming.

8 R5905448 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2. THE BARCO PROJECTION PROTOCOL

Overview

• T h e Barco P ro ject io n Pro t oco l expla in ed

• Ethernet communication

• RS232/RS422/USB -B communication

• The command representation in this manu al

R5905448 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 communication with a B arco device. T his 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 k now that a comman d will follow.

• Device address: when multiple devices (m aximum 25 6) are connected on t he same physical conn ection, the device address

is used to specify the device (only for RS232 connections). In case of an Ethernet conne ction, this s hould be set to 0.

• Req uest/Response: the actual command bytes.

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

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

How is the checksum calculated?

The checksum calculation is base d on mod ular 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 g ives an overview.

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 m us t be converted to the

corresponding byte.

Characters and character strings

Each character is sent as a byte, us ing the ANSI encoding method.

Character strings can b e 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 o f 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. Therefore, Pascal-style s trings

are limited to 255 characters.

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

ANSI

American National Standards Institute

10 R5905448 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

Data words

A data wor d is a value which consists of m ultiple bytes. Data words 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 * 16777216) + (32 * 65536) + (80 * 256) + (48 * 1)

= 16 777216 + 2097152 + 20480 + 48

= 18894896

msb

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

lsb

The less signiﬁcant byte, is the byte with the s mallest weight (v alue).

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-com plement) system is used for the representation of negative values.

Acknowledgement (ACK and NACK)

If a c omm and is received, the receiver will check the v alidity and correctness of the comm and before process ing it. If the comm and

is understood, the receiver w ill ﬁrst ack nowledge the com mand before doing the actual p rocessing of the command. An AC K (AC -

Knowledge) is sent when these conditions are me t:

• The command format is correct

• The command and its parame ters are valid

• The checksum is correct

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

ACK NACK

Byte 1 0x00 0x00

Byte 2 0x06 0x15

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

discard the com man d.

Acknowledgements are not used in m ulticast commu 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 mus t be sent in the Barco Projection Pr otocol 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 Projection P rotocol format.

Keep in mind that:

• For Ethernet c omm unication, the Device ad dress must be set t

o0.

• A correct Checksu m must be generated for the c omm and.

After a request has been sent to the device, the acknowledgement of the request must be read ﬁrst. A fter 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 devic e. It send s the following command: projector type, read. The device will

acknowledge (ACK) the request and then send the response which contains the device type.

R5905448 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 device doesn’t recognize the comm and 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 send a command, or a receiver fails to return the expected response (ACK, NACK or response), some steps

must be followed to handle this failing commun ication.

There are 2 possible failures:

• 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 m eans that the communication link

is OK but the receiver is unable to answer back .

Each type of failure needs another way of handling.

Handling com mu nication link problems

As communica tion link problems will most likely have a physical reason (cable disconnected, hub down, device dow n, … ), the user

must be notiﬁed and mus t be as ked for his feedback. In most cases t

here will be a user intervention needed to correct this 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 an swer back problems

Answer back problem s sh ould be addressed in another way. When a receiver fails to answer back it might be that it is currently too

busy to ans wer back. T he application software should implement s ome simple m echanism s to avoid problem s when this occurs:

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

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

that the app lication can react when a comm and do esn’t get answere d in time.

2. Retry waiting: if the timeout expires, one can retry waiting for the answer. By do ing this, the user has the opportunity to ca ncel

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

3. Retry sending: when a comm and doe s not get answered after the timout waiting and retry waiting, the comm and is considered

to be lost in action and the ap plication 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 m ajor problem with the receiver. In this case the user should be notiﬁed o f these

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

12

R5905448 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2.2 Ethernet communication

Introduction

The comm unication follows a client/server model where the dev ice is the server. This me ans that the device responds on requests

that are s ent by a client. The dev ice will not send out me ssages 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 request. The communication blocks 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 c ross 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 0xAAA 0 (43680) for incoming co nnections. The IP add ress can be retrieved using the local u ser

interface or on the OSD menu of the device.

Device discovery

It is possible to discover all the devices on the network using a UDP broadcast. A UDP broadcast on ly wor ks on IP networks and

requires a special socket connection: the datagram connection.

Client

LAN

Device 1

Device 2

Device n

Image 2-4

To disc over the d evices, 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) strings on the

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

R5905448 COMMAND CATALOG 08/06/2015

13

2. The Barco Projection Protocol

Typically, the following strings will be returned:

• h ostname=value; the hostname of the dev ice

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

• m ac-address=value; the MAC 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 marked 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 Projection Protocol format.

• The size of the array is undeterm ined, but in m ost c ases it will contain 4 strings. H owever, this is open to future expansion, so

more strings can be added later.

• The strings normally appe ar in this order: hostname, ip-address, mac-address and type, but this cannot b e guaranteed.

The used broadcast is a limited bro adcast. This means that the broadcast messag e is transmitted to all NIC’s

which a re on the same IP seg men t as the client. This type of broadcast is n ot forwarded by ro uters so it will

not detect d evices w hich are on another segment.

NIC

Network Interface Card

14 R5905448 COMMAND CATALOG 08/06/2015

2. The Barco Projection Protocol

2.3 RS232/RS422/USB-B communication

RS232

An Electronic Industries Association (EIA) serial digital interface standard specifying the characteristics of the comm u-

nication path between two devices using either D-SUB 9 pins or D-SUB 25 pins connectors. This s tandard is used for

relatively s hort-range communications and do es no t specify balanced control lines. RS-232 is a serial 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 c alled 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 range 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 ov er longer distances than RS-232. T his signal governs the asy n-

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 Mac intosh computers. W hen 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ﬁnes the speed of the data transfer. The baud rate can be set using the local user interface on the device. Consult

the user m anual of the device for more detailed information.

Data bits: Eight ( 8) data bits are used for eac h character of the data transfer.

Parity: T here is no parity b it used to perform error c hecking.

Stop bit: O ne (1) stop bit is used to deﬁ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 S et Ready [RS232]

RXD+ : R eceived Data [RS422]

7

— (not connected) —

8 CTS : C lear To Send

9 RI : Ring Indicator

R5905448 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 comm and is built up from its function (e.g. netw ork s ettings), followed by its type (e.g. read).

• Description: A general desc ription of the command is given in the A bout this command section.

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

a) Pos: The position of the dataﬁ eld. W hen the size of the dataﬁeld is greater than 1, the dataﬁeld will take m ore than 1 position.

b) Size: The num ber of values the dataﬁ eld must contain. This can be different from the total num ber of available values,

dependent on the value groups.

c) Name: The name of th e dataﬁeld.

d) Description: The description of the dataﬁeld.

e) Content: The value(s) of the dataﬁeld. This column c onsists 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 be distinguished as follows:

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

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

Only 1 v alue gro up per dataﬁe ld m ay be choosen to be used in the comm and. All the values of a value group m ust appe ar

together and in the sam e order.

Example: the dataﬁeld below contains 2 IP addresses. Only 1 of t he 2 IP-addresses m ay be choosen in the comm and. The values

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 R5905448 COMMAND CATALOG 08/06/2015

Page is loading ...

Barco HDF-W30 FLEX User guide

This manual is also suitable for

Barco HDF-W30 FLEX User guide

Related papers

Other documents