®
RS-232 Control Manual
Table Of Contents
Overview.....................................................................................................................................................5
RS-232 Control...........................................................................................................................................6
Telnet Control.............................................................................................................................................6
Command...................................................................................................................................................7
Device Number...........................................................................................................................................9
Attribute ....................................................................................................................................................10
Input/Output Blocks..................................................................................................................................11
Mixer Blocks .............................................................................................................................................15
Equalizer Blocks.......................................................................................................................................17
Filter Blocks..............................................................................................................................................18
Crossover Blocks......................................................................................................................................19
Dynamics Blocks ......................................................................................................................................20
Router Blocks ...........................................................................................................................................21
Delay Blocks.............................................................................................................................................22
Control Blocks...........................................................................................................................................23
Meter Blocks.............................................................................................................................................24
Generator Blocks......................................................................................................................................25
Instance ID................................................................................................................................................26
Index.........................................................................................................................................................27
Value.........................................................................................................................................................28
Responses................................................................................................................................................29
HyperTerminal..........................................................................................................................................32
IP Address Commands.............................................................................................................................32
Index.........................................................................................................................................................34
iii
RS-232 and Telnet Protocol
Overview
Nexia can be controlled via the control dialogs in the Nexia software, or via third-party controllers using RS-232
Telnet.
For control of Nexia, Biamp created NTP (Nexia Text Protocol). This simply means that Nexia will accept strings of
ASCII characters to control and read settings of gain, mute, logic state, frequency, audio levels, and other parameters
of DSP Blocks in Nexia products.
NTP strings can be sent via third-party controllers using RS-232 (see RS-232 Control
Telnet Control). A line feed needs to be sent after each command string sent.
) or Telnet via TCP/IP (see
or
The NTP string is structured in the following order:
Command
NTP strings require a space between each parameter; the last character in the st ring needs to be a line feed <LF>. A
space is not required before a line feed, but is acceptable and is used in examples shown in this manual (for legibility
only). A space normally proceeds the carriage return/line feed <CR><LF> in a response to a GET command (see
Command and Responses).
For each control string a few components will need to be derived from the Nexia software: Device Number
InstanceID, and Index. Command and Attribute are derived from this document. In a SET command, Value is used to
specify what the DSP block attribute is to be set to. In an increment or decrement (INC or DEC) command Value is
used to specify how much the DSP block attribute is to be changed by.
**Note** Nexia software will assign an Instance ID number to each DSP block on the initial Compile
Subsequent compiles will not change the Instance ID numbers unless the "Reassign Instance IDs" check box is
selected in the ‘Compile
Custom names (Instance ID Tags
NTP command strings.
Example: A string to control a Fader Level might look like this: SET 1 FDRLVL 2 1 9 <LF>.
The individual components for this string are:
Command Dev # Attribute Inst ID Index 1 Index 2 Value Line Feed
Notice that Index2 is not used since there is nothing entered in this parameter.
Example: A string to Mute a Standard Mixer Output: SET 3 SMMUTEOUT 5 5 1 <LF>
The individual components for this string are:
Command Dev # Attribute Inst ID Index 1 Index 2 Value Line Feed
Notice that Index1 is not used since there is nothing entered in this parameter.
Example: A string to turn up (increment) a Crosspoint on a Matrix Mixer: INC 2 MMLVLXP 4 3 2 1 <LF>
The individual components for this string are:
Command Dev # Attribute Inst ID Index 1 Index 2 Value Line Feed
In this example Index1 and Index2 are both used, together they specify which Crosspoint to change.
DeviceNumber Attribute InstanceID Index1 Index2 Value <LF>
,
of the system.
’ tab of the ‘Options’ screen (located on the Tools pull-down menu) in the Nexia software.
) may be assigned to DSP blocks, and used in lieu of Instance ID numbers within
SET 1 FDRLVL 2 1 None 9 <LF>
SET 3 SMMUTEOUT 5 None 5 1 <LF>
INC 2 MMLVLXP 4 3 2 1 <LF>
5
Nexia-RS232
RS-232 Control
The RS-232 port on the back of an Nexia unit is set to a default baud rate of 38400, 8 data bits, no parity, 1 stop bit,
and no flow control. (38400:8:None:1). If multiple Nexias are connected together in a system then only one RS-232
port needs to be connected to a third-party control system; communication data is shared via Ethernet throu gh a
switch.
When controlling multiple Nexia units that are not part of the same NEX file, each Nexia unit will need to be addressed
via its own RS-232 port from a control system or PC. Nexia units cannot be linked together via RS-232, like some
other BIAMP products can.
(The RS-232 baud rate can be set to 9600, 19200, 38400, 57600, or 115200 – default is 384 00)
A straight through PC Serial Cable is used to communicate from an RS-232 port on a third-party controller (or PC*) to
the RS-232 port located on the back of an Nexia unit.
Since the Nexia's serial port does not implement flow control, waiting for a response from the Nexia is essential prio r
to sending the next command. After receiving the +OK response, the next command can be sent. By waiting for the
+OK response, the serial buffer will not be overloaded.
(* A PC can send/receive NTP Strings, using a terminal emulator program such as Hype rTerminal.)
Telnet Control
Nexia can be controlled using Telnet via TCP/IP. The same command strings that are used for RS-232 Control are
used for Telnet.
When controlling multiple Nexias that are not a part of the same NEX file, each Nexia device will need to be
addressed via its own Telnet session from a control system or PC.
Nexia supports standard Telnet Echo Negotiation. By default, the Telnet server will echo characters sent to it, one by
one.
To turn echo OFF during a session
:
Send byte sequence 0xFF 0xFE 0x01.
Receive 3 byte response from server (0xFF 0xFC 0x01 = echo OFF).
Send desired commands.
To turn echo back ON during a session
:
Send byte sequence 0xFF 0xFD 0x01.
Receive 3 byte response from server (0xFF 0xFB 0x01 = echo ON).
Send desired commands.
6
Index
Command
SET – Tells
points
GET - Tells Nexia that a DSP attribute is to be read – the response may contain a decimal point and/or a negative
number
INC - Tells Nexia that a DSP attribute is to be incremented by a specific amount
DEC- Tells Nexia that a DSP attribute is to be decremented by a specific amount
RECALL – Tells Nexia that a preset is to be recalled.
DIAL – Tells the Nexia that a dial command is being sent
Nexia that a DSP attribute is to be set to a specific value – may contain negative numbers and/or decimal
(see Responses).
SETL and GETL can be used if negative numbers and/or decimals are not supported by a control system.
SETL – Tells Nexia that a DSP attribute is to be set to a specific value, no decimal places or negative numbers –To
convert a dB number: add 100 to the desired level and then multiply by 10.
Example: To set a level to –60.5dB, add 100 (-60.5 +100 = 39.5). Then multiply by 10 (39.5 X 10 = 395). Instead of
Value being –60.5, Value after this SETL command will equal 395.
GETL - Tells Nexia that a DSP attribute is to be read without negative numbers or decimals. To convert this number to
dB: divide the number by 10, then subtract 100.
Example: With a returned GETL response of 405, divide by 10 (405 / 10 = 40.5), and then subtract 100 (40.5 – 100 = -
59.5dB)
For your reference, the SETL/GETL Table on the following page shows .5dB increments converted into the
SETL/GETL format.
Some Attributes do not support all commands. The Attribute
GET/GETL, INC, or DEC functions. RECALL is only used on preset commands. DIAL is only used on telephone
dialing commands.
*When GET or GETL is used, a Value
must be specified in order for strings with SET/SETL, INC, DEC, and RECALL to work.
Note: SETD, GETD, INCD, DECD, SETLD, and GETLD commands may be used when a ‘full path’ serial response to
the command is desired (see Responses
the original command, and the resulting value or state.
will not need to be specified since GET/GETL is a request command. A Value
). A ‘full path’ serial response will provide identification of the target object,
section defines which commands support SET/SETL,
7
Nexia-RS232
Level Value Level Value Level Value Level Value Level Value
12 1120 -10.5 895 -33 670 -55.5 445 -78 220
11.5 1115 -11 890 -33.5 665 -56 440 -78.5 215
11 1110 -12 885 -34 660 -56.5 435 -79 210
10.5 1105 -12.5 880 -34.5 655 -57 430 -79.5 205
10 1100 -13 875 -35 650 -57.5 425 -80 200
9.5 1095 -13.5 870 -35.5 645 -58 420 -80.5 195
9 1090 -14 865 -36 640 -58.5 415 -81 190
8.5 1085 -14.5 860 -36.5 635 -59 410 -81.5 185
8 1080 -15 855 -37 630 -59.5 405 -82 180
7.5 1075 -15.5 850 -37.5 625 -60 400 -82.5 175
7 1070 -16 845 -38 620 -60.5 395 -83 170
6.5 1065 -16.5 840 -38.5 615 -61 390 -83.5 165
6 1060 -17 835 -39 610 -61.5 385 -84 160
5.5 1055 -17.5 830 -39.5 605 -62 380 -84.5 155
5 1050 -18 825 -40 600 -62.5 375 -85 150
4.5 1045 -18.5 820 -40.5 595 -63 370 -85.5 145
4 1040 -19 815 -41 590 -63.5 365 -86 140
3.5 1035 -19.5 810 -41.5 585 -64 360 -86.5 135
3 1030 -20 805 -42 580 -64.5 355 -87 130
2.5 1025 -20.5 800 -42.5 575 -65 350 -87.5 125
2 1020 -21 795 -43 570 -65.5 345 -88 120
1.5 1015 -21.5 790 -43.5 565 -66 340 -88.5 115
1 1010 -22 785 -44 560 -66.5 335 -89 110
.5 1005 -22.5 780 -44.5 555 -67 330 -89.5 105
0 1000 -23 775 -45 550 -67.5 325 -90 100
-.5 995 -23.5 770 -45.5 545 -68 320 -90.5 95
-1 990 -24 765 -46 540 -68.5 315 -91 90
-1.5 985 -24.5 760 -46.5 535 -69 310 -91.5 85
-2 980 -25 755 -47 530 -69.5 305 -92 80
-2.5 975 -25.5 750 -47.5 525 -70 300 -92.5 75
-3 970 -26 745 -48 520 -70.5 295 -93 70
-3.5 965 -26.5 740 -48.5 515 -71 290 -93.5 65
-4 960 -27 735 -49 510 -71.5 285 -94 60
-4.5 955 -27.5 730 -49.5 505 -72 280 -94.5 55
-5 950 -28 725 -50 500 -72.5 275 -95 50
-5.5 945 -28.5 720 -50.5 495 -73 270 -95.5 45
-6 940 -29 715 -51 490 -73.5 265 -96 40
-6.5 935 -29.5 710 -51.5 485 -74 260 -96.5 35
-7 930 -30 705 -52 480 -74.5 255 -97 30
-7.5 925 -30.5 700 -52.5 475 -75 250 -97.5 25
-8 920 -31 695 -53 470 -75.5 245 -98 20
-8.5 915 -31.5 690 -53.5 465 -76 240 -98.5 15
-9 910 -32 685 -54 460 -76.5 235 -99 10
-9.5 905 -32.5 680 -54.5 455 -77 230 -99.5 5
-10 900 -33 675 -55 450 -77.5 225 -100 0
8
Device Number
A Nexia Device Number represents the physical Nexia box’s defined address. The Nexia software automatically sets
this number when a system is Compiled
and loaded.
The Device number that a DSP block has been assigned to can be determined in 3 ways:
First Way
1. Right click on the DSP block and select ‘Properties’.
2. Click on DSP 1 attributes tab and scroll down. The device that the block is assigned to will be
:
displayed in the ‘Allocated To Unit’ field.
Index
Second Way
1. In the Display tab of the Options screen select "Display Device Assignment in DSP
Block info field". This will display the device that each DSP block is assigned to on the main screen.
Third Way
1. While connected an Nexia’s RS-232 port, type the string; GET 0 DEVID
Nexia will return the Device Number of the unit you are connected to.
:
:
9
Nexia-RS232
Attribute
The Attribute defines the portion of the DSP block to be controlled (fader level, crosspoint mute etc). The following
tables show whether each NTP Attribute supports SET/SETL, GET/GETL, INC, and DEC Commands
, as well as the
Value range that the Attribute will accept. Index1/Index2 determines whether Index1, Index2 or BOTH are needed for
a NTP String to be complete.
NTP Strings can address: (click on the links to view the tables in each topic)
Input/Output Blocks
Mixer Blocks
Equalizer Blocks
Filter Blocks
Crossover Blocks
Dynamics Blocks
Router Blocks
Delay Blocks
Control Blocks
Meter Blocks
Generator Blocks
10
Input/Output Blocks
The following table of Attributes is valid for all Nexia input blocks except
Nexia PM Stereo Line Inputs, Nexia TC &
Nexia VC AEC Inputs, and Nexia TC & Nexia VC Pre-AEC Inputs.
Analog Inputs Attribute Commands Index Value Range
Input Gain INPGAIN SET, SETL, GET, GETL, INC,
DEC
Input Level INPLVL SET, SETL, GET, GETL, INC,
1 0, 6, 12, 18, 24, 30, 36,
42, 48, 54, 60, 66
1 -100 ~ 12 *
DEC
Phantom Power PHPWR SET, GET 1 0 = off
1 = on
Input Mute INPMUTE SET, GET 1 0 = unmuted
1 = muted
Invert Polarity INPINVRT SET, GET 1 0 =normal
1 = inverted
* Can contain a decimal number.
Note: Nexia SP Line Inputs only support input gain values of 0, 6, 12, & 18 (dB).
Example: Set Device 1 Input Level at Instance ID 6, Input 3 to –10dB.
Command Dev # Attribute Inst ID Index 1 Index 2 Value Line Feed
SET 1 INPLVL 6 3 None -10 <LF>
Result: SET 1 INPLVL 6 3 –10 <LF>
The following table of Attributes is valid for all Nexia output blocks except
Nexia PM Stereo Line Outputs.
Outputs Attribute Commands Index Value Range
Output
Level
OUTLVL SET, SETL, GET, GETL, INC,
DEC
2 -100 ~ 0 *
Output OUTMUTE SET, GET 2 0 = unmuted
1 = muted
Output Full
OUTFS SET, SETL, GET, GETL 2 -31, 0, 6, 12, 18, 24
Scale Level **
Invert
Polarity
OUTINVRT SET, GET 2 0 = normal
1 = inverted
* Can contain a decimal number.
Note: Nexia SP Line Outputs do not support the output full scale value of -31 (dBu).
Example: Set Device 2 Output Mute at Instance ID 3, Output 4 to muted.
Command Dev # Attribute Inst ID Index 1 Index 2 Value Line Feed
SET 2 OUTMUTE 2 None 4 1 <LF>
Result: SET 2 OUTMUTE 3 4 1 <LF>
The following table of Attributes is valid only
for Nexia PM Stereo Line Inputs.
PM Stereo Line
Attribute Commands Index Value Range
Inputs
Line Input Gain INPGAINPML SET, SETL, GET, GETL, INC,
1 0, 6, 12, 18
DEC
Input Level INPLVLPML SET, SETL, GET, GETL, INC,
1 -100 ~ 12 *
DEC
Input Mute INPMUTEPML SET, GET 1 0 = unmuted
1 = muted
Input Invert INPINVRTPML SET, GET 1 0 = normal
1 = inverted
Line Input Stereo
Linking
INPGANGPML SET, GET 1 0 = separate
1 = ganged
* Can contain a decimal number.
Note: PM Line Input faders can be ganged as pairs: 1 & 2, 3 & 4, 5 & 6, 7 & 8, 9 & 10, and 11 & 12.
Index1 is used to indicate either one of the Inputs in the pair to be ganged (not both).
Index
11
Loading...