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 '
T**GAINIT10
'. The device type for this command is '
T
' and the device ID is a
wildcard, thus the command will be broadcast to all EF2201 devices linked together. The command
name in this case is '
GAINIT
' and the command data (payload) is '
10
'. This command sets the gain on
input T of all connected EF2201's to 10 dB.
Command
Effects
***PING
Requests
PONG
response from all linked Vortex devices.
T**GAINIT10
Sets the gain on input T of all connected EF2201 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 '
T**GAINIT10
' and there are two EF2201's linked
together with device IDs 3 and 7. The EF2201's will respond with '
T03GAINIT10
' and '
T07GAINIT10
',
respectively. Now, someone uses the front panel of the EF2201 set to ID 7 to decrease input T's gain
by 1 dB. When this happens, the EF2201 will respond with '
T07GAINIT9
'. 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
ACKMOD
command.
ACKMOD
refers to acknowledgement
mode since the term status message and acknowledgement are synonymous for our purposes.
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.