Barco PGWU-61B 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 PGW U-6 1B

R5905746/03

07/05/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 ......................................................................................................... 3
1 About this docu ment.................................................................................................................. 4
The Barco Projection Protocol................................................................................... 5
1 The Barco Projection Protocol explained............................................................................................ 6
2 Ethernet communication ............................................................................................................. 9
3 RS232/RS422/USB-B communication.............................................................................................. 11
4 The comm and representation in this ma nual ....................................................................................... 12
Commands .........................................................................................................13
1 AV mute, read........................................................................................................................ 15
2 AV mute, write .......................................................................................................................16
3 decrement noise reduction, write . ..................................................................................................17
4 get about info, read ..................................................................................................................18
5 get advanced control info, read ..................................................................................................... 20
6 get aspect ratio ﬁle, read ............................................................................................................21
7 get auto image adjust, read .........................................................................................................22
8 get auto power off, read .............................................................................................................23
9 get auto power on, read .............................................................................................................24
10 get auto source, read................................................................................................................ 25
11 get brightness, read .................................................................................................................26
12 get ceiling mode, read ...............................................................................................................27
13 get color temperature, read .........................................................................................................28
14 get color wheel index, re ad..........................................................................................................29
15 get contrast, read....................................................................................................................30
16 get diagnostics info, read. . . .........................................................................................................31
17 get dimming, read ................................................................................................................... 32
18 get display m ode, read .............................................................................................................. 33
19 get format, read......................................................................................................................34
20 get freeze, read......................................................................................................................35
21 get gamma, read ....................................................................................................................36
22 get general info, read ................................................................................................................37
23 get geometry adjust info, read ......................................................................................................38
24 get H start, read .....................................................................................................................39
25 get high altitude, read ............................................................................................................... 40
26 get image setting info, read .........................................................................................................41
27 get input black balance, read .......................................................................................................42
28 get input selection, read .............................................................................................................43
29 get input white ba lance, read ....................................................................................................... 44
30 get internal pattern, read ............................................................................................................ 45
31 get IP conﬁguration info, read.......................................................................................................46
32 get lamp max runtime, read .........................................................................................................47
33 get lamp on, read.................................................................................................................... 48
34 get lamp runtime, read ..............................................................................................................49
35 get lamp status, read ................................................................................................................50
36 get language, read. .................................................................................................................. 51
37 get main zoom, read.................................................................................................................52
38 get menu position, read .............................................................................................................53
39 get no signal color logo, read .......................................................................................................54
40 get noise reduction, read . . ..........................................................................................................55
41 get phase, read ......................................................................................................................56
42 get PIP enable, read ................................................................................................................. 57
43 get PIP position, write ............................................................................................................... 58
44 get PIP select, read.................................................................................................................. 59
45 get PIP size, read.................................................................................................................... 60
46 get rear projection mode , read ......................................................................................................61
47 get resolution, read.................................................................................................................. 62
48 get saturation, read..................................................................................................................63
49 get serial number, read..............................................................................................................64
50 get sharpness, read
.................................................................................................................65
51 get tint, read .........................................................................................................................66
52 get V start, read......................................................................................................................67
53 get versions, read ...................................................................................................................68
54 get warp keystone vertical, read ....................................................................................................69
55 increment noise reduction, write . ...................................................................................................70
56 reset settings to factory defaults, write.............................................................................................. 71
57 set aspect r atio ﬁle, write............................................................................................................72
58 set auto image adjust, write .........................................................................................................73
59 set auto power off, write.............................................................................................................74
60 set auto power on, write.............................................................................................................75
61 set auto source, write................................................................................................................ 76
62 set brightness, write .................................................................................................................77
63 set ceiling mode, write............................................................................................................... 78
R5905746 COMMAND CATALOG 07/05/2015
1

Table of contents
64 set color temperature, write .........................................................................................................79
65 set color w heel index, write .........................................................................................................80
66 set contrast, write....................................................................................................................81
67 set dimming, write ................................................................................................................... 82
68 set display mode, wr ite ..............................................................................................................83
69 set format, write......................................................................................................................84
70 set freeze, write...................................................................................................................... 85
71 set gamma, write ....................................................................................................................86
72 set H start, write ..................................................................................................................... 87
73 set high altitude, write ...............................................................................................................88
74 set input black balance, wr ite .......................................................................................................89
75 set input selection, write.............................................................................................................90
76 set input white balance, write .......................................................................................................91
77 set internal pattern, write ............................................................................................................92
78 set language, write .................................................................................................................. 93
79 set lens center, write.................................................................................................................94
80 set lens focus, write ................................................................................................................. 95
81 set lens shift, write................................................................................................................... 96
82 set lens zoom, wr ite .................................................................................................................97
83 set main z oom, write ................................................................................................................98
84 set menu position, write .............................................................................................................99
85 set no signal color logo, write ......................................................................................................100
86 set noise reduction, write. . . ........................................................................................................101
87 set phase, write.....................................................................................................................102
88 set PIP e nable, write ...............................................................................................................103
89 set PIP position, write ..............................................................................................................104
90 set PIP select, write ................................................................................................................105
91 set PIP size, write...................................................................................................................106
92 set projector power on/off, write....................................................................................................107
93 set rear projection mode, write .....................................................................................................108
94 set saturation, write.................................................................................................................109
95 set sharpness, write ................................................................................................................110
96 set TCP/IP, write....................................................................................................................111
97 set tint, write ........................................................................................................................112
98 set V start, write ....................................................................................................................113
99 set warp keystone vertical, write ...................................................................................................114
Index.................................................................................................................... 115
R5905746 COMMAND CATALOG 07/05/2015

1. Introduction

1. INTRODUCTION

R5905746 COMMAND CATALOG 07/05/2015 3

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.

4 R5905746 COMMAND CATALOG 07/05/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

R5905746 COMMAND CATALOG 07/05/2015

5

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

6 R5905746 COMMAND CATALOG 07/05/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.

R5905746 COMMAND CATALOG 07/05/2015

7

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.

8

R5905746 COMMAND CATALOG 07/05/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.

R5905746 COMMAND CATALOG 07/05/2015

9

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

10 R5905746 COMMAND CATALOG 07/05/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

R5905746 COMMAND CATALOG 07/05/2015

11

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

12 R5905746 COMMAND CATALOG 07/05/2015

3. Commands

3. COMMANDS

R5905746 COMMAND CATALOG 07/05/2015 13

3. Commands

14 R5905746 COMMAND CATALOG 07/05/2015

3. Commands

3.1 AV mute, read

About this comma nd

This c omm and reads the AV mute status. W hen AV mu te is set to O n, the screen will be black.

Request

Pos Size Name Description Content

0 1 get adj byte value known as "get adj"

0x21

get adj (hex)

1 1 AV mute

0xa9

Response

Pos

Size

Name Description

Content

0 1 get adj byte value known as "get adj"

0x21

get adj (hex)

1 1 AV mute

0xa9

0x00

Off (hex)

2 1 AV mute status

0x01

On (hex)

R5905746 COMMAND CATALOG 07/05/2015 15

3. Commands

3.2 AV mute, write

About this comma nd

This com mand will turn the screen black when AV mute is s et t o On. W hen AV mute is set to O ff, the screen will turn back to the

original im age.

Request

Pos

Size

Name Description

Content

0 1 set adj byte value known as "set adj"

0x20

set adj (hex)

1 1 AV mute

0xa9

0x00

Off (hex)

2 1 AV mute status

0x01

On (hex)

16 R5905746 COMMAND CATALOG 07/05/2015

Page is loading ...

Barco PGWU-61B User guide

Related papers

Other documents