Command Data; Command Terminator; Examples; Status Messages - Polycom Vortex EF2241 Programming Manual

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 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 'B**GAINIA10'. The device type for this command is 'B' and the device ID is a
wildcard, thus the command will be broadcast to all EF2241 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 EF2241's to 10 dB.
Command
***PING
B**GAINIA10

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 'B**GAINIA10' and there are two EF2241's linked together
with device IDs 3 and 7. The EF2241's will respond with 'B03GAINIA10' and 'B07GAINIA10', respectively.
Now, someone uses the front panel of the EF2241 set to ID 7 to decrease input A's gain by 1 dB. When this
happens, the EF2241 will respond with 'B07GAINIA9'. This example illustrates that status messages can be
Effects
Requests PONG response from all linked Vortex devices.
Sets the gain on input A of all connected EF2241 devices to 10 dB.