Vocia Text Protocol Document
6/22/2010
Contents
1.0 Connecting to the VTP Service
2.0 VTP Commands
2.1 Username and Password Information
2.2 Zone Definition
2.3 Interactive Mode
2.4 Activity Logging
2.5 Page progress
2.6 Terminating a VTP session
2.7 Background Source Change
2.8 Control Handle Change
3.0 Vocia Configuration Query Commands
4.0 Page Execute Commands
5.0 Creating a User Audio Input Even t
6.0 XML Respons e s
7.0 Glossary of VTP Commands
Biamp Systems 9300 S.W. Gemini Drive Beaverton, Oregon 97008 U.S.A. 503.641.7287 www.biamp.com 2
VTP Commands Document
Vocia Text Protocol (VTP) is a remote control protocol that provides an interface for third
party control. A control system can connect to the IP address of a Vocia MS-1 at a specific
port address (8020) and the MS-1 will accept VTP commands for the Vocia system. An
MS-1 is needed in a Vocia system to accept VTP commands.
This document describes the Vocia Text Protocol and gives a list of valid commands to use
with this process. Each command is listed in a separate section and can be referenced
against the Table of Contents. In addition a glossary has been provided at the end of the
document for quick reference purposes (see Section 7.0).
VTP is an ASCII, line based protocol. Commands are entered as a single command letter,
followed by a string of arguments relevant to the command, and then executed by a
command entered on a newline. VTP commands are not case sensitive, although
arguments can be case sensitive. Commands and arguments are separated by a space.
There are no timeouts or checksums associated with the protocol operation and all VTP
responses are in XML to facilitate parsing by third party applications.
The following fun c tions are accessible vi a the VTP service, and the section of this
document that examples can be found in.
• A Background Source can be changed in a zone/s (Section 2.7)
• The state of a control handle can be changed (Section 2.8)
• A range of system configuration information can be queried (Section 3.0)
• Wav files imported into a configuration can be triggered as a paging event
(Section 4.1, 4.2)
• A user audio input event can be created & deleted (Section 5.1, 5.2)
Biamp Systems 9300 S.W. Gemini Drive Beaverton, Oregon 97008 U.S.A. 503.641.7287 www.biamp.com 3
1.0 Connecting to the VTP Service
To communicate with the MS-1 via VTP a VTP User Account will need to be set up. The set
up procedure for this requirement is performed in the Universe Properties window as
shown in Figure 1. Create a New User and assign a password in the fields provided. Please
note that both the User Name and Password are case sensitive.
Figure 1 – Universe Properti es Window
Once you have set up a VTP User Name and Password, send the configuration to the Vocia
devices over the network. After this action is completed you can connect to the VTP
service using:
• TCP
• Port 8020
• IP Address of the MS-1
Biamp Systems 9300 S.W. Gemini Drive Beaverton, Oregon 97008 U.S.A. 503.641.7287 www.biamp.com 4
Within this document example screenshots are shown that detail connecting to the MS-1
VTP service via a software tool called PuTTY. PuTTY is a free implementation of Telnet
and SSH for Windows and Unix platforms, along with an
xterm terminal emulator. This
software can be downloaded from the following link:
http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
Instructions on its use can be found here:
http://www.chiark.greenend.org.uk/~sgtatham/putty/docs.html
PuTTY is used in this document to demonstrate the communications that would take place
between a third party control system and a Vocia MS-1.
Figure 2 – PuTTY Configuration Window
Shown above in Fig ure 2 is a screenshot of the PuTTY emulation tool configured to
communicate with an MS-1 at IP address 10.21.12.50. The connection type has been set
as a RAW socket through port 8020. Selecting Open will initiate communication with the
MS-1 and VTP commands can then be sent.
Biamp Systems 9300 S.W. Gemini Drive Beaverton, Oregon 97008 U.S.A. 503.641.7287 www.biamp.com 5
Loading...