AEC -- Enable or Disable Acoustic Echo Cancellation
8.2.
AECMODE -- Set Amount of Double Talk Suppression used in the AEC.
8.3.
AGC -- Enable or Disable Mic/Line Input Automatic Gain Control
8.4.
AGCMAX -- Set Maximum Allowed Mic/Line Input AGC Gain
8.5.
AGCMIN -- Set Minimum Allowed Mic/Line Input AGC Gain
8.6.
AGCRATE -- Set Ramp Rate of Mic/Line Input AGC
8.7.
AMASGN -- Assign Inputs to an Automixer
8.8.
AMAUTO -- Select Automatic or Manual Gating for each Automixer Input
8.9.
8.10.
8.11.
8.12.
8.13.
AMBUSID -- Set Automixer Groupings for EF Bus
AMCHAIR -- Enable Chairman Mode for Specified Automixer
AMCHNUM -- Set Chairman Mic
AMDECAY -- Set Decay Time for Automixers
Page 3
8.14. AMGATEC -- Set Automixer Gating Control Mode
8.15.
8.16.
8.17.
8.18.
8.19.
8.20.
8.21.
8.22.
8.23.
8.24.
8.25.
8.26.
8.27.
8.28.
8.29.
8.30.
8.31.
8.32.
8.33.
8.34.
8.35.
8.36.
8.37.
8.38.
8.39.
8.40.
8.41.
8.42.
8.43.
8.44.
8.45.
8.46.
8.47.
8.48.
8.49.
8.50.
8.51.
8.52.
8.53.
8.54.
8.55.
8.56.
8.57.
8.58.
AMGATER -- Set Automixer Gate Ratio
AMGATET -- Set Automixer Gate Threshold
AMGNOM -- Set Global Maximum Number of Open Mics for Bus Automixer
AMHOLD -- Set Automixer Hold Time
AMLMM -- Set Last Mic On Mode for Specified Automixer
AMLMN -- Set Microphone That Will Remain On in Manual Last Mic On Mode
AMNOM -- Set Local Maximum Number of Open Mics for Automixer
AMNOMAT -- Select NOM Attenuation on Each Output
AMOFFAT -- Set Off Attenuation for the Specified Automixer
AMPRIOR -- Set Gating Priority for the Specified Mic
AMREFB -- Set Automixer Reference Bias for the Specified Automixer
AMREFE -- Enable Automixer Reference for Specified Automixer
BAUD -- Set Baud Rate for RS-232 Port
BLAUTO -- Enable Automatic BLDATA Messages
BLDATA -- Request Level Information
BLINFO -- Select Information to be Reported in BLDATA
BROAD2 -- Broadcast Arbitrary Command Strings to RS-232 Port
BROADA -- Broadcast Commands to Other Connected Devices
BUSREF -- Set Which AEC Reference is Placed on EF Bus
CGATE -- Query Camera Gating Status Information
CGATEEN -- Enable Automatic Camera Gating Messages
CGATET -- Set Camera Gating Hold Time
DELAYO -- Set Output Delay
DELAYOE -- Enable Output Delay
DSPAUTO -- Enable Automatic DSPLOAD Status Messages
DSPLOAD -- Query Percentage of Variable DSP Resources Used
ERROR -- Enable or Disable Error Messages
FADERGIL -- Set Fader Gain of Line Inputs as a Group
FADERI -- Set Input Gain Fader
FLOW -- Set Flow Control Mode for RS-232 Port
FPLOCK -- Lock/Unlock Front Panel
FPPSWD -- Change Front Panel Password
GAINGIL -- Set Gain of Line Inputs as a Group
GAINI -- Set Input Gain
GAINO -- Set Output Gain
GATE -- Query Gating Status Information
GATEEN -- Enable Automatic Gating Messages
GMUTEO -- Mute All Outputs
ID -- Set Device ID
LABEL -- Set or Query one of the Device Labels
LAGC -- Enable or Disable Line Input Automatic Gain Control
LAGCLINKAB -- Enable or Disable Stereo AGC Linking on Inputs A and B
LAGCMAX -- Set Maximum Allowed Line Input AGC Gain
LAGCMIN -- Set Minimum Allowed Line Input AGC Gain
Page 4
8.59. LAGCRATE -- Set Ramp Rate of Line Input AGC
8.60.
8.61.
8.62.
8.63.
8.64.
8.65.
8.66.
8.67.
8.68.
8.69.
8.70.
8.71.
8.72.
8.73.
8.74.
8.75.
8.76.
8.77.
8.78.
8.79.
8.80.
8.81.
8.82.
8.83.
8.84.
8.85.
8.86.
8.87.
8.88.
8.89.
8.90.
8.91.
8.92.
8.93.
8.94.
8.95.
8.96.
8.97.
8.98.
8.99.
8.100.
8.101.
8.102.
8.103.
MACROA -- Add Command to Current Macro
MACROK -- Delete One or All Macros
MACROL -- List All Commmands in a Macro
MACROQ -- Execute Macro Quietly
MACROS -- Start a New Macro
MACROW -- Write Macro to Non-Volatile Memory
MACROX -- Execute Macro
METER -- Select which Signal is Displayed on the Front Panel LED Meter
MGAIN -- Set Crosspoint Gains in Main Matrix or Submatrix
MGATE -- Select Gated or Ungated Microphone Signal in Matrix
MIC -- Enable Microphone Gain Stage on Input 1
MINI -- Enable Modem Initialization String
MINISTR -- Set Modem Initialization String
MMUTE -- Mute Crosspoint in Main Matrix or Submatrix
MUTEGIL -- Set Mute Status of Line Inputs as a Group
MUTEI -- Mute One or More Inputs
MUTEO -- Mute One or More Outputs
NC -- Enable Noise Cancellation
NCL -- Set Noise Cancellation Attenuation
NVINIT -- Reinitialize Non-Volatile Memory
NVLOCK -- Lock/Unlock Non-Volatile Memory
NVPSWD -- Change Non-Volatile Memory Password
PEQIA -- Set All Parameters for Specified Parametric EQ Input Stage
PEQIB -- Set Bandwidth Parameter for Specified Parametric EQ Input Stage
PEQIE -- Set Enabled Parameter for Specified Parametric EQ Input Stage
PEQIF -- Set Frequency Parameter for Specified Parametric EQ Input Stage
PEQIG -- Set Gain Parameter for Specified Parametric EQ Input Stage
PEQIS -- Set Slope Parameter for Specified Parametric EQ Input Stage
PEQIT -- Set Type Parameter for Specified Parametric EQ Input Stage
PEQOA -- Set All Parameters for Specified Parametric EQ Output Stage
PEQOB -- Set Bandwidth Parameter for Specified Parametric EQ Output Stage
PEQOE -- Set Enabled Parameter for Specified Parametric EQ Output Stage
PEQOF -- Set Frequency Parameter for Specified Parametric EQ Output Stage
PEQOG -- Set Gain Parameter for Specified Parametric EQ Output Stage
PEQOS -- Set Slope Parameter for Specified Parametric EQ Output Stage
PEQOT -- Set Type Parameter for Specified Parametric EQ Output Stage
PHANTOM -- Enable Phantom Power on Input 1
PING -- See Which Devices Are Present
PRESETK -- Delete One or All Presets
PRESETL -- List All Commmands in a Preset
PRESETP -- Set Which Preset Will Be Activated At Power-Up
PRESETQ -- Execute a Preset Quietly
PRESETW -- Save a Preset
PRESETX -- Execute a Preset
Page 5
8.104. REFASGN -- Assign AEC Reference to Input Channel
8.105.
8.106.
8.107.
8.108.
8.109.
8.110.
8.111.
8.112.
8.113.
8.114.
8.115.
8.116.
REFGAIN -- Set Reference Output Gain
SGGAIN -- Set Gain of Signal Generator
SGMUTE -- Mute Signal Generator
SGTYPE -- Set Type of Signal Produced by Signal Generator
SSDELAY -- Set Delay Between Screen Saver Screens
SSEN -- Enable or Disable Screen Saver
SSSTART -- Set Idle Time Required for Screen Saver to Start
SSTEXT -- Set Text to be Displayed by Screen Saver
SWRESET -- Perform Soft Reset of System
SWVER -- Query Software Version
VTXMODI -- Enable VTX Mode on Specified Inputs
VTXMODO -- Enable VTX Mode on Specified Inputs
1. Introduction
This document describes the command protocol that is used to communicate with the Vortex EF2210
via its RS-232 port.
2. RS-232 Hardware
The communication between the Vortex and a host controller is conducted via the RS-232 port on the
back panel of the Vortex. The Vortex's RS-232 port operates at the following settings:
● Bit Rate (bps): 9600 (default), 19200, or 38400
● Data Format: 8 data bits, no parity, 1 stop bit (8N1)
● Flow Control: none (default) or hardware (RTS, CTS)
Note that although the flow control setting is user selectable to none or hardware, hardware flow
control must be used when updating the firmware of the Vortex. This means that while a 3-wire RS232 cable (RX, TX, GND) is acceptable for control of the Vortex, the minimum cable for updating
firmware should contain 5 wires (RX, TX, RTS, CTS, GND).
3. Programming Tips
3.1. Initialization
During power up of the Vortex device or initialization of the host program, electrical fluctuations on
the RS-232 lines may cause the Vortex to receive spurious data. After initialization, the host program
should send a few carriage return characters (^M, ASCII 13) to the connected Vortex to flush out any
spurious characters it may have received. Failure to do this could result in the Vortex ignoring the first
command received after initialization.
As part of the host program initialization, the host will want to synchronize the status of its controls
Page 6
with the current status of the Vortex devices that are being controlled. The host could initialize its
controls to default values and then send commands to the Vortexes to set them to the same state.
This approach has significant disadvantages since initializing the host program could undo settings
made by other host programs or by the front panel controls of one of the linked Vortex devices. A
better approach is to query the linked Vortex devices for their status and set the host program
controls based on the return values.
3.2. Wildcard Characters
The use of the wildcard character, '*', can make programming the host controller much easier. Be
careful when using wildcards, however, since they can generate a lot of traffic on the digital bus.
3.3. Using Acknowledgements
It is a good idea for the host program or control system to make sure that all connected Vortex
devices have acknowledgment mode enabled (see the ACKMOD command). When acknowledgment
mode is on, a Vortex device will send an acknowledgment for each command it receives. Proper use
of acknowledgments makes the host program more robust and makes supporting multiple hosts
effortless. The rest of this section describes how to use acknowledgments to achieve these goals.
As a convenient example, let us imagine a host program with a graphical user interface (GUI). The
user presses buttons on the GUI to enable or disable features of various linked Vortex devices. The
buttons on the GUI reflect the current status of the corresponding feature.
When the user presses a button on the GUI to enable or disable a feature, the host program should
send the corresponding command to the selected Vortex device. It may be tempting to update the
status of the GUI button at this point, but this can cause problems if there are transmission errors or
if there are multiple host controllers. The proper way to handle this is to only update the GUI controls
based on acknowledgments received from the Vortex device.
To implement this, organize your code so that the functions that send commands are totally separate
from the functions that receive responses from the Vortex devices. This also enables your host
program to support the presence of multiple host controllers. For example, consider the following
sequence of events.
1. Another host sends a command to a Vortex device.
2. The Vortex device responds with an acknowledgment that is broadcast to all of the other hosts.
3. Your host program receives the acknowledgment and updates the status of the corresponding
control.
The result of this programming model is that all hosts and linked Vortex devices will always be
synchronized.
For simple on/off features, your host program can make use of the toggle arguments to some
commands (e.g., 'SSEN2'). By sending a toggle command when a button is pressed, and updating the
button based on acknowledgments, your host program will not have to keep track of the status of the
button.
Page 7
In a similar fashion, many of the integer commands (such as gains) can be controlled by incrementing
or decrementing them by a specific amount. For example, the command ' ' increments the input gain
on channel by 1 dB. The acknowledgment for this command will return the actual value that the gain
was incremented to. Thus, to implement a volume control, your control program can send a
command to increment the gain by 1 dB when the "up" button is pressed and decrement the gain by
1 dB when the "down" button is pressed. The control can update its level indicator based on the
acknowledgment that is received.
3.4. Macros and Presets
Although macros and presets are similar, there are times when using one is better than the other.
Presets store the absolute values of all of the non-global settings of the device. This includes, but is
not limited to, input and output gain settings, matrix settings, algorithm settings, parametric EQ
settings, and automixer settings. See
saved to presets.
Presets should be used when you really want to change all the settings in a device. One example
would be when you want to have one unit be able to control different rooms. In this case, having a
preset for each different room is the easiest solution.
Section 7 for a list showing all the commands and which are
Macros are like mini-presets. You can define them to change only the settings you are interested in.
One advantage of macros over presets is that macros can make relative changes in addition to
absolute changes. An absolute change is something like "set the input gain to -3 dB". A relative
change is something like "raise the input gain by 3 dB". One example of using macros for a relative
change is stereo volume ramping. If you have two outputs setup to have left and right program
audio, then you could build a macro that contains two commands: one to increment the left channel
by 1 dB and the other to increment the right channel by 1 dB. Then, by calling that macro, you can
ramp the stereo outputs. A similar thing can be done with decreasing the volume.
Another thing to consider when using macros and presets is to use the
commands instead of the
macro or preset, but the X versions produce acknowledgements for the settings that change, while
the Q versions don't. If your control system updates its status by looking at the acknowledgements
that come back, then you'll probably want to use the X versions. Another option would be to use the
Q versions and then manually query the values you're interested in. If your control system does not
need use acknowledgements, or if you are manually querying the values you're interested in, using
the Q versions is better since it doesn't generate acknowledgements and thus reduces RS-232 traffic.
MACROX and PRESETX commands. Both the Q and X versions execute the
MACROQ and PRESETQ
4. Command Structure
A Vortex command consists of a series of ASCII characters with the following structure.
DescriptionNumber of CharactersRange of Values
Device Type1
Device ID2
0-9, A-Z, *
0-9, *
Page 8
Command Name1-7
Command Data0-64ASCII characters
0-9, A-Z
Command Terminator1
^M (ASCII 13)
4.1. Device Type
A single alphanumeric character is used to indicate the device type. The devices in Polycom's
EchoFree family have the following device types.
DeviceDevice Type
EF200
EF1210
EF2280
EF2241
EF2211
EF2210
EF2201
A
C
F
B
S
Q
T
Device type '*' can be used to send a command to all device types simultaneously.
4.2. Device ID
Two numeric characters are used to indicate the device ID. The Vortex can be configured for device
IDs from '00' to '07'. Note that even though the device ID is less than 10, the leading '0' must be
included. Device ID '**' can be used to send a command to all device IDs simultaneously. Some
examples of using wildcard characters are given below.
● 'Q**' broadcasts to all EF2210 devices that are linked together.
● '*07' broadcasts to all devices with device ID 07 (this format is not commonly used).
● '***' broadcasts to all devices that are linked together.
4.3. Command Name
The command name can be from 1 to 7 characters long. Command names will be specific to device
types. In other words, the EF2280 has its own command set, which is different from the EF2241's,
which is different from the EF1210's, etc. There are some commands, such as 'PING', that are
common among all the various command sets.
4.4. Command Data
The command data is a series of 0-64 characters containing payload data for the command.
Obviously, the command data will be specific to the command type. note that the maximum number
Page 9
of payload characters for the EF200 and EF1210 is 32, but the Vortex devices support up to 64
characters in the payload. This increase was necessary to accommodate the matrix gain and
macro/preset commands.
4.5. Command Terminator
The command terminator is a single character indicating the end of a command. ASCII 13 (^M) was
chosen as the terminator to allow manually typing commands using a simple text terminal.
4.6. Examples
In the following examples, Vortex commands are enclosed in single quotes, 'like this'. Also, the
terminator character is not explicitly shown, but its presence is implied.
Consider the command '***PING'. The device type and ID for this command are wildcards, thus the
command will be sent to all devices. The command name in this case is 'PING', and there are no data
characters (payload). Note that the 'PING' command is supported by all of the Vortex devices, thus
broadcasting the command to all devices makes sense.
Consider the command 'Q**GAINIA10'. The device type for this command is 'Q' and the device ID is
a wildcard, thus the command will be broadcast to all EF2210 devices linked together. The command
name in this case is 'GAINIA' and the command data (payload) is '10'. This command sets the gain
on input A of all connected EF2210's to 10 dB.
CommandEffects
***PING
Q**GAINIA10
Requests PONG response from all linked Vortex devices.
Sets the gain on input A of all connected EF2210 devices to 10 dB.
5. Status Messages
The Vortex sends status messages via RS-232 and EF Bus any time one of its internal parameters
changes. This means that the host program does not need to continually poll the Vortex in order to
detect status changes. Status messages are in the same format as the commands used to set the
corresponding parameter.
For example, suppose you send the command 'Q**GAINIA10' and there are two EF2210's linked
together with device IDs 3 and 7. The EF2210's will respond with 'Q03GAINIA10' and
'Q07GAINIA10', respectively. Now, someone uses the front panel of the EF2210 set to ID 7 to
decrease input A's gain by 1 dB. When this happens, the EF2210 will respond with 'Q07GAINIA9'.
This example illustrates that status messages can be sent as the result of an RS-232 command or as
the result of some other change in the Vortex device such as front panel adjustments, logic inputs,
etc.
Status messages can be turned off via the
mode since the term status message and acknowledgement are synonymous for our purposes.
ACKMOD command. ACKMOD refers to acknowledgement
Page 10
6. Command Types
Many of the Vortex commands have similar formats. The main formats are described here in order to
provide a better understanding of the command set.
6.1. Boolean Commands
Boolean commands take one of the three following arguments.
● '0' indicates that the parameter should be turned off.
● '1' indicates that the parameter should be turned on.
● '2' indicates that the parameter should be toggled (i.e., '0' becomes '1' and '1' becomes '0').
Parameters associated with boolean commands can be queried using the '?' character. For example, if
input A is muted, and you send ' Q04MUTEIA? ', the EF2210 will respond with a status message of '
Q04MUTEIA1 '. When a status message is generated for a boolean command, the command data will
either be a '0' or '1', since '2' is obviously not a valid state.
6.2. Integer Commands
Integer commands can take one of two types of arguments. The first argument type is absolute,
meaning that the parameter will be set to the specified number. For example, ' Q04GAINIA10 '
means that the gain on input A will be set to 10 dB. In this case, the device will respond with a status
message of ' Q04GAINIA10 '.
The second argument type is relative, meaning that the parameter will be incremented or
decremented by the specified amount. The increment character is '>' and the decrement character is
'<'. For example, ' Q04GAINIA>3 ' increments the gain on input A by 3 dB. If the input's gain was
previously set to 6 dB, then it would now be set to 9 dB. In this case the device would respond with a
status message of ' Q04GAINIA9 '.
The numeric part of both the absolute and relative arguments can contain a '+' or '-' to indicate the
algebraic sign of the argument. If no sign is given, '+' is assumed.
The parameters associated with integer commands have maximum and minimum values associated
with them. If you try to set a parameter above its maximum or below its minimum, the parameter will
be set to its maximum or minimum value, respectively.
Parameters associated with integer commands can be queried using the '?' character. For example, if
input A 's gain is set to 12, and you send ' Q04GAINIA? ', the device will respond with a status
message of ' Q04GAINIA12 '.
6.3. Channel Commands
Page 11
A command can be a channel command in addition to being one of the other types of commands
(integer or boolean). A channel command means that the command applies to a specific input or
output channel. The channel is specified by a single character (e.g., '1', 'A', 'B', etc.) occurring before
any other payload data.
An example of a boolean channel command is the '
AGC' (Automatic Gain Control) command. '
Q04AGC10 ' disables the AEC on input channel 1 . After sending this command, the device will
respond with a status message of ' Q04AGC10 '.
An example of an integer channel command is the 'GAINI' command, which adjusts the gain on the
input channels. ' Q04GAINIA12 ' sets the input gain of channel A to 12 dB. After sending this
command, the device will respond with a status message of ' Q04GAINIA12 '.
A wildcard character ('*') can be used as the channel specifier for many of the channel commands. If
this is the case, there are two options for specifying the values for the channels. The first method is
to specify a single value that will be applied to all the channels.
Take the
MUTEI command for example: ' Q04MUTEI*1' mutes input channels 1 and A-B After
sending this command, the device will respond with a status message of ' Q04MUTEI*111'. In this
status message, the device reports the status of all the channels. Since the MUTEI command applies
to channels 1 and A-B the status of all 3 channels. The first (left most) value corresponds to channel
1 and the last (right most) value corresponds to channel B.
This leads us to the second method of using a wildcard character: specifying the values for each of
the channels. For example, ' B04MUTEI*101' mutes channels 1, B and unmutes channel A. In this
case, the device will respond with a status message of ' B04MUTEI*101'.
As an interesting example, consider sending ' Q04MUTEI*2' after the above example. The device will
respond with a status message of ' Q04MUTEI*010'. Notice that all the states have been toggled.
Queries using the '?' character are straightforward. For example, ' Q04MUTEI1?' might return '
Q04MUTEI11', while ' Q04MUTEI*?' might return ' Q04MUTEI*100'.
Using the wildcard character with integer channel commands is similar to using it with boolean
commands, but there are some differences. If we sent ' Q04GAINI*10', the input gains on channels
1 and A-B will all be set to 10 dB. The device will respond with a status message of '
S04GAINI*ÄÄÄ'. Those weird characters are the main difference between using wildcards with
integer channel commands versus boolean channel commands. When reporting multiple integer
values, the Vortex uses a binary format with one byte per integer value. This allows for more compact
commands and reduces RS-232 and bus traffic. To convert from an integer value to a byte value, we
add 132 to the integer value. In the above example, where the gain is set to 10 dB, we have: 10 +
132 = 142 = 0x8E (hex) = Ä (ASCII). The reason for adding 132 is to allow us to conveniently
represent negative numbers as well as avoid the use of special characters that are normally used in
RS-232 and EF Bus communications.
When using a wildcard character to specify separate values for each channel, you must also use the
binary format. For example, ' Q04GAINI*Äää' sets the input gain of channel 1 to 10 dB and the input
gain of channels A-B to 0 dB. (10 + 132 = 142 = 0x8E (hex) = Ä (ASCII), 0 + 132 = 132 = 0x84
Page 12
(hex) = ä (ASCII))
As an interesting example, consider sending ' Q04GAINI*>3' after the above example. This will result
in all the input gains being incremented by 3 dB so that channel 1 is at 13 dB and channels A-B are at
3 dB. The Vortex will respond with a status message of ' Q04GAINI*æçç'. (13 + 132 = 145 = 0x91
(hex) = æ (ASCII), 3 + 132 = 135 = 0x87 (hex) = ç (ASCII))
Queries using the '?' character are straightforward. For example, ' Q04GAINI1?' might return '
Q04GAINI110', while ' Q04GAINI*?' might return ' Q04GAINI*Äää'.
6.4. Matrix Commands
Matrix commands are used for controlling parameters that exist at the crosspoints of the mixing
matrices. Typical parameters include gain and mute. Before describing the matrix commands, it is
necessary to give a description of the matrices involved. During the following discussion, it will be
helpful to refer to the figure below, which shows all the matrices with their input and output labels.
Page 13
The EF2210 has three analog outputs labeled 1, A, and B. These outputs are all at line level. This
yields a total of three physical outputs. The EF2210 also has a power amplifier output, however the
power amplifier does not have a separate output in the matrix -- it is tied to output 1. Thus the signal
routed to output 1 will also be routed to the power amplifier output.
The EF2210 has three analog inputs labeled 1, A, and B. Input 1 is mic/line selectable, and inputs A-B
are line level only. Input 1 can also have phantom power enabled and contain channel processing,
which includes the following DSP algorithms: Acoustic Echo Cancellation, Noise Cancellation, and AGC.
Inputs 1, A, and B yield a total of three physical inputs.
Vortex devices can be linked together so that they can share control information and digital audio
signals. The audio signals are shared on four digital busses labeled P, W, X, Y, and Z. All Vortex
devices can receive signals from all of these busses. Only certain devices can transmit on the busses.
This information is given in the following table.
The P bus is meant for routing telephone audio between the devices. The W, X, Y, and Z busses are
meant for routing microphone and auxiliary audio between the devices. The W, X, Y, and Z busses
also carry NOM (Number of Open Microphones) information from the automixer so that outputs
created from these busses can be appropriately attenuated for the number of open microphones.
The digital inputs consist of all of the signals placed on the EF Bus by the other connected Vortex
devices. Each P, W, X, Y, and Z bus can carry channels from up to eight other devices, so we have
the following digital inputs to each Vortex device: PB0-PB7, WB0-WB7, XB0-XB7, YB0-YB7, and ZB0ZB7. The inputs are designated by three characters: the bus letter (P, W, X, Y, or Z), a B indicating
that it is a bus input, and a number between 0 and 7 indicating the channel of the bus.
There is also an internal signal generator, labeled SG, that is capable of producing white or pink
noise. this signal is fed into the matrix so that it can be routed to the appropriate outputs for
calibration or testing.
The mixing capabilities of the Vortex devices can be broken down into two parts: the EF Bus
submatrices and the main matrix.
For each of the W, X, Y, and Z signal busses, there is a 7 x 3 matrix that allows the user to define up
to three mixes of each of the four signal busses. The reason the matrix is 7 x 3 instead of 8 x 3 is that
since we can transmit on the W, X, Y, and Z busses, we do not need to mix our own channels in
Page 14
these matrices. The inputs and outputs for the 7 x 3 matrices are as follows.
W Submatrix
● Inputs: WB0-WB7 (with one invalid)
● Outputs: WM0-WM2
X Submatrix
● Inputs: XB0-XB7 (with one invalid)
● Outputs: XM0-XM2
Y Submatrix
● Inputs: YB0-YB7 (with one invalid)
● Outputs: YM0-YM2
Z Submatrix
● Inputs: ZB0-ZB7 (with one invalid)
● Outputs: ZM0-ZM2
For the P signal bus, there is an 8 x 2 matrix that allows the user to define up to two mixes of the P
signal bus. This matrix has a full 8 inputs since the EF2210 does not transmit on the P bus. The inputs
and outputs for the 8 x 2 P bus matrix are as follows.
P Submatrix
● Inputs: PB0-PB7
● Outputs: PM0-PM1
The crosspoint gains on all outputs are user adjustable. The "M" in the output labels of the
submatrices indicates that the signals are being fed into the Main Matrix.
The main matrix consists of the following inputs: analog inputs 1, A, and B, the signal generator (SG),
the outputs of the EF Bus submatrices PM0-PM1, WM0-WM2, XM0-XM2, YM0-YM2, and ZM0-ZM2.
This is a total of 18 inputs.
The main matrix consists of the following outputs: analog outputs 1, A, and B, AEC reference signal
R1, and the EF bus outputs W, X, Y, and Z. This is a total of 8 outputs.
The matrix commands can adjust two types of parameters: integer and boolean. We will introduce
the matrix commands by using the MGAIN command as an example. This is an integer matrix
command that is used to set the gain (in dB) at any of the crosspoints in the main matrix or EF Bus
submatrices.
Matrix commands are similar to channel commands except that instead of specifying a single channel,
it is necessary to specify a crosspoint (or range of crosspoints). In order to specify a single crosspoint,
you use the input and output labels discussed in this section. The first label always specifies the input
Page 15
to the matrix and the second label always specifies the output of the matrix. For example, to set the
gain of the crosspoint (1, A) to -3 dB, you would send ' Q04MGAIN1,A,-3 ' which sets the gain at
the crosspoint to -3 dB. In this case, a status message will be generated similar to ' Q04MGAIN1,A,-3 '.
It is also possible to use the wildcard character ('*') to specify ranges of crosspoints with the matrix
commands. The only restriction is that you can only use a wildcard to specify the input or output, but
not both simultaneously. Thus you could specify all the inputs going to a specific output (one column)
or the value of an input to all of the outputs (one row), but not the entire matrix. One example of
using a wildcard for an integer matrix command would be ' Q04MGAINSG,*,0 '. This will set all the
crosspoints in the signal generator row of the main matrix to 0 dB. Thus, the signal generator will be
added to all of the outputs of the main matrix with a gain of 0 dB. In this case a status message will
be generated that looks like ' Q04MGAINSG,*,дддддддд '. The binary representation used here is
the same method described in
Section 6.3.
You can also use the wildcard character to set the crosspoints of a row or column individually. For
example, 'Q04MGAIN1,*,äzzxxxxx' sets the crosspoints of input 1 to 0 dB for output 1, -10 dB for
outputs A and B, and -12 dB for outputs R1, and W-Z. In this case, the EF2210 will respoind with a
status message of 'Q04MGAIN1,*,äzzxxxxx'.
Queries using the '?' character work in the usual manner. For example, ' Q04MGAIN1,A,? ' might
return ' Q04MGAIN1,A,-6 ', while ' Q04MGAIN1,*,? ' might return ' Q04MGAIN2,*,дддддддд '.
Boolean matrix commands work as you would expect. They use the characters '0', '1', and '2' as
described in
●' Q04MMUTE1,A,1 ' mutes crosspoint (1, A) of the main matrix. In other words, the signal at
Section 6.1. Here are some examples.
input 1 will not be heard on output A A status message will be generated of the form '
Q04MMUTE1,A,1 '.
●'Q04MMUTEA,*,11100000' sets the mutes for input A of the main matrix. The signal path
from input A to outputs 1, A, and B is muted, while the signal path from input A to outputs R1
and W-Z is unmuted. The EF2210 will respond with a status message of
'Q04MMUTEA,*,11100000'.
●'Q04MMUTEA,*,2' toggles the mutes for input A of the main matrix. If this command follows
after the command in the above example, the EF2210 will respond with a status message of
'Q04MMUTEA,*,00011111'.
●'Q04MMUTEA,*,?' queries the status of the mutes for input A of the main matrix. If this
command follows after the commands in the above examples, the EF2210 will respond with a
status message of 'Q04MMUTEA,*,00011111'.
6.5. Miscellaneous Commands
Miscellaneous commands are those that don't fall under any of the other categories. See the
description of a given command for specific details on how it operates.
7. Command List
Page 16
The following table is a list of the commands recognized by the EF2210 Detailed descriptions of each
command are given in the next section.
The Storage column contains one of the following values indicating when and where the parameter is
stored.
● "Global"
● "Preset"
● "-" = not stored or not applicable
Globally stored parameters are not changed when a preset is executed. Only one copy of a global
parameter is stored. Global parameters are written to non-volatile memory each time they are
changed. Globally stored parameters retain their values when the power is cycled.
Parameters stored in presets are changed each time a new preset is restored/executed. Preset
parameters are not saved in non-volatile memory until a
GlobalEnable or Disable Acknowledgment Mode
PresetEnable or Disable Acoustic Echo Cancellation
PresetSet Amount of Double Talk Suppression used in the AEC.
PresetEnable or Disable Mic/Line Input Automatic Gain Control
PresetSet Maximum Allowed Mic/Line Input AGC Gain
PresetSet Minimum Allowed Mic/Line Input AGC Gain
PresetSet Ramp Rate of Mic/Line Input AGC
PresetAssign Inputs to an Automixer
PresetSelect Automatic or Manual Gating for each Automixer Input
PresetSet Automixer Groupings for EF Bus
PresetEnable Chairman Mode for Specified Automixer
PresetSet Chairman Mic
PresetSet Decay Time for Automixers
PresetSet Automixer Gating Control Mode
AMGATER
AMGATET
AMGNOM
AMHOLD
AMLMM
AMLMN
PresetSet Automixer Gate Ratio
PresetSet Automixer Gate Threshold
PresetSet Global Maximum Number of Open Mics for Bus Automixer
PresetSet Automixer Hold Time
PresetSet Last Mic On Mode for Specified Automixer
PresetSet Microphone That Will Remain On in Manual Last Mic On Mode
Page 17
AMNOM
PresetSet Local Maximum Number of Open Mics for Automixer
PresetSelect NOM Attenuation on Each Output
PresetSet Off Attenuation for the Specified Automixer
PresetSet Gating Priority for the Specified Mic
PresetSet Automixer Reference Bias for the Specified Automixer
PresetEnable Automixer Reference for Specified Automixer
GlobalSet Baud Rate for RS-232 Port
Preset
Enable Automatic BLDATA Messages
-Request Level Information
Preset
Select Information to be Reported in BLDATA
-Broadcast Arbitrary Command Strings to RS-232 Port
-Broadcast Commands to Other Connected Devices
PresetSet Which AEC Reference is Placed on EF Bus
-Query Camera Gating Status Information
PresetEnable Automatic Camera Gating Messages
PresetSet Camera Gating Hold Time
PresetSet Output Delay
PresetEnable Output Delay
-
Enable Automatic DSPLOAD Status Messages
-Query Percentage of Variable DSP Resources Used
GlobalEnable or Disable Error Messages
PresetSet Fader Gain of Line Inputs as a Group
PresetSet Input Gain Fader
GlobalSet Flow Control Mode for RS-232 Port
GlobalLock/Unlock Front Panel
-Change Front Panel Password
PresetSet Gain of Line Inputs as a Group
PresetSet Input Gain
PresetSet Output Gain
GATE
GATEEN
GMUTEO
ID
LABEL
-Query Gating Status Information
PresetEnable Automatic Gating Messages
PresetMute All Outputs
GlobalSet Device ID
GlobalSet or Query one of the Device Labels
Page 18
LAGC
PresetEnable or Disable Line Input Automatic Gain Control
PresetEnable or Disable Stereo AGC Linking on Inputs A and B
PresetSet Maximum Allowed Line Input AGC Gain
PresetSet Minimum Allowed Line Input AGC Gain
PresetSet Ramp Rate of Line Input AGC
-Add Command to Current Macro
GlobalDelete One or All Macros
-List All Commmands in a Macro
-Execute Macro Quietly
-Start a New Macro
GlobalWrite Macro to Non-Volatile Memory
-Execute Macro
PresetSelect which Signal is Displayed on the Front Panel LED Meter
PresetSet Crosspoint Gains in Main Matrix or Submatrix
PresetSelect Gated or Ungated Microphone Signal in Matrix
MIC
MINI
MINISTR
MMUTE
MUTEGIL
MUTEI
MUTEO
NC
NCL
NVINIT
NVLOCK
NVPSWD
PEQIA
PEQIB
PresetEnable Microphone Gain Stage on Input 1
GlobalEnable Modem Initialization String
GlobalSet Modem Initialization String
PresetMute Crosspoint in Main Matrix or Submatrix
PresetSet Mute Status of Line Inputs as a Group
PresetMute One or More Inputs
PresetMute One or More Outputs
PresetEnable Noise Cancellation
PresetSet Noise Cancellation Attenuation
PresetAssign AEC Reference to Input Channel
PresetSet Reference Output Gain
PresetSet Gain of Signal Generator
PresetMute Signal Generator
PresetSet Type of Signal Produced by Signal Generator
PresetSet Delay Between Screen Saver Screens
PresetEnable or Disable Screen Saver
PresetSet Idle Time Required for Screen Saver to Start
PresetSet Text to be Displayed by Screen Saver
-Perform Soft Reset of System
-Query Software Version
PresetEnable VTX Mode on Specified Inputs
PresetEnable VTX Mode on Specified Inputs
8. Command Reference
8.1. ACKMOD -- Enable or Disable Acknowledgment Mode
This command controls whether or not status messages are sent. See Section 5 for more information
on status messages. This parameter is enabled by default, and it is rarely turned off by the host
Page 20
controller.
This command is a boolean command. See
command.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
Q01ACKMOD1
Q01ACKMOD0
Q01ACKMODx , where x is 0 or 1 depending on the
current state of acknowledgement mode.
Q01ACKMODx , where x is 0 or 1 depending on the
current state of acknowledgement mode.
8.2. AEC -- Enable or Disable Acoustic Echo Cancellation
This command sets or queries the status of the Acoustic Echo Cancellation (AEC) algorithm on input
channel 1.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AEC11
Q01AEC10
Q01AEC12
Q01AEC1?
Enable AEC on input channel 1.
Disable AEC on input channel 1.
Toggle AEC state on input channel 1.
Query AEC state on input channel 1.
Section 6.3 and Section 6.1 for more information
Q01AEC11
Q01AEC10
Q01AEC1x, where x is 0 or 1 depending on the
current state of the AEC on input channel 1.
Q01AEC1x, where x is 0 or 1 depending on the
current state of the AEC on input channel 1.
8.3. AECMODE -- Set Amount of Double Talk Suppression
used in the AEC.
This command sets the amount of double talk suppression used in the AEC on input channel 1. The
values correspond to the following settings.
Page 21
● 1 = No Suppression
● 2 = Light Suppression
● 3 = Heavy Suppression
● 4 = Half Duplex
This command is a channel integer command. See
Section 6.3 and Section 6.2 for more information
on this type of command. The minimum and maximum values for this command are 1 and 4,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AECMODE13
Q01AECMODE1?
Set AEC on input channel 1 to
Heavy Suppression.
Query AEC suppression level on
input channel 1.
Q01AECMODE13
Q01AECMODE1x, where x is 1, 2, 3, or 4
depending on the current setting of the AEC
suppression level on input channel 1.
8.4. AGC -- Enable or Disable Mic/Line Input Automatic
Gain Control
This command sets or queries the status of the Automatic Gain Control (AGC) algorithm on input
channel 1 .
This command is a channel boolean command. See
Section 6.3 and Section 6.1 for more information
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AGC11
Q01AGC10
Q01AGC12
Q01AGC1?
Enable AGC on input channel 1 .
Disable AGC on input channel 1 .
Toggle AGC state on input channel 1 .
Query AGC state on input channel 1 .
Q01AGC11
Q01AGC10
Q01AGC1x , where x is 0 or 1 depending on the
current state of the AGC on input channel 1 .
Q01AGC1x , where x is 0 or 1 depending on the
current state of the AGC on input channel 1 .
8.5. AGCMAX -- Set Maximum Allowed Mic/Line Input AGC
Page 22
Gain
This command sets the maximum gain that the AGC can apply on input channel 1 . For example, if
AGCMAX is set to 10, then the AGC for that channel can apply a maximum of 10 dB of gain to the
input signal.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 15,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AGCMAX13
Q01AGCMAX1?
Set AGC maximum gain on input
channel 1 to 3 dB.
Query the AGC maximum gain on
input channel 1 .
Section 6.3 and Section 6.2 for more information
Q01AGCMAX13
Q01AGCMAX1x where x is a number
between 0 and 15, depending on the
current setting of the AGC maximum gain on
input channel 1 .
8.6. AGCMIN -- Set Minimum Allowed Mic/Line Input AGC
Gain
This command sets the minimum gain that the AGC can apply on input channel 1 . For example, if
AGCMIN is set to -10, then the AGC for that channel can apply a minimum of -10 dB of gain to the
input signal.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are -15 and 0,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AGCMIN1-3
Q01AGCMIN1?
Set AGC minimum gain on input
channel 1 to -3 dB.
Query the AGC minimum gain on
input channel 1 .
Section 6.3 and Section 6.2 for more information
Q01AGCMIN1-3
Q01AGCMIN1x where x is a number
between -15 and 0, depending on the
current setting of the AGC minimum gain
on input channel 1 .
Page 23
8.7. AGCRATE -- Set Ramp Rate of Mic/Line Input AGC
This command sets or queries the maximum rate at which the AGC can increase or decrease the gain
of the signals on input channel 1 . The ramp rate is expressed in dB/sec.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 5,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AGCRATE13
Q01AGCRATE1?
Set AGC ramp rate on input channel
1 to 3 dB/sec.
Query the AGC ramp rate on input
channel 1 .
Section 6.3 and Section 6.2 for more information
Q01AGCRATE13
Q01AGCRATE1x where x is a number
between 1 and 5, depending on the current
setting of the AGC ramp rate on input
channel 1 .
8.8. AMASGN -- Assign Inputs to an Automixer
This command is used to assign the mic/line inputs (1) to an internal automixers. Setting AMASGN to
0 for a given input channel corresponds to no automixer, and 1 corresponds to Automixer #1 .
Although this command is a channel integer command, the increment and decrement operators (>
and <) are not supported for this particular command.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 2,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMASGN11
Q01AMASGN1?
Assign input 1 to automixer #1.
Query current automixer assignment
for channel 1.
Section 6.3 and Section 6.2 for more information
Q01AMASGN11
Q01AMASGN1x, where x is 0, 1, or 2
depending on the current automixer
assignment for channel 1. If this command is
issued after the example above, then the
status message will be Q01AMASGN11.
Page 24
8.9. AMAUTO -- Select Automatic or Manual Gating for each
Automixer Input
This command selects or queries the state of automatic or manual automixer gating thresholds for the
specified input channel. Automatic thresholds mean that the automixer adaptively determines the
gating thresholds based on current speech and noise levels using the gating ratio specified by the
AMGATER command. Manual thresholds mean that the automixer uses the absolute threshold set via
AMGATET command.
the
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMAUTO11
Q01AMAUTO10
Q01AMAUTO12
Q01AMAUTO1?
Select automatic thresholds for
automixer gating on input channel 1.
Select manual thresholds for
automixer gating on input channel 1.
Toggle between automatic and
manual thresholds for automixer
gating on input channel 1.
Query AMAUTO state on input
channel 1.
Section 6.3 and Section 6.1 for more information
Q01AMAUTO11
Q01AMAUTO10
Q01AMAUTO1x, where x is 0 or 1 depending
on whether input channel 1 is currently set
for manual or automatic thresholds.
Q01AMAUTO1x, where x is 0 or 1 depending
on whether input channel 1 is currently set
for manual or automatic thresholds.
8.10. AMBUSID -- Set Automixer Groupings for EF Bus
This command is used to assign the internal automixer to one of the EF Bus automixer groups. For
example, consider three EF2210's, each of which has its automixer enabled for its microphone input
(input 1). Now, if each of these EF2210's sets its automixer to have Bus ID 5, then the three
automixers (one from each EF2210) will work as a single automixer containing 3 (3 x 1) microphones.
Setting AMBUSID to 0 means that the specified automixer is not grouped on the bus. For compatibility
with EF2280 and EF2241 commands, the AMBUSID command requires you to specify the automixer
number with the command. On the EF2280 and EF2241, there are two internal automixers. However,
the EF2210 only has one internal automixer, so 1 is always specified.
The first argument in the AMBUSID command is the automixer number (always 1 for the EF2210) and
the second argument is the Bus ID (0 for none, or 1 through 8). Although this command is a channel
integer command, use of the wildcard character for the automixer number is not supported.
This command is a channel integer command. See
Section 6.3 and Section 6.2 for more information
Page 25
on this type of command. The minimum and maximum values for this command are 0 and 8,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Configure the automixer to be part
Q01AMBUSID12
Q01AMBUSID10
of the Bus Automixer having Bus ID
2.
Configure the automixer to be part
of the Bus Automixer having Bus D
0. This means that the automixer is
not part of any Bus Automixer.
Q01AMBUSID12
Q01AMBUSID10
Q01AMBUSID1x, where x is a number
between 0 and 8 indicating the current Bus ID
of the automixer.
Q01AMBUSID1?
Query the current Bus ID of the
automixer.
8.11. AMCHAIR -- Enable Chairman Mode for Specified
Automixer
This command enables, disables, or queries the chairman mode feature for the specified automixer.
The first argument in the command specifies the automixer number (always 1 for the EF2210) and
the second argument specifies whether chairman mode should be enabled, disabled, toggled, or
queried.
Even though this is a channel boolean command, use of the wildcard character for the automixer
number is not supported.
This command is a channel boolean command. See
on this type of command.
Section 6.3 and Section 6.1 for more information
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMCHAIR10
Q01AMCHAIR11
Q01AMCHAIR1?
Disable chairman mode for the
automixer.
Enable chairman mode for the
automixer.
Query current setting of chairman
mode for the automixer.
Q01AMCHAIR10
Q01AMCHAIR11
Q01AMCHAIR1x, where x is 0 or 1 depending
on the current setting of chairman mode for
the automixer.
Page 26
8.12. AMCHNUM -- Set Chairman Mic
This command sets the chairman microphone for the automixer. The first argument of the command
specifies the automixer number (always 1 for the EF2210). The second argument specifies which
microphone should be the chairman microphone for the automixer (always 1 for the EF2210). This
command is not particularly useful on the EF2211 and EF2210, however it is provided for consistency
with the EF2280 and EF2241.
Even though this is a channel integer command, use of the wildcard character for the automixer
number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 1,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMCHNUM11
Q01AMCHNUM1?
Set microphone 1 as the chairman
mic for the automixer.
Query the current chairman mic for
the automixer.
Section 6.3 and Section 6.2 for more information
Q01AMCHNUM11
Q01AMCHNUM11, querying the chairman mic
number will always return 1 since there is only
one microphone on the EF2210.
8.13. AMDECAY -- Set Decay Time for Automixers
This command sets or queries the decay time (in milliseconds) for the automixer.
This command is an integer command. See
command. The minimum and maximum values for this command are 0 and 5000, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMDECAY500
Set automixer decay time to
500 ms.
Section 6.2 for more information on this type of
Q01AMDECAY500
Page 27
Q01AMDECAYx, where x is between 0 and
5000 depending on the current AMDECAY
setting. If this command is issued after the
above example, then the status message will
Q01AMDECAY>500
Increase automixer decay time
by 500 ms.
be
Q01AMDECAYx, where x is between 0 and
5000 depending on the current AMDECAY
Q01AMDECAY?
Query automixer decay time.
setting. If this command is issued after the
above example, then the status message will
be Q01AMDECAY1000
8.14. AMGATEC -- Set Automixer Gating Control Mode
This command sets the automixer gating control mode for the specified input channel. The possible
modes are:
● 0 - normal gating
● 1 - microphone forced on
● 2 - microphone forced off
This command is a channel integer command. See
Section 6.3 and Section 6.2 for more information
on this type of command. The minimum and maximum values for this command are 0 and 2,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMGATEC10
Q01AMGATEC11
Q01AMGATEC12
Q01AMGATEC1?
Configure microphone input 1 for
normal gating.
Configure microphone input 1 to be
forced on.
Configure microphone input 1 to be
forced off.
Query current gating control mode
for microphone input 1.
Q01AMGATEC10
Q01AMGATEC11
Q01AMGATEC12
Q01AMGATEC3x, where x is 0, 1, or 2
depending on the current gating control mode
setting for microphone input 1.
8.15. AMGATER -- Set Automixer Gate Ratio
This command sets the automixer gate ratio (in dB) for the specified input channel. The gate ratio is
the ratio of the speech power to noise power required to gate the microphone on. This value is only
used if the input is set to automatic gating via the
AMAUTO.
Page 28
This command is a channel integer command. See Section 6.3 and Section 6.2 for more information
on this type of command. The minimum and maximum values for this command are 0 and 100,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set gate ratio for automatic
Q01AMGATER112
Q01AMGATER1>3
Q01AMGATER1?
gating threshold to 12 dB for
input channel 1.
Increase gate ratio for automatic
gating threshold by 3 dB for
input channel 1.
Query gate ratio for automatic
gating threshold for input
channel 1.
Q01AMGATER112
Q01AMGATER1x, where x is between 0 and
100 depending on the current setting of the
gate ratio for input channel 1. If this command
is issued after the example above, then the
status message will be Q01AMGATER115.
Q01AMGATER1x, where x is between 0 and
100 depending on the current setting of the
gate ratio for input channel 1. If this command
is issued after the example above, then the
status message will be Q01AMGATER115.
8.16. AMGATET -- Set Automixer Gate Threshold
This command sets the automixer gate threshold (in dB) for the specified input channel. The gate
threshold is the level that the input signal must reach in order to gate the microphone on. This value
us only used if the input is set to manual gating via the
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 100,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set gate threshold for manual
Q01AMGATET112
gating threshold to 12 dB for
input channel 1.
AMAUTO command.
Section 6.3 and Section 6.2 for more information
Q01AMGATET112
Page 29
Q01AMGATET1x, where x is between 0 and
100 depending on the current setting of the
gate threshold for input channel 1. If this
command is issued after the example above,
then the status message will be
Q01AMGATET315.
Q01AMGATET1x, where x is between 0 and
100 depending on the current setting of the
gate threshold for input channel 1. If this
command is issued after the example above,
then the status message will be
Q01AMGATET115.
Q01AMGATET1>3
Q01AMGATET1?
Increase gate threshold for
manual gating threshold by 3 dB
for input channel 1.
Query gate threshold for manual
gating threshold for input
channel 1.
8.17. AMGNOM -- Set Global Maximum Number of Open
Mics for Bus Automixer
This command sets the global maximum number of open mics (NOM) allowed for the specified bus
automixer. The NOM limit is a global limit, meaning that this applies to all bus automixers with the
same
the EF2210.
AMBUSID. In contrast, the AMNOM command is a local limit that applies to the local automixer in
The first argument of this command specifies the automixer number (always 1 in the EF2210) to
adjust. The second argument specifies the NOM limit (1-64). Even though this is a channel integer
command, use of the wildcard for specifying the automixer number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 64,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMGNOM13
Q01AMGNOM1?
Set global NOM for the automixer to a
maximum of 3 mics.
Query current global NOM limit for
the automixer.
Section 6.3 and Section 6.2 for more information
Q01AMGNOM13
Q01AMGNOM1x, where x is between 1 and
64 depending on the current setting of the
global NOM limit for the automixer.
8.18. AMHOLD -- Set Automixer Hold Time
This command sets or queries the hold time (in milliseconds) for the automixer.
Page 30
This command is an integer command. See Section 6.2 for more information on this type of
command. The minimum and maximum values for this command are 0 and 5000, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMHOLD500
Set automixer hold time to 500
ms.
Q01AMHOLD500
Q01AMHOLDx, where x is between 0 and
5000 depending on the current AMHOLD
setting. If this command is issued after the
above example, then the status message will
Q01AMHOLD>500
Increase automixer hold time by
500 ms.
be Q01AMHOLD1000Q01AMHOLDx, where x is between 0 and
5000 depending on the current AMHOLD
Q01AMHOLD?
Query automixer hold time.
setting. If this command is issued after the
above example, then the status message will
be Q01AMHOLD1000
8.19. AMLMM -- Set Last Mic On Mode for Specified
Automixer
This command sets "last mic on" mode for the specified automixer. The first argument specifies which
automixer (always 1 on the EF2210) The second parameter specifies the operation of "last mic on"
mode and can be one of the following:
● 0 - last mic mode is off
● 1 - manual (use a specific mic)
● 2 - automatic (the last gated mic remains on)
Even though this is a channel integer command, use of the wildcard character for specifying the
automixer number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 2,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Section 6.3 and Section 6.2 for more information
Page 31
Q01AMLMM10
Disable "last mic on" mode for
automixer 1.
Q01AMLMM10
Q01AMLMM11
Q01AMLMM12
Q01AMLMM1?
Set "last mic on" mode to manual for
automixer 1.
Set "last mic on" mode to automatic for
automixer 1.
Query the current setting of "last mic
on" mode for automixer 1.
Q01AMLMM11
Q01AMLMM12
Q01AMLMM1x, where x is 0, 1, or 2
depending on the current setting of "last
mic on" mode for automixer 1. If this
command is issued after the example
above, then the status message will be
Q01AMLMM12.
8.20. AMLMN -- Set Microphone That Will Remain On in
Manual Last Mic On Mode
This command sets the microphone number that will remain on when "last mic on" mode is set to
manual (see the AMLMM command). The first argument to this command is the number of the
automixer (always 1 on the EF2210) that will be adjusted. The second argument is the microphone
number (always 1) that should be gated on if no other mics are gated on and
manual. The value of the AMLMN command is only valid when
AMLMM is set to manual.
AMLMM is set to
This command is not particularly useful on the EF2210 since there is only one mic on this device.
However, it is provided in order to be consistent with the command sets of the other Vortex devices.
Even though this is a channel integer command, use of the wildcard character for the automixer
number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 8,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMLMN11
Q01AMLMN1?
Set microphone 1 as the manual last
mic on for automixer 1.
Query the current manual last mic on
number mic for automixer 1.
Section 6.3 and Section 6.2 for more information
Q01AMLMN11
Q01AMLMN1x, where x is always 1, since
there is only 1 mic on this device.
8.21. AMNOM -- Set Local Maximum Number of Open Mics
Page 32
for Automixer
This command sets the local maximum number of open mics (NOM) allowed for the specified
automixer. The NOM limit is a local limit, meaning that this limit applies only to the specific Vortex
that is is set on. In contrast, the
automixers with the same
The first argument of this command specifies the automixer number (always 1 on the EF2210) to
adjust. The second argument specifies the NOM limit (always 1). Even though this is a channel
integer command, use of the wildcard for specifying the automixer number is not supported.
This command is not particularly useful on the EF2210 since there is only one mic on this device.
However, it is provided in order to be consistent with the command sets of the other Vortex devices.
AMBUSID.
AMGNOM command is a global limit that applies to all linked Vortex
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 64,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMNOM11
Q01AMNOM1?
Set local NOM for automixer 1 to a
maximum of 1 mics.
Query current local NOM limit for
automixer 1.
Section 6.3 and Section 6.2 for more information
Q01AMNOM11
Q01AMNOM1x, where x is always 1, since
there is only 1 mic on this device.
8.22. AMNOMAT -- Select NOM Attenuation on Each Output
This command enables, disables, or queries NOM attenuation for the specified output (1, A, B). . NOM
attenuation is calculated as 10*log(Number of Open Microphones).
Remember that even though there is only one microphone on this device, other microphones can be
brought in via the W, X, Y, and Z busses. These signals will have NOM information carried with them
from the other devices, which is why NOM attenuation is provided at the outputs.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Section 6.3 and Section 6.1 for more information
Page 33
Q01AMNOMAT11
Enable NOM attenuation on
output 1 .
Q01AMNOMAT11
Q01AMNOMATA0
Q01AMNOMATB2
Q01AMNOMATB?
Q01AMNOMAT*1
Q01AMNOMAT*0
Q01AMNOMAT*100
Q01AMNOMAT*2
Disable NOM attenuation on
output A.
Toggle NOM attenuation status
on output B.
Query NOM attenuation status
of output B.
Enable NOM attenuation on all
outputs (1, A, B) .
Disable NOM attenuation on all
outputs (1, A, B) .
Enable NOM attenuation on
output 1, and disable NOM
attenuation on outputs A and B.
Toggle status of NOM
attenuation on all outputs.
Q01AMNOMATA0
Q01AMNOMATBx , where x is either 0 or 1
depending on the current mute status of NOM
attenuation on the ouptut.
Q01AMNOMATBx , where x is either 0 or 1
depending on the current NOM attenuation
status of the output.
Q01AMNOMAT*111
Q01AMNOMAT*000
Q01AMNOMAT*100
Q01AMNOMAT*abc , where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status of NOM attenuation on the
corresponding output. If this command was
sent after the example above, then the status
message would be Q01AMNOMAT*011 .
Q01AMNOMAT*abc , where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
Q01AMNOMAT*?
Query NOM attenuation status
of all outputs.
current status of the NOM attenuation on the
corresponding output. If this command was
sent after the example above, then the status
message would be Q01AMNOMAT*011 .
8.23. AMOFFAT -- Set Off Attenuation for the Specified
Automixer
This command sets the off attenuation (in dB) for the specified automixer. Setting this value to 18
would result in the microphone signals being attenuated by 18 dB when gated off. This value is set
independently for each of the automixers. The first argument of this command specifies the
automixer number (1-2) to adjust. The second argument specifies the off attenuation.
Even though this is a channel integer command, use of the wildcard for specifying the automixer
number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 100,
respectively.
Section 6.3 and Section 6.2 for more information
Page 34
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMOFFAT118
Q01AMOFFAT1?
Set off attenuation for automixer
1 to 18 dB.
Query current off attenuation for
automixer 1.
Q01AMOFFAT118
Q01AMOFFAT1x, where x is between 1 and
100 depending on the current setting of the
off attenuation for automixer 1.
8.24. AMPRIOR -- Set Gating Priority for the Specified Mic
This command sets the automixer gating priority for the specified input channel. Priority levels of 1-4
are allowed with 1 being the highest priority and 4 being the lowest.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 1 and 4,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.3 and Section 6.2 for more information
ExampleDescriptionStatus Message
Q01AMPRIOR11
Q01AMPRIOR1?
Set microphone input 1 to gating
priority 1.
Query current gating priority for
microphone input . 1.
Q01AMPRIOR11
Q01AMPRIOR1x, where x is between 1 and 4
depending on the current gating priority
setting for microphone input . 1.
8.25. AMREFB -- Set Automixer Reference Bias for the
Specified Automixer
This command sets or queries the reference bias for the automixer reference mode feature of the
specified automixer. When enabled, the automixer reference feature uses the AEC reference to
prevent local microphones from gating on audio from the remote side. The
controls the enabled status of this feature. The AMREFB command can be used to bias the AEC
reference signal to make the automixer even less likely to gate on remote audio.
The first argument in this command specifies the automixer number (always 1 on the EF2210) and
the second argument specifies the reference bias in dB.
AMREFE command
Even though this is a channel integer command, use of the wildcard character for the automixer
Page 35
number is not supported.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 20,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01AMREFB16
Q01AMREFB1?
Set reference bias for automixer 1 to
6 dB.
Query current reference bias for
automixer 1.
Section 6.3 and Section 6.2 for more information
Q01AMREFB16
Q01AMREFB1x, where x is between 0 and
20 depending on the current setting of the
reference bias for automixer 1.
8.26. AMREFE -- Enable Automixer Reference for Specified
Automixer
This command enables, disables, or queries the automixer referece feature for the specified
automixer. When enabled, the automixer reference feature uses the AEC reference to prevent local
microphones from gating on audio from the remote side. The AMREFE command controls the enabled
status of this feature. The
the automixer even less likely to gate on remote audio.
The first argument in the command specifies the automixer number (always 1 on the EF2210) and
the second argument specifies whether automixer reference mode should be enabled, disabled,
toggled, or queried.
Even though this is a channel boolean command, use of the wildcard character for the automixer
number is not supported.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
AMREFB command can be used to bias the AEC reference signal to make
Section 6.3 and Section 6.1 for more information
ExampleDescriptionStatus Message
Q01AMREFE10
Q01AMREFE11
Disable automixer reference mode for
Automixer 1.
Enable automixer reference mode for
Automixer 1.
Q01AMREFE10
Q01AMREFE11
Page 36
Q01AMREFE1x, where x is 0 or 1 depending
on the current setting of automixer reference
mode for Automixer 1.
Q01AMREFE1?
Query current setting of automixer
reference mode for Automixer 1.
8.27. BAUD -- Set Baud Rate for RS-232 Port
This command sets the baud rate for the rear panel RS-232 port. The baud rate is specified in bits per
second (bps). Valid baud rates are 9600, 19200, and 38400. Although, this command returns an
acknowledgement, it is likely that you will not receive it, since it is sent at the new baud rate. If you
setup your control system to quickly change its RS-232 baud rate after you send this command, then
you can probably receive the acknowledgement at the new baud rate.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01BAUD38400
Q01BAUD?
Set baud rate of rear panel RS-232
port to 38400 bps.
Query current baud rate of rear
panel RS-232 port.
Q01BAUD38400
Q01BAUDx , where x is 9600, 19200, or
38400 depending on the current baud rate
setting.
8.28. BLAUTO -- Enable Automatic BLDATA Messages
This command sets whether or not BLDATA messages are automatically generated by the Vortex. See
BLDATA command for more information.
the
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.1 for more information on this type of
ExampleDescriptionStatus Message
Q01BLAUTO0
Q01BLAUTO1
Q01BLAUTO2
Disable automatic
Enable automatic
Toggle enabled status of automatic
BLDATA messages.
BLDATA messages.
BLDATA messages.
Q01BLAUTO0
Q01BLAUTO1
Q01BLAUTOx , where x is 0 or 1
depending on the current setting of
BLAUTO.
Page 37
Q01BLAUTOx , where x is 0 or 1
depending on the current setting of
BLAUTO.
Q01BLAUTO?
Query enabled status of automatic
BLDATA messages.
8.29. BLDATA -- Request Level Information
This command is used to request "blinking light" data from the EF2210. Blinking light data consists of
signal levels for the 3 inputs (1, A, B), 3 outputs (1, A, B), and AEC reference (R1) as well as the
room gain level for input 1, AGC gain level for input 1, and AEC state information for input 1.
The blinking light data can be received in two ways. The first way is by polling the Vortex by sending
a BLDATA? command. The second way is to have the Vortex automatically send BLDATA responses
via the
The most general format of the BLDATA responses generated by the Vortex is as follows.
Q01BLDATAiiiooorgas
BLAUTO command.
Each of the i, o, r, g, a and s characters above represents a single byte of data as shown in the
table below.
BLDATA Bytes
iii
ooo
r
g
a
s
Each of the i bytes correspond to signal levels on the 3 inputs in the following order (from left to
right): 1, A, B. The o bytes correspond to signal levels on the 3 outputs in the following order (from
left to right): 1, A, B. The r byte indicates the signal level for AEC reference R1. The the g byte
indicates the room gain for input 1. The a byte indicates the AGC gain on input 1. The s byte
indicates the AEC state for input 1.
Meaning
input levels 1, A, B
output levels 1, A, B
AEC reference level R1
room gain 1
AGC gain 1
AEC state 1
The formats of the i, o, r, g, and a bytes are the same as for the binary gain commands (binary
values offset by 132). See
The range for the i and o bytes is -100 dB to +20 dB, which corresponds to byte values of 32 to 152.
For reference, the LEDs on the front panel signal meter correspond to teh following dB levels (left to
right): -20, -12, -7, -3, 0, 3, 9, 20.
The format of the s bytes are also the same as the binary gain commands. The bytes are integers
(offset by 132) that represent the current AEC state. The following table shows how the byte values
Section 6.3 and Section 6.4 for more information on the binary format.
Page 38
translate to AEC states.
Byte ValueAEC State Value (Byte Value - 132)AEC State Description
1320Idle
1331Transmit
1342Receive
1353Double Talk
Here's an example BLDATA message to clear things up.
Q01BLDATApèpçppppèä
The first three bytes (pèp) consist of only two values.
So, the signal at output 1 is at 3 dB, while the signals at the rest of the outputs are at -20 dB.
The next byte (p) consists of only one value.
p = 0x70 = 112 → 112 - 132 = -20
So, the signal level of the AEC reference is -20 dB.
The next byte (p) consists of only one value.
p = 0x70 = 112 → 112 - 132 = -20
So, we know that the room gain for input 1 is -20 dB.
The next byte (è) consists of only one value.
è = 0x8A = 138 → 138 - 132 = 6
So, we know that the AGC gain for input1 1 is 6 dB.
Page 39
The last byte (ä) consists of only one value.
ä = 0x84 = 132 → 132 - 132 = 0 = Idle
So, we know that the AEC on input 1 is in idle mode.
In the above description, the data in the BLDATA command consists of 10 bytes (3 input levels + 3
output levels + 1 AEC reference level + 1 room gain level + 1 AGC gain level + 1 AEC state). It is
possible to tell the EF2210 to only send a subset of this information. There are two reasons you might
want to do this. First, it makes parsing the data easier since you can ask for only the data that you
are interested in. Second, when you decrease the amount of data being sent, the EF2210 can send
the messages faster. This means that if you are trying to implement a signal level meter, you can get
faster refresh rates by asking the EF2210 to only send the data you're interested in.
Suppose you were only interested in signal levels on inputs A-B. You could send the following
command.
Q01BLINFO0110000000
In the above
positions of the data that we don't want. Now, when we send a BLDATA? command or enable
BLAUTO, the Vortex sends messages of the form:
Q01BLDATAii
Where the ii bytes are the signal levels for inputs A-B.
BLINFO command, there are 1's in the positions of the data that we want and 0's in the
8.30. BLINFO -- Select Information to be Reported in
BLDATA
This command controls which bytes are sent in the BLDATA command. See the description of the
BLDATA command for more information on the BLINFO command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
8.31. BROAD2 -- Broadcast Arbitrary Command Strings to
RS-232 Port
This command is used to broadcast arbitrary commands to the RS-232 port for controlling other
devices (not necessarily other Vortex devices). For example, ' ' ' ' Q01BROAD2:ATDT4048921180' '
would cause the Vortex to send out 'ATDT4048921180' via its RS-232 port. If a modem was
Page 40
connected to the RS-232 port, this command would cause the modem to dial the Polycom Installed
Voice Business Group in Atlanta.
ExampleDescriptionStatus Message
Q01BROAD2:ATDT4048921180
Sends the string ATDT4048921180 out the RS232 port.
Q01BROAD2
8.32. BROADA -- Broadcast Commands to Other Connected
Devices
This command is used to broadcast commands to other connected Polycom devices via the EF Bus
and/or ASPI Bus. For example, the command ' Q01BROADA:B02PHONE1 ' would cause device ID 1 to
send a command to the EF2241 at device ID 2 to tell it to take its phone off-hook. The EF2241 at
device ID 2 would respond by taking its device off-hook and sending an acknowledgement.
This command is usually used in macros when one needs to have a macro on one device trigger an
action on another device.
ExampleDescriptionStatus Message
Q01BROADA
Q01BROADA:B02PHONE1
Sends the command B02PHONE2
over the digital bus.
B02PHONE1, this second status
message is from the EF2241 at
device ID 2 when it takes its phone
off hook.
8.33. BUSREF -- Set Which AEC Reference is Placed on EF
Bus
This command sets or queries whic AEC reference (if any) is placed on the EF Bus. Setting BUSREF to
'0' means that no reference is placed on the EF Bus. Setting BUSREF to '1' means that AEC reference
1 (R1) is placed on the bus.
Only one Vortex can put a reference on the EF Bus at a time. If more than one Vortex places its
reference on the EF Bus, then an 'ERROR#093' will occur.
This command is an integer command. See
command. The minimum and maximum values for this command are 0 and 2, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.2 for more information on this type of
Page 41
ExampleDescriptionStatus Message
S01BUSREF1
S01BUSREF0
Q01BUSREF?
Put AEC Reference 1 (R1) on the EF Bus.
Set Vortex to not place any AEC
reference on the EF Bus.
Query which AEC reference this Vortex is
placing on the EF Bus.
S01BUSREF1
S01BUSREF0
, where x is 0 or 1 depending on which
AEC reference (if any) is currently being
placed on EF Bus.
8.34. CGATE -- Query Camera Gating Status Information
This command is used to query the gating status of the microphone input. It is identical to the GATE
command except that any given microphone must be gated on for a specified hold time in order for it
to be considered "on" by the CGATE command. A typical use for this command is to control camera
pointing based on microphone activity. The added hold time prevents the camera from jumping too
quickly between positions when there are short amounts of signal present.
The
CGATET specifies the hold time used for the gating decisions in this command. The CGATEEN can
be used to have gating information sent automatically instead of having to poll this command.
ExampleDescriptionStatus Message
, , Q01CGATE1x where x is 0 or 1
depending on whether the input is gated off
or gated on, respectively.
Q01CGATE*x, where x is either 0 or 1
depending on whether the corresponding
microphone input is gated off or gated on,
respectively.
Q01CGATE1?
Q01CGATE*?
Query camera gating status of
microphone input 1.
Query camera gating status of all
microphone inputs.
8.35. CGATEEN -- Enable Automatic Camera Gating
Messages
This command controls whether or not camera gating information messages are sent automatically. If
CGATEEN is enabled, then a CGATE*? query is performed each time the camera gating status of any
microphone changes.
For example, if the microphone is currently gated off and CGATEEN is enabled, then if the microphone
gates on, the following status message will be automatically generated:
Q01CGATE*1
See the
This command is a boolean command. See
CGATE command for more information.
Section 6.1 for more information on this type of
Page 42
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01CGATEEN0
Q01CGATEEN1
Q01CGATEEN2
Q01CGATEEN?
Disable automatic camera gating
messages.
Enable automatic camera gating
messages.
Toggle enabled state of automatic
camera gating messages.
Query enabled state of automatic
camera gating messages.
Q01CGATEEN0
Q01CGATEEN1
Q01CGATEENx, where x is either 0 or 1
depending on whether automatic camera
gating messages are currently disabled or
enabled.
Q01CGATEENx, where x is either 0 or 1
depending on whether automatic camera
gating messages are currently disabled or
enabled.
8.36. CGATET -- Set Camera Gating Hold Time
This command sets the hold time (in milliseconds) for the camera gating (CGATE) feature.
This command is an integer command. See
command. The minimum and maximum values for this command are 100 and 5000, respectively.
Section 6.2 for more information on this type of
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01CGATET500
Q01CGATET>500
Q01CGATET?
Set camera gating hold time to
500 ms.
Increase camera gating hold time
by 500 ms.
Query camera gating hold.
Q01CGATET500
Q01CGATETx, where x is between 100 and
5000 depending on the current setting of
CGATET. If this command is issued after the
example above, the status message will be
Q01CGATET1000.
Q01CGATETx, where x is between 100 and
5000 depending on the current setting of
CGATET. If this command is issued after the
example above, the status message will be
Q01CGATET1000.
Page 43
8.37. DELAYO -- Set Output Delay
This command sets the amount of output delay (in tenths of milliseconds) on each of the three output
channels (1, A, B) . Use of the wildcard character (*) for specifying the channel is not supported for
this command. The output delay can be separately enabled or disabled via the
DELAYOE command.
This command is an integer command. See
command. The minimum and maximum values for this command are 0 and 3400, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set output delay on output
Q01DELAYOB1500
Q01DELAYOB>1700
Q01DELAYOB?
channel B to 150 ms (1500
tenths of milliseconds).
Increase output delay on output
channel B by 170 ms (1700
tenths of milliseconds.)
Query current output delay on
output channel B .
Section 6.2 for more information on this type of
Q01DELAYOB1500
Q01DELAYOBx , where x is between 0 and
3400 depending on the current output delay
setting for output channel B . If this
command is issued after the above example,
then the status message will be
Q01DELAYOB3200 .
Q01DELAYOBx , where x is between 0 and
3400 depending on the current output delay
setting for output channel 2. If this command
is issued after the above example, then the
status message will be Q01DELAYOB3200 .
8.38. DELAYOE -- Enable Output Delay
This command sets or queries the enabled state of the output delay for each of the three output
channels (1, A, B) .
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01DELAYOEB1
Enable output delay on output B
.
Section 6.3 and Section 6.1 for more information
Q01DELAYOEB1
Page 44
Q01DELAYOEB0
Disable output delay on output
B .
Q01DELAYOEB0
Q01DELAYOEB0
Q01DELAYOEB?
Q01DELAYOE*1
Q01DELAYOE*0
Q01DELAYOE*010
Q01DELAYOE*2
Toggle enabled status of output
delay on output B .
Query enabled status of output
delay on output B .
Enable output delay on all
outputs (1, A, B) .
Disable output delay on all
outputs (1, A, B) .
Enable output delay on output
A, and disable output delay on
outputs 1 and B.
Toggle enabled status of output
delay on all outputs.
Q01DELAYOEBx , where x is either 0 or 1
depending on the current enabled status of the
output delay on the output.
Q01DELAYOEBx , where x is either 0 or 1
depending on the current enabled status of the
output delay on the output.
Q01DELAYOE*111
Q01DELAYOE*000
Q01DELAYOE*010
Q01DELAYOE*abc , where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current enabled status of the output delay on
the corresponding output. If this command
was sent after the example above, then the
status message would be Q01DELAYOE*101 .
Q01DELAYOE*abc , where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
Q01DELAYOE*?
Query enabled status of output
delay on all outputs.
current enabled status of the output delay on
the corresponding output. If this command
was sent after the example above, then the
status message would be Q01DELAYOE*101 .
8.39. DSPAUTO -- Enable Automatic DSPLOAD Status
Messages
This command sets or queries whether or not DSPLOAD messages will be automatically generated
whenever the DSP utilization changes.
8.40. DSPLOAD -- Query Percentage of Variable DSP
Resources Used
This command queries the current percentage used of the available variable DSP resources. When
this number reaches 100 percent, no more variable DSP veatures may ben enabled. An 'ERROR#060'
will be generated if a command attempts to exceend 100 percent utilization.
If the
any time the percent utilization changes.
DSPAUTO feature is enabled, then a DSPLOAD status message will be generated automatically
ExampleDescriptionStatus Message
Q01DSPLOADx , where x is between 0 and
99 and indicates the percentage of the
variable DSP resources being used.
Q01DSPLOAD?
Query percentage of variable DSP
resources used.
8.41. ERROR -- Enable or Disable Error Messages
This command sets or queries whether or not error messages for non-fatal errors are reported via RS232 and the digital bus.
If an error is generated and error messages are enabled, a status message will be automatically
generated of the form ' Q01ERROR#xxx ', where xxx is a three digit number indicating the error
code. The following table lists the non-fatal error messages that can be generated by the Vortex.
Error Number Description
ERROR#001
ERROR#002
ERROR#004
ERROR#005
ERROR#040
Unrecognized command.
Syntax error in command.
Attempt to change parameter that is locked via
Attempt to unlock
This error occurs as the result of an
command would remove a microphone from an automixer where it is assigned as
the "last mic on" and the automixer is set to manual "last mic on" mode.
NVLOCK or FPLOCK, but invalid password given.
AMASGN command. It happens when the
NVLOCK or FPLOCK.
Page 46
ERROR#041
This error occurs as the result of an
AMASGN command. It happens when the
command would remove a microphone from an automixer where it assigned as the
chairman imcrophone and the automixer has chairman mode enabled.
ERROR#042
ERROR#043
ERROR#044
ERROR#045
ERROR#060
ERROR#070
This error occurs as the result of an
AMLMM command. It happens when the
command attempts to set "last mic on" mode to manual, but the last mic number is
set to a microphone that does not belong to the specified automixer.
This error occurs as the result of an
AMLMN command. It happens when the
command attempts to set a "last mic on" number that does not belong to the
specified automixer while "last mic on" mode is set to manual.
This error occurs as the result of an
AMCHAIR command. It happens when the
command tries to enable chairman mode, but the chairman microphone is set to a
microphone that does not belong to the specified automixer.
This error occurs as the result of an
AMCHAIR command. It happens when the
command tries to set the chairman microphone to a microphone that does not
belong to the specified automixer while chairman mode is enabled.
This error occurs when the user has attempted to utilize more variable DSP
resources than are available. This may occur if too many matrix crosspoints are
unmuted or too many parametric EQ filters are enabled. The
DSPLOAD command
can query the current percentage utilization of DSP resources.
This error occurs as a result of a macro or preset execution command (
PRESETX,
PRESETQ, MACROX, MACROQ). It indicates that the macro or preset requested was
empty.
ERROR#071
ERROR#072
ERROR#073
ERROR#075
ERROR#076
ERROR#077
This error occurs as a result of a
PRESETW or PRESETK command. In the case of
PRESETW it indicates that an attempt was made to write to a factory preset, which
is not allowed. In the case of
PRESETK, it indicates that an attempt was made to
delete a factory preset, which is not allowed.
This error occurs as a result of a
PRESETQ command. It indicates that one or more
commands in the preset had errors during execution.
This error occurs as a result of a
MACROA command when there are already too
many commands in the macro. The limit is 256 commands per macro.
This error occurs when a command attempts to write non-volatile memory, but non-
volatile memory is password protected via
NVLOCK.
This error occurs when attempting to add a macro command (either during an
upload or while writing a single macro) and the Vortex runs out of room in nonvolatile memory. As a result, the entire macro is discarded. If this occurs during an
upload, all previous macros (before the one that caused the error) are written
successfully.
This error occurs when attempting to add a command to a macro, but the Vortex is
not in the process of writing a macro. This may happen if you forget to do a
MACROS or UMACROS command, or if you had an ERROR#076 and continued
trying to add commands.
Page 47
ERROR#090
ERROR#091
This error indicates an EF Bus hardware handshaking error. This could happen if
bussed units are not powered on simultaneously. Powering the units up
simultaneously should remove the error.
This error indicates an EF Bus software handshaking error. This could happen if
bussed units are not powered on simultaneously. Powering the units up
simultaneously should remove the error.
ERROR#092
ERROR#093
This command is a boolean command. See
command.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01ERROR1
Q01ERROR0
Q01ERROR2
This error indicates an EF Bus ID conflict. See the Vortex user manual for
information on valid device IDs.
This error indicates an EF Bus reference conflict. This error occurs when more than
one Vortex is placing its AEC reference on the bus. Use the
remove the extra reference(s) in order to resolve the conflict.
Q01ERROR1
Q01ERROR0
Q01ERRORx , where x is 0 or 1 depending on the
current state of error mode.
BUSREF command to
Q01ERROR?
Query the state of error mode.
Q01ERRORx , where x is 0 or 1 depending on the
current state of error mode.
8.42. FADERGIL -- Set Fader Gain of Line Inputs as a
Group
This command sets the fader gains of all the line inputs simultaneously. This is different from using a
wildcard, * with the FADERI command because that command sets all the mic and line inputs
together, while the FADERGIL sets only the line inputs.
This command will generate acknowledgements from each of the line inputs separately.
This command is an integer command. See
command. The minimum and maximum values for this command are -100 and 20, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.2 for more information on this type of
Page 48
ExampleDescriptionStatus Message
Q01FADERGIL7
Q01FADERGIL>3
Q01FADERGIL?
Set fader gain of all line inputs to 7
dB.
Increase fader gains on all line
inputs by 3 dB.
Query fader gains on all line
inputs.
Q01FADERIA7
Q01FADERIB7
Q01FADERIAa
Q01FADERIBb,
where a and b are the new values of the
fader gains for each of the line inputs. If this
command was issued after the example
above, then the status messages would be:
Q01FADERIA10
Q01FADERIB10.
Q01FADERIAa
Q01FADERIBb,
where a and b are the new values of the
fader gains for each of the line inputs. If this
command was issued after the example
above, then the status messages would be:
Q01FADERIA10
Q01FADERIB10.
8.43. FADERI -- Set Input Gain Fader
The input channels of the Vortex pass through an analog gain stage before reaching the analog to
digital converter. The gain of this stage is adjustable via a the GAINI command. Once in the digital
domain, there is an additional gain stage, referred to as a fader. The fader gain is adjustable by the
FADERI command. The
resolution and quality of the signal at the analog to digital converter. The FADERI command is
provided as a way to do volume control on the inputs without affecting the calibration.
This command was introduced in firmware version 2.5.0.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are -100 and 20,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
GAINI setting should be used for calilbration in order to maximize the
Section 6.3 and Section 6.2 for more information
ExampleDescriptionStatus Message
Q01FADERIA10
Q01FADERIA?
Set fader gain on input A to 10
dB.
Query the fader gain on input A.
Q01FADERIA10
Q01FADERIAx , where x is a number between
0 and 30, depending on the current setting of
the fader gain on input channel A.
Page 49
Q01FADERI*6
Q01FADERI*ìää
Q01FADERI*?
Set fader gain on all inputs (1, A,
B) to 6 dB.
Set fader gain on input channels
A and B to 0 dB and gain on
input channel 1 to 9 dB.
Query fader gain on all inputs (1,
A, B) .
Q01FADERI*èèè
Q01FADERI*ìää
S01FADERI*abc, where a-c are each
between ä and ÿ, depending on the current
setting of the fader gains for each of the three
input channels.
8.44. FLOW -- Set Flow Control Mode for RS-232 Port
This command sets the flow control mode for the rear panel RS-232 port. The valid settings are:
Command ValueDescription
0No flow control.
1Hardware flow control.
2Auto-detect hardware flow control or no flow control.
We recommend using hardware flow control whenever possible, especially when using higher baud
rates.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01FLOW1
Q01FLOW?
Set rear panel RS-232 port to use hardware
flow control.
Query flow control setting of rear panel RS-232
port.
Q01FLOW1
Q01FLOWx , where x is 0, 1, or 2
depending on the current flow control
setting.
8.45. FPLOCK -- Lock/Unlock Front Panel
This command controls the front panel lock feature. When FPLOCK is enabled, the user may not
make any changes to the system via the front panel. The system settings will still be viewable on the
LCD, but the user will get an error message if he tries to change them. When FPLOCK is disabled, the
user has full access to the system settings via the front panel.
Usage of this command is similar to other boolean commands (see
disabling this feature, the password must be supplied for the command to work. If an incorrect
password is supplied, 'ERROR#005' will be generated. The examples below illustrate the correct
Section 6.1) except that when
Page 50
usage. The examples assume that the password has been set to 'aspi' (the default). The front panel
password can be changed via the
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
FPPSWD command.
Q01FPLOCK1
Q01FPLOCK0,yumyum
Q01FPLOCK0,aspi
Q01FPLOCK?
Lock the front panel to prevent
users from changing the settings.
Attempt to unlock the front panel
by using an invalid password
(yumyum).
Unlock the front panel by using
the correct password.
Query the locked status of the
front panel.
Q01FPLOCK1
Q01ERROR#005 -- since an invalid
password was given, an error message
was generated. If error messages have
been disabled (via the
then no status message will be
generated.
Q01FPLOCK0
Q01FPLOCKx , where x is 0 or 1
depending on whether the front panel is
unlocked or locked, respectively.
ERROR command),
8.46. FPPSWD -- Change Front Panel Password
This command sets or queries the front panel password. This password is used in conjunction with
the FPLOCK command. The front panel must be unlocked ('FPLOCK0') in order to use this command
to set or query the front panel password. If the front panel is locked, then this command will result in
'ERROR#004'. The examples below assume that the front panel is unlocked.
ExampleDescriptionStatus Message
Q01FPPSWDmonkey
Q01FPPSWD?
Set front panel password to 'monkey'.
Query the current front panel password.
8.47. GAINGIL -- Set Gain of Line Inputs as a Group
This command sets the gains of all the line inputs simultaneously. This is different from using a
wildcard, * with the
together, while the GAINGIL sets only the line inputs.
This command will generate acknowledgements from each of the line inputs separately.
This command is an integer command. See
command. The minimum and maximum values for this command are 0 and 20, respectively.
GAINI command because that command sets all the mic and line inputs
Q01FPPSWDmonkey
Q01FPPSWDmonkey
Section 6.2 for more information on this type of
Page 51
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01GAINGIL7
Q01GAINGIL>3
Q01GAINGIL?
Set gain of all line inputs to 7 dB.
Increase incoming gain on all line
inputs by 3 dB.
Query gains on all line inputs.
Q01GAINIA7
Q01GAINIB7
Q01GAINIAa
Q01GAINIBb,
where a and b are the new values of each
of the line inputs. If this command was
issued after the example above, then the
status messages would be:
Q01GAINIA10
Q01GAINIB10.
Q01GAINIAa
Q01GAINIBb,
where a and b are the new values of each
of the line inputs. If this command was
issued after the example above, then the
status messages would be:
Q01GAINIA10
Q01GAINIB10.
8.48. GAINI -- Set Input Gain
The input channels of the Vortex pass through an analog gain stage before reaching the analog to
digital converter. The gain of this stage is adjustable via a digitally controlled analog trim pot. It is
important that this gain is set correctly in order to maximize the resolution and quality of the signal at
the analog to digital converter. This command lets you adjust the gain of these input gain stages. For
volume control, the
without affecting the calibration.
The following table shows the relationship between the input gain settings (via GAINI and
the nominal level expected at each of the inputs.
Input Channel
11 (mic level)0 to 300 to -30
10 (line level)0 to 3033 to 3
A-BN/A (line level)0 to 200 to -20
The GAINIT command has a range of -100 to +20.
FADERI command can be used to adjust the signal level in the digital domain
MIC) and
MIC SettingGAINI Setting (dB)
Expected level at Input (dBu)
This command is a channel integer command. See
Section 6.3 and Section 6.2 for more information
Page 52
on this type of command. The minimum and maximum values for this command are 0 and 20 or 30,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescription Status Message
Set gain on
Q01GAINIA10
input A to 10
dB.
Q01GAINIA10
Q01GAINIA?
Q01GAINI*6
Q01GAINI*ìää
Q01GAINI*?
Query the
gain on
input A.
Set gain on
all inputs (1,
A, B) to 6
dB.
Set gain on
input
channels A
and B to 0
dB and gain
on input
channel 1 to
9 dB.
Query gain
on all inputs
(1, A, B) .
F01GAINI2xB01GAINITxS01GAINIAxQ01GAINIAxT01GAINITx,
where x is a number between 0 and 30, depending on the current
setting of the gain on input channel A.
Q01GAINI*èèè
Q01GAINI*ìää
S01GAINI*abc, where a-c are each between ä and ÿ, depending
on the current setting of the gains for each of the three input
channels.
8.49. GAINO -- Set Output Gain
This command sets or queries the gain (in dB) of the three output channels (1, A, B) .
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are -100 and 20,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01GAINOA10
Set gain on output channel A to 10
dB.
Section 6.3 and Section 6.2 for more information
Q01GAINOA10
Page 53
Q01GAINOA?
Query the gain on output channel A
.
, , Q01GAINOAx where x is a number
between -100 and 20, depending on the
current setting of the gain on output channel
A .
Q01GAINO*6
Q01GAINO*äìì
Q01GAINO*?
Set the gain on all output channels
(1, A, B) to 6 dB.
Set gain on output channel 1 to 0
dB, and gain on output channels A
and B to 9 dB.
Query gain settings on all output
channels (1, A, B) .
Q01GAINO*èèè
Q01GAINO*äìì
Q01GAINO*abc, where a-c are each between
<space> and ÿ, depending on the current
setting of the gains for each of the ten output
channels (1, A, B).
8.50. GATE -- Query Gating Status Information
This command is used to query the gating status of the microphone inputs. The command can be
used to query the status of individual microphones, or the wildcard character can be used to query
the status of all the microphone inputs. On the EF2211 and EF2210, there is only one microphone, so
the wildcard character is of limited use.
The
GATEEN can be used to have gating information sent automatically instead of having to poll this
command.
Also see the
specified hold time.
ExampleDescriptionStatus Message
Q01GATE1?
CGATE command, which only reports microphones that have been gated on for a
Q01GATE1?, where x is 0 or 1 depending
Query gating status of microphone input 1.
on whether the input is gated off or gated
on, respectively.
8.51. GATEEN -- Enable Automatic Gating Messages
This command controls whether or not gating information messages are sent automatically. If
GATEEN is enabled, then a GATE*? query is performed each time the gating status of any
microphone changes. For example, if no microphones are currently gated on and GATEEN is enabled,
then if microphone input 1 gates on, the following status message will be automatically generated:
Q01GATE*1
See the
GATE command for more information.
This command is a boolean command. See
Section 6.1 for more information on this type of
Page 54
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Toggle enabled state of automatic
gating messages.
Query enabled state of automatic gating
messages.
Q01GATEEN0
Q01GATEEN1
Q01GATEENx, where x is either 0 or 1
depending on whether automatic gating
messages are currently disabled or enabled.
Q01GATEENx, where x is either 0 or 1
depending on whether automatic gating
messages are currently disabled or enabled.
8.52. GMUTEO -- Mute All Outputs
The name of this command is an abbreviation of "Global Mute Outputs." Enabling this option causes
all of the physical outputs to be muted (outputs 1, A, B) . This muting is independent of the normal
output mute command,
a "saftey mute" feature. The idea is that if the user accidentally misconfigures the Vortex and
feedback begins to occur, they can press the saftey mute to instantly mute all outputs before they
damage their equipment or ears.
MUTEO. This command is provided so that the control program can implement
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01GMUTEO1
Q01GMUTEO0
Q01GMUTEO2
Q01GMUTEO?
Enable global output mute.
Disable global output mute.
Toggle global output mute.
Query acknowledgement mode.
Section 6.1 for more information on this type of
Q01GMUTEO1
Q01GMUTEO0
Q01GMUTEOx , where x is 0 or 1 depending on the
current state of the global output mute.
Q01GMUTEOx , where x is 0 or 1 depending on the
current state of the global output mute.
8.53. ID -- Set Device ID
This command sets or queries the Device ID for the Vortex. Typically, the device ID is set from the
Page 55
front panel of the Vortex, so this command is not normally used. There are restrictions involving
having devices with the same ID linked on EF Bus -- see the Vortex Reference Manual for more
details.
This command is an integer command. See
command. The minimum and maximum values for this command are 0 and 7, respectively.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01ID3
Q01ID?
Change the device ID from 1 to 3
Query current device ID.
Section 6.2 for more information on this type of
Q03ID3
Q01ID1
8.54. LABEL -- Set or Query one of the Device Labels
This command sets or queries one of the many labels stored in the device. The LABEL command has
the following syntax:
iLABELx,y
where i is the device type and ID, x is the label specifier, and y is the label text (to set the label) or
a ? character (to query the label). The label specifiers are as follows:
Label SpecifierDescription
DA label for the device itself.
SGA label for the signal generator.
I1, IA, IBLabels for the input channels.
O1, OA, OBLabels for the output channels.
W, X, Y, ZLabels for matrix outputs to EF Bus.
PB0-PB7, WB0-WB7, XB0-XB7, YB0-YB7,
ZB0-ZB7
PM0-PM1, WM0-WM2, XM0-XM2, YM0-
YM2, ZM0-ZM2
R1Label for AEC reference.
P0-P47Labels for user presets.
M0-M255Labels for user macros.
Labels for inputs from EF Bus to submatrices.
Labels for outputs from EF Bus submatrices to main
matrix.
The text of each label can be up to 16 characters long. Labels for presets 0-15 are read-only.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to non-
Page 56
volatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01LABELOB,Zone 2 Speaker
Q01LABELOB,?
Set label of output B
to "Zone 2 Speaker".
Query label for
output B .
Q01LABELOB,Zone 2 Speaker
Q01LABELOB,<string> , where
<string> is the current label assigned to
output B .
8.55. LAGC -- Enable or Disable Line Input Automatic Gain
Control
This command sets or queries the status of the Automatic Gain Control (AGC) algorithm on input
channels A-B.
This command was introduced in firmware version 2.5.0.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.3 and Section 6.1 for more information
ExampleDescriptionStatus Message
Q01LAGCB1
Q01LAGCA0
Q01LAGCB2
Q01LAGCA?
Q01LAGC*1
Q01LAGC*0
Q01LAGC*2
Q01LAGC*?
Enable AGC on input channel B.
Disable AGC on input channel A.
Toggle AGC state on input channel B.
Query AGC state on input channel A.
Enable AGC on input channels A-B.
Disable AGC on input channels A-B.
Toggle AGC state on input channels AB.
Query AGC state on input channels AB.
Q01LAGCB1
Q01LAGCA0
Q01LAGCBx, where x is 0 or 1 depending on
the current state of the AGC on input channel
B.
Q01LAGCAx, where x is 0 or 1 depending on
the current state of the AGC on input channel
A.
Q01LAGC*11
Q01LAGC*0000
Q01LAGC*ab, where a and b are each 0 or 1
depending on the current state of the AGC for
each of the line input channels.
Q01LAGC*ab, where a and b are each 0 or 1
depending on the current state of the AGC for
each of the line input channels.
Page 57
8.56. LAGCLINKAB -- Enable or Disable Stereo AGC Linking
on Inputs A and B
This command links the line input AGC of inputs A and B into a stereo pair. The overall volume level
of the stereo signal will be analyzed, and the same gain will be applied to both channels.
This command has some side effects on the way the other line input AGC commands work. When
LAGCLINKAB is first enabled, the settings for
A will be copied to channel B. The original settings for channel B will not be restored after
LAGCLINKAB is disabled. Acknowledgements will be sent for any changes to channel B. From then
on, any changes for these commands for either channel A or B will be set for both channels, and
acknowledgements will be sent for both channels.
LAGC, LAGCMAX, LAGCMIN, and LAGCRATE on channel
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01LAGCLINKAB1
Q01LAGCLINKAB0
Q01LAGCLINKAB2
Q01LAGCLINKAB?
Enable stereo AGC linking on
inputs A and B.
Disable stereo AGC linking on
inputs A and B.
Toggle stereo AGC linking on
inputs A and B.
Query status of stereo AGC
linking on inputs A and B.
Section 6.1 for more information on this type of
Q01LAGCLINKAB1
Q01LAGCLINKAB0
Q01LAGCLINKABx, where x is 0 or 1
depending on the current state of stereo AGC
linking on inputs A and B.
Q01LAGCLINKABx, where x is 0 or 1
depending on the current state of stereo AGC
linking on inputs A and B.
8.57. LAGCMAX -- Set Maximum Allowed Line Input AGC
Gain
This command sets the maximum gain that the AGC can apply on input channels A-B. For example, if
LAGCMAX is set to 10, then the AGC for that channel can apply a maximum of 10 dB of gain to the
input signal.
This command was introduced in firmware version 2.5.0.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 15,
respectively.
Section 6.3 and Section 6.2 for more information
Page 58
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01LAGCMAXA3
Q01LAGCMAXB?
Set AGC maximum gain on input
channel A to 3 dB.
Query the AGC maximum gain on
input channel B.
Q01LAGCMAXA3
Q01LAGCMAXBx, where x is a number
between 0 and 15, depending on the current
setting of the AGC maximum gain on input
channel B.
8.58. LAGCMIN -- Set Minimum Allowed Line Input AGC
Gain
This command sets the minimum gain that the AGC can apply on input channels A-B. For example, if
LAGCMIN is set to -10, then the AGC for that channel can apply a minimum of -10 dB of gain to the
input signal.
This command was introduced in firmware version 2.5.0.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are -15 and 0,
respectively.
Section 6.3 and Section 6.2 for more information
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01LAGCMINA-3
Q01LAGCMINB?
Set AGC minimum gain on input
channel A to -3 dB.
Query the AGC minimum gain on
input channel B.
Q01LAGCMINA-3
Q01LAGCMINBx, where x is a number
between -15 and 0, depending on the current
setting of the AGC minimum gain on input
channel B.
8.59. LAGCRATE -- Set Ramp Rate of Line Input AGC
This command sets or queries the maximum rate at which the AGC can increase or decrease the gain
of the signals on input channels A-B. The ramp rate is expressed in dB/sec.
This command was introduced in firmware version 2.5.0.
Page 59
This command is a channel integer command. See Section 6.3 and Section 6.2 for more information
on this type of command. The minimum and maximum values for this command are 1 and 5,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01LAGCRATEA3
Set AGC ramp rate on input
channel A to 3 dB/sec.
Q01LAGCRATEA3
Q01LAGCRATEBx, where x is a number
Q01LAGCRATEB?
Query the AGC ramp rate on
input channel B.
between 1 and 5, depending on the current
setting of the AGC ramp rate on input channel
B.
8.60. MACROA -- Add Command to Current Macro
This command adds a command to the macro currently in progress. This is used in conjunction with
the MACROS and MACROW commands to create a new macro.
The syntax of this command specifies a macro number, a comma, and then the command to be
added to the macro. The command to be added to the macro can be any valid command except the
following:
● any PRESET command
● any MACRO command
● any logic input or output command
If an attempt to assign an invalid command to a macro is made (via
condition ERROR#074 will be generated.
An error will be generated if the specified command is not a valid command. However, an error will
not be generated if the specified command is valid, but its data is invalid. For example:
Q01MACROA25,LAYDOWNTHEBOOGIE
Would return an error because it does not contain a valid command. However:
Q01MACROA62,MUTEOMYMOTHERINLAW
Would not return an error because it contains a
the macro is executed with a
MACROX or MACROQ command and it tries to execute the MUTEO
command with strange data.
MACROA), then the error
MUTEO command. An error would be returned when
Page 60
The proper sequence for creating a macro (macro number 112 in this example) is as follows.
This defines macro number 112 to unmute all inputs, set all input gains to 0 dB, and unmute all
outputs. It is acceptable if another command is sent in between these commands (such as Q01NC*? )
as long as it isn't another non-volatile memory command which could interfere with the storage of the
macro.
8.61. MACROK -- Delete One or All Macros
This command kills (deletes) the specified macro. If the wildcard character (*) is used the specify the
macro number, then all macros are deleted. Deleting all macros via MACROK* is more efficient than
deleting them all individually since it requires less writes to non-volatile memory.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01MACROK25
Q01MACROK*
Delete all the commands associated with macro number 25.
Delete all the commands associated with all 255 macros.
Q01MACROK25
Q01MACROK*
8.62. MACROL -- List All Commmands in a Macro
This command lists all the commands in a given macro. For example, assume that a macro has been
defined via the following command sequence.
This command executes the macro corresponding to the specified number. The macro must have
been previously defined and stored in non-volatile memory via the
commands. If the specified macro is empty, then an error condition of ERROR#070 will be generated.
When the MACROQ command executes, status messages for all of the commands in the macro will not
be generated. The MACROQ is provided so that a control system can execute a macro and not
generate heavy data traffic from the resulting status messages. Of course, this assumes that the
control system is not interested in any of the acknowledgements. The
to execute the macro without suppressing status messages.
ExampleDescriptionStatus Message
MACROS, MACROA, and MACROW
MACROX command can be used
Q01MACROQ125
Execute macro number 125 without generating any status
messages.
Q01MACROQ125
8.64. MACROS -- Start a New Macro
This command is used to start writing a new macro with a specified macro number. This command is
used in conjunction with the
command is sent while another macro is in the process of being written (before the
command is sent), then the macro in progress will be deleted and the new one will be started.
See the description of the
MACROA and MACROW commands to create a new macro. If this
MACROW
MACROA command for detailed information on creating macros.
8.65. MACROW -- Write Macro to Non-Volatile Memory
This command writes the macro that is currently being defined to non-volatile memory. This
command is used in conjunction with
is sent when no macro is in progress (i.e., if a
number sent with this command does not match the number of the macro in progress, then an error
will be returned.
MACROA and MACROS to create a new macro. If this command
MACROS command has not been sent) or if the macro
See the description of the
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
MACROA command for detailed information on creating macros.
Page 62
8.66. MACROX -- Execute Macro
This command executes the macro corresponding to the specified number. The macro must have
been previously defined and stored in non-volatile memory via the MACROS, MACROA, and MACROW
commands. If the specified macro is empty, then an error condition of ERROR#070 will be generated.
When the MACROX executes, status messages for all of the commands in the macro will be generated
(unless acknowledgement mode is turned off). The status messages can be suppressed by using the
MACROQ command, which is exactly the same as MACROX except that status messages are
suppressed.
ExampleDescriptionStatus Message
Status messages for all the commands in the macro
Q01MACROX125
Execute macro number 125.
will be generated first, followed by the message:
Q01MACROX125
8.67. METER -- Select which Signal is Displayed on the
Front Panel LED Meter
This command selects which signal is displayed on the front panel LED meter. The options correspond
to any of the 3 inputs, 3 outputs, or the AEC reference. The inputs are specified by the labels I1, IA,
and IB. The outputs are specified by the labels O1, OA, and OB. The AEC reference is specified by the
label R1.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01METERI1
Q01METER?
Set front panel LED meter to display the
signal on input 1 .
Query which signal the front panel LED
meter is currently set to monitor.
Q01METERI1
Q01METERx , where x is the label
corresponding to the signal currently being
monitored. If this command was sent after
the first example given above, the response
would be Q01METERI1 .
8.68. MGAIN -- Set Crosspoint Gains in Main Matrix or
Submatrix
This command sets or queries one or more crosspoint gains in either the main matrix or one of the EF
Page 63
Bus submatrices.
This command is a matrix integer command. See
Section 6.4 and Section 6.2 for more information on
this type of command. The minimum and maximum values for this command are -100 and 20,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set gain from input B
Q01MGAINB,R1,-3
to AEC reference 1 to -
Q01MGAINB,R1,-3
3 dB.
Q01MGAIN1,B,x where x is the new value of
the crosspoint gain. If the crosspoint gain was
set to -3 dB before this command, then the
status message would be Q01MGAIN1,B,3 .
Q01MGAIN1,B,>6
Increase gain from
input 1 to output B by
6 dB.
Q01MGAINA,W,x , where x is the current value
of the crosspoint gain. If the crosspoint gain
was set to -12 dB before this command, then
the status message would be Q01MGAINA,W,-
Q01MGAINA,W,?
Query gain from input
A to W Bus output.
12 .
Q01MGAINWB0,WM0,-3
Q01MGAIN1,*,д{{дЗЗЗЗ
Q01MGAINB,*,-3
Set crosspoint gain in
EF Bus submatrix on
crosspoint that routes
the W bus signal from
the device at ID0
(WB0) to W submatrix
output 0 (WM0).
Set all crosspoint gains
for input channel 1.
Set the gain to output
1 to 0 dB (ä), the gain
to outputs A-B to -9 dB
({), the gain to AEC
reference 1 to 0 dB
(ä), and the gain to
bus outputs W, X, Y,
and Z to -3 dB (Ç).
Set all crosspoint gains
for input channel B to 3 dB.
Q01MGAINWB0,WM0,-3
Q01MGAIN1,*,д{{дЗЗЗЗ
Q01MGAINB,*,ЗЗЗЗЗЗЗЗ
Page 64
Q01MGAINB,*,abcdefgh , where the value of
each of letters (a, b, etc.) depends on the
current state of each of the crosspoint gains. If
this command was issued after the example
above, then the status message would be
Q01MGAINB,*,ииииииии
Q01MGAINB,*,abcdefgh , where the value of
each of letters (a, b, etc.) depends on the
current state of each of the crosspoint gains. If
this command was issued after the example
above, then the status message would be
Q01MGAINB,*,ииииииии
Q01MGAINB,*,>12
Q01MGAINB,*,?
Increase the gain for
all crosspoints of input
channel B by 12 dB.
Query the gains for all
crosspoints of input
channel B .
8.69. MGATE -- Select Gated or Ungated Microphone Signal
in Matrix
For each crosspoint of the microphone input channels of the main matrix, the microphone signals can
be taken before the automixer (ungated) or after the automixer (gated). This command selects the
gated or ungated microphone signal. If MGATE is set to 1 for a given crosspoint, then the signal will
be gated (taken after the automixer). If MGATE is set to 0 for a given crosspoint, then the signal will
be ungated (taken before the automixer).
This command is a matrix boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Select the gated version of
Q01MGATE1,A,1
Q01MGATE1,A,0
Q01MGATE1,A,2
Q01MGATE1,A,?
microphone input 1 to be sent to
output A.
Select the ungated version of
microphone input 1 to be sent to
output A.
Toggle the gated status of the
crosspoint that routes
microphone input 1 to output A.
Query the gated status of the
crosspoint that routes
microphone input 1 to output A.
Section 6.4 and Section 6.1 for more information
Q01MGATE1,A,1
Q01MGATE1,A,0
Q01MGATE1,A,x, where x is 0 or 1
depending on the current gated status of the
crosspoint.
Q01MGATE1,A,x, where x is 0 or 1
depending on the current gated status of the
crosspoint.
8.70. MIC -- Enable Microphone Gain Stage on Input 1
Page 65
This command sets or queries the enabled state of the microphone gain stages on the microphone
input. Enabling the gain stage adds an extra 33 dB of gain in the input signal path. See the
description of the
nominal input levels.
GAINI command for information on how the MIC and GAINI commands relate to
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01MIC11
Q01MIC10
Q01MIC12
Q01MIC1?
Enable microphone gain stage for input
channel 1.
Disable microphone gain stage for input
channel 1.
Toggle microphone gain stage for input
channel 1.
Query enabled status of microphone gain
stage for input channel 1.
Section 6.3 and Section 6.1 for more information
Q01MIC11
Q01MIC10
Q01MIC1x, where x is 0 or 1 depending
on the current enabled state of the
microphone gain stage on input channel
1.
Q01MIC1x, where x is 0 or 1 depending
on the current enabled state of the
microphone gain stage on input channel
1.
8.71. MINI -- Enable Modem Initialization String
This command controls whether or not the modem initialization string is sent at power-up. If MINI is
0, then the modem initialization string is not sent. If MINI is 1, then the modem initialization string is
sent. The text of the modem initialization string is set via the
This command is a boolean command. See
command.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
Toggle enabled state of modem initialization
string.
Q01MINIx , where x is 0 or 1 depending
on the current enabled state of the
modem initialization string.
Q01MINIx , where x is 0 or 1 depending
on the current enabled state of the
modem initialization string.
Q01MINI?
Query enabled state of modem initialization
string.
8.72. MINISTR -- Set Modem Initialization String
This command is used to set or query the modem initialization string. The string can be a maximum
of 32 characters long. The recommended modem initialization string for the Vortex is:
ATF1E0&B1S0=2
This can be set via the following command.
Q01MINISTRATF1E0&B1S0=2
Whether or not the modem initialization string is sent at power-up is controlled via the
command.
MINI
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Set modem initialization
Q01MINISTRATF1E0&B1S0=2
Q01MINISTR?
string to
ATF1E0&B1S0=2.
Query current modem
initialization string.
Q01MINISTRATF1E0&B1S0=2
Q01MINISTR<string> , where
<string> is the current modem
initialization string. If this command was
sent after the above example, then the
status message would be
Q01MINISTRATF1E0&B1S0=2 .
8.73. MMUTE -- Mute Crosspoint in Main Matrix or
Submatrix
This command sets or queries the mute status of one or more crosspoints in either the main matrix or
one of the EF Bus submatrices.
This command is a matrix boolean command. See
on this type of command.
Section 6.4 and Section 6.1 for more information
Page 67
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Mute signal path (in
Q01MMUTEB,R1,1
main matrix) from
input B to AEC
Q01MMUTEB,R1,1
reference 1 .
Mute signal path (in EF
Bus W submatrix) from
Q01MMUTEWB0,WM0,0
W bus signal at device
ID0 (WB0) to W
Q01MMUTEWB0,WM0,0
submatrix output 0
(WM0).
Q01MMUTE1,B,2
Q01MMUTEA,W,?
Q01MMUTE1,*,01100000
Q01MMUTEA,*,0
Q01MMUTEA,*,2
Toggle mute status of
signal path (in main
matrix) from input 1 to
output B .
Query mute status of
signal path (in main
matrix) from input A to
W-Bus output .
Set all crosspoint
mutes for input
channel 1. Mute the
paths from input 1 to
outputs A and B, and
unmute the paths from
input 1 to outputs 1,
R1, and W-Z.
Unmute all crosspoints
for input channel A .
Toggle all crosspoint
mutes for input
channel A .
Q01MMUTE1,B,x , where x is either 0 or 1
depending on the current mute status of the
crosspoint.
Q01MMUTEA,W,x , where x is either 0 or 1
depending on the current mute status of the
crosspoint.
Q01MMUTE1,*,01100000
Q01MMUTEA,*,00000000
Q01MMUTEA,*,abcdefgh , where the value of
each of letters (a, b, etc.) is either 0 or 1
depending on the current state of each of the
crosspoint mutes. If this command was issued
after the example above, then the status
message would be Q01MMUTEA,*,00000000
Query all crosspoint
Q01MMUTEA,*,?
mutes for input
channel A .
Q01MMUTEA,*,abcdefgh , where the value of
each of letters (a, b, etc.) is either 0 or 1
depending on the current state of each of the
crosspoint mutes. If this command was issued
after the example above, then the status
message would be Q01MMUTEA,*,00000000
Page 68
8.74. MUTEGIL -- Set Mute Status of Line Inputs as a
Group
This command sets the mute status of all the line inputs simultaneously. This is different from using a
wildcard, * with the
together, while the MUTEGIL sets only the line inputs.
This command will generate acknowledgements from each of the line inputs separately.
MUTEI command because that command sets all the mic and line inputs
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01MUTEGIL1
Q01MUTEGIL2
Q01MUTEGIL?
Mute all line inputs.
Toggle mute status of all line inputs.
Query the mute status of all the line
inputs.
Section 6.1 for more information on this type of
Q01MUTEIA1
Q01MUTEIB1
Q01MUTEIAa
Q01MUTEIBb,
where a and b reflect the mute status (0 or
1) of each of the line inputs. If this
command was issued after the example
above, then the status messages would be:
Q01MUTEIA0
Q01MUTEIB0.
Q01MUTEIAa
Q01MUTEIBb,
where a and b reflect the mute status (0 or
1) of each of the line inputs. If this
command was issued after the example
above, then the status messages would be:
Q01MUTEIA0
Q01MUTEIB0.
8.75. MUTEI -- Mute One or More Inputs
This command sets or queries the mute status of the analog inputs (1, A, B) .
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
Section 6.3 and Section 6.1 for more information
Page 69
preset.
ExampleDescriptionStatus Message
Q01MUTEI11
Q01MUTEIA0
Q01MUTEIB2
Q01MUTEI1?
Q01MUTEI*1
Q01MUTEI*0
Q01MUTEI*100
Q01MUTEI*2
Q01MUTEI*?
Mute input 1 .
Unmute input A .
Toggle mute status of input B.
Query mute status of input 1 .
Mute all inputs (1, A, B) .
Unmute all inputs (1, A, B) .
Toggle mute status of all inputs.
Query mute status of all inputs.
Q01MUTEI11
Q01MUTEIA0
Q01MUTEIBx , where x is either 0 or 1
depending on the current mute status of the
input.
Q01MUTEI1x , where x is either 0 or 1
depending on the current mute status of the
input.
Q01MUTEI*111
Q01MUTEI*000
Q01MUTEI*100
Q01MUTEI*abc, where each of the letters (a, b,
etc.) is either 0 or 1 depending of the current
status of the mute on the corresponding input. If
this command was sent after the example above,
then the status message would be
Q01MUTEI*011.
Q01MUTEI*abc where each of the letters (a, b,
etc.) is either 0 or 1 depending of the current
status of the mute on the corresponding input. If
this command was sent after the example above,
then the status message would be
Q01MUTEI*011 .
8.76. MUTEO -- Mute One or More Outputs
This command sets or queries the mute status of the analog outputs (1, A, B) .
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01MUTEO11
Q01MUTEOA0
Mute output 1 .
Unmute output A .
Section 6.3 and Section 6.1 for more information
Q01MUTEO11
Q01MUTEOA0
Page 70
Q01MUTEOB2
Q01MUTEOB?
Query mute status of output B .
Q01MUTEOBx , where x is either 0 or 1
depending on the current mute status of the
output.
Q01MUTEOBx , where x is either 0 or 1
depending on the current mute status of the
output.
Q01MUTEO*1
Q01MUTEO*0
Q01MUTEO*100
Q01MUTEO*2
Q01MUTEO*?
Mute all outputs (1, A, B) .
Unmute all outputs (1, A, B) .
Mute output 1 and unmute outputs
A and B.
Toggle mute status of all outputs.
Query mute status of all outputs.
Q01MUTEO*111
Q01MUTEO*000
Q01MUTEO*100
Q01MUTEO*abc where each of the letters (a,
b, etc.) is either 0 or 1 depending of the
current status of the mute on the
corresponding output. If this command was
sent after the example above, then the status
message would be Q01MUTEO*011.
Q01MUTEO*abc , where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status of the mute on the
corresponding output. If this command was
sent after the example above, then the status
message would be Q01MUTEO*011
8.77. NC -- Enable Noise Cancellation
This command sets or queries the status of the Noise Cancellation (NC) algorithm on input channel 1 .
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Example DescriptionStatus Message
Q01NC11
Q01NC10
Q01NC12
Q01NC1?
Q01NC*1
Enable NC on input channel 1 .
Disable NC on input channel 1 .
Toggle NC state on input channel 1 .
Query NC state on input channel 1 .
Enable NC on input channel 1.
Section 6.3 and Section 6.1 for more information
Q01NC11
Q01NC10
Q01NC1x , where x is 0 or 1 depending on
the current state of NC on input channel 1 .
Q01NC1x , where x is 0 or 1 depending on
the current state of NC on the input channel.
Q01NC*1
Page 71
Q01NC*0
Disable NC on all microphone input
channels (only input 1 on EF2210).
Q01NC*0
Q01NC*x, where x is 0 or 1 depending on
the current state of NC for each of the
corresponding input.
Q01NC*x, where x is 0 or 1 depending on
the current state of NC for each of the
corresponding input.
Q01NC*2
Q01NC*?
Toggle NC state on all microphone input
channels (only input 1 on EF2210).
Query NC state on all microphone input
channels (only input 1 on EF2210).
8.78. NCL -- Set Noise Cancellation Attenuation
This command sets or queries the attenuation level of the Noise Cancellation algorithm on input
channel 1 . For example, if NCL is set to 10, then the Noise Cancellation for that channel will cancel
10 dB of noise. Higher numbers mean more cancellation will be applied, but may result in slight
artifacts depending on the characteristics of the noise. Typical settings are 10 dB for normal
cancellation and 6 dB for light cancellation.
This command is a channel integer command. See
on this type of command. The minimum and maximum values for this command are 0 and 20,
respectively.
Section 6.3 and Section 6.2 for more information
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01NCL13
Q01NCL1?
Q01NCL*6
Q01NCL*?
Set NC attenuation level on input channel 1 to
3 dB.
Query the NC attenuation level on input
channel 1 .
Set NC attenuation level on all microphone
input channels (only 1 on EF2210) to 6 dB.
Query NC attenuation level on all microphone
input channels (only 1 on EF2210).
Q01NCL13
Q01NCL1x , where x is a number
between 0 and 20, depending on the
current setting of the NC attenuation
level on input channel 1 .
Q01NCL*è
Q01NCL*x, where x is between ä and ÿ,
depending on the current setting of the
NC attenuation level for input 1.
8.79. NVINIT -- Reinitialize Non-Volatile Memory
This command reinitializes (or formats) all non-volatile memory settings. This will effectively erase
settings for global settings, user presets, macros, labels, and logic I/O configurations. This will
basically reset the unit to a "fresh-out-of-the-box" state.
Page 72
When this command is issued, it writes to non-volatile memory in order to format the contents back
to the factory default state. The writing process results in a short delay. After the non-volatile
memory has been reformatted, the Vortex will perform a software reset, which is equivalent to a
power cycle.
ExampleDescriptionStatus Message
No status message will be generated.
There will be a short delay and then
the Vortex will reset.
Q01NVINIT
Reinitialize non-volatile memory and perform a
software reset.
8.80. NVLOCK -- Lock/Unlock Non-Volatile Memory
This command controls the non-volatile memory lock feature. When NVLOCK is enabled, the user may
not save any system settings to non-volatile memory. This includes global parameters, presets,
macros, labels, and logic assignments. The lock applies whether the user tries to make the changes
via RS-232, front panel, logic inputs, or any other method. The user will still be able to query all the
features of the device, but will get an error message if an attempt is made to change them. When
NVLOCK is disabled, the user has full access to the system settings.
Usage of this command is similar to other boolean commands (see
disabling this feature, the password must be supplied for the command to work. If an incorrect
password is supplied, 'ERROR#005' will be generated. The examples below illustrate the correct
usage. The examples assume that the password has been set to 'aspi' (the default). The NVLOCK
password can be changed via the
NVPSWD command.
Section 6.1) except that when
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Lock the non-volatile memory to
Q01NVLOCK1
Q01NVLOCK0,yumyum
Q01NVLOCK0,aspi
Q01NVLOCK?
prevent users from changing the
settings.
Attempt to unlock the nonvolatile memory by using an
invalid password.
Unlock the non-volatile memory
by using the correct password.
Query the locked status of the
non-volatile memory.
Q01NVLOCK1
Q01ERROR#005 -- since an invalid
password was given, an error message
was generated. If error messages have
been disabled (via the
then no status message will be
generated.
Q01NVLOCK0
Q01NVLOCKx , where x is 0 or 1
depending on whether the non-volatile
memory is unlocked or locked,
respectively.
This command sets or queries the non-volatile memory password. This password is used in
conjunction with the NVLOCK command. The non-volatile memory must be unlocked ('NVLOCK0') in
order to use this command to set or query the non-volatile memory password. If the non-volatile
memory is locked, then this command will result in 'ERROR#004'. The examples below assume that
the non-volatile memory is unlocked.
ExampleDescriptionStatus Message
Q01NVPSWDlemur
Q01NVPSWD?
Set non-volatile memory password to 'lemur'.
Query the current non-volatile memory password.
Q01NVPSWDlemur
Q01NVPSWDlemur
8.82. PEQIA -- Set All Parameters for Specified Parametric
EQ Input Stage
This command sets or queries all of the parameters for the parametric equalizer (EQ) filters on input
channels 1, A, and B . Each channel has five bands of parametric EQ that can be independently
controlled.
The input parametric EQ filter parameters can be set individually via the
PEQIG, PEQIS, and PEQIE commands. The output parametric EQ filter parameters can be set
simultaneously via the
PEQOS, and PEQOE commands.
When using this command, you must specify all of the following parameters.
PEQOA command or individually with the PEQOT, PEQOF, PEQOB, PEQOG,
The paramters are specified in the order shown and are separated by commas. The wildcard
character, *, may not be used for any of the parameters listed above. If an attempt is made to set
one of the parameters outside the valid range, the command will fail and return an error message of
ERROR#002.
Not all of the parameters are valid for each of the filter types. The following table shows which
parameters are used in each of the filter types.
When a parameter is invalid for a given filter type, the parametric EQ commands will still set that
parameter, however its value will not be used for filter computations. This valid/invalid parameter
information above is provided mainly as guidelines for programmers writing control software for the
Vortex. If a parameter is not valid for a specific filter type, then the control for editing that parameter
should be disabled or removed when that filter type is selected.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set the
parametric EQ on
input 1 , band 2
to the following
parameters: type
= parametric
filter, frequency
= 1250 Hz,
bandwidth = 40
1/100th octaves,
Q01PEQIA1,2,1,1250,40,-20,1,1
gain = -20 dB,
Q01PEQIA1,2,1,1250,40,-20,1,1
enabled = yes,
slope = 1 dB per
octave. The
value of the
Page 75
slope parameter
is irrelevant for
this type of filter,
we could have
set it to
anything.
Q01PEQIAB,1,t,f,b,g,s,e , where
the parameters t, f, b, g, s, and e
correspond to the current settings of the
type, frequency, bandwidth, gain, slope,
and enabled parameters, respectively. If
this filter was set to the same parameters
as given in the above example, the status
message would be
Q01PEQIAB,2,1,1250,40,-20,1,1 .
Q01PEQIAB,1,?
Query the
current
parameter
settings for the
parametric eq
filter on input B ,
band 1.
8.83. PEQIB -- Set Bandwidth Parameter for Specified
Parametric EQ Input Stage
This command sets or queries the bandwidth parameter (in 1/100th octaves) for the parametric
equalizer (EQ) filters on input channels 1, A, and B . Each channel has five bands of parametric EQ
that can be independently controlled.
The minimum and maximum values for the bandwidth parameter are 5 and 200, respectively.
This command has the same format and restrictions as the
parameter, the bandwidth, is specified instead of all the parameters. See the
more information. To set the bandwidth parameter for an output parametric EQ filter, use the
command. To set all the parameters for an output parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set bandwidth of parametric EQ
Q01PEQIB1,2,40
on input 1 , band 2 to 40
1/100th octaves.
PEQIA command except that only one
PEQIA command for
PEQOB
PEQOA command.
Q01PEQIB1,2,40
Query current bandwidth setting
Q01PEQIBB,1,?
of parametric EQ on input B ,
band 1.
Q01PEQIBB,1,b , where b is the current
setting of the bandwidth parameter for the
parametric EQ on input B , band 1. If the
bandwidth parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQIBB,1,40
.
Page 76
8.84. PEQIE -- Set Enabled Parameter for Specified
Parametric EQ Input Stage
This command sets or queries the enabled parameter (0 = filter is disabled, 1 = filter is enabled) for
the parametric equalizer (EQ) filters on input channels 1, A, and B . Each channel has five bands of
parametric EQ that can be independently controlled.
This command has the same format and restrictions as the
parameter, the enabled status, is specified instead of all the parameters. See the
more information. To set the enabled parameter for an output parametric EQ filter, use the
command. To set all the parameters for an output parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01PEQIE1,2,1
Q01PEQIEB,1,?
Enable parametric EQ on input 1 ,
band 2.
Query enabled status of
parametric EQ on input B , band
1.
PEQIA command except that only one
PEQIA command for
PEQOE
PEQOA command.
Q01PEQIE1,2,1
Q01PEQIEB,1,e , where e is the current
setting of the enabled parameter for the
parametric EQ on input B , band 1. If the
enabled parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQIEB,1,1 .
8.85. PEQIF -- Set Frequency Parameter for Specified
Parametric EQ Input Stage
This command sets or queries the frequency parameter (in Hz) for the parametric equalizer (EQ)
filters on input channels 1, A, and B . Each channel has five bands of parametric EQ that can be
independently controlled.
The minimum and maximum values for the frequency parameter are 20 and 20000, respectively.
For filter types that have a center frequency (e.g., parametric), this parameter specifies the center
frequency. For filter types that have a cutoff frequency (e.g, highpass, lowpass, etc.), this parameter
specifies the cutoff frequency.
This command has the same format and restrictions as the
parameter, the frequency, is specified instead of all the parameters. See the
more information. To set the frequency parameter for an output parametric EQ filter, use the
command. To set all the parameters for an output parametric EQ filter, use the
PEQIA command except that only one
PEQIA command for
PEQOF
PEQOA command.
Page 77
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set frequency of parametric
Q01PEQIF1,2,1250
Q01PEQIFB,1,?
EQ on input 1 , band 2 to
1250 Hz.
Query current frequency
setting of parametric EQ on
input B , band 1.
Q01PEQIF1,2,1250
Q01PEQIFB,1,f , where f is the current
setting of the frequency parameter for the
parametric EQ on input B , band 1. If the
frequency parameter of this filter is set to the
same value given in the example above, then
the status message will be
Q01PEQIFB,1,1250 .
8.86. PEQIG -- Set Gain Parameter for Specified Parametric
EQ Input Stage
This command sets or queries the gain parameter (in dB) for the parametric equalizer (EQ) filters on
input channels 1, A, and B . Each channel has five bands of parametric EQ that can be independently
controlled.
The minimum and maximum values for the gain parameter are -20 and 20, respectively.
This command has the same format and restrictions as the
parameter, the gain, is specified instead of all the parameters. See the
information. To set the gain parameter for an output parametric EQ filter, use the
To set all the parameters for an output parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set the gain of the parametric
Q01PEQIG1,2,-20
EQ on input 1 , band 2 to -20
dB.
PEQIA command except that only one
PEQIA command for more
PEQOG command.
PEQOA command.
Q01PEQIG1,2,-20
Page 78
Q01PEQIGB,1,g , where g is the current
setting of the gain parameter for the
Q01PEQIGB,1,?
Query current gain setting of
parametric EQ on input B , band
1.
parametric EQ on input B , band 1. If the
gain parameter of this filter is set to the
same value given in the example above,
then the status message will be
Q01PEQIGB,1,-20 .
8.87. PEQIS -- Set Slope Parameter for Specified
Parametric EQ Input Stage
This command sets or queries the slope parameter (in dB per octave) for the parametric equalizer
(EQ) filters on input channels 1, A, and B . Each channel has five bands of parametric EQ that can be
independently controlled.
For the Linkwitz-Riley filters, the slope can either be 12 or 24 (dB/Octave).For the low shelf and high
shelf filters, the minimum value for the slope parameter is 1, and the maximum value is 1.2 times the
current value of the gain parameter. See the
PEQIG command for information on the gain parameter.
This command has the same format and restrictions as the
parameter, the slope, is specified instead of all the parameters. See the
information. To set the slope parameter for an output parametric EQ filter, use the
To set all the parameters for an output parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set the slope of the parametric
Q01PEQIS1,2,1
Q01PEQISB,1,?
EQ on input 1 , band 2 to 1 dB
per octave.
Query current slope setting of
parametric EQ on input B , band
1.
PEQIA command except that only one
PEQIA command for more
PEQOS command.
PEQOA command.
Q01PEQIS1,2,1
Q01PEQISB,1,s , where s is the current
setting of the slope parameter for the
parametric EQ on input B , band 1. If the
slope parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQISB,1,1 .
8.88. PEQIT -- Set Type Parameter for Specified
Parametric EQ Input Stage
The type parameter specifies what type of filter is executed for the specified band of the specified
input channel. The different filter types and their corresponding values are shown in the table below.
This command has the same format and restrictions as the
parameter, the filter type, is specified instead of all the parameters. See the
more information. To set the slope parameter for an output parametric EQ filter, use the
command. To set all the parameters for an output parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01PEQIT1,2,1
Q01PEQITB,1,?
Set the type of the parametric EQ
on input 1 , band 2 to parametric.
Query current type setting of
parametric EQ on input B , band
1.
PEQIA command except that only one
PEQIA command for
PEQOT
PEQOA command.
Q01PEQIT1,2,1
Q01PEQITB,1,t , where t is the current
setting of the type parameter for the
parametric EQ on input B , band 1. If the type
parameter of this filter is set to the same
value given in the example above, then the
status message will be Q01PEQITB,1,1 .
8.89. PEQOA -- Set All Parameters for Specified Parametric
EQ Output Stage
This command sets or queries all of the parameters for the parametric equalizer (EQ) filters on output
channels 1, A, and B . Each channel has five bands of parametric EQ that can be independently
controlled.
The output parametric EQ filter parameters can be set individually via the
PEQOG, PEQOS, and PEQOE commands. The input parametric EQ filter parameters can be set
simultaneously via the
PEQIS, and PEQIE commands.
When using this command, you must specify all of the following parameters.
PEQIA command or individually with the PEQIT, PEQIF, PEQIB, PEQIG,
1 - 1.2 * Gain for shelving filters, 12 or 24 for LinkwitzRiley filters
dB per octave
0 = filter disabled
1 = filter enabled
The paramters are specified in the order shown and are separated by commas. The wildcard
character, *, may not be used for any of the parameters listed above. If an attempt is made to set
one of the parameters outside the valid range, the command will fail and return an error message of
ERROR#002.
Not all of the parameters are valid for each of the filter types. The following table shows which
parameters are used in each of the filter types.
When a parameter is invalid for a given filter type, the parametric EQ commands will still set that
parameter, however its value will not be used for filter computations. This valid/invalid parameter
information above is provided mainly as guidelines for programmers writing control software for the
Vortex. If a parameter is not valid for a specific filter type, then the control for editing that parameter
should be disabled or removed when that filter type is selected.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
Page 81
preset.
ExampleDescriptionStatus Message
Set the
parametric EQ on
output 1 , band 2
to the following
parameters: type
= parametric
filter, frequency
= 1250 Hz,
bandwidth = 40
1/100th octaves,
Q01PEQOA1,2,1,1250,40,-20,1,1
gain = -20 dB,
enabled = yes,
slope = 1 dB per
octave. The
value of the
slope parameter
is irrelevant for
this type of filter,
we could have
set it to
anything.
Q01PEQOA1,2,1,1250,40,-20,1,1
Q01PEQOAB,1,t,f,b,g,s,e , where
the parameters t, f, b, g, s, and e
correspond to the current settings of the
type, frequency, bandwidth, gain, slope,
and enabled parameters, respectively. If
this filter was set to the same parameters
as given in the above example, the status
message would be
Q01PEQOAB,2,1,1250,40,-20,1,1 .
Q01PEQOAB,1,?
Query the
current
parameter
settings for the
parametric eq
filter on output B
, band 1.
8.90. PEQOB -- Set Bandwidth Parameter for Specified
Parametric EQ Output Stage
This command sets or queries the bandwidth parameter (in 1/100th octaves) for the parametric
equalizer (EQ) filters on output channels 1, A, and B . Each channel has five bands of parametric EQ
that can be independently controlled.
The minimum and maximum values for the bandwidth parameter are 5 and 200, respectively.
This command has the same format and restrictions as the
parameter, the bandwidth, is specified instead of all the parameters. See the
more information. To set the bandwidth parameter for an input parametric EQ filter, use the
PEQOA command except that only one
PEQOA command for
PEQIB
Page 82
command. To set all the parameters for an input parametric EQ filter, use the PEQIA command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set bandwidth of parametric EQ
Q01PEQOB1,2,40
Q01PEQOBB,1,?
on output 1 , band 2 to 40
1/100th octaves.
Query current bandwidth setting
of parametric EQ on output B ,
band 1.
Q01PEQOB1,2,40
Q01PEQOBB,1,b , where b is the current
setting of the bandwidth parameter for the
parametric EQ on output B , band 1. If the
bandwidth parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQOBB,1,40
.
8.91. PEQOE -- Set Enabled Parameter for Specified
Parametric EQ Output Stage
This command sets or queries the enabled parameter (0 = filter is disabled, 1 = filter is enabled) for
the parametric equalizer (EQ) filters on output channels 1, A, and B . Each channel has five bands of
parametric EQ that can be independently controlled.
This command has the same format and restrictions as the
parameter, the enabled status, is specified instead of all the parameters. See the
more information. To set the enabled parameter for an input parametric EQ filter, use the
command. To set all the parameters for an intput parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01PEQOE1,2,1
Enable parametric EQ on output 1
, band 2.
PEQOA command except that only one
PEQOA command for
PEQIE
PEQIA command.
Q01PEQOE1,2,1
Query enabled status of
Q01PEQOEB,1,?
parametric EQ on output B , band
1.
Q01PEQOEB,1,e , where e is the current
setting of the enabled parameter for the
parametric EQ on output B , band 1. If the
enabled parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQOEB,1,1 .
Page 83
8.92. PEQOF -- Set Frequency Parameter for Specified
Parametric EQ Output Stage
This command sets or queries the frequency parameter (in Hz) for the parametric equalizer (EQ)
filters on output channels 1, A, and B . Each channel has five bands of parametric EQ that can be
independently controlled.
The minimum and maximum values for the frequency parameter are 20 and 20000, respectively.
For filter types that have a center frequency (e.g., parametric), this parameter specifies the center
frequency. For filter types that have a cutoff frequency (e.g, highpass, lowpass, etc.), this parameter
specifies the cutoff frequency.
This command has the same format and restrictions as the
parameter, the frequency, is specified instead of all the parameters. See the
more information. To set the frequency parameter for an input parametric EQ filter, use the
command. To set all the parameters for an input parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set frequency of parametric
Q01PEQOF1,2,1250
Q01PEQOFB,1,?
EQ on output 1 , band 2 to
1250 Hz.
Query current frequency
setting of parametric EQ on
output B , band 1.
Q01PEQOF1,2,1250
Q01PEQOFB,1,f , where f is the current
setting of the frequency parameter for the
parametric EQ on output B , band 1. If the
frequency parameter of this filter is set to the
same value given in the example above, then
the status message will be
Q01PEQOFB,1,1250 .
PEQOA command except that only one
PEQOA command for
PEQIF
PEQIA command.
8.93. PEQOG -- Set Gain Parameter for Specified Parametric
EQ Output Stage
This command sets or queries the gain parameter (in dB) for the parametric equalizer (EQ) filters on
output channels 1, A, and B . Each channel has five bands of parametric EQ that can be
independently controlled.
The minimum and maximum values for the gain parameter are -20 and 20, respectively.
This command has the same format and restrictions as the
PEQOA command except that only one
Page 84
parameter, the gain, is specified instead of all the parameters. See the PEQOA command for more
information. To set the gain parameter for an input parametric EQ filter, use the
set all the parameters for an input parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set the gain of the parametric
Q01PEQOG1,2,-20
Q01PEQOGB,1,?
EQ on output 1 , band 2 to -20
dB.
Query current gain setting of
parametric EQ on output B ,
band 1.
Q01PEQOG1,2,-20
Q01PEQOGB,1,g , where g is the current
setting of the gain parameter for the
parametric EQ on output B , band 1. If the
gain parameter of this filter is set to the
same value given in the example above,
then the status message will be
Q01PEQOGB,1,-20 .
PEQIA command.
PEQIG command. To
8.94. PEQOS -- Set Slope Parameter for Specified
Parametric EQ Output Stage
This command sets or queries the slope parameter (in dB per octave) for the parametric equalizer
(EQ) filters on output channels 1, A, and B . Each channel has five bands of parametric EQ that can
be independently controlled.
For the Linkwitz-Riley filters, the slope can either be 12 or 24 (dB/Octave).For the low shelf and high
shelf filters, the minimum value for the slope parameter is 1, and the maximum value is 1.2 times the
current value of the gain parameter. See the
This command has the same format and restrictions as the
parameter, the slope, is specified instead of all the parameters. See the
information. To set the slope parameter for an input parametric EQ filter, use the
To set all the parameters for an input parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
PEQIG command for information on the gain parameter.
PEQOA command except that only one
PEQOA command for more
PEQIS command.
PEQIA command.
ExampleDescriptionStatus Message
Set the slope of the parametric
Q01PEQOS1,2,1
EQ on output 1 , band 2 to 1 dB
per octave.
Q01PEQOS1,2,1
Page 85
Q01PEQOSB,1,s , where s is the current
setting of the slope parameter for the
parametric EQ on output B , band 1. If the
slope parameter of this filter is set to the
same value given in the example above, then
the status message will be Q01PEQOSB,1,1 .
Q01PEQOSB,1,?
Query current slope setting of
parametric EQ on output B , band
1.
8.95. PEQOT -- Set Type Parameter for Specified
Parametric EQ Output Stage
This command sets or queries the type parameter for the parametric equalizer (EQ) filters on output
channels 1, A, and B . Each channel has five bands of parametric EQ that can be independently
controlled.
The type parameter specifies what type of filter is executed for the specified band of the specified
output channel. The different filter types and their corresponding values are shown in the table
below.
This command has the same format and restrictions as the
parameter, the filter type, is specified instead of all the parameters. See the
more information. To set the slope parameter for an input parametric EQ filter, use the
command. To set all the parameters for an input parametric EQ filter, use the
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
PEQOA command except that only one
PEQOA command for
PEQIT
PEQIA command.
ExampleDescriptionStatus Message
Set the type of the parametric EQ
Q01PEQOT1,2,1
on output 1 , band 2 to
parametric.
Q01PEQOT1,2,1
Page 86
Q01PEQOTB,1,t , where t is the current
setting of the type parameter for the
parametric EQ on output B , band 1. If the
type parameter of this filter is set to the same
value given in the example above, then the
status message will be Q01PEQOTB,1,1 .
Q01PEQOT1,2,1
Query current type setting of
parametric EQ on output B , band
1.
8.96. PHANTOM -- Enable Phantom Power on Input 1
This command sets or queries the status of phantom power on microphone input 1.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01PHANTOM11
Q01PHANTOM10
Q01PHANTOM12
Q01PHANTOM1?
Enable phantom power for input
channel 1.
Disable phantom power for input
channel 1.
Toggle phantom power state for
input channel 1.
Query state of phantom power for
input channel 1.
Section 6.3 and Section 6.1 for more information
Q01PHANTOM11
Q01PHANTOM10
Q01PHANTOM1x, where x is 0 or 1 depending
on the current state of phantom power on
input channel 1.
Q01PHANTOM1x, where x is 0 or 1 depending
on the current state of phantom power on
input channel 1.
8.97. PING -- See Which Devices Are Present
When any Vortex device receives this command, it responds with a PONG status message. This is
typically used by the host program to determine the types and IDs of all linked devices. When used in
this manner, wildcard characters are usually given for the device type and ID so that all connected
devices will respond.
In the following example, it is assumed that there are two EF2280's (device IDs 0 and 1), two
EF2241's (device IDs 2 and 3), two EF2211's (device IDs 4 and 5), two EF2210's (device ID's 6 and
7), and two EF2201's (device ID's 0 and 1) linked together via EF Bus.
Ping all connected device to determine the number, type, and ID of
the connected devices.
8.98. PRESETK -- Delete One or All Presets
This command kills (deletes) the specified preset. If a wildcard character (*) is used to specify the
preset, then all presets are deleted.
If an attempt is made to delete one of the factory presets (in the range 0-15), the PRESETK
command will fail and generate an ERROR#071. This is because the factory presets are read-only,
thus the cannot be changed or deleted.
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01PRESETK18
Q01PRESETK*
Delete preset number 18.
Delete all presets.
Q01PRESETK18
Q01PRESETK*
8.99. PRESETL -- List All Commmands in a Preset
This command lists all the commands in a given preset. For example, assume that user preset 18 has
been defined previously by the following command.
Q01PRESETW18
Now, issuing the command:
Q01PRESETL18?
Will result in a long sequence of status mesages reflecting all the data stored in the preset. At the end
of the status messages, a final message of
Page 88
Q01PRESETL18
will be displayed.
8.100. PRESETP -- Set Which Preset Will Be Activated At
Power-Up
This command sets or queries the power-up preset, which is executed each time the device powers
up. The power-up preset must be one of the factory presets (0-15) or one of the user presets (16-
47).
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01PRESETP16
Q01PRESETP?
Set the power-up preset to be user
preset 16.
Query the current power-up preset.
Q01PRESETP16
Q01PRESETPx , where x is between 0 and
47 depending on which preset is currently
set to be the power-on preset.
8.101. PRESETQ -- Execute a Preset Quietly
This command executes the preset corresponding to the specified number, which must be between 0
and 47. The preset must either be a pre-defined factory preset (0 - 15) or a user preset (16 - 47) that
has been previously defined via the
error condition of ERROR#070 will be returned. If one or more of the commands in the preset
generated errors, then an error condition of ERROR#072 will be returned.
When the PRESETQ command executes, status messages for all of the commands in the preset will
not be generated. The PRESETQ command is provided so that a control system can execute a preset
and not generated heavy data traffic from the resulting status messages. Of course, this assumes that
the control system is not interested in any of the acknowledgements. The
used to execute the preset without suppressing the status messages.
PRESETW command. If the specified preset is empty, then an
PRESETX command can be
ExampleDescriptionStatus Message
Q01PRESETQ18
Execute preset number 18 without generating any status
messages.
8.102. PRESETW -- Save a Preset
This command writes the current settings of the device into the user preset with the specified
Q01PRESETQ18
Page 89
number. Since the factory presets (0 - 15) are read-only, an ERROR#071 will be generated if they are
specified in the PRESETW command.
Once a preset it saved, it can be recalled via the
also be set to be executed automatically at power-up via the
This command is saved to global non-volatile memory and is not part of a preset. Its value is saved
each time it is changed. It will retain its value after power-down. Since this command writes to nonvolatile memory, there will be a delay before an acknowledgment is returned.
ExampleDescriptionStatus Message
Q01PRESETW18
Save the current device settings as preset 18.
PRESETX and PRESETQ commands. The preset can
PRESETP command.
Q01PRESETW18
8.103. PRESETX -- Execute a Preset
This command executes the preset corresponding to the specified number, which must be between 0
and 47. The preset must either be a pre-defined factory preset (0 - 15) or a user preset (16 - 47) that
has been previously defined via the
error condition of ERROR#070 will be returned. If one or more of the commands in the preset
generated errors, then an error condition of ERROR#072 will be returned.
PRESETW command. If the specified preset is empty, then an
When the PRESETX command executes, status messages for all of the commands in the preset will
be generated (unless
by using the
status messages are suppressed.
ExampleDescriptionStatus Message
Q01PRESETX18
PRESETQ command, which is exactly the same as the PRESETX command except that
acknowledgement mode is turned off). The status messages can be suppressed
Status messages for all the commands in the preset
Execute preset number 18.
will be generated first, followed by the message:
Q01PRESETX18
8.104. REFASGN -- Assign AEC Reference to Input Channel
This command assigns an AEC reference signal (R1 or EF Bus) to an input channel. Only input 1 has
echo cancellation, so the command is only valid for that channel. Assigning 1 to the input channel
selects AEC Reference 1 (R1). Assigning 3 to an input channel selects the EF Bus Reference. The EF
Bus reference is an AEC reference that is placed on the EF Bus by one (and only one) of the linked
Vortexes. See the
REFASGN a value of 2 is not supported on this device. The value of 2 is only supported on devices
that can build a second AEC reference (i.e., the EF2280, EF2241).
BUSREF command for more information about the EF Bus reference. Assigning
Although this command is a channel integer command, the increment and decrement operators (>
and <) are not supported for this particular command.
Page 90
This command is a channel integer command. See Section 6.3 and Section 6.2 for more information
on this type of command. The minimum and maximum values for this command are 1 and 3,
respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01REFASGN11
Q01REFASGN1?
Configure the AEC on input channel
1 to use AEC Reference 1 (R1).
Query which AEC reference is
currently being used for the AEC on
input channel 1.
Q01REFASGN11
Q01REFASGN1x, where x is either 1, or 3
depending on which AEC reference is
currently being used.
8.105. REFGAIN -- Set Reference Output Gain
This command sets the effective output gain of the corresponding AEC reference. When doing volume
control of room speakers, it is a good idea to adjust this reference gain along with the speaker output
gain so that the AEC is aware of any volume changes. This will help prevent short echoes when
volume changes are made.
There are two AEC references on the EF2280, EF2241, and EF2241, so there are two separate
commands, REFGAINR1 and REFGAINR2, for controlling the effective output gain of R1 and R2,
respectively.
There is only one AEC reference on the EF2211 and EF2210, so there is only one command,
REFGAINR1 for controlling the effective output gain of R1.
This command was introduced in firmware version 2.5.0.
This command is an integer command. See
command. The minimum and maximum values for this command are -100 and 20, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Example DescriptionStatus Message
Increase phone output gain by 3 dB.
Set effective output gain of AEC reference 1 (R1)
to 6 dB.
Section 6.2 for more information on this type of
, where x is the new value of the
phone output gain. If this command
was issued after the example above,
then the status message would be .
Page 91
, where x is the new value of the
Query phone output gain.
phone output gain. If this command
was issued after the example above,
then the status message would be .
8.106. SGGAIN -- Set Gain of Signal Generator
This command sets the gain of the internal signal generator. The value of SGGAIN specifies the gain
in dB applied to signal generator. A gain of 0 dB produces a signal at nominal level (-20 dB full scale).
This command is an integer command. See
command. The minimum and maximum values for this command are -100 and 20, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01SGGAIN6
Q01SGGAIN>3
Q01SGGAIN?
Set signal generator gain to 6 dB.
Increase signal generator gain by 3 dB.
Query signal generator gain.
Section 6.2 for more information on this type of
Q01SGGAIN6
Q01SGGAINx , where x is the new value of
the signal generator gain. If this command
was issued after the example above, then
the status message would be Q01SGGAIN9
.
Q01SGGAINx , where x is the new value of
the signal generator gain. If this command
was issued after the example above, then
the status message would be Q01SGGAIN9
.
8.107. SGMUTE -- Mute Signal Generator
This command controls the muting of the signal generator.
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01SGMUTE1
Q01SGMUTE0
Mute signal generator.
Unmute signal generator.
Section 6.1 for more information on this type of
Q01SGMUTE1
Q01SGMUTE0
Page 92
Q01SGMUTE2
Toggle mute on signal generator.
Q01SGMUTEx , where x is 0 or 1 depending on the
current state of the signal generator mute.
Q01SGMUTE?
Query signal generator mute.
Q01SGMUTEx , where x is 0 or 1 depending on the
current state of the signal generator mute.
8.108. SGTYPE -- Set Type of Signal Produced by Signal
Generator
This command sets the type of signal produced by the internal signal generator. Setting the type to 0
produces white noise, while setting the type to 1 produces pink noise.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01SGTYPE0
Q01SGTYPE1
Configure signal generator to produce
white noise.
Configure signal generator to produce
pink noise.
Q01SGTYPE0
Q01SGTYPE1
Q01SGTYPEx , where x is either 0 or 1
Q01SGTYPE?
Query current signal generator type.
depending on whether the signal generator
is currently configured to generate white or
pink noise, respectively.
8.109. SSDELAY -- Set Delay Between Screen Saver
Screens
This command sets or queries the amount of time (in milliseconds) between each new screen of the
LCD screen saver.
This command is an integer command. See
command. The minimum and maximum values for this command are 500 and 600000, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
Section 6.2 for more information on this type of
ExampleDescriptionStatus Message
Q01SSDELAY2000
Set screen saver delay to 2
seconds (2000 ms).
Q01SSDELAY2000
Page 93
Q01SSDELAYx , where x is the new value of
Q01SSDELAY>500
Q01SSDELAY?
Increase screen saver delay by
0.5 seconds (500 ms).
Query screen saver delay.
the screen saver delay. If this command was
issued after the example above, then the
status message would be Q01SSDELAY2500 .
Q01SSDELAYx , where x is the new value of
the screen saver delay. If this command was
issued after the example above, then the
status message would be Q01SSDELAY2500 .
8.110. SSEN -- Enable or Disable Screen Saver
This command controls whether or not the LCD screen saver is enabled.
This command is a boolean command. See
command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01SSEN1
Q01SSEN0
Q01SSEN2
Q01SSEN?
Enable screen saver.
Disable screen saver.
Toggle screen saver enabled state.
Query screen saver enabled state.
Section 6.1 for more information on this type of
Q01SSEN1
Q01SSEN0
Q01SSENx , where x is 0 or 1 depending on the
current enabled state of the scrren saver.
Q01SSENx , where x is 0 or 1 depending on the
current enabled state of the scrren saver.
8.111. SSSTART -- Set Idle Time Required for Screen
Saver to Start
This command sets or queries the amount of time (in milliseconds) that the front panel buttons must
be idle before the screen saver starts.
This command is an integer command. See
command. The minimum and maximum values for this command are 500 and 600000, respectively.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Section 6.2 for more information on this type of
Page 94
Q01SSSTART2000
Q01SSSTART>500
Q01SSSTART?
Set screen saver start time to 2
seconds (2000 ms).
Increase screen saver start time
by 0.5 seconds (500 ms).
Query screen saver start time.
Q01SSSTART2000
Q01SSSTARTx , where x is the new value of
the screen saver start time. If this command
was issued after the example above, then the
status message would be Q01SSSTART2500 .
Q01SSSTARTx , where x is the new value of
the screen saver start time. If this command
was issued after the example above, then the
status message would be Q01SSSTART2500 .
8.112. SSTEXT -- Set Text to be Displayed by Screen Saver
This command sets or queries the text messages displayed by the screen saver. The arguments of
this command are the screen number, the line number, and the text to be displayed. The screen
number must be between 0 and 3. It indicates which message screen we are trying to set or query.
Each message screen consists of two lines of text that can be up to 16 characters long. The second
number indicates which line of the message we are tring to set or query. The line number must be 0
or 1 corresponding to the first and second line, respectively. Finally, the text argument is the actual
text that will be displayed on the LCD. If the text is '?', then a query will be performed. If the text
empty, then the message will be cleared. If both message lines are cleared for a given screen, then
that screen will not be displayed by the screen saver. If all screens have been cleared, then the
screen saver will never start (although it is easier just to use the
SSEN command for this).
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Set the first line of
Q01SSTEXT0,0,Play that
Q01SSTEXT0,1,funky music
Q01SSTEXT0,1,?
the first screen to
read "Play that".
Set the second line
of the first screen to
read "funky music".
Query the text of
the second line of
the first screen.
Q01SSTEXT0,0,Play that
Q01SSTEXT0,1,funky music
Q01SSTEXT0,1,<string> , where
<string> is the text of the second line of
the first screen. If this command was issued
after the example above, then the status
message would be Q01SSTEXT0,1,funky music .
8.113. SWRESET -- Perform Soft Reset of System
Executing this command causes the Vortex to perform a software reset. The effect of the software
Page 95
reset is similar to cycling the power.
ExampleDescriptionStatus Message
Q01SWRESET
Perform a software reset.
No status message will be received. The Vortex will reset
within a few seconds.
8.114. SWVER -- Query Software Version
This command is used to query the firmware version of the Vortex.
ExampleDescriptionStatus Message
Q01SWVER<string> , where <string> is the
Q01SWVER?
Query current software version.
current sofware version. If the software version was
2.5.0, then the status message would be
Q01SWVER2.5.0 .
8.115. VTXMODI -- Enable VTX Mode on Specified Inputs
Vortex devices can be connected to a Polycom VTX 1000 in order to use the wideband capabilities of
that device. When connecting to a VTX 1000, special proccessing is done on the Vortex in order to
guarantee compatibility with the VTX 1000. This command enables processing for the VTX 1000 on
the specified line input or inputs. Note that VTX 1000 mode can only be enabled on the line inputs (AB).
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01VTXMODIA1
Q01VTXMODIB0
Q01VTXMODIB2
Q01VTXMODIA?
Q01VTXMODI*1
Q01VTXMODI*0
Enable VTX mode on input A.
Disable VTX mode on input B.
Toggle status VTX mode on input
B.
Query status of VTX mode on
input A.
Enable VTX mode on inputs A-B.
Disable VTX mode on inputs A-B.
Section 6.3 and Section 6.1 for more information
Q01VTXMODIA1
Q01VTXMODIB0
Q01VTXMODIBx, where x is either 0 or 1
depending on the current status of VTX mode
on input B.
Q01VTXMODIAx, where x is either 0 or 1
depending on the current status of VTX mode
on input A.
Q01VTXMODI*11
Q01VTXMODI*00
Page 96
Q01VTXMODI*10
Q01VTXMODI*2
Q01VTXMODI*?
Enable VTX mode on input A and
disable VTX mode on input B.
Toggle status of VTX mode on
inputs A-B.
Query status of VTX mode on
inputs A-B.
Q01VTXMODI*10
Q01VTXMODI*ab, where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status VTX mode on the corresponding
input. If this command was sent after the
example above, then the status message
would be Q01VTXMODI*01.
Q01VTXMODI*ab, where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status VTX mode on the corresponding
input. If this command was sent after the
example above, then the status message
would be Q01VTXMODI*01.
8.116. VTXMODO -- Enable VTX Mode on Specified Inputs
Vortex devices can be connected to a Polycom VTX 1000 in order to use the wideband capabilities of
that device. When connecting to a VTX 1000, special proccessing is done on the Vortex in order to
guarantee compatibility with the VTX 1000. This command enables processing for the VTX 1000 on
the specified line output or outputs.
This command is a channel boolean command. See
on this type of command.
This command is saved to non-volatile memory only as part of a preset. The state of this command
will be restored after power-up only if a preset is saved and that preset is set to be the power-on
preset.
ExampleDescriptionStatus Message
Q01VTXMODO11
Q01VTXMODOA0
Q01VTXMODO12
Q01VTXMODOA?
Q01VTXMODO*1
Enable VTX mode on output 1.
Disable VTX mode on output A.
Toggle status VTX mode on
output 1.
Query status of VTX mode on
output A.
Enable VTX mode on outputs 1,
A-B.
Section 6.3 and Section 6.1 for more information
Q01VTXMODO11
Q01VTXMODOA0
Q01VTXMODO1x, where x is either 0 or 1
depending on the current status of VTX mode
on output 1.
Q01VTXMODOAx, where x is either 0 or 1
depending on the current status of VTX mode
on output A.
Q01VTXMODO*111
Q01VTXMODO*0
Disable VTX mode on outputs
1, A-B.
Q01VTXMODO*000
Page 97
Q01VTXMODO*100
Q01VTXMODO*2
Q01VTXMODO*?
Enable VTX mode on output 1
and disable VTX mode on
output A-B.
Toggle status of VTX mode on
outputs 1, A-B.
Query status of VTX mode on
outputs 1, A-B.
Q01VTXMODO*100
Q01VTXMODO*abc, where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status VTX mode on the corresponding
output. If this command was sent after the
example above, then the status message would
be Q01VTXMODO*011.
Q01VTXMODO*abc, where each of the letters
(a, b, etc.) is either 0 or 1 depending of the
current status VTX mode on the corresponding
output. If this command was sent after the
example above, then the status message would
be Q01VTXMODO*011.
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.