Crestron AudioReQuest User manual

AudioReQuest Crestron™ Interface Guide
Version 7.0.0
Control of 1 or more AudioReQuest™ devices from a Crestron control
system through RS2 2 or Ethernet
ReQuest Incorporated 100 Saratoga Village Blvd. #44 Ballston Spa, NY
Direct Line:518.899.1254 Support:800.2 6.2812 Facsimile:518.899.1251

Table of Contents
AudioReQuest Crestron™ Interface Guide........................................................................1
Table of Contents..............................................................................................................2
Crestron Install Checklist...................................................................................................4
Introduction:......................................................................................................................1
Rear Serial Port Pinout (Male RS-2 2 Port).........................................................................................1
Serial Cable Pinout (Female Female RS2 2 cable)...........................................................................1
COM Settings....................................................................................................................................1
Design Changes and New Features..................................................................................
Multiple Product Model Support....................................................................................
Single START-COMMUNICATIONS Signal....................................................................
Simplified Design...........................................................................................................
Ethernet Control................................................................................................................4
Cover Art on Supported Panels.........................................................................................4
Customizing the Program..................................................................................................5
Adding Touch Panels.....................................................................................................5
Adding AudioReQuests.................................................................................................7
Serial Control.....................................................................................................................................9
Ethernet Control................................................................................................................................9
Complete List of Module Inputs and Outputs.................................................................10
ARQConnect Module – Inputs.....................................................................................10
ARQConnect Module – Outputs..................................................................................1
ARQConnect Module – Parameters.............................................................................14
Touchpanel Controller Module – Inputs.......................................................................15
Touchpanel Controller Module – Outputs....................................................................15
Touchpanel Controller Module – Parameters...............................................................15
Keyboard Handler Module – Inputs..............................................................................16
Keyboard Handler Module – Outputs...........................................................................17
Keyboard Handler Module – Parameters......................................................................17
Appendix A: Troubleshooting..........................................................................................18
A)Can’t establish 1-way serial communication:............................................................18
B)I have one-way control but I can’t get any feedback:................................................18
C)Getting garbage text or lines not refreshing on Crestron Touch panels:...................19
D)The text is being drawn slowly on the touch screens:..............................................19
E)When I go into the ARQ pages on my touch panel nothing happens:.......................19
Appendix B: Using Hyper Terminal:................................................................................20
ReQuest Incorporated 100 Saratoga Village Blvd. #44 Ballston Spa, NY
Direct Line:518.899.1254 Support:800.2 6.2812 Facsimile:518.899.1251

Revision History
Revision Number Changes
4.0.2 Updated for 1.7.11, updated graphics
4.0. Updated for 1.7.5 (genre commands)
4.1.0 Updated for 1.8.1
4.1.5 Updated version number to match program version number. No changes
to document
4.5.0 Complete redesign
Added new 1.9.0 commands
4.5.1 Added POWER-ON and POWER-OFF to Basic Module
4.5.5 Added info about single Start Comm signal
Minor formatting changes
5.0.0 Initial F-Series Version
5.5.0 Added support for cover art using Dynamic Graphics
6.0.0 Redesigned module
Added Keyboard Handler and Touchpanel modules
Added support for new 4.6.0 features
Added support for classical mode
7.0.0 Simplified module, removing a lot of legacy code
Went back to single module design
ReQuest Incorporated 100 Saratoga Village Blvd. #44 Ballston Spa, NY
Direct Line:518.899.1254 Support:800.2 6.2812 Facsimile:518.899.1251

Crestron Install Checklist
Hardware Requirements
1) 2-Series Crestron Processor and AudioReQuest Digital Music Server
2) FemaleFemale NULL Modem serial cable if connecting serially (one ships with the ARQ). It
is HIGHLY recommended to use a cable that is no longer than 10ft to prevent ground
problems.
Hardware Configuration
1) Install ARQ unit and Crestron processor in rack
2) Connect cables for control (NULL Modem Serial or Ethernet)
Software Requirements/Setup
1) Ensure that you have the all the latest SIMPL Windows and VTPro programs and components
installed. Don’t forget the SIMPL Windows Cross Compiler!
Software Configuration
1) Import the ReQuest demo program into SIMPL Windows using FileImport Archived Program
(see page 2 below for more info)
2) Select a control method (Ethernet or Serial). The demo is setup for Serial. If using Ethernet,
comment out the COM port, uncomment the TCP/IP client, and configure it with your
AudioReQuest’s IP address.
) If integrating the AudioReQuest into an existing Crestron program, copy the logic from the
demo program to your program. Be sure to copy Digital, Analog, and Serial joins for the touch
screens. Modify the joins as necessary to fit into your system.
4) If using the ReQuest demo touch screen interfaces, open those in VTPro and modify as
necessary. Copy our screens to yours if integrating with an existing system
ReQuest Incorporated 100 Saratoga Village Blvd. #44 Ballston Spa, NY
Direct Line:518.899.1254 Support:800.2 6.2812 Facsimile:518.899.1251
Client Name: _______________________________________Date Installed:__________________________________
Module Version:____________________________________________Processor Type:________________________________
Number of ReQuests:______________________________________Connection to ARQ: Ethernet Serial

Introduction:
This document explains how to interface all models of AudioReQuest Digital Music Servers with Crestron
control systems using the AudioReQuest Crestron Demo Program version 7.0.0. It will not give a detailed
explanation of the protocol used to communicate with the AudioReQuest via Ethernet, Serial, or IR. For
this information, please download the Communication Protocol Guide from www.request.com.
Rear Serial Port Pinout (Male RS-232 Port)
Pin Purpose
1 Not Used
2 Receive
Transmit
4 Not Used
5 Ground
6-9 Not Used
Serial Cable Pinout (Female  Female RS232 cable)
Pin (ARQ Side) Pin (Control Side)
2 (Rx) (Tx)
(Tx) 2 (Rx)
5 (GND) 5 (GND)
COM Settings
The rear serial port is used for integrating the AudioReQuest with a control system. Connection to the rear
serial port requires a FemaleFemale NULL MODEM serial cable. The front serial port(if equipped) is
used ONLY for configuring certain settings on the AudioReQuest, such as the IP Address. You CANNOT
use the front serial port to control the ARQ.
The default baud rate depends on the model of AudioReQuest unit. On newer AudioReQuest units, the
baud rate is configurable in the webserver (SettingsHardwareControl Port Baud Rate). The table
below shows the default baud rates by model.
Rear Serial Port
(Single Zone Units)
Rear Serial Port
(Multi Zone Units)
Parameter Value Parameter Value
Baud 9600 Baud 57600
Data Bits 8 Data Bits 8
Stop Bits 1 Stop Bits 1
Parity None Parity None
Flow Control None Flow Control None
Phone [phone] • Fax [phone] • www.request.com
- 1 -

Phone [phone] • Fax [phone] • www.request.com
- 2 -
What To Do irst:
Do Not Unzip The Demo Program You Download!!!
Download ARQConnect_Crestron_Demo_v7_0_0.zip from www.request.com.
Open SIMPL Windows.
Select Import Archived Program from the File pull-down menu
Click Browse and find the zipped file you downloaded in step 1 above.
Click Start to import the file.
Following the above steps is CRITICAL to the success of your project. Although it is typically sufficient to
simply copy the files to the appropriate place on your hard drive, SIMPL Windows performs better when
the file is imported.
Importing the file will unzip the project, placing the .smw, .umc and .usp files in the appropriate places,
and open our demo program in SIMPL Windows. This program works as a complete solution with our
touch panel designs, which are also available on our website. If you choose to use our module in another
program, but you plan to use our panel designs, you MUST copy over the Subpage Logic subsystem in
order for the panels to work correctly. If you have any questions or problems, call (800) 2 6-2812 for
further assistance.

Design Changes and New eatures
In an effort to simplify integration between Crestron and AudioReQuest, ReQuest has made a number of
changes to the demo program, the ARQConnect module, and the demo touch screens. This section
describes the changes that have been made.
Multiple Product Model Support
ReQuest now has main types of AudioReQuest unit: Single Zone (N.Series), 2 Output Multizone
(F2.Series), and 4 Output Multizone (F4.Series and S.Series). Using the ARQConnect Demo Program, you
can interface to any number of units of any type simply by changing the zone number on the module/
Single START-COMMUNICATIONS Signal
Previous versions of the demo program and touch screen interfaces contained 2 separate Start-
Communications signals: One for Ethernet (join 771) and one for Serial (join 772). These 2 signals have
been combined into 1 signal named ARQ-CONNECT (join 771). This allows you to switch between
Ethernet and Serial communications by simply moving the ARQ-CONNECT signal from the [START-
SERIAL-COMMUNICATIONS] input to the [START-ETHERNET-COMMUNICATIONS] input on the module.
For more information on using Ethernet, see the Ethernet Control section on the next page.
Simplified Design
Version 5.0.0 introduced a new 2 module design: Basic and Advanced. While beneficial for organization,
this design caused problems in timing and processor usage. For version 7.0.0 we have returned to a
single, simplified module design. We have added a number of things from the Advanced module to make
it a complete solution.
**NOTE: The Keyboard Handler and Touchpanel Controller modules are still used.
The Keyboard Handler Module
This is a stand-alone module that handles all the necessary work for displaying an onscreen keyboard and
building a string based on input from the touch panel. This is used mainly for creating playlists.
The Touchpanel Controller Module
This module handles all the logic for displaying subpages on the touch panel. Previously, this logic lived in
the demo program. This made it more difficult to integrate a ReQuest into an existing project.
Phone [phone] • Fax [phone] • www.request.com
- 3 -

Ethernet Control
The demo program provided by ReQuest includes a commented out TCP/IP client that is ready to use.
In order to control AudioReQuest with Ethernet:
1. Uncomment the TCP/IP client that is already in our demo program
(Slot-08, IP-ID-04).
2. Verify that the TCP/IP client is configured as shown in the figure below.
. Switch to Configure view and set the IP address of the TCP/IP client to the IP address of your
AudioReQuest. You can find the IP by going to MenuSystem Information on the AudioReQuest.
4. Switch back to Program View and delete the AUDIO-REQUEST-RX$ and AUDIO-REQUEST-TX$
signals going to the COMM Port (Slot-04, Port-A).
Cover Art on Supported Panels
With the addition of Dynamic Graphics on newer Crestron panels, you can now get cover art images on
your touch panel without the need for a video input. The module contains a number of serial outputs you
can use (see Module Outputs on page 15 for details on the different outputs).
For the Player image as well as the single Browse image, you have the option of choosing a large image
(170 x 170px) or a small image (75 x 75px). The Browse images per line are hard-coded to use a smaller
image size to increase performance.
To use cover art and set the browse image sizes you desire:
1. Open the Module into detail view
2. At the bottom of the module, set the IP_ADDRESS and WEB-PORT parameters to the ip address
and web port of your AudioReQuest
. Set the cover art modes for the size of image you wish to receive
0d: Disable this image
1d: Large Image (170 x 170 pixels) default
2d: Small Image (75 x 75 pixels)
4. If you wish to use cover art on each browse line, set ENABLE-BROWSE-LINE-ART to 1d
5. Connect the serial outputs from the module to the appropriate serial joins on the panels that will
display the images (see image below for more info)
Phone [phone] • Fax [phone] • www.request.com
- 4 -
igure 2

igure 4
Customizing the Program
Adding Touch Panels
To simplify customization of the program, we have added templates for the Touch Screens and Panel
Specific Logic folders. The demo program has five 2-way panels already in it. If you wish to add more
panels, you can use the templates to make it easier.
NOTE: You may find it easier to delete all but one AudioReQuest Zone subsystem, add the new panel
logic, then add back in the ARQ Zone logic folders.
To add another touch screen:
1. Add your new touch screen to the system in Configure
View.
2. Under Program View, locate ID-FE : Xpanel: ARQ
Template{Panel_TEMP} (Figure ).
. Right-Click AND HOLD on the TEMPLATE.
4. Move the mouse over top of the new touch panel
5. Release the mouse button.
6. Select Copy all signals and parameters from the menu
that pops up (Figure 4). This will copy all the Digital,
Analog, and Serial signals from the template to your
new touch screen.
All of the signals for the touch screens have a suffix that
distinguishes that screen from the others. This is used
to isolate one panel from another. The template has the
suffix {Panel_TEMP} on all signals. The next steps will
walk you through changing this. You will need to use a
unique suffix for each new touch screen you add. In the
demo, we use {Panel_A} through {Panel_E . If you add
panels, you could start with {Panel_F} and continue
alphabetically from there (Panel_G, Panel_H, etc.).
7. Select the new touch screen in Program View and press F9 on your
keyboard to begin a Search and Replace.
8. Search for Panel_TEMP and replace it with the suffix you decided to use
above.
Phone [phone] • Fax [phone] • www.request.com
- 5 -
igure 3

The next step is to create the Panel Logic folder for the new panel.
9. Select the S-1.4.10 : {Panel_TEMP} subsystem and press Ctrl-C on your keyboard.
10. Select the S-1.4 : Panel Logic subsystem and press Ctrl-V.
11. Uncomment the newly copied subsystem.
12. Select the newly copied subsystem and press F9 on your keyboard.
1 . Search for Panel_TEMP and replace it with the same as in Step 8 on the previous page.
You must also create the Panel Specific Logic in each zone for the new panel.
14. Select S-1.5.2.2.10 : {Panel_TEMP} subsystem and press Ctrl-C on your keyboard.
15. Select S-1.5.2.2 : Panel Specific Logic for This Zone subsystem and press Ctrl-V. This will create S-
1.5.2.2.11 : {Panel_TEMP}.
16. Uncomment the newly copied subsystem.
17. Select the newly copied subsystem and press F9 on your keyboard.
18. Search for Panel_TEMP and replace it with the same as in Step 8 on the previous page.
19. Repeat steps 14-18 above for ALL remaining {ZONE_XX} subsystems.
Phone [phone] • Fax [phone] • www.request.com
- 6 -
igure 5
igure 6