ReQuest Multimedia VideoReQuest User manual

Communication Protocol Guide
Version 1.1.2
IR, RS-232, and Ethernet Interface Guide

Communication Protocol Guide v1.9.0 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
VideoReQuest with a Zektor or Key Digital Switch
1. Connect the VideoReQuest Video output to Input 1 of the switch.
2. Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
3. Connect the RS-232 cable from the DVD changers to Ports 1–3 of the VideoReQuest.
4. Connect Port 4 of the VideoReQuest to the RS-232 Port of the switch.
5. 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.
DIGITAL COAX
OPTICAL
GR EE
N
RED
BLU E
OUTPUT 1
To A/V Receiver and or
Video Display
1. VideoReQuest and Direct RS-232 Control of Switchers
and Receivers
Component Switcher
Recommended
Zektor HDS4.2 w/RS-232 (shown)
Key Digital KD-SW4x1
RS232
CONTROL
Sony DVP-CX777ES Son y D VP -C X7 77 E S
RS232 CONTROL
GR EE
NBLUE
RED

Communication Protocol Guide v1.9.0 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
VideoReQuest with Xantech Control
1. Connect the VideoReQuest Video output to the receiver (Can be Composite, S-Video, or
Component).
2. Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
3. Connect the RS-232 cable from the DVD changers to Ports 1–3 of the VideoReQuest.
4. Connect Port 4 of the VideoReQuest to the Xantech RS232IR module.
5. 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.
6. Connect the IR emitter or plug to the receiver.
7. Using Xantech Dragon Drop-IR software, load receiver codes. First code is for VideoReQuest.
Code 2- 4 is for DVD changer 1-3.

Communication Protocol Guide v1.9.0 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
VideoReQuest with Pronto
1. Connect the VideoReQuest Audio and Video to the receiver (Can be Composite, S-Video, or
Component).
2. Connect the Audio and Video from DVD Changers 1-3 to Inputs 2-4.
3. Connect the RS-232 cable from the DVD changers to Ports 1–3 of the VideoReQuest.
4. Program the Pronto with the VideoReQuest sample program. Program the VRQ, DVD, Play, Stop,
and Pause command to the appropriate receiver command.

Communication Protocol Guide v1.9.0 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
I -
T ABLE OF C ONTENTS
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 Advanced IR Commands........................................................ 2
Part 2: Serial/Ethernet Protocol ......................................................... 3
Rear Serial Port Pinout .................................................................... 3
Serial Cable Pinout........................................................................... 3
COM Settings ................................................................................... 3
Using Ethernet ................................................................................. 3
Communicating with the VideoReQuest ........................................... 4
Sending Commands ......................................................................... 4
Breakdown of Each Command Portion: ...............................................................4
Marker: .............................................................................................................4
Command Type:.................................................................................................4
Command Subtype: ............................................................................................4
Flags: ...............................................................................................................5
Data Size: .........................................................................................................5
Header Check Sum: ............................................................................................5
Engine: .............................................................................................................5
Mode: ...............................................................................................................5
Data: ................................................................................................................5
Data Check Sum: ...............................................................................................6
Initializing the Connection ............................................................... 6
Lines: ...............................................................................................................6
Calculating Checksum ...................................................................... 6
Data Commands:.............................................................................. 7
Examples of Strings to Send: ........................................................... 8
Subtype 01h – Cursor Up: ...................................................................................8
Subtype 02h – Letter ‘A’: ....................................................................................8
Subtype 03h – Number ‘3’:..................................................................................8
Subtype 04h – Requesting Player Detail “Genres”: .................................................8
Calculating the 4 Byte Number Argument: ..........................................................8
Handling Feedback........................................................................... 9
Possible Subtypes: .............................................................................................9
Special Data Formats:....................................................................................... 10
Appendix A – The GUI .................................................................... 13

Communication Protocol Guide v1.9.0 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
II -
R EVISION H ISTORY
Revision Number Changes
1.1.2 Initial Version

VideoReQuest Protocol Guide v1.1.2 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
1 -
I NTRODUCTION
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.

VideoReQuest Protocol Guide v1.1.2 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
2 -
P ART 1: IR C ONTROL
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.
List of Advanced IR Commands
Action Description Alt/Shift 2nd Button
Refresh DVD Details Performs a lookup on the current DVD ALT EDIT

VideoReQuest Protocol Guide v1.1.2 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
3 -
P ART 2: S ERIAL /E THERNET P ROTOCOL
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 Purpose
1 Not Used
2 Receive
3 Transmit
4 Not Used
5 Ground
6 Not Used
7 RTS
8 CTS
9 Not Used
Serial Cable Pinout
Pin (VRQ Side) Pin (Control Side)
2 3
3 2
5 5
7 8
8 7
COM Settings
The rear serial port is used for integrating the VideoReQuest with a control system. These
settings can be found by going to Menu

Configuration

Control Port on the
VideoReQuest.
Parameter Value Value Value Value
Baud 9600 19200 38400 57600
Data Bits 8 8 8 8
Stop Bits 1 1 1 1
Parity None None None None
Flow Control None HW HW HW
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.

VideoReQuest Protocol Guide v1.1.2 - 5/18/04
Phone [phone] •Fax [phone] •www.request.com
-
4 -
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 DATA
Marker Command
Type
Command
Subtype
Flags Data Size Chk
Sum
Engine Mode Data Chk
Sum
FChA0h0Ah1 Byte 00h00hByte 1 Byte 2 00hFFhFFh1+ 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 0Ahwhen sending commands to the
VideoReQuest. All possible command types are as follows:
Command
Type
Description
05hStart Communications (see Initializing the Connection
on page 6 for more information
0AhCommand (most commands sent to the VRQ)
0FhData (not typically used)
14hAcknowledgement (used only if ACK flag is turned ON)
19hEnd Communications (used to terminate connection)
Command Subtype:
The 4 possible subtypes are as follows:
Command
Subtype
Description Data Length
(bytes)*
01h1 byte command, no arguments 4
02h2 bytes (1 for command, 1 for character argument) 5
03h5 bytes (1 for command, 4 for integer argument) 8
04hMulti-byte string argument TBD
*The data length includes the Engine, Mode, and Data Checksum bytes.