Technical Newsletter
VOLUME I, ISSUE 5
NOVEMBER ISSUE
Third Party Control
In the last few years, system control has
clearly become a major design aspect of a
successful A/V installation. With flexibility,
robustness and user acceptance in mind,
control system design creates all sorts of
new challenges for integrators, consultants
and programmers.
Biamp’s Audia and Nexia DSP platforms
have a complete control protocol that is
simple to use and understand yet provides
the flexibility necessary to integrate into
any 3rd party A/V control system.
In this month’s issue, we hope to get
beginners fluent with our control protocol
and/or just improve the existing knowledge of experienced users. While the first
section will highlight the basics of the control protocol, the subsequent sections will
focus on advanced features such as the
newly introduced “Full Path Response”.
We want to hear from you. Share your
comments, suggest topics for future
issues of the newsletter by e-mailing us
at [email protected].
Biamp Technical Support Team
Audia/Nexia Text Protocol
ATP/NTP
ATP stands for Audia Text Protocol while NTP stands for Nexia Text Protocol. Both protocols allows one to control Audia/
Nexia DSP platforms from a third party device (Control processor, PC, etc…).
Command structure
Both ATP and NTP commands have a similar command structure:
COMMAND DEVICE_ID ATTRIBUTE INSTANCE_ID INDEX_1 INDEX _2 VALUE <LF>
COMMAND: SET / GET / INC / DEC / RECALL / DIAL / SETL / GETL
DEVICE_ID: In a multi-unit system, each DSP block is assigned to a device during the compilation process.
ATTRIBUTE: Each processing block carries a set of attributes to control various settings of the block.
INSTANCE_ID: A unique number assigned to each block during the compilation process.
INDEX_1: Depending on the attributes, Index1 will refer to an input or a row of cross points.
INDEX_2: Depending on the attributes, Index2 will refer to an output or a column of cross points.
VALUE: Specified setting /adjustment to be performed on the defined attribute.
<LF>: A line feed (LF) must always terminate a command.
Example: In a multi-unit system (Device 3), increase (INC) the gain of a level control block (FDRLVL). The Instance ID shall be 2,
the channel 4 (Index 1) and the increment of 2dB (VALUE):
•
•
•
•
•
•
•
•
INC 3 FDRLVL 2 4 2 <LF>
Example: Recall (RECALL) preset 1004 in a multi-units system (DEVICE_ID is 0 since presets apply to the entire system):
RECALL 0 PRESET 1004 <LF>
ATP/NTP protocol reference manual
In Audia/Nexia software, a complete list of commands is available under the “System Control” section of the help file.
A control protocol manual is also available for download on Biamp Systems’ website or software CD (Help file folder).
Things to remember about third party control
•
•
•
•
Audia/Nexia DSP platforms can only receive and interpret ATP/NTP commands.
ATP/NTP commands must be executed with ALL CAPS on.
Successful execution of a command will be followed by a +OK <CR><LF> (Carriage return + Line Feed).
Device ID for a RECALL command will always be 0 since presets apply to the entire system.
Did you know?
Our technical support team is growing again! Welcome to Kevin Jacobson, the latest addition to the Technical support team!
Kevin will be based out of Biamp's Headquarters in Beaverton, Oregon and will be responsible for providing technical and
product application support to Biamp customers throughout the world. As a Product Application Specialist, Kevin will report
directly to Kiley Henner, Technical Support Manager.
PAGE 1
PAGE 2
Control from a Serial Connection
A serial connection is a handy troubleshooting tool operating from your favorite terminal software.
Serial connection settings
1.
2.
3.
4.
5.
1.
2.
3.
4.
With a straight through serial cable in place between the DSP unit and your PC, open Hyper Terminal.
In Windows Start menu, select Program
Accessories
Communications
HyperTerminal.
Enter a name for the new connection, then click OK.
In the next dialog box, select your COM port in the “Connect Using” drop down menu.
Set the port settings as follow:
Bits per Second: 38400 (Factory default settings)
Data bits: 8
Parity: None
Stop bits: 1
Flow control: None
You should now be connected to the unit. To enable Character echo locally, go to File
Properties
Settings tab.
Click on ASCII Setup and check: “Send line Ends with line feeds” and “Echo typed characters locally”.
Test the connection with the unit by pressing ENTER a couple of times. (ERR:SYNTAX response will indicate proper connection)
You are now able to send your ATP or NTP commands from the terminal.
Finally, Save the connection settings for a quick setup on your next connection to the unit.
Recovering an IP address
If the IP address of a unit is unknown, a serial connection is your only means to recover it.
1. Using the previously created HyperTerminal session, power cycle the unit while connected.
2. At the reboot of the unit, the following message should appear on your terminal screen:
*INFO:Welcome to the Audia Text Protocol Server…
*INFO:Running firmware 3.207-2.3-4.360
*INFO:IP Address: 192.168.3.102
*INFO:Subnet Mask: 255.255.255.0
*INFO:Default Gateway: 0.0.0.0
*INFO:Audio Stopped
*INFO:READY.
You are now connected to the unit and have recovered the IP address of the DSP unit.
Control from a Telnet Session
Providing you know the IP address of the unit, control from a telnet session may be easier.
Telnet session
1.
2.
In Windows Start Menu, select Run and type Telnet xxx.xxx.xxx.xxx (xxx is the IP address of the unit) and click OK.
A successful connection will receive the following confirmation message:
3.
For testing purposes, let’s send a simple ATP/NTP command to mute channel 1 of the input block of a single unit system
COMMAND: SET
DEVICE_ID: 1 (Single unit system)
ATTRIBUTE: INPMUTE
INSTANCE_ID: 14
INDEX_1 (Input Ch #): 1
INDEX_2: not applicable
VALUE : 1 (muted)
Note how +OK is returned to confirm the execution of the command.
4.
PAGE 2
PAGE 3
Advanced Control Programming
Full Path ATP/NTP response - New Feature!
While the ATP/NTP protocol already provided extensive control of our DSP platforms, explicit feedback on the execution of
the command (other than +OK) was a common request from most control programmers. Full path responses are now available starting with firmware release 1.360 (Nexia), 3.360 (AudiaSolo) and 4.360 (AudiaFlex).
Command syntax:
For maximum flexibility and complete backwards compatibility, the command syntax is unchanged. The only variant is adding a
“D” (Detailed) to the normal command set:
SETD / GETD / INCD / DECD / SETLD / DECLD
Full path response syntax:
The structure of a full path response is as follow:
# [Original command less any value specified] [Resulting value] [ Typical Full path off response]
Examples
The following examples of current response versus “Full path” response format will provide a better side by side comparison:
Note: Unlike SETD command/response, INCD/DECD response provide the resulting value rather than the increment value.
A white paper describing Full path response is also available for download at the technical support section of the website.
Control of a Third Party Device
This document principally highlighted the ATP/NTP protocol, it should however be noted that Audia/Nexia platforms are also
capable of controlling third party devices using the Command string block (Available in the Control section of the object toolbar).
Pushing it a step further, while daVinci is already a very good control interface for Audia/Nexia platforms, it could easily turn into a
touch panel alternative for control applications requiring no feedback. (e.g. projector, blinds, lighting controller,
partition motors, etc).
PAGE 3
PAGE 4
Template file of the month
A template file will not be provided with this issue since the topic has no real application from a Audia/Nexia software point of
view. We would however like to strongly recommend training yourself on the ATP/NTP protocol, full path responses and other
topics detailed in this issue.
Product/Software Release Announcement
A quick summary of what our Engineering department has been up to for the past few months:
•
RCB hub now shipping: All RCB control accessories (VS8/S8/V8/Logic Box/Voltage Control Box) are to be installed in
a daisy chain topology. A tree topology, with branching of the RCB control bus for up to 8 ports, is now possible with
the introduction of the RCB hub. For more information, download the RCB hub specification sheet from our website.
•
Template Nexia TC/VC files: In an effort to get your Nexia TC/VC design up and running in the quickest time, our
team developed a series of template files for different design combinations (e.g: 1x TC + 1 x VC; 1 x TC + 3 x VC…).
If you are interested, contact the technical support team for a copy of the template files.
•
Networking details application note: Jason Damori (Hardware Development manager) authored a very useful application note now available for download on our website. Need to learn more about networking ports on Biamp networkenabled products, download the Networking Details tech note at biamp.com/support.php.
•
Archiving and distribution of the Newsletter: Previous issues of this technical newsletter are now available for
download from the Technical Support section of our website. If you would like to include yourself or other team members on the distribution list, simply create an account at biamp.com. The newsletter will only be received if you specify
yourself as an Integrator/Consultant/Distributor.
Biamp Technical Support Team
US West Coast Office (Headquarters)
Contact Information
Technical Support Manager :
Product Application Specialist :
Product Application Specialist :
Email: [email protected]
Phone: +1 800 826 1457 (North America only)
+1 503 341 7287
Kiley Henner
Michael Erwin
Kevin Jacobson
US East Coast Office
Product Application Specialist :
Contact Information
Chris Flanagan
Email: [email protected]
Phone: +1 919 333 2331
Asia Pacific Office (Hong Kong)
Contact Information
Product Application Specialist :
Email: [email protected]
Phone: +852 9305 1255
Tony Rouget
Biamp Sales Team Contact Info
Regional Sales Managers
Contact Biamp Systems’ Head Office for more information on the local regional sales manager in charge of your area.
PAGE 4