Installed Voice Business Group RS-232 Command Set: Vortex EF2280 Programming Guide Copyright © 2003 Polycom, Inc. Polycom and the Polycom logo are registered trademarks of Polycom, Inc. ASPI, Vortex, VS4000, Viewstation, and iPower are registered trademarks of Polycom, Inc.
Vortex EF2280 Programming Guide Table of Contents 1. Introduction 2. RS-232 Hardware 3. Programming Tips 3.1. Initialization 3.2. Wildcard Characters 3.3. Using Acknowledgements 3.4. Macros and Presets 3.5. Automixer Dependencies 4. Command Structure 4.1. Device Type 4.2. Device ID 4.3. Command Name 4.4. Command Data 4.5. Command Terminator 4.6. Examples 5. Status Messages 6. Command Types 6.1. Boolean Commands 6.2. Integer Commands 6.3. Channel Commands 6.4. Matrix Commands 6.5. Miscellaneous Commands 7.
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. 8.59. 8.60. 8.61. 8.62. 8.63. 8.64. 8.65. 8.66. 8.67. 8.68. 8.69.
8.70. LIM -- Mask Logic Input Pins 8.71. LIN -- Assign Command to Logic Input Group 8.72. LIP -- Set Polarity for Logic Inputs 8.73. LO -- Query or Set Status of Logic Output Pins 8.74. LOA -- Define Behavior for Logic Output Activated State 8.75. LOD -- Define Behavior for Logic Output Deactivated Status 8.76. LOEN -- Enable Automatic Logic Output Status Messages 8.77. LOK -- Delete One or All Logic Output Pin Commands 8.78. LOM -- Mask Logic Output Pins 8.79. LOP -- Set Polarity for Logic Outputs 8.80.
8.120. 8.121. 8.122. 8.123. 8.124. 8.125. 8.126. 8.127. 8.128. 8.129. 8.130. 8.131. 8.132. 8.133. 8.134. 8.135. 8.136. 8.137.
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.
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 Section 7 for a list showing all the commands and which are 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.
AMLMM21 AMLMN25 In this case, the AMCHAIR21 command and the AMLMM21 would not get executed. They would produce ERROR#044 and ERROR#042, respectively. The AMCHAIR21 command causes an error because we try to turn on chairman mode for automixer 2, but automixer 2's chairman mic is set to 1, whic belongs to automixer 1. Similarly, the AMLMM21 command causes an error because we try to set last mic on mode to manual for automixer 2, but automixer 2's last mic number is set to 1, which belongs to automixer 1.
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. ● ● ● 'F**' broadcasts to all EF2280 devices that are linked together.
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 'F**GAINIA10' and there are two EF2280's linked together with device IDs 3 and 7.
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 'F04GAINIA? ', the device will respond with a status message of 'F04GAINIA12 '. 6.3. Channel Commands 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.
format. For example, 'F04GAINI*ÄÄÄÄÄÄÄÄääää ' sets the input gain of channels 1-8 to 10 dB and the input gain of channels A-D to 0 dB. (10 + 132 = 142 = 0x8E (hex) = Ä (ASCII), 0 + 132 = 132 = 0x84 (hex) = ä (ASCII)) As an interesting example, consider sending 'F04GAINI*>3 ' after the above example. This will result in all the input gains being incremented by 3 dB so that channels 1-8 are at 13 dB and channels A-D are at 3 dB. The Vortex will respond with a status message of 'F04GAINI*ææææææææçççç '.
The EF2280 has twelve analog outputs labeled 1-8 and A-D. These outputs are all at line level. The EF2280 has twelve analog inputs labeled 1-8 and A-D. Inputs 1-8 are mic/line selectable, and inputs A-D are line level only. Inputs 1-8 can also have phantom power enabled and contain channel processing, which includes the follwoing DSP algorithms: Acoustic Echo Cancellation, Noise Cancellation, AGC, and Automatic Microphone Mixing.
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 EF2280 does not transmit on the P bus.
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 'F04MGAINSG,*,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.
● "-" = 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 PRESETW command is executed.
BROAD2 - Broadcast Arbitrary Command Strings to RS-232 Port BROADA - Broadcast Commands to Other Connected Devices BUSREF Preset Set Which AEC Reference is Placed on EF Bus CGATE - Query Camera Gating Status Information CGATEEN Preset Enable Automatic Camera Gating Messages CGATET Preset Set Camera Gating Hold Time DELAYO Preset Set Output Delay DELAYOE Preset Enable Output Delay DSPAUTO - Enable Automatic DSPLOAD Status Messages DSPLOAD - Query Percentage of Variable DSP Resour
LIK Global Delete One or All Logic Input Pin Commands LIM Preset Mask Logic Input Pins LIN Global Assign Command to Logic Input Group LIP Global Set Polarity for Logic Inputs LO - Query or Set Status of Logic Output Pins LOA Global Define Behavior for Logic Output Activated State LOD Global Define Behavior for Logic Output Deactivated Status LOEN Preset Enable Automatic Logic Output Status Messages LOK Global Delete One or All Logic Output Pin Commands LOM Preset Mask Logic Outp
PEQIG Preset Set Gain Parameter for Specified Parametric EQ Input Stage PEQIS Preset Set Slope Parameter for Specified Parametric EQ Input Stage PEQIT Preset Set Type Parameter for Specified Parametric EQ Input Stage PEQOA Preset Set All Parameters for Specified Parametric EQ Output Stage PEQOB Preset Set Bandwidth Parameter for Specified Parametric EQ Output Stage PEQOE Preset Set Enabled Parameter for Specified Parametric EQ Output Stage PEQOF Preset Set Frequency Parameter for Specifi
This command is a boolean command. See Section 6.1 for more information on this type of 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 non-volatile memory, there will be a delay before an acknowledgment is returned. Example Description Status Message F01ACKMOD1 Enable acknowledgement mode. F01ACKMOD1 F01ACKMOD0 Disable acknowledgement mode.
● ● ● ● 1 2 3 4 = = = = No Suppression Light Suppression Heavy Suppression 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.
F01AGC*2 F01AGC*abcdefgh, where a-h are each 0 or 1 depending Toggle AGC state on input channels 1on the current state of the AGC for each of the eight input 8. channels. F01AGC*? F01AGC*abcdefgh, where a-h are each 0 or 1 depending Query AGC state on input channels 1on the current state of the AGC for each of the eight input 8. channels. 8.5. AGCMAX -- Set Maximum Allowed Mic/Line Input AGC Gain This command sets the maximum gain that the AGC can apply on input channels 1-8 .
F01AGCMIN1? Query the AGC minimum gain on input channel 1 . F01AGCMIN1x where x is a number between -15 and 0, depending on the current setting of the AGC minimum gain on input channel 1 . F01AGCMIN*-6 Set AGC minimum gain on input channels 1-8 to -6 dB. F01AGCMIN*~~~~~~~~ Set AGC minimum gain on input channels 1-4 to 0 dB F01AGCMIN*ääääüüüü and AGC minimum gain on input channels 5-8 to -3 dB.
(AMLMM)) is set to manual for that automixer, then the AMASGN command will fail and an ERROR#040 message will be generated. If the microphone is removed from an automixer where it was a ssigned as the "Chairman Mic" and chairman mode (AMCHAIR) is enabled for that automixer, then an ERROR#041 message will be generated. See the ERROR command for more information on error messages. See Section 3.5 for more information on dependencies within the automixer commands.
Select automatic thresholds for F01AMAUTO31 automixer gating on input channel 3 . F01AMAUTO31 Select manual thresholds for F01AMAUTO30 automixer gating on input channel 3 . F01AMAUTO30 Toggle between automatic and F01AMAUTO3x , where x is 0 or 1 depending on whether F01AMAUTO32 manual thresholds for automixer input channel 3 is currently set for manual or automatic gating on input channel 3 . thresholds. F01AMAUTO3? Query AMAUTO state on input channel 3 .
Configure Automixer 2 to be part of the Bus Automixer having Bus D 0. This F01AMBUSID20 means that the automixer is not part of any Bus Automixer. F01AMBUSID1? F01AMBUSID20 Query the current Bus ID of Automixer 1 F01AMBUSID1x , where x is a number between 0 . and 8 indicating the current Bus ID of Automixer 1 . 8.11. AMCHAIR -- Enable Chairman Mode for Specified Automixer This command enables, disables, or queries the chairman mode feature for the specified automixer.
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. Example Description Status Message F01AMCHNUM14 Set microphone 4 as the chairman mic for automixer 1. F01AMCHNUM14 F01AMCHNUM21 Set microphone 1 as the chairman mic for automixer 2.
Example Description Status Message F01AMGATEC10 Configure microphone input F01AMGATEC10 1 for normal gating. F01AMGATEC21 Configure microphone input F01AMGATEC21 2 to be forced on. F01AMGATEC32 Configure microphone input F01AMGATEC32 3 to be forced off. F01AMGATEC3? Query current gating control F01AMGATEC3x , where x is 0, 1, or 2 depending on mode for microphone input the current gating control mode setting for microphone 3. input 3 .
F01AMGATER3x , where x is between 0 and 100 depending on the current setting of the gate ratio for input channel 3 . If this command is issued after the example above, then the status message will be F01AMGATER315 . F01AMGATER3? Query gate ratio for automatic gating threshold for input channel 3 . F01AMGATER*12 Set gate ratio for automatic F01AMGATER*ÉÉÉÉÉÉÉÉ gating threshold to 12 dB for all input channels.
F01AMGATET*12 Set gate threshold for manual gating threshold to F01AMGATET*ÉÉÉÉÉÉÉÉ 12 dB for all input channels. Set gate threshold for manual gating threshold to F01AMGATET*ÉÉÉÉôôôô F01AMGATET*ÉÉÉÉôôôô 12 dB for inputs 1-4 and 15 dB for inputs 5-8. F01AMGATET*<3 F01AMGATET*abcdefgh , where a-h will each be Decrease gate threshold for between ä and Φ depending on the setting of the gate manual gating threshold by threshold for each input channel. If this command is 3 dB for all input channels.
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 Description Status Message F01AMHOLD500 Set automixer hold time to 500 ms. F01AMHOLD500 Increase automixer hold time by 500 F01AMHOLD>500 ms. F01AMHOLD? Query automixer hold time. F01AMHOLDx , where x is between 0 and 5000 depending on the current AMHOLD setting.
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 (1-2) that will be adjusted. The second argument is the microphone number (1-8) that should be gated on if no other mics are gated on and AMLMM is set to manual. The value of the AMLMN command is only valid when AMLMM is set to manual.
Example Description Status Message F01AMNOM13 Set local NOM for automixer 1 to a maximum of 3 mics. F01AMNOM13 F01AMNOM2x , where x is between 1 and 8 F01AMNOM2? Query current local NOM limit for automixer 2 . depending on the current setting of the local NOM limit for automixer 2. 8.22. AMNOMAT -- Select NOM Attenuation on Each Output This command enables, disables, or queries NOM attenuation for the specified output (1-8, A-D) . . NOM attenuation is calculated as 10*log(Number of Open Microphones).
Query NOM attenuation status of all outputs. F01AMNOMAT*? F01AMNOMAT*abcdefghijkl , where each of the letters (a, b, etc.) is either 0 or 1 depending of the 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 F01AMNOMAT*000000001111 . 8.23. AMOFFAT -- Set Off Attenuation for the Specified Automixer This command sets the off attenuation (in dB) for the specified automixer.
F01AMPRIOR*2 Set microphone inputs 1-8 to gating priority 2. F01AMPRIOR*åååååååå Set gating priority of inputs 1-2 to 1, inputs 3-4 to 2, F01AMPRIOR*ààååççêê F01AMPRIOR*ààååççêê inputs 5-6 to 3, and 7-8 to 4. F01AMPRIOR*? Query gating priorities for all microphone inputs. F01AMPRIOR*abcdefgh , where a-h are each between à and ê depending on the current setting of the gating priority for each channel.
The first argument in the command specifies the automixer number (1-2) 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 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.
Example Description Status Message F01BLAUTO0 Disable automatic BLDATA messages. F01BLAUTO0 F01BLAUTO1 Enable automatic BLDATA messages. F01BLAUTO1 F01BLAUTO2 Toggle enabled status of automatic BLDATA messages. F01BLAUTOx , where x is 0 or 1 depending on the current setting of BLAUTO. F01BLAUTO? Query enabled status of automatic BLDATA messages. F01BLAUTOx , where x is 0 or 1 depending on the current setting of BLAUTO. 8.29.
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 translate to AEC states. Byte Value AEC State Value (Byte Value - 132) AEC State Description 132 0 Idle 133 1 Transmit 134 2 Receive 135 3 Double Talk Here's an example BLDATA message to clear things up.
ä = 0x84 = 132 → 132 - 132 = 0 = Idle à = 0x85 = 133 → 133 - 132 = 1 = Transmit å = 0x86 = 134 → 134 - 132 = 2 = Receive ç = 0x87 = 135 → 135 - 132 = 3 = Double Talk So, we know that the AEC on inputs 1-2 are in idle, inputs 3-4 are in transmit, inputs 5-6 are in receive, and inputs 7-8 are in double talk. In the above description, the data in the BLDATA command consists of 50 bytes (12 input levels + 12 output levels + 2 AEC reference levels + 8 room gain levels + 8 AGC gain levels + 8 AEC states).
to send out 'ATDT4048921180' via its RS-232 port. If a modem was connected to the RS-232 port, this command would cause the modem to dial the Polycom Installed Voice Business Group in Atlanta. Example Description Status Message F01BROAD2:ATDT4048921180 Sends the string ATDT4048921180 out the RS-232 port. F01BROAD2 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.
8.34. CGATE -- Query Camera Gating Status Information This command is used to query the gating status of the microphone inputs . 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. 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.
This command sets the hold time (in milliseconds) for the camera gating (CGATE) feature. 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 100 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.
F01DELAYO2? Query current output delay on output channel 2 . F01DELAYO2x , 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 F01DELAYO23200 . 8.38. DELAYOE -- Enable Output Delay This command sets or queries the enabled state of the output delay for each of the twelve output channels (1-8, A-D) . This command is a channel boolean command. See Section 6.3 and Section 6.
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. This command is a boolean command. See Section 6.1 for more information on this type of command. Example Description Status Message F01DSPAUTO1 Enable automatic DSPLOAD messages. F01DSPAUTO1 F01DSPAUTO0 Disable automatic DSPLOAD messages. F01DSPAUTO0 F01DSPAUTO2 Toggle automatic DSPLOAD messages.
ERROR#040 This error occurs as the result of an AMASGN command. It happens when the 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. 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#091 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 This error indicates an EF Bus ID conflict. See the Vortex user manual for information on valid device IDs. ERROR#093 This error indicates an EF Bus reference conflict. This error occurs when more than one Vortex is placing its AEC reference on the bus.
F01FADERIAa F01FADERIBb F01FADERICc F01FADERIDd , where a, b, c, and d are the new values of the Increase fader gains on all line inputs by fader gains for each of the line inputs. If this F01FADERGIL>3 3 dB. command was issued after the example above, then the status messages would be: F01FADERIA10 F01FADERIB10 F01FADERIC10 F01FADERID10 . F01FADERGIL? Query fader gains on all line inputs.
F01FADERGIM>3 F01FADERGIM? Increase fader gain on all mic inputs by 3 dB. F01FADERI1a F01FADERI2b F01FADERI3c F01FADERI4d F01FADERI5e F01FADERI6f F01FADERI7g F01FADERI8h , where a, b, c, d, e, f, g, and h are the new values of the fader gains for each of the mic inputs. If this command was issued after the example above, then the status messages would be: F01FADERI110 F01FADERI210 F01FADERI310 F01FADERI410 F01FADERI510 F01FADERI610 F01FADERI710 F01FADERI810 . Query fader gains on all mic inputs.
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 -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 Description Status Message F01FADERI210 Set fader gain on input F01FADERI210 2 to 10 dB.
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 Section 6.1) except that when disabling this feature, the password must be supplied for the command to work. If an incorrect password is supplied, 'ERROR#005' will be generated.
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. Example F01GAINGIL7 Description Status Message Set gain of all line inputs to 7 dB.
F01GAINGIM7 Set gain of all mic inputs to 7 dB. F01GAINI17 F01GAINI27 F01GAINI37 F01GAINI47 F01GAINI57 F01GAINI67 F01GAINI77 F01GAINI87 F01GAINI1a F01GAINI2b F01GAINI3c F01GAINI4d F01GAINI5e F01GAINI6f F01GAINI7g F01GAINI8h , where a, b, c, d, e, f, g, and h are the new Increase incoming gain on all mic inputs by values of each of the mic inputs. If this command F01GAINGIM>3 3 dB.
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 FADERI command can be used to adjust the signal level in the digital domain without affecting the calibration. The following table shows the relationship between the input gain settings (via GAINI and MIC) and the nominal level expected at each of the inputs.
restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Status Message F01GAINO210 Set gain on output channel 2 to 10 dB. F01GAINO210 F01GAINO2? F01GAINO2x , , where x is a number between -100 Query the gain on output and 20, depending on the current setting of the gain on channel 2 . output channel 2 . F01GAINO*6 Set the gain on all output channels (1-8, A- F01GAINO*èèèèèèèèèèèè D) to 6 dB.
This command is a boolean command. See 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. Example Description Status Message F01GATEEN0 Disable automatic gating messages. F01GATEEN0 F01GATEEN1 Enable automatic gating messages.
Example Description Status Message F01ID3 Change the device ID from 1 to 3 F03ID3 F01ID? Query current device ID. F01ID1 8.56. 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).
This command sets or queries the status of the Automatic Gain Control (AGC) algorithm on input channels A-D . This command was introduced in firmware version 2.5.0. 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.
F01LAGCLINKAB0 Disable stereo AGC linking on inputs F01LAGCLINKAB0 A and B. F01LAGCLINKAB2 Toggle stereo AGC linking on inputs A and B. F01LAGCLINKABx , where x is 0 or 1 depending on the current state of stereo AGC linking on inputs A and B. F01LAGCLINKAB? Query status of stereo AGC linking on inputs A and B. F01LAGCLINKABx , where x is 0 or 1 depending on the current state of stereo AGC linking on inputs A and B. 8.59.
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 Description Status Message F01LAGCMAXA3 Set AGC maximum gain on input channel A to 3 dB. F01LAGCMAXA3 F01LAGCMAXB? Query the AGC maximum gain on input channel B. F01LAGCMAXBx , where x is a number between 0 and 15, depending on the current setting of the AGC maximum gain on input channel B.
8.62. 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-D . The ramp rate is expressed in dB/sec. This command was introduced in firmware version 2.5.0. 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.
input and a closed switch would normally be considered active. This polarity setting can be changed via the LIP command. A single command can be assigned to each of three conditions occurring on the logic pin: a change to the active state, a change to the inactive state, and a repeating command when the pin is held in the active state. The LIA command assigns a single command to the logic pin that is executed when the logic pin changes to the active state.
F01LIA7, F01LIA4,? Assign a blank command to occur when logic input pin 7 changes from the inactive state to the active state. Assigning a blank command means no action will take place as a result of this state change. F01LIA7, Query the command associated with the active state of logic pin 4. F01LIA4, , where is the command string that will be executed when logic input 4 is activated.
state. Typically, the inactive state is logic high ('1') and the active state is logic low ('0'). This is commonly referred to as active low. Acitve low is considered normal because a closed switch would ground the input and a closed switch would normally be considered active. This polarity setting can be changed via the LIP command.
Example Description Status Message F01LIEN1 Enable automatic logic input status messages. F01LIEN1 F01LIEN0 Disable automatic logic input status messages. F01LIEN0 F01LIEN2 Toggle automatic logic input status messages. F01LIENx , where x is 0 or 1 depending on the current setting of LIEN. F01LIEN? Query automatic logic input status messages. F01LIENx , where x is 0 or 1 depending on the current setting of LIEN. 8.68.
Using this command is more efficient than deleting one command or pin at a time since this command deletes them all at once and requires fewer 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 non-volatile memory, there will be a delay before an acknowledgment is returned.
LIN command specifies which logic group to be affected. The second number specifies the configuraion. In this case, the number '10' translates to '01010' in binary. There are zeros in the positions for the first, third, and last bits -- these correspond to logic inputs 6, 8, and 10 for our case. Similarly, the ones in the second and fourth positions correspond to bits 7 and 9. The last part of the command specifies the command to be executed with the pins enter this configuration.
settings imposed by the LO command. If a logic pin is masked via the LOM command, its status will still be affected by the LO command. Example Description Status Message F01LO*00000000000000000000 Set all logic outputs F01LO*00000000000000000000 low. Set even numbered logic output pins F01LO*10101010101010101010 low and odd F01LO*10101010101010101010 numbered logic output pins high.
Logic output 10 will be deactivated if: ● ● (input 1, input 2, input A, and input B are unmuted) AND (input C OR input D is muted) An error condition of ERROR#074 will be generated if the assigned command is invalid. 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-volatile memory, there will be a delay before an acknowledgment is returned.
F01LOEN? Query automatic logic output status messages. F01LOENx , where x is 0 or 1 depending on the current setting of LOEN. 8.77. LOK -- Delete One or All Logic Output Pin Commands This command "kills" or deletes all commands for a given logic output pin. In other words, the commands associated with LOA and LOD will be deleted for the specified logic output. A wildcard character can also be specified for the logic output pin, in which case the commands for all logic output pins will be deleted.
8.79. LOP -- Set Polarity for Logic Outputs This command sets the polarity for the 20 logic input pins. Setting the polarity for a given pin to 1 indicates that the polarity should be normal (active high). Setting the polarity for a given pin to 0 indicates that the polarity should be inverted (active low). Active high is considered normal because it would light an LED connected to an output pin if the output pin was in the active state. This command affects the operation of the LOA and LOD commands.
F01MACROA62,MUTEOMYMOTHERINLAW Would not return an error because it contains a MUTEO command. An error would be returned when the macro is executed with a MACROX or MACROQ command and it tries to execute the MUTEO command with strange data. The proper sequence for creating a macro (macro number 112 in this example) is as follows.
F01MACROL112,MUTEI*0 F01MACROL112,GAINI*0 F01MACROL112,MUTEO*0 F01MACROL112 8.83. MACROQ -- Execute Macro Quietly 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 MACROQ command executes, status messages for all of the commands in the macro will not 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. Example Description Status Message F01MACROX125 Execute macro number 125. Status messages for all the commands in the macro will be generated first, followed by the message: F01MACROX125 8.87.
F01MGAINA,W,? F01MGAINA,W,x , where x is the current value of Query gain from the crosspoint gain. If the crosspoint gain was set input A to W to -12 dB before this command, then the status Bus output. message would be F01MGAINA,W,-12 . F01MGAINWB0,WM0,-3 Set crosspoint gain in EF Bus submatrix on crosspoint that routes the W F01MGAINWB0,WM0,-3 bus signal from the device at ID0 (WB0) to W submatrix output 0 (WM0). Set all crosspoint gains for input channel 1.
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 Section 6.4 and Section 6.1 for more information on this type of command.
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. Example Description Status Message F01MIC21 Enable microphone gain stage for input channel 2 . F01MIC21 F01MIC20 Disable microphone gain stage for F01MIC20 input channel 2 .
F01MINIx , where x is 0 or 1 depending on F01MINI2 Toggle enabled state of modem initialization string. the current enabled state of the modem initialization string. F01MINIx , where x is 0 or 1 depending on F01MINI? Query enabled state of modem initialization string. the current enabled state of the modem initialization string. 8.92. 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.
F01MMUTEB,R1,1 Mute signal path (in main matrix) from input B to F01MMUTEB,R1,1 AEC reference 1 . F01MMUTEWB0,WM0,0 Mute signal path (in EF Bus W submatrix) from W bus signal at F01MMUTEWB0,WM0,0 device ID0 (WB0) to W submatrix output 0 (WM0). F01MMUTE1,B,2 Toggle mute status of signal path (in main matrix) from input 1 to output B . F01MMUTE1,B,x , where x is either 0 or 1 depending on the current mute status of the crosspoint.
8.94. 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 MUTEI command because that command sets all the mic and line inputs together, while the MUTEGIL sets only the line inputs. This command will generate acknowledgements from each of the line inputs separately. This command is a boolean command. See Section 6.1 for more information on this type of command.
This command will generate acknowledgements from each of the mic inputs separately. This command is a boolean command. See 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. Example Description F01MUTEGIM1 Mute all mic inputs.
F01MUTEI70 F01MUTEI80 . 8.96. MUTEI -- Mute One or More Inputs This command sets or queries the mute status of the analog inputs (1-8, A-D) . 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.
Example Description Status Message F01MUTEO41 Mute output 4 . F01MUTEO41 F01MUTEOA0 Unmute output A . F01MUTEOA0 F01MUTEO72 Toggle mute status of output 7 . F01MUTEO7x , where x is either 0 or 1 depending on the current mute status of the output. F01MUTEOC? Query mute status of output C . F01MUTEOCx , where x is either 0 or 1 depending on the current mute status of the output. F01MUTEO*1 Mute all outputs (1-8, AF01MUTEO*111111111111 D) .
F01NC*2 F01NC*abcdefgh , where the letters (a, b, etc.) are each Toggle NC state on all microphone input 0 or 1 depending on the current state of NC for each of channels (1-8) . the corresponding input. F01NC*? Query NC state on all microphone input channels (1-8) . F01NC*abcdefgh , where the letters (a, b, etc.) are each 0 or 1 depending on the current state of NC for each of the corresponding input. 8.99.
F01NVINIT Reinitialize non-volatile memory and perform a software reset. No status message will be generated. There will be a short delay and then the Vortex will reset. 8.101. 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.
8.103. 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 18, and A-D . 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 PEQIT, PEQIF, PEQIB, PEQIG, PEQIS, and PEQIE commands.
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.
Example Description Set bandwidth of parametric EQ on F01PEQIB3,2,40 input 3 , band 2 to 40 1/100th octaves. F01PEQIBB,1,? Query current bandwidth setting of parametric EQ on input B , band 1. Status Message F01PEQIB3,2,40 F01PEQIBB,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 F01PEQIBB,1,40 . 8.105.
This command has the same format and restrictions as the PEQIA command except that only one parameter, the frequency, is specified instead of all the parameters. See the PEQIA command for more information. To set the frequency parameter for an output parametric EQ filter, use the PEQOF command. To set all the parameters for an output parametric EQ filter, use the PEQOA command. This command is saved to non-volatile memory only as part of a preset.
input channels 1-8 and A-D . 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.
restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Status Message F01PEQIT3,2,1 Set the type of the parametric EQ on input 3 , band 2 to parametric. F01PEQIT3,2,1 Query current type setting of parametric EQ on input B , band 1. F01PEQITB,1,t , where t is the current setting of the type parameter for the parametric EQ on input B , band 1.
Filter Type Bandwidth Frequency Gain Slope Parametric (1) Yes Yes Yes No Low Shelf (2) No Yes Yes Yes High Shelf (3) No Yes Yes Yes Lowpass (4) No Yes No No Highpass (5) No Yes No No Linkwitz-Riley Lowpass (6) No Yes No Yes Linkwitz-Riley Highpass (7) No Yes No Yes 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 command sets or queries the bandwidth parameter (in 1/100th octaves) for the parametric equalizer (EQ) filters on output channels 1-8 and A-D . 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 PEQOA command except that only one parameter, the bandwidth, is specified instead of all the parameters.
8.113. 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-8 and A-D . 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.
F01PEQOG3,2,-20 F01PEQOGB,1,? Set the gain of the parametric EQ on output 3 , band 2 to -20 dB. F01PEQOG3,2,-20 Query current gain setting of parametric EQ on output B , band 1. F01PEQOGB,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 F01PEQOGB,1,-20 . 8.115.
Low Shelf 2 High Shelf 3 Lowpass 4 Highpass 5 Linkwitz-Riley Lowpass 6 Linkwitz-Riley Highpass 7 This command has the same format and restrictions as the PEQOA command except that only one parameter, the filter type, is specified instead of all the parameters. See the PEQOA command for more information. To set the slope parameter for an input parametric EQ filter, use the PEQIT command. To set all the parameters for an input parametric EQ filter, use the PEQIA command.
F01PHANTOM*abcdefgh where a-h are each 0 or 1 depending on the current state of phantom power for the corresponding input channel. F01PHANTOM*2 Toggle phantom power for input channels 1-8. F01PHANTOM*? F01PHANTOM*abcdefgh where a-h are each 0 or 1 Query status of phantom power for input channels 1- depending on the current state of phantom power for 8. the corresponding input channel. Enable phantom power for inputs 1-4 and disable F01PHANTOM*11110000 F01PHANTOM*11110000 phantom power for inputs 58.
F01PRESETK18 Delete preset number 18. F01PRESETK18 F01PRESETK* Delete all presets. F01PRESETK* 8.120. 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. F01PRESETW18 Now, issuing the command: F01PRESETL18? Will result in a long sequence of status mesages reflecting all the data stored in the preset.
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 PRESETX command can be used to execute the preset without suppressing the status messages. Example Description Status Message F01PRESETQ18 Execute preset number 18 without generating any status messages. F01PRESETQ18 8.123.
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 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.
, 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 . Query phone output gain. 8.127. 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 Section 6.
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. Example Description Status Message F01SGTYPE0 Configure signal generator to produce white noise.
Example Description Status Message F01SSEN1 Enable screen saver. F01SSEN1 F01SSEN0 Disable screen saver. F01SSEN0 F01SSEN2 Toggle screen saver enabled state. F01SSENx , where x is 0 or 1 depending on the current enabled state of the scrren saver. F01SSEN? Query screen saver enabled state. F01SSENx , where x is 0 or 1 depending on the current enabled state of the scrren saver. 8.132.
F01SSTEXT0,0,Play that Set the first line of the first screen to read "Play that". F01SSTEXT0,0,Play that Set the second line of F01SSTEXT0,1,funky music the first screen to read "funky music". F01SSTEXT0,1,funky music F01SSTEXT0,1, , where 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 F01SSTEXT0,1,funky music . Query the text of the second line of the first screen. F01SSTEXT0,1,? 8.134.
F01VTXMODIB2 Toggle status VTX mode on input B. F01VTXMODIBx , where x is either 0 or 1 depending on the current status of VTX mode on input B. F01VTXMODIA? Query status of VTX mode on input A. F01VTXMODIAx , where x is either 0 or 1 depending on the current status of VTX mode on input A. F01VTXMODI*1 Enable VTX mode on inputs A-D . F01VTXMODI*1111 F01VTXMODI*0 Disable VTX mode on inputs A-D .
Enable VTX mode on outputs 1-8 and F01VTXMODO*111111110000 disable VTX mode on outputs A-D . F01VTXMODO*2 F01VTXMODO*? F01VTXMODO*111111110000 Toggle status of VTX mode on outputs 1-8, A-D . F01VTXMODO*abcdefghijkl , 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 F01VTXMODO*000000001111 . Query status of VTX mode on outputs 1-8, A-D .
