Polycom Vortex EF2241 Programming Manual
  1. Manuals
  2. Brands
  3. Polycom Manuals
  4. Telephone Accessories
  5. Vortex EF2241
  6. Programming manual

Polycom Vortex EF2241 Programming Manual

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

Advertisement

Quick Links

Download this manual See also: Reference Manual
Installed Voice Business Group
RS-232 Command Set:
Vortex EF2241 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

Related Manuals for Polycom Vortex EF2241

Summary of Contents for Polycom Vortex EF2241

  • Page 1 Vortex EF2241 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 EF2241 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.19. AMGATET -- Set Automixer Gate Threshold 8.20. AMGNOM -- Set Global Maximum Number of Open Mics for Bus Automixer 8.21. AMHOLD -- Set Automixer Hold Time 8.22. AMLMM -- Set Last Mic On Mode for Specified Automixer 8.23. AMLMN -- Set Microphone That Will Remain On in Manual Last Mic On Mode 8.24.
  • Page 4 8.67. GMUTEO -- Mute All Outputs 8.68. ID -- Set Device ID 8.69. LABEL -- Set or Query one of the Device Labels 8.70. LAGC -- Enable or Disable Line Input Automatic Gain Control 8.71. LAGCLINKAB -- Enable or Disable Stereo AGC Linking on Inputs A and B 8.72.

  • Page 5: Introduction

    8.114. NCL -- Set Noise Cancellation Attenuation 8.115. NVINIT -- Reinitialize Non-Volatile Memory 8.116. NVLOCK -- Lock/Unlock Non-Volatile Memory 8.117. NVPSWD -- Change Non-Volatile Memory Password 8.118. PEQIA -- Set All Parameters for Specified Parametric EQ Input Stage 8.119. PEQIB -- Set Bandwidth Parameter for Specified Parametric EQ Input Stage 8.120.

  • Page 6: Hardware

    This document describes the command protocol that is used to communicate with the Vortex EF2241 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 7: Macros And Presets

    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: Automixer Dependencies

    instead of the MACROX PRESETX but the X versions produce acknowledgements for the settings that change, while the Q versions don't. If your control system updates its status by looking at the acknowledgements that come back, then you'll probably want to use the X versions. Another option would be to use the Q versions and then manually query the values you're interested in.

  • Page 9: 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 10: Command Data

    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...

  • Page 11: Command Types

    Parameters associated with boolean commands can be queried using the '?' character. For example, if input A is muted, and you send ' B04MUTEIA? ', the EF2241 will respond with a status message of ' B04MUTEIA1 '. When a status message is generated for a boolean command, the command data will either be a '0' or '1', since '2' is obviously not a valid state.

  • Page 12: Channel Commands

    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. The channel is specified by a single character (e.g., '1', '2', 'A', 'B', etc.) occurring before any other payload data.

  • Page 13: Matrix Commands

    the input gains being incremented by 3 dB so that channels 1-4 are at 13 dB and channels A-D are at 3 dB. The Vortex will respond with a status message of ' B04GAINI*ææææçççç '. (13 + 132 = 145 = 0x91 (hex) = æ...
  • Page 14 The EF2241 has eight analog outputs labeled 1-4 and A-D. These outputs are all at line level. There are two additional outputs: the output to the telephone interface, labeled T, and the output to the power amplifier, labeled L (for loudspeaker). This yields a total of ten physical outputs.
  • Page 15 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 a 7 x 2 matrix that allows the user to define up to two mixes of the P signal bus.

  • Page 16: Miscellaneous Commands

    'B04MGAIN1,*,ääääzzzzzzxxxxxxx' sets the crosspoints of input 1 to 0 dB for outputs 1-4, -10 dB for outputs A-D, T, and L, and -12 dB for outputs R1, R2, P, and W-Z. In this case, the EF2241 will respoind with a status message of 'B04MGAIN1,*,ääääzzzzzxxxxxxx'.
  • Page 17 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.
  • Page 18 Enable Automatic BLDATA Messages Preset BLAUTO Request Level Information BLDATA Preset Select Information to be Reported in BLDATA BLINFO 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...
  • Page 19 Preset Mute All Outputs GMUTEO Global Set Device ID Global Set or Query one of the Device Labels LABEL Preset Enable or Disable Line Input Automatic Gain Control LAGC Preset Enable or Disable Stereo AGC Linking on Inputs A and B LAGCLINKAB Preset Enable or Disable Stereo AGC Linking on Inputs C and D...
  • Page 20 Preset Set Crosspoint Gains in Main Matrix or Submatrix MGAIN Preset Select Gated or Ungated Microphone Signal in Matrix MGATE Preset Enable Microphone Gain Stage on Inputs 1-4 Global Enable Modem Initialization String MINI Global Set Modem Initialization String MINISTR Preset Mute Crosspoint in Main Matrix or Submatrix MMUTE...

  • Page 21: Command Reference

    Global Save a Preset PRESETW Execute a Preset PRESETX Redial the Last Dialed Phone Number REDIAL Preset Assign AEC Reference to Input Channel REFASGN Preset Set Reference Output Gain REFGAIN Preset Enable or Disable Ring Messages RING Preset Set Gain of Signal Generator SGGAIN Preset Mute Signal Generator...

  • Page 22: Ackmod -- Enable Or Disable Acknowledgment Mode

    Query auto answer mode. B01AA? 8.2. ACKMOD -- Enable or Disable Acknowledgment Mode This command controls whether or not status messages are sent. See status messages. This parameter is enabled by default, and it is rarely turned off by the host controller. This command is a boolean command.

  • Page 23: Aecmode -- Set Amount Of Double Talk Suppression Used In The Aec

    B01AEC*? Query AEC state on input channels 1-4. 8.4. AECMODE -- Set Amount of Double Talk Suppression used in the AEC. This command sets the amount of double talk suppression used in the AEC on input channels 1-4 . The values correspond to the following settings.

  • Page 24: Agcmax -- Set Maximum Allowed Mic/Line Input Agc Gain

    This command is a channel boolean command. See 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 B01AGC31 Enable AGC on input channel 3 .

  • Page 25: Agcmin -- Set Minimum Allowed Mic/Line Input Agc Gain

    Set AGC maximum gain on input channels 1-2 to 0 dB and AGC B01AGCMAX*ääìì maximum gain on input channels 3-4 to 9 dB. Query AGC maximum gain on B01AGCMAX*? input channels 1-4. 8.7. AGCMIN -- Set Minimum Allowed Mic/Line Input AGC Gain This command sets the minimum gain that the AGC can apply on input channels 1-4 and T (the telephone input) .

  • Page 26: Ahcp -- Enable Or Disable Call Progress Based Auto Hangup

    'B01AGCRATET10', 'B01AGCRATET?'). This command is a channel integer command. See type of command. The minimum and maximum values for this command are 1 and 5, respectively. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset.

  • Page 27: Ahld -- Enable Or Disable Loop Drop Based Auto Hangup

    B01AHCP? Query auto hangup mode. 8.10. AHLD -- Enable or Disable Loop Drop Based Auto Hangup This command sets or queries the status of the loop drop based auto hangup feature. There are two methods of auto hangup supported: call progress and loop drop. The call progress method listens for off- hook or busy tones and hangs up the phone if they are detected.

  • Page 28: Amauto -- Select Automatic Or Manual Gating For Each Automixer Input

    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 Assign input 3 to automixer #1.

  • Page 29: Ambusid -- Set Automixer Groupings For Ef Bus

    Automixer 2. Now, if each of these EF2241's sets their Automixer 1 to have Bus ID 5, then the three automixers (one from each EF2241) will work as a single automixer containing 6 (3 x 2) microphones. Setting AMBUSID to 0 means that the specified automixer is not grouped on the bus.

  • Page 30: Amchnum -- Set Chairman Mic For Specified Automixer

    This command enables, disables, or queries the chairman mode feature for the specified automixer. The first argument in the command specifies the automixer number (1 or 2) and the second argument specifies whether chairman mode should be enabled, disabled, toggled, or queried. If an AMCHAIR command requests that chairman mode be enabled, but the chairman microphone (AMCHNUM) does not belong to the specified automixer, the AMCHAIR command will fail and return ERROR#044.

  • Page 31: Amdecay -- Set Decay Time For Automixers

    Set microphone 4 as the chairman mic B01AMCHNUM14 for automixer 1. Set microphone 1 as the chairman mic B01AMCHNUM21 for automixer 2. Query the current chairman mic for B01AMCHNUM1? automixer 1. 8.16. AMDECAY -- Set Decay Time for Automixers This command sets or queries the decay time (in milliseconds) for both automixers. Note that the decay time is set globally for both automixers.

  • Page 32: Amgater -- Set Automixer Gate Ratio

    Configure microphone input 1 for B01AMGATEC10 normal gating. Configure microphone input 2 to B01AMGATEC21 be forced on. Configure microphone input 3 to B01AMGATEC32 be forced off. Query current gating control B01AMGATEC3? mode for microphone input 3 . Configure microphone inputs 1-4 B01AMGATEC*0 for normal gating.

  • Page 33: Amgatet -- Set Automixer Gate Threshold

    Set gate ratio for automatic gating threshold to 12 dB for all B01AMGATER*12 input channels. Set gate ratio for automatic gating threshold to 12 dB for B01AMGATER*ÉÉôô inputs 1-2 and 15 dB for inputs 3- Decrease gate ratio for automatic gating threshold by 3 dB for all B01AMGATER*<3 input channels.

  • Page 34: Amgnom -- Set Global Maximum Number Of Open Mics For Bus Automixer

    AMBUSID. In contrast, the AMNOM EF2241. The first argument of this command specifies the automixer number (1-2) to adjust. The second argument specifies the NOM limit (1-64). Even though this is a channel integer command, use of the wildcard for specifying the automixer number is not supported.

  • Page 35: 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 B01AMHOLD500 Set automixer hold time to 500 ms.

  • Page 36: Amlmn -- Set Microphone That Will Remain On In Manual Last Mic On Mode

    Query the current setting of "last mic on" B01AMLMM1? mode for automixer 1. 8.23. 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 command).

  • Page 37: Amnomat -- Select Nom Attenuation On Each Output

    The first argument of this command specifies the automixer number (1-2) to adjust. The second argument specifies the NOM limit (1-4) . Even though this is a channel integer command, use of the wildcard for specifying the automixer number is not supported. This command is a channel integer command.

  • Page 38: Amoffat -- Set Off Attenuation For The Specified Automixer

    B01AMNOMAT*1111000010 B01AMNOMAT*2 B01AMNOMAT*? 8.26. 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 39: Amrefb -- Set Automixer Reference Bias For The Specified Automixer

    When enabled, the automixer reference feature uses the AEC reference to prevent local microphones from gating on audio from the remote side. The of this feature. The AMREFB command can be used to bias the AEC reference signal to make the automixer even less likely to gate on remote audio.

  • Page 40: Amrefe -- Enable Automixer Reference For Specified Automixer

    When enabled, the automixer reference feature uses the AEC reference to prevent local microphones from gating on audio from the remote side. The AMREFE command controls the enabled status of this feature. The command can be used to bias the AEC reference signal to make the automixer even less likely to AMREFB gate on remote audio.

  • Page 41: Blauto -- Enable Automatic Bldata Messages

    8.32. BLDATA -- Request Level Information This command is used to request "blinking light" data from the EF2241. Blinking light data consists of signal levels for the 9 inputs (1-4, A-D, T), 10 outputs (1-4, A-D, T, L), and 2 AEC references (R1, R2) as well as room gain levels for inputs 1-4, AGC gain levels for inputs 1-4, and AEC state information for inputs 1-4.
  • Page 42 gggg aaaa ssss Each of the i bytes correspond to signal levels on the 9 inputs. The first, eighth, and ninth i bytes indicate the signal levels on input 1, input D, and input T, respectively. The o bytes correspond to signal levels on the 10 outputs.
  • Page 43 + 2 AEC reference levels + 4 room gain levels + 4 AGC gain levels + 4 AEC states). It is possible to tell the EF2241 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 44: Blinfo -- Select Information To Be Reported In Bldata

    ASPI Bus. For example, the command ' B01BROADA:B02PHONE1 ' would cause device ID 1 to send a command to the EF2241 at device ID 2 to tell it to take its phone off-hook. The EF2241 at device ID 2 would respond by taking its device off-hook and sending an acknowledgement.

  • Page 45: Busref -- Set Which Aec Reference Is Placed On Ef Bus

    8.36. BUSREF -- Set Which AEC Reference is Placed on EF Bus This command sets or queries whic AEC reference (if any) is placed on the EF Bus. Setting BUSREF to '0' means that no reference is placed on the EF Bus. Setting BUSREF to '1' means that AEC reference 1 (R1) is placed on the bus.

  • Page 46: Cgateen -- Enable Automatic Camera Gating Messages

    8.38. CGATEEN -- Enable Automatic Camera Gating Messages This command controls whether or not camera gating information messages are sent automatically. If CGATEEN is enabled, then a CGATE*? query is performed each time the camera gating status of any microphone changes. For example, if no microphones are currently gated on and CGATEEN is enabled, then if microphone input 3 gates on, the following status message will be automatically generated: B01CGATE*0010...

  • Page 47: Country -- Specify Country Definitions For Phone Interface

    Query camera gating hold. B01CGATET? 8.40. COUNTRY -- Specify Country Definitions for Phone Interface This command is used to set or query the country that the Vortex is configured for operation in. The country setting affects parameters associated with the phone interface including transmit and receive impedances, flash hook timing, timing thresholds for detecting hangup based on loop current drop, timing thresholds for detecting incoming rings, and outgoing DTMF levels.

  • Page 48: Delayoe -- Enable Output Delay

    Set output delay on output channel 2 to 150 ms (1500 tenths of B01DELAYO21500 milliseconds). Increase output delay on output channel 2 by 170 ms (1700 tenths B01DELAYO2>1700 of milliseconds.) Query current output delay on B01DELAYO2? output channel 2 . 8.42.

  • Page 49: Dial -- Send Dtmf Digits To Phone Interface

    B01DELAYOE*2 B01DELAYOE*? 8.43. DIAL -- Send DTMF Digits to Phone Interface This command dials the specified string of digits by sending the equivalent DTMF tones to the phone interface. Valid digits are '0'-'9', '*', '#', and ',' (delay). If the phone is not off-hook when this command is executed, it will automatically be taken off-hook.

  • Page 50: Error -- Enable Or Disable Error Messages

    generated if a command attempts to exceend 100 percent utilization. If the feature is enabled, then a DSPLOAD status message will be generated automatically any DSPAUTO time the percent utilization changes. Example Description Query percentage of variable DSP B01DSPLOAD? resources used. 8.46.
  • Page 51 This error occurs when the user has attempted to utilize more variable DSP resources than are available. This may occur if too many matrix crosspoints are unmuted or too many ERROR#060 parametric EQ filters are enabled. The percentage utilization of DSP resources. This error occurs as a result of a macro or preset execution command (PRESETX, ERROR#070 PRESETQ, MACROX, MACROQ).

  • Page 52: Fadergil -- Set Fader Gain Of Line Inputs As A Group

    B01ERROR0 Disable error messages mode. B01ERROR0 B01ERROR2 Toggle error message mode. B01ERROR? Query the state of error mode. 8.47. FADERGIL -- Set Fader Gain of Line Inputs as a Group This command sets the fader gains of all the line inputs simultaneously. This is different from using a wildcard, * with the command because that command sets all the mic and line inputs together, FADERI...

  • Page 53: Fadergim -- Set Gain Of Microphone Inputs As A Group

    8.48. 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, FADERI while the FADERGIM sets only the mic inputs.

  • Page 54: Flash -- Execute Hook Flash

    is an additional gain stage, referred to as a fader. The fader gain is adjustable by the FADERI command. The setting should be used for calilbration in order to maximize the resolution and quality of the signal at GAINI the analog to digital converter. The FADERI command is provided as a way to do volume control on the inputs without affecting the calibration.

  • Page 55: Flow -- Set Flow Control Mode For Rs-232 Port

    B01FLASH Execute hook flash. 8.51. FLOW -- Set Flow Control Mode for RS-232 Port This command sets the flow control mode for the rear panel RS-232 port. The valid settings are: Command Value Description No flow control. Hardware flow control. Auto-detect hardware flow control or no flow control.

  • Page 56: Fppswd -- Change Front Panel Password

    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 Lock the front panel to prevent B01FPLOCK1 users from changing the settings. Attempt to unlock the front panel by using an invalid password B01FPLOCK0,yumyum...

  • Page 57: Gaind -- Set Gain Of Incoming Dtmf Tones

    B01GAINA? Query phone input gain. 8.55. GAIND -- Set Gain of Incoming DTMF Tones This command sets the gain of the incoming DTMF tones. The gain of the outgoing DTMF depends on the country that the Vortex is configured for (see the COUNTRY) command. This command is an alias for the command.

  • Page 58: Gaindt -- Set Dial Tone Gain

    B01GAINDIT? Query incoming DTMF tone gain. 8.57. GAINDT -- Set Dial Tone Gain This command sets the gain of the dial tone received from the phone interface. This command is an integer command. See minimum and maximum values for this command are -20 and 20, respectively. This command is saved to non-volatile memory only as part of a preset.

  • Page 59: Gaingim -- Set Gain Of Microphone Inputs As A Group

    Increase incoming gain on all line inputs B01GAINGIL>3 by 3 dB. B01GAINGIL? Query gains on all line inputs. 8.59. GAINGIM -- Set Gain of Microphone Inputs as a Group This command sets the 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 GAINI...

  • Page 60: Gaini -- Set Input Gain

    Increase incoming gain on all mic inputs B01GAINGIM>3 by 3 dB. B01GAINGIM? Query gains on all mic inputs. 8.60. GAINI -- Set Input Gain The input channels of the Vortex pass through an analog gain stage before reaching the analog to digital converter.

  • Page 61: Gaino -- Set Output 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 Status Message Set gain on input T to 10...

  • Page 62: Gainp -- Set Phone Output Gain

    Set gain on output channels 1-4 to 0 dB, gain on output channels A-D to B01GAINO*ääääììììçç 9 dB, and gain on telephone output T and power amplifier L to 3 dB. Query gain settings on all output channels (1-4, A- B01GAINO*? D, T, L) .

  • Page 63: Gainsot -- Set To Phone User Tone Gain

    Example Description B01GAINSIT6 Set tone output gain to 6 dB. B01GAINSIT>3 Increase tone output gain by 3 dB. B01GAINSIT? Query tone output gain. 8.64. GAINSOT -- Set To Phone User Tone Gain This command sets the gain of the user tones coming from the phone DSP. User tones include entry and exit tones (see TONEE) and custom tones (see the are played out "locally"...

  • Page 64: Gateen -- Enable Automatic Gating Messages

    Example Description Query gating status of microphone input B01GATE3? Query gating status of all microphone B01GATE*? inputs. 8.66. GATEEN -- Enable Automatic Gating Messages This command controls whether or not gating information messages are sent automatically. If GATEEN is enabled, then a GATE*? query is performed each time the gating status of any microphone changes. For example, if no microphones are currently gated on and GATEEN is enabled, then if microphone input 3 gates on, the following status message will be automatically generated: B01GATE*0010...

  • Page 65: Id -- Set Device Id

    restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description B01GMUTEO1 Enable global output mute. B01GMUTEO0 Disable global output mute. B01GMUTEO2 Toggle global output mute. B01GMUTEO? Query acknowledgement mode. 8.68.

  • Page 66: Lagc -- Enable Or Disable Line Input Automatic Gain Control

    PM0-PM1, WM0-WM2, XM0-XM2, YM0-YM2, ZM0-ZM2 R1, R2 G0-G3 LI1-LI24 LO1-LO20 P0-P47 M0-M255 The text of each label can be up to 16 characters long. Labels for presets 0-15 are read-only. This command is saved to global non-volatile memory and is not part of a preset. Its value is saved each time it is changed.

  • Page 67: Lagclinkab -- Enable Or Disable Stereo Agc Linking On Inputs A And B

    B01LAGC*2 Toggle AGC state on input channels A-D. B01LAGC*? Query AGC state on input channels A-D. 8.71. LAGCLINKAB -- Enable or Disable Stereo AGC Linking on Inputs A and B This command links the line input AGC of inputs A and B into a stereo pair. The overall volume level of the stereo signal will be analyzed, and the same gain will be applied to both channels.

  • Page 68: Lagcmax -- Set Maximum Allowed Line Input Agc Gain

    disabled. Acknowledgements will be sent for any changes to channel D. From then on, any changes for these commands for either channel C or D will be set for both channels, and acknowledgements will be sent for both channels. This command is a boolean command. See This command is saved to non-volatile memory only as part of a preset.

  • Page 69: Lagcmin -- Set Minimum Allowed Line Input Agc Gain

    Query AGC maximum gain on B01LAGCMAX*? input channels A-D. 8.74. LAGCMIN -- Set Minimum Allowed Line Input AGC Gain This command sets the minimum gain that the AGC can apply on input channels A-D . For example, if LAGCMIN is set to -10, then the AGC for that channel can apply a minimum of -10 dB of gain to the input signal.

  • Page 70: Lec -- Enable Or Disable Lec

    Example Description Set AGC ramp rate on input B01LAGCRATEA3 channel A to 3 dB/sec. Query the AGC ramp rate on B01LAGCRATEB? input channel B. Set AGC ramp rate on input B01LAGCRATE*5 channels A-D to 5 dB/sec. Set AGC ramp rate on input channels A-B to 1 dB/sec and B01LAGCRATE*ààêê...

  • Page 71: Li -- Query State Of Logic Inputs

    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. Example Description B01LECMODE3 Set LEC to Heavy Suppression.

  • Page 72: Lid -- Assign Action For When Logic Input Is Deactivated

    This command causes the EF2241 at ID 2 to mute its input channel 1 when logic pin 6 on the EF2241 at ID 1 changes from the inactive to active state. Assign a blank command to...

  • Page 73: Lih -- Assign Action For When Logic Input Is Held

    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 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.

  • Page 74: Lien -- Enable Automatic Logic Input Status Messages

    is also useful in logic pin assignments. The BROADA device on the EF Bus, so you can effectively make a logic pin state change on one device cause an action to occur on another device. ERROR#074 will be generated if the assigned command is one that writes non-volatile memory, and the pin will not actually be assigned.

  • Page 75: Lik -- Delete One Or All Logic Input Pin Commands

    certain combinations of inputs are present on the logic pins. For example, if a logic group was defined that consisted of three logic input pins (pin 1, pin 2, and pin 3), then a total of eight combinations (2 possible, and a command or macro can be assigned to each combination. This feature is particularly useful in room-combining applications.

  • Page 76: Lim -- Mask Logic Input Pins

    Delete all the commands associated with logic input pin 5. This one command is equivalent to executing the commands ' B01LIA5, ', ' B01LID5, ', and ' B01LIK5 B01LIH5, ' except that this command is more efficient. Delete all the commands associated with all logic input pins. This one command is equivalent to executing the commands ' B01LIA1, ' B01LID1, B01LIK* ', and ' B01LIH1, ' for each logic input, except that this command is much...

  • Page 77: Lip -- Set Polarity For Logic Inputs

    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 Configure logic input group...

  • Page 78: Loa -- Define Behavior For Logic Output Activated State

    Example B01LO*00000000000000000000 B01LO*10101010101010101010 B01LO*? 8.89. 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. Active high is the default because it would light an LED connected to the output when the output was in the active state.

  • Page 79: Lod -- Define Behavior For Logic Output Deactivated Status

    (input1, 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.

  • Page 80: Lok -- Delete One Or All Logic Output Pin Commands

    B01LOEN2 Toggle automatic logic output status messages. B01LOEN? Query automatic logic output status messages. 8.92. 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 specified for the logic output pin, in which case the commands for all logic output pins will be deleted.

  • Page 81: Lop -- Set Polarity For Logic Outputs

    B01LOM? 8.94. 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 82: Macrok -- Delete One Or All Macros

    generated if the specified command is valid, but its data is invalid. For example: B01MACROA25,LAYDOWNTHEBOOGIE Would return an error because it does not contain a valid command. However: B01MACROA62,MUTEOMYMOTHERINLAW Would not return an error because it contains a macro is executed with a MACROX strange data.

  • Page 83: Macroq -- Execute Macro Quietly

    B01MACROA112,MUTEO*0 B01MACROW112 Once this macro has been defined, issuing the command: B01MACROL112? Will result in the following status messages: B01MACROL112,MUTEI*0 B01MACROL112,GAINI*0 B01MACROL112,MUTEO*0 B01MACROL112 8.98. 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 the specified macro is empty, then an error condition of ERROR#070 will be generated.

  • Page 84: Macrox -- Execute Macro

    See the description of the MACROA 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 85 This command is a matrix integer command. See 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.

  • Page 86: Mgate -- Select Gated Or Ungated Microphone Signal In Matrix

    B01MGAINB,*,-3 B01MGAINB,*,>12 B01MGAINB,*,? 8.104. MGATE -- Select Gated or Ungated Microphone Signal in Matrix For each crosspoint of the microphone input channels of the main matrix, the microphone signals can be taken before the automixer (ungated) or after the automixer (gated). This command selects the gated or ungated microphone signal.

  • Page 87: Mic -- Enable Microphone Gain Stage On Inputs

    Query the gated status of the crosspoint that routes B01MGATE3,A,? microphone input 3 to output Select the gated version of all microphone inputs to be sent B01MGATE*,A,1 to output A. Select the ungated version of all microphone inputs to be B01MGATE*,A,0 sent to output A.

  • Page 88: Mini -- Enable Modem Initialization String

    Enable microphone gain stage for input B01MIC*1 channels 1-4. Toggle enabled status microphone gain B01MIC*2 stage for input channels 1-4. Query enabled status of microphone gain B01MIC*? stage for input channels 1-4. Enable microphone gain stages for inputs 1-2 and disable microphone gain stages B01MIC*1100 for inputs 3-4.

  • Page 89: Mmute -- Mute Crosspoint In Main Matrix Or Submatrix

    Whether or not the modem initialization string is sent at power-up is controlled via the This command is saved to global non-volatile memory and is not part of a preset. Its value is saved each time it is changed. It will retain its value after power-down. Since this command writes to non-volatile memory, there will be a delay before an acknowledgment is returned.

  • Page 90: Mutegil -- Set Mute Status Of Line Inputs As A Group

    B01MMUTEA,W,? B01MMUTE1,*,11110000000000000 B01MMUTE2,*,0 B01MMUTE2,*,2 B01MMUTE2,*,? 8.109. 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 MUTEI the MUTEGIL sets only the line inputs.

  • Page 91: Mutegim -- Set Mute Status Of Microphone Inputs As A Group

    Example Description B01MUTEGIL1 Mute all line inputs. B01MUTEGIL2 Toggle mute status of all line inputs. B01MUTEGIL? Query the mute status of all the line inputs. 8.110. MUTEGIM -- Set Mute Status of Microphone Inputs as a Group This command sets the mute status of all the microphone inputs simultaneously. This is different from using a wildcard, * with the MUTEI while the MUTEGIM sets only the mic inputs.

  • Page 92: Mutei -- Mute One Or More Inputs

    B01MUTEGIM1 Mute all mic inputs. B01MUTEGIM2 Toggle mute status of all mic inputs. B01MUTEGIM? Query mute status of all mic inputs. 8.111. MUTEI -- Mute One or More Inputs This command sets or queries the mute status of the analog inputs (1-4, A-D, T) . This command is a channel boolean command.

  • Page 93: Muteo -- Mute One Or More Outputs

    Unmute all inputs (1-4, A-D, B01MUTEI*0 T) . Mute inputs 1-4 and unmute inputs T and A-D. Mute B01MUTEI*111100000 input 1 and unmute inputs A and B. Toggle mute status of all B01MUTEI*2 inputs. Query mute status of all B01MUTEI*? inputs.

  • Page 94: Nc -- Enable Noise Cancellation

    Toggle mute status of all B01MUTEO*2 outputs. Query mute status of all B01MUTEO*? outputs. 8.113. NC -- Enable Noise Cancellation This command sets or queries the status of the Noise Cancellation (NC) algorithm on input channels 1-4 and When the wildcard character, '*', is used to specify the channel in this command, it only affects input channels 1-4 .

  • Page 95: Nvinit -- Reinitialize Non-Volatile Memory

    This command sets or queries the attenuation level of the Noise Cancellation algorithm on input channels 1-4 and T . For example, if NCL is set to 10, then the Noise Cancellation for that channel will cancel 10 dB of noise.

  • Page 96: Nvpswd -- Change Non-Volatile Memory Password

    This command controls the non-volatile memory lock feature. When NVLOCK is enabled, the user may not save any system settings to non-volatile memory. This includes global parameters, presets, macros, labels, and logic assignments. The lock applies whether the user tries to make the changes via RS-232, front panel, logic inputs, or any other method.
  • Page 97 This command sets or queries all of the parameters for the parametric equalizer (EQ) filters on input channels 1-4, A-D, and T . 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 commands.

  • Page 98: Peqib -- Set Bandwidth Parameter For Specified Parametric Eq Input Stage

    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.

  • Page 99: Peqie -- Set Enabled Parameter For Specified Parametric Eq Input Stage

    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 bandwidth of parametric EQ on input 3 , band 2 to 40 1/100th...

  • Page 100: Peqig -- Set Gain Parameter For Specified Parametric Eq Input Stage

    The minimum and maximum values for the frequency parameter are 20 and 20000, respectively. For filter types that have a center frequency (e.g., parametric), this parameter specifies the center frequency. For filter types that have a cutoff frequency (e.g, highpass, lowpass, etc.), this parameter specifies the cutoff frequency.

  • Page 101: Peqis -- Set Slope Parameter For Specified Parametric Eq Input Stage

    Query current gain setting of B01PEQIGB,1,? parametric EQ on input B , band 1. 8.123. PEQIS -- Set Slope Parameter for Specified Parametric EQ Input Stage This command sets or queries the slope parameter (in dB per octave) for the parametric equalizer (EQ) filters on input channels 1-4, A-D, and T .

  • Page 102: Peqoa -- Set All Parameters For Specified Parametric Eq Output Stage

    High Shelf Lowpass Highpass Linkwitz-Riley Lowpass Linkwitz-Riley Highpass This command has the same format and restrictions as the parameter, the filter type, is specified instead of all the parameters. See the information. To set the slope parameter for an output parametric EQ filter, use the all the parameters for an output parametric EQ filter, use the This command is saved to non-volatile memory only as part of a preset.
  • Page 103 Filter Type Frequency 20 - 20000 Bandwidth 5 - 200 Gain -20 - 20 1 - 1.2 * Gain for shelving filters, 12 or 24 for Linkwitz-Riley Slope filters Enable 0 - 1 The paramters are specified in the order shown and are separated by commas. The wildcard character, *, may not be used for any of the parameters listed above.

  • Page 104: Peqob -- Set Bandwidth Parameter For Specified Parametric Eq Output Stage

    B01PEQOA3,2,1,1250,40,-20,1,1 B01PEQOAB,1,? 8.126. PEQOB -- Set Bandwidth Parameter for Specified Parametric EQ Output Stage This command sets or queries the bandwidth parameter (in 1/100th octaves) for the parametric equalizer (EQ) filters on output channels 1-4, A-D, T, and L . Each channel has five bands of parametric EQ that can be independently controlled.

  • Page 105: Peqoe -- Set Enabled Parameter For Specified Parametric Eq Output Stage

    Query current bandwidth setting of parametric EQ on output B , band B01PEQOBB,1,? 8.127. PEQOE -- Set Enabled Parameter for Specified Parametric EQ Output Stage This command sets or queries the enabled parameter (0 = filter is disabled, 1 = filter is enabled) for the parametric equalizer (EQ) filters on output channels 1-4, A-D, T, and L .

  • Page 106: Peqog -- Set Gain Parameter For Specified Parametric Eq Output Stage

    information. To set the frequency parameter for an input parametric EQ filter, use the set all the parameters for an input parametric EQ filter, use the This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset.

  • Page 107: Peqot -- Set Type 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-4, A-D, T and L . 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 108: Phantom -- Enable Phantom Power On Inputs

    This command has the same format and restrictions as the parameter, the filter type, is specified instead of all the parameters. See the information. To set the slope parameter for an input parametric EQ filter, use the all the parameters for an input parametric EQ filter, use the This command is saved to non-volatile memory only as part of a preset.

  • Page 109: Phone -- Take Phone On-Hook Or Off-Hook

    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 110: Presetk -- Delete One Or All Presets

    Ping all connected device to determine the number, type, and ID of the ***PING connected devices. 8.135. PRESETK -- Delete One or All Presets This command kills (deletes) the specified preset. If a wildcard character (*) is used to specify the preset, then all presets are deleted.

  • Page 111: Presetp -- Set Which Preset Will Be Activated At Power-Up

    8.137. PRESETP -- Set Which Preset Will Be Activated At Power- This command sets or queries the power-up preset, which is executed each time the device powers up. The power-up preset must be one of the factory presets (0-15) or one of the user presets (16-47). This command is saved to global non-volatile memory and is not part of a preset.

  • Page 112: Presetx -- Execute A Preset

    memory, there will be a delay before an acknowledgment is returned. Example Description Save the current device settings as preset 18. B01PRESETW18 8.140. PRESETX -- Execute a Preset This command executes the preset corresponding to the specified number, which must be between 0 and 47. The preset must either be a pre-defined factory preset (0 - 15) or a user preset (16 - 47) that has been previously defined via the PRESETW...

  • Page 113: Refgain -- Set Reference Output Gain

    AEC is aware of any volume changes. This will help prevent short echoes when volume changes are made. There are two AEC references on the EF2280, EF2241, and EF2241, so there are two separate commands, REFGAINR1 and REFGAINR2, for controlling the effective output gain of R1 and R2, respectively.

  • Page 114: Ring -- Enable Or Disable Ring Messages

    Query phone output gain. B01GAINP? 8.144. RING -- Enable or Disable Ring Messages This command sets or queries the enabled status of the ring message feature. If ring messages are enabled, a RING status message will be generated each time the connected phone line rings. This command is a boolean command.

  • Page 115: Sgmute -- Mute Signal Generator

    8.148. SOUNDL -- Play Sound Locally This command can be used to play sounds from the telephone interface to serve as audio cues. The command plays sounds out to the phone output. The SOUNDL command plays sounds through the input from the telephone interface (so they will be heard locally).

  • Page 116: Soundp -- Play Sound To Phone

    B01SOUNDL0 8.149. SOUNDP -- Play Sound to Phone This command can be used to play sounds from the telephone interface to serve as audio cues. The SOUNDP command plays sounds out to the phone output. The from the telephone interface (so they will be heard locally). The same sound generator is also used for playing entry and exit tones for the auto answer and auto hangup features.

  • Page 117: Ssdelay -- Set Delay Between Screen Saver Screens

    B01SOUNDP1 Play "descending thirds" sound (same as exit tone) to phone output. 8.150. SSDELAY -- Set Delay Between Screen Saver Screens This command sets or queries the amount of time (in milliseconds) between each new screen of the LCD screen saver. This command is an integer command.

  • Page 118: Sstext -- Set Text To Be Displayed By Screen Saver

    This command sets or queries the amount of time (in milliseconds) that the front panel buttons must be idle before the screen saver starts. This command is an integer command. See minimum and maximum values for this command are 500 and 600000, respectively. This command is saved to non-volatile memory only as part of a preset.

  • Page 119: Swreset -- Perform Soft Reset Of System

    B01SSTEXT0,1,? 8.154. SWRESET -- Perform Soft Reset of System Executing this command causes the Vortex to perform a software reset. The effect of the software reset is similar to cycling the power. Example Description B01SWRESET Perform a software reset. 8.155. SWVER -- Query Software Version This command is used to query the firmware version of the Vortex.

  • Page 120: Toner -- Enable Or Disable Ring Tones

    8.158. 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 121: Vtxmodo -- Enable Vtx Mode On Specified Inputs

    8.159. 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 122 Toggle status of VTX mode on outputs 1-4, A-D B01VTXMODO*2 Query status of VTX mode B01VTXMODO*? on outputs 1-4, A-D . B01VTXMODO*abcdefgh , where each of the letters (a, b, etc.) is either 0 or 1 depending of the current status VTX mode on the corresponding output.

Table of Contents