Polycom Vortex EF2280 Programming Manual

Rs-232 command set
Hide thumbs Also See for Vortex EF2280:
Table of Contents

Advertisement

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.
All other brand names, product names, and trademarks are the
sole property of their respective owners

Advertisement

Table of Contents
loading

Summary of Contents for Polycom Vortex EF2280

  • Page 1 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. All other brand names, product names, and trademarks are the...
  • Page 2: Table Of Contents

    Vortex EF2280 Programming Guide Table of Contents Introduction RS-232 Hardware Programming Tips 3.1. Initialization 3.2. Wildcard Characters 3.3. Using Acknowledgements 3.4. Macros and Presets 3.5. Automixer Dependencies Command Structure 4.1. Device Type 4.2. Device ID 4.3. Command Name 4.4. Command Data 4.5.
  • Page 3 8.21. AMNOM -- Set Local Maximum Number of Open Mics for Automixer 8.22. AMNOMAT -- Select NOM Attenuation on Each Output 8.23. AMOFFAT -- Set Off Attenuation for the Specified Automixer 8.24. AMPRIOR -- Set Gating Priority for the Specified Mic 8.25.
  • Page 4 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.
  • Page 5: Introduction

    8.137. VTXMODO -- Enable VTX Mode on Specified Inputs 1. Introduction This document describes the command protocol that is used to communicate with the Vortex EF2280 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.
  • Page 6: Wildcard Characters

    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.
  • Page 7: Automixer Dependencies

    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.
  • Page 8: Command Structure

    Device Type Device ID Command Name Command Data Command Terminator 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. Device EF200 EF1210 EF2280 EF2241...
  • Page 9: Device Id

    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.
  • Page 10: Status Messages

    IDs 3 and 7. The EF2280's will respond with 'F03GAINIA10' and 'F07GAINIA10', respectively. Now, someone uses the front panel of the EF2280 set to ID 7 to decrease input A's gain by 1 dB. When this happens, the EF2280 will respond with 'F07GAINIA9'. 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.
  • Page 11: Channel Commands

    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.
  • Page 12: Matrix Commands

    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.
  • Page 13 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.
  • Page 14 The main matrix consists of the following outputs: analog outputs 1-8 and A-D, AEC reference signals R1 and R2, and the EF Bus outputs W, X, Y, and Z. There is no P output since the EF2280 does not transmit on the P bus.
  • Page 15: Miscellaneous Commands

    'F04MGAIN1,*,ääääääääzzzzxxxxxx' sets the crosspoints of input 1 to 0 dB for outputs 1-8, -10 dB for outputs A-D, and -12 dB for outputs R1, R2, and W-Z. In this case, the EF2280 will respond with a status message of 'F04MGAINSG,*,ääääääääzzzzxxxxxx'.
  • Page 16 "-" = 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.
  • Page 17 Broadcast Arbitrary Command Strings to RS-232 Port BROAD2 Broadcast Commands to Other Connected Devices BROADA Preset Set Which AEC Reference is Placed on EF Bus BUSREF Query Camera Gating Status Information CGATE Preset Enable Automatic Camera Gating Messages CGATEEN Preset Set Camera Gating Hold Time CGATET Preset...
  • Page 18 Global Delete One or All Logic Input Pin Commands Preset Mask Logic Input Pins Global Assign Command to Logic Input Group Global Set Polarity for Logic Inputs Query or Set Status of Logic Output Pins Global Define Behavior for Logic Output Activated State Global Define Behavior for Logic Output Deactivated Status Preset...
  • Page 19: Command Reference

    Preset Set Gain Parameter for Specified Parametric EQ Input Stage PEQIG Preset Set Slope Parameter for Specified Parametric EQ Input Stage PEQIS Preset Set Type Parameter for Specified Parametric EQ Input Stage PEQIT Preset Set All Parameters for Specified Parametric EQ Output Stage PEQOA Preset Set Bandwidth Parameter for Specified Parametric EQ Output Stage...
  • Page 20: Aec -- Enable Or Disable Acoustic Echo Cancellation

    This command is a boolean command. See 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.
  • Page 21: Agc -- Enable Or Disable Mic/Line Input Automatic Gain Control

    1 = No Suppression 2 = Light Suppression 3 = Heavy Suppression 4 = Half Duplex This command is a channel integer command. See 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.
  • Page 22: Agcmax -- Set Maximum Allowed Mic/Line Input Agc Gain

    Toggle AGC state on input channels 1- F01AGC*2 Query AGC state on input channels 1- F01AGC*? 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 . 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.
  • Page 23: Agcrate -- Set Ramp Rate Of Mic/Line Input Agc

    Query the AGC minimum F01AGCMIN1? gain on input channel 1 . Set AGC minimum gain on F01AGCMIN*-6 input channels 1-8 to -6 dB. 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.
  • Page 24: Amauto -- Select Automatic Or Manual Gating For Each Automixer Input

    (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.
  • Page 25: Ambusid -- Set Automixer Groupings For Ef Bus

    EF2280's, each of which has four microphones assigned to Automixer 1 and four microphones assigned to Automixer 2. Now, if each of these EF2280's sets their Automixer 1 to have Bus ID 5, then the three automixers (one from each EF2280) will work as a single automixer containing 12 (3 x 4) microphones.
  • Page 26: Amchair -- Enable Chairman Mode For Specified Automixer

    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. Query the current Bus ID of Automixer 1 F01AMBUSID1? 8.11. AMCHAIR -- Enable Chairman Mode for Specified Automixer This command enables, disables, or queries the chairman mode feature for the specified automixer.
  • Page 27: Amdecay -- Set Decay Time For Automixers

    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 Set microphone 4 as the chairman mic...
  • Page 28: Amgater -- Set Automixer Gate Ratio

    Example Description Configure microphone input F01AMGATEC10 1 for normal gating. Configure microphone input F01AMGATEC21 2 to be forced on. Configure microphone input F01AMGATEC32 3 to be forced off. Query current gating control mode for microphone input F01AMGATEC3? Configure microphone inputs 1-8 for normal F01AMGATEC*0 gating.
  • Page 29: Amgatet -- Set Automixer Gate Threshold

    Query gate ratio for automatic gating threshold F01AMGATER3? for input channel 3 . Set gate ratio for automatic gating threshold to 12 dB F01AMGATER*12 for all input channels. Set gate ratio for automatic gating threshold to 12 dB F01AMGATER*ÉÉÉÉôôôô for inputs 1-4 and 15 dB for inputs 5-8.
  • Page 30: Amgnom -- Set Global Maximum Number Of Open Mics For Bus Automixer

    The NOM limit is a global limit, meaning that this applies to all bus automixers with the same AMBUSID. In contrast, the command is a local limit that applies to the two local automixers in the EF2280. AMNOM The first argument of this command specifies the automixer number (1-2) to adjust. The second argument specifies the NOM limit (1-64).
  • Page 31: Amlmm -- Set Last Mic On Mode For Specified Automixer

    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 F01AMHOLD500 Set automixer hold time to 500 ms.
  • Page 32: Amlmn -- Set Microphone That Will Remain On In Manual Last Mic On Mode

    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 command). The first argument to this command is the number of the automixer (1-2) that will be AMLMM adjusted.
  • Page 33: Amnomat -- Select Nom Attenuation On Each Output

    Example Description Set local NOM for automixer 1 to a maximum F01AMNOM13 of 3 mics. F01AMNOM2? Query current 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).
  • Page 34: Amoffat -- Set Off Attenuation For The Specified Automixer

    F01AMNOMAT*? 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.
  • Page 35: Amrefb -- Set Automixer Reference Bias For The Specified Automixer

    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 command can be used to bias the AEC reference signal to make the automixer even less likely to gate on remote audio.
  • Page 36: Baud -- Set Baud Rate For Rs-232 Port

    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.
  • Page 37: Bldata -- Request Level Information

    8.29. BLDATA -- Request Level Information This command is used to request "blinking light" data from the EF2280. Blinking light data consists of signal levels for the 12 inputs (1-8, A-D), 12 outputs (1-8, A-D), and 2 AEC references (R1, R2) as well as room gain levels for inputs 1-8, AGC gain levels for inputs 1-8, and AEC state information for inputs 1-8.
  • Page 38 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) Here's an example BLDATA message to clear things up.
  • Page 39: Blinfo -- Select Information To Be Reported In Bldata

    + 2 AEC reference levels + 8 room gain levels + 8 AGC gain levels + 8 AEC states). It is possible to tell the EF2280 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.
  • Page 40: Broada -- Broadcast Commands To Other Connected Devices

    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 'F01BROADA: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.
  • Page 41: Cgate -- Query Camera Gating Status Information

    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 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.
  • Page 42: Delayo -- Set Output Delay

    The output delay feature is only available on Rev F and later EF2280's. All Rev F and later EF2280's have the Polycom logo on the front panel. EF2280 revisions earlier than Rev F have the ASPI Digital logo on the front panel.
  • Page 43: Delayoe -- Enable Output Delay

    Query current output delay on F01DELAYO2? output channel 2 . 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 of command.
  • Page 44: Dspauto -- Enable Automatic Dspload Status Messages

    8.39. DSPAUTO -- Enable Automatic DSPLOAD Status Messages This command sets or queries whether or not DSP utilization changes. This command is a boolean command. See Example Description F01DSPAUTO1 Enable automatic DSPLOAD messages. F01DSPAUTO0 Disable automatic DSPLOAD messages. F01DSPAUTO2 Toggle automatic DSPLOAD messages. Query the value of the DSPAUTO F01DSPAUTO? parameter.
  • Page 45 This error occurs as the result of an remove a microphone from an automixer where it is assigned as the "last mic on" and the ERROR#040 automixer is set to manual "last mic on" mode. This error occurs as the result of an remove a microphone from an automixer where it assigned as the chairman imcrophone and ERROR#041 the automixer has chairman mode enabled.
  • Page 46: Fadergil -- Set Fader Gain Of Line Inputs As A Group

    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#091 error. This error indicates an EF Bus ID conflict. See the Vortex user manual for information on valid ERROR#092 device IDs.
  • Page 47: Fadergim -- Set Gain Of Microphone Inputs As A Group

    Increase fader gains on all line inputs by F01FADERGIL>3 3 dB. F01FADERGIL? Query fader gains on all line inputs. 8.43. FADERGIM -- Set Gain of Microphone Inputs as a Group This command sets the fader gains of all the microphone inputs simultaneously. This is different from using a wildcard, * with the command because that command sets all the mic and line inputs together, while FADERI...
  • Page 48: Faderi -- Set Input Gain Fader

    Increase fader gain on all mic inputs by F01FADERGIM>3 3 dB. F01FADERGIM? Query fader gains on all mic inputs. 8.44. FADERI -- Set Input Gain Fader The input channels of the Vortex pass through an analog gain stage before reaching the analog to digital converter.
  • Page 49: Flow -- Set Flow Control Mode For Rs-232 Port

    This command is a channel integer command. See 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.
  • Page 50: Fppswd -- Change Front Panel Password

    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.
  • Page 51: Gaingim -- Set Gain Of Microphone Inputs As A Group

    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 Description F01GAINGIL7 Set gain of all line inputs to 7 dB.
  • Page 52: Gaini -- Set Input Gain

    F01GAINGIM7 Set gain of all mic inputs to 7 dB. Increase incoming gain on all mic inputs by F01GAINGIM>3 3 dB. F01GAINGIM? Query gains on all mic inputs. 8.50. GAINI -- Set Input Gain The input channels of the Vortex pass through an analog gain stage before reaching the analog to digital converter.
  • Page 53: Gaino -- Set Output Gain

    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 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.
  • Page 54: Gate -- Query Gating Status Information

    restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Set gain on output F01GAINO210 channel 2 to 10 dB. Query the gain on output F01GAINO2? channel 2 . Set the gain on all output channels (1-8, A- F01GAINO*6...
  • Page 55: Gmuteo -- Mute All Outputs

    This command is a boolean command. See 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 F01GATEEN0 Disable automatic gating messages.
  • Page 56: Label -- Set Or Query One Of The Device Labels

    Example Description Change the device ID from 1 to 3 F01ID3 Query current device ID. F01ID? 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 ?
  • Page 57: Lagclinkab -- Enable Or Disable Stereo Agc Linking On Inputs A And B

    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 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.
  • Page 58: Lagclinkcd -- Enable Or Disable Stereo Agc Linking On Inputs C And D

    Disable stereo AGC linking on inputs F01LAGCLINKAB0 A and B. Toggle stereo AGC linking on inputs F01LAGCLINKAB2 A and B. Query status of stereo AGC linking F01LAGCLINKAB? on inputs A and B. 8.59. LAGCLINKCD -- Enable or Disable Stereo AGC Linking on Inputs C and D This command links the line input AGC of inputs C and D into a stereo pair.
  • Page 59: Lagcmin -- Set Minimum Allowed Line Input Agc Gain

    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 Set AGC maximum gain on input F01LAGCMAXA3...
  • Page 60: Lagcrate -- Set Ramp Rate Of Line Input Agc

    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.
  • Page 61 This command causes the EF2280 at ID 2 to mute its input channel 1 when logic pin 6 on the EF2280 at ID 1 changes from the inactive to active state. MACROX Status Message...
  • Page 62: Lid -- Assign Action For When Logic Input Is Deactivated

    F01LIA7, F01LIA4,? 8.65. LID -- Assign Action for when Logic Input is Deactivated This function assigns a single command to be executed when a given logic input changes from the active state to the inactive 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.
  • Page 63: Lien -- Enable Automatic Logic Input Status Messages

    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.
  • Page 64: Lig -- Configure Logic Input Pins Into A Group

    Example Description F01LIEN1 Enable automatic logic input status messages. F01LIEN1 F01LIEN0 Disable automatic logic input status messages. F01LIEN0 F01LIEN2 Toggle automatic logic input status messages. F01LIEN? Query automatic logic input status messages. 8.68. LIG -- Configure Logic Input Pins Into a Group This conmmand configures which logic input pins are in a group.
  • Page 65: Lim -- Mask Logic Input Pins

    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.
  • Page 66: Lip -- Set Polarity For Logic Inputs

    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.
  • Page 67: Loa -- Define Behavior For Logic Output Activated State

    settings imposed by the LO command. If a logic pin is masked via the Example F01LO*00000000000000000000 F01LO*10101010101010101010 F01LO*? 8.74. LOA -- Define Behavior for Logic Output Activated State This command is used to define the conditions under which a given logic output pin goes into the active state. By default the logic output pins are active high.
  • Page 68: Lod -- Define Behavior For Logic Output Deactivated Status

    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.
  • Page 69: Lok -- Delete One Or All Logic Output Pin Commands

    F01LOEN? Query automatic logic output status messages. 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 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.
  • Page 70: Lop -- Set Polarity For Logic Outputs

    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).
  • Page 71: Macrok -- Delete One Or All Macros

    F01MACROA62,MUTEOMYMOTHERINLAW Would not return an error because it contains a executed with a MACROX MACROQ The proper sequence for creating a macro (macro number 112 in this example) is as follows. F01MACROS112 F01MACROA112,MUTEI*0 F01MACROA112,GAINI*0 F01MACROA112,MUTEO*0 F01MACROW112 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 F01NC*? ) as long as it isn't another non-volatile memory command which could interfere with the storage of the macro.
  • Page 72: Macroq -- Execute Macro Quietly

    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 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.
  • Page 73: Meter -- Select Which Signal Is Displayed On The Front Panel Led Meter

    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 which is exactly the same as MACROX except that status messages are suppressed. Example Description F01MACROX125 Execute macro number 125.
  • Page 74: Mgate -- Select Gated Or Ungated Microphone Signal In Matrix

    F01MGAINA,W,? F01MGAINWB0,WM0,-3 F01MGAIN1,*,ääääääää{{{{ääÇÇÇÇ F01MGAINB,*,-3 F01MGAINB,*,>12 F01MGAINB,*,? 8.89. 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 F01MGAINA,W,x , where x is the current value of Query gain from the crosspoint gain.
  • Page 75: Mic -- Enable Microphone Gain Stage On Inputs

    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).
  • Page 76: Mini -- Enable Modem Initialization String

    This command is a channel boolean command. See 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 Enable microphone gain stage for...
  • Page 77: Ministr -- Set Modem Initialization String

    F01MINI2 Toggle enabled state of modem initialization string. F01MINI? Query enabled state of 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.
  • Page 78 F01MMUTEB,R1,1 F01MMUTEWB0,WM0,0 F01MMUTE1,B,2 F01MMUTEA,W,? F01MMUTE1,*,111111110000000000 F01MMUTE2,*,0 F01MMUTE2,*,2 F01MMUTE2,*,? Mute signal path (in main matrix) from input B to F01MMUTEB,R1,1 AEC reference 1 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).
  • Page 79: Mutegil -- Set Mute Status Of Line Inputs As A Group

    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 command because that command sets all the mic and line inputs together, while the MUTEGIL MUTEI sets only the line inputs.
  • Page 80 This command will generate acknowledgements from each of the mic inputs separately. This command is a boolean command. See 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.
  • Page 81: Mutei -- Mute One Or More Inputs

    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 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.
  • Page 82: Nc -- Enable Noise Cancellation

    Example Description Mute output 4 . F01MUTEO41 Unmute output A . F01MUTEOA0 Toggle mute status of F01MUTEO72 output 7 . Query mute status of F01MUTEOC? output C . Mute all outputs (1-8, A- F01MUTEO*1 D) . Unmute all outputs (1-8, F01MUTEO*0 A-D) .
  • Page 83: Ncl -- Set Noise Cancellation Attenuation

    Toggle NC state on all microphone input F01NC*2 channels (1-8) . Query NC state on all microphone input F01NC*? channels (1-8) . 8.99. NCL -- Set Noise Cancellation Attenuation This command sets or queries the attenuation level of the Noise Cancellation algorithm on input channels 1-8 . For example, if NCL is set to 10, then the Noise Cancellation for that channel will cancel 10 dB of noise.
  • Page 84: Nvlock -- Lock/Unlock Non-Volatile Memory

    Reinitialize non-volatile memory and perform a F01NVINIT software 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.
  • Page 85: Peqia -- Set All Parameters For Specified Parametric Eq Input Stage

    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 1- 8, 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, commands.
  • Page 86: Peqib -- Set Bandwidth Parameter For Specified Parametric Eq Input Stage

    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.
  • Page 87: Peqie -- Set Enabled Parameter For Specified Parametric Eq Input Stage

    Example Description Set bandwidth of parametric EQ on input 3 , band 2 to 40 1/100th F01PEQIB3,2,40 octaves. Query current bandwidth setting of F01PEQIBB,1,? parametric EQ on input B , band 1. 8.105. 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-8 and A-D .
  • Page 88: Peqig -- Set Gain Parameter For Specified Parametric Eq Input Stage

    This command has the same format and restrictions as the frequency, is specified instead of all the parameters. See the frequency parameter for an output parametric EQ filter, use the 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.
  • Page 89: Peqit -- Set Type Parameter For Specified Parametric Eq Input Stage

    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.
  • Page 90: Peqoa -- Set All Parameters For Specified Parametric Eq Output Stage

    restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Set the type of the parametric EQ on F01PEQIT3,2,1 input 3 , band 2 to parametric. Query current type setting of F01PEQITB,1,? parametric EQ on input B , band 1.
  • Page 91: Peqob -- Set Bandwidth Parameter For Specified Parametric Eq Output Stage

    Filter Type Parametric (1) Low Shelf (2) High Shelf (3) Lowpass (4) Highpass (5) Linkwitz-Riley Lowpass (6) Linkwitz-Riley Highpass (7) 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.
  • Page 92: Peqoe -- Set Enabled 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-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 bandwidth, is specified instead of all the parameters.
  • Page 93: Peqof -- Set Frequency Parameter For Specified Parametric Eq Output Stage

    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.
  • Page 94: Peqos -- Set Slope Parameter For Specified Parametric Eq Output Stage

    Set the gain of the parametric EQ on F01PEQOG3,2,-20 output 3 , band 2 to -20 dB. Query current gain setting of F01PEQOGB,1,? parametric EQ on output B , band 1. 8.115. 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-8 and A-D .
  • Page 95: Phantom -- Enable Phantom Power On Inputs

    Low Shelf High Shelf Lowpass Highpass Linkwitz-Riley Lowpass Linkwitz-Riley Highpass This command has the same format and restrictions as the filter type, is specified instead of all the parameters. See the slope parameter for an input parametric EQ filter, use the input parametric EQ filter, use the This command is saved to non-volatile memory only as part of a preset.
  • Page 96: Ping -- See Which Devices Are Present

    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.
  • Page 97: Presetl -- List All Commmands In A Preset

    F01PRESETK18 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.
  • Page 98: Presetw -- Save A 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 suppressing the status messages.
  • Page 99: Refgain -- Set Reference Output Gain

    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.
  • Page 100: Sggain -- Set Gain Of Signal Generator

    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.
  • Page 101: Ssdelay -- Set Delay Between Screen Saver Screens

    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.
  • Page 102: Ssstart -- Set Idle Time Required For Screen Saver To Start

    Example Description F01SSEN1 Enable screen saver. F01SSEN0 Disable screen saver. F01SSEN2 Toggle screen saver enabled state. F01SSEN? Query screen saver enabled state. 8.132. 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.
  • Page 103: Swreset -- Perform Soft Reset Of System

    8.136. 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.
  • Page 104: Vtxmodo -- Enable Vtx Mode On Specified Inputs

    8.137. 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.
  • Page 105 F01VTXMODO*111111110000 F01VTXMODO*2 F01VTXMODO*? Enable VTX mode on outputs 1-8 and F01VTXMODO*111111110000 disable VTX mode on outputs A-D . F01VTXMODO*abcdefghijkl , where each of the letters (a, b, etc.) is either 0 or 1 depending of the Toggle status of VTX current status VTX mode on the corresponding output.

Table of Contents