VideoReQuest Series
Communication Protocol Guide
Version 1.4.0
IR, RS-232, and Ethernet Interface Guide
Communication Protocol Guide v1.4.0 - 5/11/06
Table of Contents
Table of Contents..............................................................................................................I
Revision History ...............................................................................................................II
Introduction......................................................................................................................1
Conventions Used ........................................................................................................1
Part 1: IR Control..............................................................................................................2
Rear IR Pinout ..............................................................................................................2
Learning IR Codes into Other Systems.........................................................................2
List of Basic IR Commands ..........................................................................................3
List of Advanced IR Commands ...................................................................................3
Part 2: Serial/Ethernet Protocol ........................................................................................5
Rear Serial Port Pinout..................................................................................................5
Serial Cable................................................................................................................... 5
COM Settings...............................................................................................................5
Using Ethernet .............................................................................................................6
Communicating with the VideoReQuest.......................................................................6
Sending Commands .....................................................................................................6
Breakdown of Each Command Portion: ........................................................................6
Initializing the Connection.............................................................................................8
Calculating Checksum ..................................................................................................8
Data Commands:..........................................................................................................9
Examples of Strings to Send:...................................................................................... 11
Calculating the 4 Byte Number Argument: ................................................................. 11
Handling Feedback ..................................................................................................... 12
Appendix A – Sample Setups ........................................................................................ A1
Appendix B – The GUI ................................................................................................... B1
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-I-
Communication Protocol Guide v1.4.0 - 5/11/06
Revision History
Revision Number
1.1.2
1.1.10
1.1.15
1.4.0
Changes
Initial Version
Added DVD-MENU
Updated to reflect changes in FW 1.1.10
Added CoverArt, Aspect Ratio, and DVD Lookup Progress feedback
Updated graphics and fonts
Added additional Serial/IP Data commands and discrete IR
commands.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- II -
Communication Protocol Guide v1.4.0 - 5/11/06
Introduction
This document describes how to communicate with the VideoReQuest via IR, Serial, or Ethernet. For
Serial and Ethernet, we will also explain how data feedback is formatted. Serial and Ethernet protocol is
identical in terms of commands sent to the VideoReQuest and feedback received from the VideoReQuest.
For the purpose of simplicity, Serial and Ethernet communication will be referred to as Serial in this
document.
Conventions Used
1)
Throughout this document, we will use the lowercase ‘H’ (h) notation when we wish to denote a
Hexadecimal number. Multi-Byte strings will be written as “XXh, YYh, …”.
Examples:
• The Hex number 39 will be written as 39h, which is 57 in ASCII, or the number 9
• The Hex string 4AC5 will be written as 4Ah, C5h.
2)
VRQ and VideoReQuest will be used synonymously to describe the VideoReQuest line of products.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-1-
Communication Protocol Guide v1.4.0 - 5/11/06
Part 1: IR Control
There are 2 ways to control the VideoReQuest via IR. The simplest method is to use a handheld remote
aimed at the IR receiver on the front of the unit. For more advanced installations, there is a 1/8th inch mini
jack on the rear of the unit for integration with IR based control systems. No matter which method you
choose, this portion of the document will describe the commands available.
Rear IR Pinout
The rear IR jack is designed for a 2 conductor 1/8th inch mini plug from a powered connecting block or
control system. You CAN NOT plug a dinkylink directly into the back of the VideoReQuest.
2 Conductor Pinout
Tip
Signal
Ring
Ground
Sleeve
Not Connected
Learning IR Codes into Other Systems
For any advanced commands (2 button key combinations), the proper method for teaching the system the
VideoReQuest IR codes is as follows:
1. Aim the VideoReQuest Remote AWAY from the learner
2. Press AND HOLD the Alt or Shift button (depending on command)
3. Aim the remote AT the learner
4. Press the second button
5. Release BOTH buttons
Most advanced commands are written on the IR remote in GREEN text. To access these commands,
press and hold the Alt button prior to pressing the desired command button. Other advanced commands
not written on the remote are listed in the table below.
All the basic and advanced IR commands are also available as a Pronto compatible CCF file from the
ReQuest website. This file is compatible with many IR learning systems for easy integration.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-2-
Communication Protocol Guide v1.4.0 - 5/11/06
List of Basic IR Commands
Action
Edit
Eject
Power
1-0
DVD Menu
VRQ Menu
DVD
Description
Edit the currently highlighted movie
Eject the currently highlighted movie
Toggles Power On/Off
Number in edit, Jump to first character with number in browse
Jumps to the menu of the currently active DVD
Jumps to the VRQ Configuration Menu
Switches control to active DVD changer (also switches video if
applicable)
Switches control to VRQ (also switches video if applicable)
Acts as “Play” in DVD mode
Acts as “Play Movie” for currently highlighted movie in VRQ mode
Toggles Pause of current DVD
Stops the current DVD and returns to VRQ
Moves cursor up in VRQ Mode and in DVD menus
Moves cursor down in VRQ Mode and in DVD menus
Acts as “Cursor Left” in VRQ Mode & DVD Menu
Acts as “Rewind” in DVD Playback
Acts as “Cursor Right” in VRQ Mode & DVD Menu
Acts as “Fast Forward” in DVD Playback
Acts as “Enter” in VRQ Browse, VRQ Menu, & DVD Menu.
Acts as “Play Movie” in VRQ Movie Info
Jumps up 6 lines in VRQ Browse
Jumps down 6 lines in VRQ Browse
Skips to the next Chapter in DVD playback
Goes to the start of the current chapter, hit twice quickly to go to
previous chapter
Jumps to the All Movies list
Jumps to the Genres List
Jumps to the Ratings List
Currently not implemented
Jumps to the Movie Info of the currently playing DVD
Letter entering for edits, jump to movie title starting with letter
pressed
Press Shift and letter for capital letters
Space used for editing
Hold for Advanced Commands
Hold for Advanced Commands
VRQ
Play
Pause
Stop
Up
Down
Left
Right
Enter
Page Up
Page Down
Chapter +
Chapter All Discs
Genres
Ratings
Search
Now Playing
a-z
A-Z
Space
Shift
Alt
List of Advanced IR Commands
Action
Refresh DVD Details
Change View/Theme
Discrete Power On
Discrete Power Off
Home
Directors
Actors
Recently Played
Recently Added
Changers
Now Playing Chapters
DVD Cursor Left
DVD Cursor Right
DVD Cursor Up
DVD Cursor Down
DVD Rewind
DVD Fast Forward
Description
Performs a lookup on the current DVD (only works in Player mode)
Changes the theme of the TV/VGA interface
Power On
Power Off
Jumps to the top of the main browser screen
Jumps to the Directors List
Jumps to the Actors List
Jumps to the Recently Play List
Jumps to the Recently Added List
Jumps to Browse by Changer
Jumps to the Now Playing Movie’s Chapter List
Discrete DVD cursor left
Discrete DVD cursor right
Discrete DVD cursor up
Discrete DVD cursor down
Discrete rewind on active DVD Changer
Discrete fast forward on active DVD Changer
Alt/Shift
Shift
Alt
Alt
Shift
Alt
Shift
Shift
Alt
Alt
Alt
Shift
Shift
Shift
Shift
Shift
Shift
Shift
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-3-
2nd Button
EDIT
D
Power
Power
VRQ
Ratings
Genres
Now Playing
Ratings
All Discs
Now Playing
Left
Right
Up
Down
DVD Menu
VRQ Menu
Communication Protocol Guide v1.4.0 - 5/11/06
DVD Play
DVD Pause
DVD Audio
DVD Subtitle
DVD Angle
Video Switch Channel 1
Video Switch Channel 2
Video Switch Channel 3
Video Switch Channel 4
TVMode NTSC
TVMode SDTV
TVMode 720p
TVMode Pal
TVMode Disable
Discrete play on active DVD Changer
Discrete pause on active DVD Changer
Changes the audio channel of the active DVD changer
Changes the subtitle mode of the active DVD changer
Changers the angle of the active DVD changer
Change the connected video switch to channel 1 (Default VRQ)
Change the connected video switch to channel 2
Change the connected video switch to channel 3
Change the connected video switch to channel 4
Change the TV Mode to composite/S-Video
Changes the TV Mode to 480i composite/component
Changes the TV Mode to 720p component only
Changes the TV Mode to PAL composite/component
Disables TV out (VGA only)
Shift
Shift
Alt
Alt
Alt
Shift
Shift
Shift
Shift
Alt
Alt
Alt
Alt
Alt
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-4-
Play
Pause
A
B
C
1
2
3
4
1
2
3
4
0
Communication Protocol Guide v1.4.0 - 5/11/06
Part 2: Serial/Ethernet Protocol
This section describes how to communicate with the VideoReQuest via Ethernet or Serial. Ethernet and
Serial protocols are identical in terms of sending commands and receiving feedback. For simplicity, we will
refer to Ethernet and Serial communication as Serial, though it can be used for Ethernet as well.
Rear Serial Port Pinout
Pin
1
2
3
4
5
Purpose
Not Used
Receive
Transmit
Not Used
Pin
6
7
8
9
Purpose
Not Used
RTS
CTS
Not Used
Ground
Serial Cable
Cable Type
FemaleÆFemale NULL MODEM cable
Usage
VRQÆControl System
VRQÆDVD Changer
VRQÆVideo Switcher
MaleÆFemale STRAIGHT cable
VRQ
Side
2
3
5
7
8
Control System/ DVD
Changer
3
2
5
8
7
Video
Switcher
2
3
5
7
8
COM Settings
The serial port NOT used for changer control is used for integrating the VideoReQuest with a control
system. This port supports four possible configurations (see table below). These settings can be found by
going to MenuÆConfigurationÆControl Port on the VideoReQuest.
Parameter
Baud
Data Bits
Stop Bits
Parity
Flow Control
Value
9600
8
1
None
None
Value
19200
8
1
None
HW
Value
38400
8
1
None
HW
Value
57600
8
1
None
HW
default
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-5-
Communication Protocol Guide v1.4.0 - 5/11/06
Using Ethernet
The default port used to communicate with the VideoReQuest via Ethernet is port 3663. If you open a
connection to the VideoReQuest’s IP address at port 3663, you can communicate with the unit just as if
you connected serially.
Communicating with the VideoReQuest
Before you can communicate with the VideoReQuest, you must initialize the connection. A “Start
Communications” command is similar to all other commands, with a few exceptions. See Initializing the
Connection on page 6 for more information.
Sending Commands
Commands are sent to the VideoReQuest in strings of Hexadecimal (or Hex) numbers. Depending on the
command, these strings are anywhere from 13 bytes to 17 or more bytes.
All commands are in the following format:
HEADER
Marker
FCh
A0h
Command
Type
Command
Subtype
0Ah
1 Byte
Flags
00h
DATA
Data Size
00h
Byte 1
Byte 2
Chk
Sum
Engine
Mode
Data
Chk
Sum
00h
FFh
FFh
1+ Bytes
00h
Breakdown of Each Command Portion:
Marker:
The Marker bytes are ALWAYS FCh, A0h. These bytes tell the VideoReQuest the data that follows is valid.
Command Type:
The Command Type will almost always be 0Ah when sending commands to the VideoReQuest. All
possible command types are as follows:
Command
Description
Type
05h
Start Communications (see Initializing the Connection on page 6
for more information
0Ah
Command (most commands sent to the VRQ)
0Fh
Data (not typically used)
14h
Acknowledgement (used only if ACK flag is turned ON)
19h
End Communications (used to terminate connection)
Command Subtype:
The 4 possible subtypes are as follows:
Command
Description
Subtype
01h
1 byte command, no arguments
02h
2 bytes (1 for command, 1 for character argument)
03h
5 bytes (1 for command, 4 for integer argument)
04h
Multi-byte string argument
Data Length
(bytes)*
4
5
8
TBD
* The data length includes the Engine, Mode, and Data Checksum bytes.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-6-
Communication Protocol Guide v1.4.0 - 5/11/06
Flags:
The 2 flag bytes are used to tell the VideoReQuest whether you do or do not want to use certain features.
Setting both to 00h turns off all options. Each byte is broken up into 8 bits. Each bit is a flag for a certain
feature. The possible options are as follows:
Byte 1
Byte 2
Bit 8
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 8
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
ACK
Chk
Sum
Example:
To turn on the use of Check Sums, but not Acknowledgments, send 00h, 01h for the flag bytes. This
should be done on initialization of the connection as well as for any subsequent command sent.
Data Size:
2 byte value that contains the length (in bytes) of the data portion of the command string. For Command
Subtypes 1, 2, or 3, use the Subtype table on page 4 to determine the data length. For Command Subtype
4, the following example illustrates how to calculate the Data Size:
Assume the length of the string is 25 bytes (25 characters, including spaces and punctuation). This
means that the full Data Size is 25 bytes PLUS 3 bytes for the Engine, Mode, and Checksum, or 28
bytes total.
BYTE 1 =
28
= 0, or 00h
255
BYTE 2 = 28 MOD 255 = 28, or 1Ch
Header Check Sum:
If you are not using Check Sum (based on your Flag settings), then set this byte to 00h. Otherwise, see
Calculating Checksum on page 6 for more information.
Engine:
The Engine is simply the page that the VideoReQuest is currently on. Setting the Engine byte to FFh
sends the command to whatever the current Engine is. Setting the Engine byte to a specific engine (see
table) sends the command to that engine ONLY.
Engine
Description
00h
Sends command to Browse mode
01h
Sends command to Player mode
02h
Sends command to DVD player
FFh
Sends command to default (current) engine
Mode:
The Mode is reserved for future use, and should always be set to FFh.
Data:
These byte(s) are the actual command and possible arguments that you are sending to the VideoReQuest.
See Data Commands on the next page for a complete list of commands.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-7-
Communication Protocol Guide v1.4.0 - 5/11/06
Data Check Sum:
If you are not using Check Sum (based on your Flag settings), then set this byte to 00h. Otherwise, see
Calculating Checksum below for more information.
Initializing the Connection
Before the VideoReQuest will respond to commands OR send you feedback, you must initialize the
connection. This tells the VideoReQuest a number of things, including whether or not you wish to
calculate Check Sum, how many lines of feedback you want at a time, etc. The format for a “Start
Communications” command is as follows:
HEADER
Marker
FCh
A0h
Command
Type
Command
Subtype
05h
01h
DATA
Flags
Byte 1
Data Size
Byte 2
00h
03h
Chk Sum
Cmd
Lines
Chk Sum
00h
01h
06h
00h
Currently, the only variable in this string is Flags, which you can set to whatever you want depending on
whether or not you want to use Acknowledgements or Check Sum (see Flags on the previous page for
more information). To simplify programming, it is recommended that you use 00h, 00h for the flag bytes,
which turns OFF both Acknowledgements and Check Sum calculation.
Lines:
The Lines portion of the data section is a 1 byte value that tells the VideoReQuest how many lines of text
you want to receive at once on the Browse and Chapters pages. Currently, the only supported value is
06h.
Calculating Checksum
The Checksum can be calculated as follows:
1. Take the value of each byte in the string, up to but NOT including the checksum, and multiply it by
the position in the string from left to right (the leftmost byte is byte 1)
2. Add all the values calculated in step 1
3. Convert the result to Hex
4. The rightmost Hex byte is the checksum
This is done the same way for both the Header and the Data checksums.
Example Header Checksum:
Incoming String
Integer value
Position Multiplier
Result
Byte 1
FC
252
1
252
Byte 2
A0
160
2
320
Byte 3
05
5
3
15
Byte 4
01
1
4
4
Byte 5
00
0
5
0
Byte 6
00
0
6
0
Byte 7
00
0
7
0
Byte 8
03
3
8
24
Byte 9
67
n/a
9
n/a
Sum of all Results = 252+320+15+4+0+0+0+24 = 615 = 02h, 67h
The rightmost byte of the result is 67h, which is the calculated checksum. As we can see, that matches
the incoming checksum, so no data was lost.
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-8-
Communication Protocol Guide v1.4.0 - 5/11/06
Data Commands:
Cursor Down
Cursor Left
Hex
String
00h
01h
Cursor Right
02h
Cursor Up
Refresh
Page Up
Page Down
All Movies
Genres
Ratings
Now Playing
Enter
Home
VRQ Mode
Power Toggle
Power ON
Power OFF
Number
DVD Menu
Play
Pause Toggle
Pause ON
Pause OFF
Stop
DVD Mode
Next Chapter
Previous Chapter
Goto Top
Goto Bottom
Move to Line
Letter
Backspace
Audio
Subtitles
Angle
Enter Line
Directors
Actors
Player Detail Request
Cancel Lookup
Changers
Close Alert
Lookup All Discs
03h
04h
05h
06h
07h
08h
09h
0Ah
0Bh
0Ch
0Dh
10h
11h
12h
13h
14h
15h
16h
17h
18h
19h
1Bh
1Ch
1Dh
1Eh
1Fh
21h
22h
23h
24h
25h
26h
2Bh
2Eh
2Fh
37h
52h
51h
54h
53h
Lookup Player
4Eh
Media Refresh
38h
Now Playing Chapters
Recently Added
Recently Played
4Dh
50h
4Fh
Command
Description
Moves cursor down 1 line at a time
Moves cursor left or moves back 1 level on Browse page. Acts as Rewind in DVD mode.
Moves cursor right or moves down 1 level on Browse page. Acts as Fast Forward in DVD
mode.
Moves cursor up 1 line at a time
Requests all data from VideoReQuest
Moves up 6 lines at a time
Moves down 6 lines at a time
Jumps to All Movies list
Jumps to Genres list
Jumps to Ratings list
Jumps to Player, displays currently playing movie info
Issues Enter command
Returns to top of Browse page (Now Playing, All Movies, etc)
When in DVD mode, returns to VRQ mode
Toggles soft power ON/OFF
If unit is soft powered OFF, turns unit ON
If unit is soft powered ON, turns unit OFF
Sends the 4 byte number in the argument portion
When playing a DVD, enters the DVD Menu
Plays the current selection or unpauses playback
Toggles playback between Pause and Unpause
Discrete Pauses playback
Discrete Resumes playback from a Paused state
Stops playback, returns to VRQ mode
When in VRQ mode, switches to DVD mode
Plays the next chapter
Resumes current chapter or plays previous chapter
Jumps to top of current list in Browse page
Jumps to bottom of current list in Browse page
Moves to the line number indicated by 4 byte integer argument
Sends the letter indicated by the 1 byte character argument
Deletes the last character entered in text entry
Toggles the Audio options in DVD playback
Toggles subtitle options in DVD playback
Toggles angle options in DVD playback on enabled DVDs
Issues an Enter command on the line number indicated by the 4 byte integer argument
Jumps to Directors list
Jumps to Actors list
Requests a certain Player Detail, based on string argument
Cancel currently running DVD Lookup
Browse to the Changers list
Closes the current alert dialog
Looks up all discs in all changers
Lookup disc range on a particular player. Format is as follows:
• Takes string argument X_Y_Z where:
o X = Changer Number (1-4)
o Y = Starting Slot (1 <= Y <= 400)
o Z = Ending Slot (Y <= Z <= 400)
• Example:
o “1_32_54” will scan all discs between 32 and 54 in changer 1
Checks online for the latest info on the currently displayed movie (only works in Player
screen)
Browse to the chapters list of the Now Playing movie
Browse to the Recently Added list
Browse to the Recently Played list
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
-9-
Cmd
Subtype
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
03h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
01h
03h
02h
01h
01h
01h
01h
03h
01h
01h
04h
01h
01h
01h
01h
04h
01h
01h
01h
01h
Communication Protocol Guide v1.4.0 - 5/11/06
85h
86h
87h
39h
Reboots the VideoReQuest
Shuts down the VideoReQuest
Checks for a software update and displays dialog if one is available
Switch to NTSC TV Mode (Composite/S-Video)
3Ah
Switch to 480i Component TV Mode (Composite/Component)
38h
46h
3Ch
3Dh
3Eh
3Fh
40h
41h
42h
43h
44h
Switch to 720p TV Mode (Component only)
Switch to PAL TV Mode (Composite/Component)
Turn off TV Mode (VGA Only)
Switches to the channel on the video switch indicated by the INT argument
Discrete DVD Cursor left for DVD Menus
Discrete DVD Cursor right for DVD Menus
Discrete DVD Cursor up for DVD Menus
Discrete DVD Cursor down for DVD Menus
Discrete DVD Enter command for DVD Menus
Discrete DVD Playback Rewind
Discrete DVD Playback Fast Forward
Discrete DVD Play command. Note: If Stop is pressed, you must select a movie to play
from the VRQ mode. Discrete Play will be ignored.
Restart
Shutdown
Software Update
TVMode NTSC
TVMode 480i
Component
TVMode 720p
TVMode PAL
TVMode Disable
Video Switch
DVD Cursor Left
DVD Cursor Right
DVD Cursor Up
DVD Cursor Down
DVD Enter
DVD Rewind
DVD Fast Forward
DVD Play
45h
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 10 -
01h
01h
01h
01h
01h
01h
01h
01h
03h
01h
01h
01h
01h
01h
01h
01h
01h
Communication Protocol Guide v1.4.0 - 5/11/06
Examples of Strings to Send:
Subtype 01h – Cursor Up:
The command for Cursor Up is 03h. Send the following:
Marker
FCh
A0h
Cmd
Type
Sub
type
0Ah
01h
Flags
00h
Data Size
00h
00h
04h
Chk
Sum
Engine
Mode
Data
Chk
Sum
00h
FFh
FFh
03h
00h
Subtype 02h – Letter ‘A’:
The command for any Letter is 22h. Send the following:
Marker
FCh
A0h
Cmd
Type
Sub
type
0Ah
02h
Flags
00h
Data Size
00h
00h
05h
Chk
Sum
Engine
Mode
00h
FFh
FFh
Data
22h
Chk
Sum
41h
00h
Subtype 03h – Number ‘3’:
The command for any Number is 13h. Send the following:
Marker
Cmd
Type
Sub
type
Flags
Data Size
Chk
Sum
Engine
Mode
Data*
FCh
A0h
0Ah
03h
00h
00h
00h
08h
00h
FFh
FFh
13h
00h
* See below for more information on calculating the 4 byte number in the Data Argument
Chk
Sum
00h
00h
03h
00h
Subtype 04h – Requesting Player Detail “Genres”:
The command for Player Detail Request is 37h. Send the following:
Marker
FCh
A0h
Cmd
Type
Sub
type
0Ah
03h
Flags
00h
Data Size**
00h
00h
0Ah
Chk
Sum
Engine
Mode
00h
FFh
FFh
Data
37h
Chk
Sum
Genres
** Data Size for Subtype 04h is a variable that depends on the length of the argument
Calculating the 4 Byte Number Argument:
1) Assume that the number you wish to send is an ASCII value, NOT the actual number
2) Determine the Hex value of the number you wish to send (see table below for examples)
a. For example, the number 3 would be 03h, NOT 33h
b. If the number is less than 4 bytes (i.e. less than 4311810304), append 00h to the
beginning of the number to complete the 4 byte requirement
Num
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Hex
00
01
02
03
04
05
06
07
08
09
0A
0B
0C
0D
0E
0F
Num
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Hex
10
11
12
13
14
15
16
17
18
19
1A
1B
1C
1D
1E
1F
Num
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Hex
20
21
22
23
24
25
26
27
28
29
2A
2B
2C
2D
2E
2F
Num
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Hex
30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F
Num
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
Hex
40
41
42
43
44
45
46
47
48
49
4A
4B
4C
4D
4E
4F
Num
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 11 -
Hex
50
51
52
53
54
55
56
57
58
59
5A
5B
5C
5D
5E
5F
00h
Communication Protocol Guide v1.4.0 - 5/11/06
Handling Feedback
Before the VideoReQuest will send feedback data, you must send a command to the VideoReQuest that
initializes communication. See Initializing the Connection on Page 6 for more information.
All feedback is formatted in the same manner as commands sent TO the VideoReQuest. In general, the
format is as follows:
HEADER
Marker
FCh
A0h
Command
Type
Command
Subtype
0Ah
1 Byte
DATA
Flags
00h
Data Size
00h
Byte 1
Byte 2
Chk
Sum
Data
Chk Sum
00h
1+ Bytes
00h
In this case, the Subtype determines what data you are receiving (i.e. Movie Title, Genre, etc) and the Data
portion contains the actual data (i.e. the actual Movie Title, the actual Genre name, etc). The length of the
Data portion is determined by the 2 byte Data Size in the Header.
For help understanding what each Subtype is, see Appendix B.
Possible Subtypes:
Hex
80
81
82
83
84
85
86
8A
8B
Integer
128
129
130
131
132
133
134
138
139
8C
8D
90
91
…
9F
A0
A1
A2
A3
140
141
144
145
…
159
160
161
162
163
A4
A5
A6
A7
A8
164
165
166
167
168
A9
AA
AB
AC
B0
B1
…
BF
169
170
171
172
176
177
…
191
Description
Browse Window Title (“Welcome”, “Total: 46”, etc)
Browse List Title (Home, Genres, etc)*
Browse Extra Info 1 Header (Total)
Browse Extra Info 2 Header (Genre, Rating, etc)
Browse Extra Info 1 Data
Browse Extra Info 2 Data
Browse List Size, Page UP/DOWN Flags and Cursor Position*
Browse Long Description
Engine Mode
0:
On Browse Page
1:
On Player Page
2:
DVD Pass-thru (Playing a movie)
View Mode, Changer Number, Slot Number*
Browse Cover Art image filename**
Browse Text Line 1*
Browse Text Line 2*
…
Browse Text Line 16*
Player Long Description (not used)
Player List Size, Page UP/DOWN Flags and Cursor Position (which chapter is selected)*
Player Movie Title
Player State
0:
Stopped
1:
Playing
2:
Paused
Player Title Icon (not used)
Player Window Title (“More Info”, “Chapters”)
Player Detail Headers*
Player Detail Text*
Player Mode (on Chapters or on Details)
0:
Details
1:
Chapters
Player List Size, Page UP/DOWN Flags and Now Playing Cursor Position (which chapter is playing)*
Player Cover Art image filename**
DVD Lookup Progress*
Movie Aspect Ratio (i.e. 1.77, etc)
Player Chapter Line 1 Text
Player Chapter Line 2 Text
…
Player Chapter Line 16 Text
* - Format of this data is explained on the next page under Special Data Formats
** - The path to each image file is always http://vrq_ip_address:2992/images/coverart/
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 12 -
Data Size
TBD
TBD
TBD
TBD
TBD
TBD
8
TBD
2
5
TBD
TBD
TBD
…
TBD
TBD
8
TBD
2
2
TBD
TBD
TBD
2
8
TBD
TBD
TBD
TBD
TBD
…
TBD
Communication Protocol Guide v1.4.0 - 5/11/06
Example:
Let’s say you received the following string from the VideoReQuest:
FCh, A0h, 0Ah, 84h, 00h, 00h, 00h, 07h, 00h, Horror, 00h
We know from the format explained on the previous page that 84h is the Command Subtype. From
the table of subtypes on the previous page, we know that 84h indicates that you are receiving the
Browse Extra Info 1 Data. Therefore, we extract Horror from the data portion and save that in our
Browse Extra Info 1 Data variable.
Special Data Formats:
Browse List Title:
The Browse List Title is sent in chunks, delimited by a NULL character (00h). For example, if you
are inside the Genres list, the data portion of the string sent by the VideoReQuest will look like
this: Home[00h]Genres[00h]. This allows you to use just the final portion to show the current list
title, or the entire thing to show the full hierarchy.
List Size, Page UP/DOWN Flags, and Cursor Position:
The List Size, Page UP/DOWN Flags and Cursor Position for the Browse and Player pages are sent
by the VideoReQuest in 1 string. The first 4 bytes of the string are the List Size, the next byte is
the Page UP/DOWN Flag, and the final 2 bytes are for the Cursor Position.
List size is calculated as follows:
2563×BYTE1+2562×BYTE2+256×BYTE3+BYTE4
Page UP/DOWN flags could be one of the following:
Value
Description
00h
No more lines exist above or below the current view
01h
More lines exist below the current view
02h
More lines exist above the current view
03h
More lines exist above AND below the current view
The 2 bytes for Cursor Position are calculated as follows:
256×BYTE1 + BYTE2 = RESULT
The following values of RESULT are possible:
Value
1
2
4
8
16
32
64
128
Cursor on Line
1
2
3
4
5
6
7
8
Value
256
512
1024
2048
4096
8192
16384
32768
Cursor on Line
9
10
11
12
13
14
15
16
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 13 -
Communication Protocol Guide v1.4.0 - 5/11/06
View Mode, Changer Number, and Slot Number:
The View Mode, Changer Number, and Slot Number are sent by the VideoReQuest in 1 string.
The first byte is the View Mode, followed by 1 byte for the Changer Number (1, 2, 3, or 4),
followed by 2 bytes for the Slot Number (1-400).
Possible View Modes are as follows:
View Mode
Description
1
In VRQ Mode. Should display VRQ video output.
2
In DVD Mode. Should display DVD video output.
Slot Number is calculated in the same manner as Cursor Position:
256×BYTE1 + BYTE2 = Slot Number
Browse Line Text:
The first byte of the Browse Line Text is a 1 byte flag indicating which icon should be displayed on
that line. Possible values are as follows:
Value
Description
Icon
00h
No Icon
N/A
02h
All Movies
03h
Genres
04h
Ratings
05h
Actors
06h
Directors
07h
Recently Added
08h
Recently Played
09h
Changers
Player Detail Headers:
The Player Detail Headers are sent by the VideoReQuest in 1 string, separated by the NULL
character (00h). The data portion of the string would look similar to the following:
Genres[00h]Cast[00h]Directors[00h]Plot Summary[00h]
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 14 -
Communication Protocol Guide v1.4.0 - 5/11/06
Player Detail Text:
The VideoReQuest will not send any Player Detail Text until it is requested to do so. Therefore,
when you receive the Player Detail Headers, you should send one or more of the following
commands to receive the Player Detail Text:
Detail
GENRES
CAST
DIRECTORS
PLOT SUMMARY
Cmd Subtype
04h
04h
04h
04h
Data Length
10
8
13
16
Data Command
37h
37h
37h
37h
Data Argument
Genres
Cast
Directors
Plot Summary
For example, to request the Genres, send the following:
FCh, A0h, 0Ah, 04h, 00h, 00h, 00h, 0Ah, 00h, FFh, FFh, 37h, Genres, 00h
The VideoReQuest will respond by sending you the Header you requested, followed by the NULL
character (00h), followed by the Detail for that header.
For example, if you requested the Genres, the VideoReQuest will respond with:
FCh, A0h, 0Ah, A7h, 00h, 00h, 00h, 0Eh, 00h, Genres, 00h, Horror, 00h
DVD Lookup Progress:
Byte1
Changer Number
Byte2
Total Discs
Byte3
Current Disc
Byte 4+
General Message text
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- 15 -
Communication Protocol Guide v1.4.0 - 5/11/06
Appendix A – Sample Setups
1. VideoReQuest and Direct RS-232 Control of Switchers
and Receivers
Sony DVP-CX777ES
Sony DVP-CX777ES
RS232 CONTROL
GREE
N
BLUE
RED
Component Switcher Zektor HDS4.2 w/RS-232 (shown)
Recommended
Key Digital KD-SW4x1
RS232
CONTROL
BLUE
RED
OUTPUT 1
To A/V Receiver and or
Video Display
GREE
N
DIGITAL COAX
OPTICAL
VideoReQuest with a Zektor or Key Digital Switch
1.
2.
3.
4.
5.
Connect the VideoReQuest Video output to Input 1 of the switch.
Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
Connect the RS-232 cables* from the DVD changers to Ports 1–3 of the VideoReQuest.
Connect the RS-232 cable† from Port 4 of the VideoReQuest to the RS-232 Port of the switch.
Set the Video Switch setting on the VideoReQuest to the switch you have by going to
MenuÆConfigurationÆVideo OptionsÆVideo Switch on the VideoReQuest GUI.
* RS-232 cables should be FemaleÆFemale NULL MODEM cables (included)
† RS-232 cable should be MaleÆFemale Straight cable (included)
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- A1 -
Communication Protocol Guide v1.4.0 - 5/11/06
VideoReQuest with Xantech Control
1.
2.
3.
4.
5.
6.
7.
Connect the VideoReQuest Video output to the receiver (Can be Composite, S-Video, or Component).
Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
Connect the RS-232 cables* from the DVD changers to Ports 1–3 of the VideoReQuest.
Connect the RS-232 cable† from Port 4 of the VideoReQuest to the Xantech RS232IR module.
Set the Video Switch setting on the VideoReQuest to Xantech IR Blaster by going to
MenuÆConfigurationÆVideo OptionsÆVideo Switch on the VideoReQuest GUI.
Connect the IR emitter or plug to the receiver.
Using Xantech Dragon Drop-IR software, load receiver codes. First code is for VideoReQuest. Code 2- 4 is for
DVD changer 1-3.
* RS-232 cables should be FemaleÆFemale NULL MODEM cables (included)
† RS 232 cable should be MaleÆFemale Straight cable (included)
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- A2 -
Communication Protocol Guide v1.4.0 - 5/11/06
VideoReQuest with Pronto
1.
2.
3.
4.
Connect the VideoReQuest Audio and Video to the receiver (Can be Composite, S-Video, or Component).
Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
Connect the RS-232 cables* from the DVD changers to Ports 1–3 of the VideoReQuest.
Program the Pronto with the VideoReQuest sample program. Program the VRQ, DVD, Play, Stop, and Pause
command to the appropriate receiver command.
* All RS-232 cables should be FemaleÆFemale NULL MODEM cables (included)
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- A3 -
Communication Protocol Guide v1.4.0 - 5/11/06
Appendix B – The GUI
This section shows what each portion of feedback is and where it is located on the TV Out GUI.
Figure 1 – The Browse Page
Figure 2 – The Chapters Page
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- B1 -
Communication Protocol Guide v1.4.0 - 5/11/06
Figure 3 – The Player Details Page
Phone (518) 899-1254 • Fax (518) 899-1251 • www.request.com
- B2 -