E T C
A R C H I T E C T U R A L
Serial Access Protocol
U n i s o n™ L i g h t i n g C o n t r o l S y s t e m
Test Utility 2.1 User Guide
Contents
Overview................................................................................................................................. 3
Installation.............................................................................................................................. 3
Operation................................................................................................................................ 3
Features.................................................................................................................................. 4
Hand icon (Interactively test Unison Serial Access Protocol) ...................................... 4
Punch card icon (Batch test Unison Serial Access Protocol) ....................................... 4
Com ports .................................................................................................................... 4
Baud rate ..................................................................................................................... 4
Unison Serial Access Protocol commands ...................................................................... 7
Rooms ......................................................................................................................... 7
Sections ....................................................................................................................... 7
Presets......................................................................................................................... 7
Preset command format .................................................................................... 7
Preset commands:............................................................................................. 7
Preset examples ................................................................................................ 8
Walls ........................................................................................................................... 8
Wall command format ....................................................................................... 8
Wall commands ................................................................................................. 8
Wall examples.................................................................................................... 8
Zones ........................................................................................................................... 9
Zone Command Format ..................................................................................... 9
Zone Commands ............................................................................................... 9
Zone Examples .................................................................................................. 9
Macros....................................................................................................................... 10
Macro command format .................................................................................. 10
Macro commands ............................................................................................ 10
Macro examples .............................................................................................. 10
Errors..................................................................................................................................... 11
Command Quick Guide....................................................................................................... 12
2
Electronic Theatre Controls, Inc.
Overview
Unison Serial Access Protocol (USAP) Test Utility is a program designed to
allow you to connect a PC running Windows 95 or Windows 98 to the Unison
Serial Access Protocol port in a Unison System and send and receive Unison
Serial Access commands. The USAP Test Utility also allows you to receive
serial input from another source, such as a show controller, to determine the
commands being sent. This allows the programmer of the serial source to
troubleshoot their system and/or packet information.
This manual will give instructions on the operation of the test utility. For
information about Unison Serial Access Protocol please consult the Unison
Serial Access Protocol Operation and Programming Guide.
Installation
Installation of the program is very simple. You may either run it from the
Floppy Disk by double clicking on the “USAPTEST.EXE” file or copy the file to
the directory of your choice on your hard drive, and run it from there. The
program will run from either location. The requirements are: the computer
needs to have Com port 1 or 2 available and be able to accept a DB9
connection.
Operation
Insert the Unison Serial Access Cable [7080B7007] into your Computer’s serial
port and into the Serial Connector in your Unison System. For further
information on connecting your Computer to the Unison system, please
consult the Unison Serial Access Protocol Operation and Programming Guide.
The Unison Serial Access Protocol Test Utility can be running while the Unison
Serial Access Cable is attached to the system. If you send a command from
the program without a connection to the Unison System, the Unison Serial
Access Protocol Test Utility will not function properly.
For advanced troubleshooting, the computer running the USAP Test Utility can
be connected to the serial device directly via a null modem DB9 cable.
Null modem cables and adapters are available from most electronics and
computer supply stores. Make sure that the gender of the cable/adapter is
correct to have a direct connection between the computer and serial device.
Unison Serial Access Protocol Test Utility
3
Features
▼
Hand Icon (Interactively test Unison Serial Access Protocol)
This allows you to send a single line of Unison Serial Access command
string to the Unison Processor. Clicking on this icon or selecting the
"Interactive" option in the File menu, will bring up a window call Serial
Access Protocol Interactive Test. This window consists of a "Send" area,
a "Received" area, and feedback windows regarding full hex information
about the strings sent and received. There are also Send and Close buttons.
Text typed into the "Send" window will be sent to the Processor with the
appropriate hex wrapper. Pressing the [Send] button in the upper right-hand
corner sends the commands. The Send Data ASCII window will display the
same text message with the hex wrapper included. The Send Data Hex
window displays both the wrapper and the command in hex.
ð
The Processor will send its reply, indicating either a completed or invalid
message, which will appear in the Received window. In addition, the full
hex stream received, both wrapper and response, will be displayed in the
Received Data Hex window.
Note: In some cases, the Received Data Hex responses may be truncated
or garbled. This happens most often when several messages are sent too
quickly.
When you have finished testing, you can close this window by either
pressing the [Close] button or clicking the "x" in the upper right-hand corner
of the window.
▼
Punch card Icon (Batch Test Unison Serial Access Protocol)
This allows you to send a series of Serial Access command strings to the
processor. Clicking on this icon or selecting “Batch” in the File menu will
bring up a dialogue box. This “open” box will allow you to select a prewritten text file with Unison Serial Access Protocol Command strings. After
selecting the file, click “OK”. At this point the Unison Serial Access Protocol
Test Utility will send the contents of the file to the Unison Processor. It will
then create a file called USAPTEST.TXT in the same location as the batch
file. This file will contain the replies from the Unison Processor. Each batch
test will cause the Unison Serial Access Protocol Test Utility to overwrite
this file with current data. If you desire to save the results of a batch test,
rename this file between batch tests.
4
Electronic Theatre Controls, Inc.
▼
Com Ports
This allows you to select which Com port you wish to output Unison Serial
Access Protocol from. They are selectable by either clicking on a specific
port icon, or via the File menu. You may need to check your Computer’s
configuration for Port set up. The Unison Serial Access Protocol Test
Utility only supports Com ports 1 and 2.
▼
Baud Rate
This allows you to select a baud rate for Data Transmission. Baud rate is
selected by either clicking on a specific port icon, or via the File menu. For
the USAP Test Utility to work, the baud rate selected must match that
which is selected in the Processor configuration.
Unison Processors running software version 1.4 through 1.55 only support
USAP at 9600 bps. Version 1.65 and higher support 4800, 9600, 19200
and 38400. The processor USAP rate is selected from within the Network
Settings Menu in Light Manager.
Unison Serial Access Protocol Test Utility
5
6
Electronic Theatre Controls, Inc.
Unison Serial Access Protocol Commands
Unison Serial Access Protocol command strings must match the case and
spacing of objects in the Unison configuration. To determine names, contact
your authorized ETC dealer or ETC Technical Services at 800-775-4382. Be
prepared to give your facility name and/or ETC Job number. Commands are
case-sensitive and need to be phrased as listed. For example if you have a
room named as “BALLROOM” you must refer to it in all capitol letters when
sending a command. Commands referring to the room as “Ballroom” will
return as invalid. Examples are shown as a Command (from the external
device to a Unison Processor) and a Response (from Unison Processor to the
external device).
Rooms
In Unison Serial Access Protocol, Room objects have no properties or actions,
but are used when referencing the objects contained in them (Presets, Walls,
Sections, and Zones).
Sections
In Unison Serial Access Protocol, Section objects have no properties or
actions, but are used when referencing the objects contained in them (Zones
and Presets).
Presets
Preset objects are contained in Room or Section objects. To send commands
which will effect a Preset, first reference the Room and then the Preset (e.g.
“Ballroom.Dinner”), or for divided rooms, you must reference the Room and
Section, and then the Preset (e.g. “Ballroom.Hall A.Dinner”) in order to access
properties or actions specific to that section.
Preset Command Format:
ð
[ROOM NAME].[SECTION NAME].[PRESET NAME].COMMAND
Note: You can send multiple commands providing they are separated by a
period. See the Preset Examples section.
Preset Commands:
Activate a Preset:
ACTI
Deactivate a Preset:
DACT
Record a Preset:
RECO
Set a fade time for a Preset:
nDFT= (time is entered in milliseconds)
Get status of a Preset:
bACT
(Unison Processor will respond with Preset name and 1=active, or 0=not
active)
Get Priority status of a Preset: bAAP
(Unison Processor will respond with preset name and priority level)
Unison Serial Access Protocol Test Utility
7
Preset Examples:
Activate a Preset
Command
Ballroom.Hall A.Dinner.ACTI
Response
Ballroom.Hall A.Dinner.ACTI
Activate a Preset, including Fade Time
Command
Ballroom.Dinner.nDFT=5000 (5 second fade)
Response
Ballroom.Dinner.nDFT=5000
Get the Active state of a Preset in a Section
Command
Ballroom.Hall A.Dinner.bACT
Response
Ballroom.Hall A.Dinner.bACT=1
Walls
Wall objects are contained in Room objects. To send commands which will
effect a Wall, first reference the Room and then the Wall (e.g., “Ballroom.East
Wall”).
Wall Command Format:
[ROOM NAME].[WALL NAME].COMMAND
Wall Commands:
Open a Wall:
OPEN
Close a Wall:
CLOS
Toggle a Wall State: TOGL
Get status of a wall: bOPN
(Unison Processor will respond with wall name and 1=open or 0=closed)
Wall Examples:
Get the open/close state of a Wall
Command
Ballroom.East Wall.bOPN
Response
Ballroom.East Wall.bOPN=0 (0= Wall is closed)
Set the open/close state of a Wall
Command
Ballroom.East Wall.bOPN=1
Response
Ballroom.East Wall.bOPN=1 (1= Wall is open)
Or
Command
Ballroom.East Wall.OPEN
Response
Ballroom.East Wall.OPEN
Toggle the open/close state of a Wall and get its new open/close state
Command
Ballroom.East Wall.TOGL.bOPN
Response
Ballroom.East Wall.TOGL.bOPN=0 (0=Wall is now closed)
8
Electronic Theatre Controls, Inc.
Zones
Zones are contained in Rooms or Sections and can be controlled by Presets.
To send commands which will effect a Zone in a Room, first reference the
Room and then the Zone (e.g. Ballroom.Downlights”). If the Room is divided
(or uses Unison room combine feature), reference the Room and Section, and
then the Zone (e.g. “Ballroom. Hall A. Downlights”).
Zone Command Format:
[ROOM NAME].[SECTION NAME].[ZONE NAME]. COMMAND
Zone Commands:
Set intensity for a Zone: nINT=[Intensity value]
Intensity values are displayed and transmitted in 16 bit. In this system 0=off
and builds to full=65535. Intensity values must be input in this numerical
system.
Get Intensity value for a Zone: nINT
(Unison Processor will respond with Zone name and 16-bit value)
Determining 16-bit Zone values
To determine 16-bit values for Zone levels, multiply the desired percentage by
65535.
Example
Level of 50%:
Level of 25%:
.50 x 65535 = 32768
.25 x 65535 = 16384
Zone Examples:
Get the Intensity of a Zone
Command
Ballroom.Downlights.nINT
Response
Ballroom.Downlights.nINT=0 (Zone is at 0)
Set the Intensity of a Zone (in a Section)
Command
Ballroom.Hall A.Downlights.nINT=65535
Response
Ballroom.Hall A.Downlights.nINT=65535 (This indicates the Zone
is at full)
Unison Serial Access Protocol Test Utility
9
Macros
A Macro is a series of pre-stored commands that can be carried out by the
Unison processor.
Macro Command Format:
[MACRO NAME].[COMMAND]
Macro Commands:
Run a Macro: EXEC
Macro Examples:
Run a Macro called Lockout
Command
Response
10
Lockout.EXEC
Lockout.EXEC
Electronic Theatre Controls, Inc.
Errors
If an object, property, or action is not understood by the Unison processor, it
will insert an error indicator (“?”) in the response string as shown:
Unknown Object Error
Command
Ballroom.Section X.Downlights.nINT=0
Response
Ballroom.?Section X (Config has no Section named X)
Unknown Property Error
Command
Ballroom.Dinner.nUNK=0
Response
Ballroom.Dinner.?nUNK (Command nUNK is not a valid command)
Unknown Action Error
Command
Ballroom.Dinner.bOPN
Response
Ballroom.Dinner.?UNKN (bOPN is a Wall command not a Preset
command)
Unison Serial Access Protocol Test Utility
11
Command Quick Guide
Commands are case sensitive and need to be phrased in the following format:
12
Activate a Preset:
ACTI
Deactivate a Preset
DACT
Record a Preset
RECO
Set a fade time for a Preset
nDFT= (time is entered in milliseconds)
Get status of a Preset
bACT
Get Priority status of a Preset
bAAP
Open a Wall
OPEN
Close a Wall
CLOS
Toggle a Wall State
TOGL
Get status of a Wall
bOPN
Set intensity for a Zone
nINT= (entered as a 16-bit value)
Get Intensity value for a Zone
nINT
Run a Macro
EXEC
Electronic Theatre Controls, Inc.
Americas • 3030 Laura Lane Middleton, WI 53562 • Tel: (+1) 608.831.4116 • Fax: (+1) 608.836.1736 • Toll free: 800.688.4116 • Toll free fax: 800.555.8912
Europe • 5 Victoria Industrial Estate, Victoria Road, London W3 6UU • Tel: +44 (0)20 8896 1000 • Fax: +44 (0)20 8896 2000
Asia • Room 605-606, Tower III Enterprise Square • 9 Sheung Yuet Road, Kowloon Bay • Kowloon, Hong Kong • Tel: (+852) 2799 1220 • Fax: (+852) 2799 9325
International • 3030 Laura Lane Middleton, WI 53562 • Tel: (+1) 608.831.4116 • Fax: (+1) 608.836.1736 • Toll free: 800.688.4116 • Toll free fax: 800.555.8912
Web: www.etcconnect.com • Email: [email protected]
Copyright © 2001 Electronic Theatre Controls, Inc., All Rights Reserved. All product information and specifications subject to change. 7080M1012 Rev.C Revised 04/01