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

Polycom Vortex EF2211 Programming Manual

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

Advertisement

Quick Links

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

Need help?

Do you have a question about the Vortex EF2211 and is the answer not in the manual?

Questions and answers

Related Manuals for Polycom Vortex EF2211

Summary of Contents for Polycom Vortex EF2211

  • Page 1 Vortex EF2211 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 EF2211 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 Command Structure 4.1. Device Type 4.2. Device ID 4.3. Command Name 4.4. Command Data 4.5. Command Terminator Examples 4.6.
  • Page 3 8.15. AMCHNUM -- Set Chairman Mic 8.16. AMDECAY -- Set Decay Time for Automixers 8.17. AMGATEC -- Set Automixer Gating Control Mode 8.18. AMGATER -- Set Automixer Gate Ratio 8.19. AMGATET -- Set Automixer Gate Threshold 8.20. AMGNOM -- Set Global Maximum Number of Open Mics for Bus Automixer 8.21.
  • Page 4 8.60. GAINP -- Set Phone Output Gain 8.61. GAINSIT -- Set From Phone User Tone Gain 8.62. GAINSOT -- Set To Phone User Tone Gain 8.63. GATE -- Query Gating Status Information 8.64. GATEEN -- Enable Automatic Gating Messages 8.65. GMUTEO -- Mute All Outputs 8.66.
  • Page 5 8.105. MMUTE -- Mute Crosspoint in Main Matrix or Submatrix 8.106. MUTEGIL -- Set Mute Status of Line Inputs as a Group 8.107. MUTEI -- Mute One or More Inputs 8.108. MUTEO -- Mute One or More Outputs 8.109. NC -- Enable Noise Cancellation 8.110.

  • Page 6: Introduction

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

    The use of the wildcard character, '*', can make programming the host controller much easier. Be careful when using wildcards, however, since they can generate a lot of traffic on the digital bus. 3.3. Using Acknowledgements It is a good idea for the host program or control system to make sure that all connected Vortex devices have acknowledgment mode enabled (see the mode is on, a Vortex device will send an acknowledgment for each command it receives.

  • Page 8: Command Name

    "raise the input gain by 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 9: Device Id

    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 EF2211 EF2210 EF2201 Device type '*' can be used to send a command to all device types simultaneously.

  • Page 10: Examples

    Consider the command 'S**GAINIA10'. The device type for this command is 'S' and the device ID is a wildcard, thus the command will be broadcast to all EF2211 devices linked together. The command name in this case is 'GAINIA' and the command data (payload) is '10'. This command sets the gain on input A of all connected EF2211's to 10 dB.

  • Page 11: Boolean Commands

    Parameters associated with boolean commands can be queried using the '?' character. For example, if input A is muted, and you send ' S04MUTEIA? ', the EF2211 will respond with a status message of ' S04MUTEIA1 '. 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 respond with a status message of ' S04AGC10 '. An example of an integer channel command is the 'GAINI' command, which adjusts the gain on the input channels. ' S04GAINIA12 ' sets the input gain of channel A to 12 dB. After sending this command, the device will respond with a status message of ' S04GAINIA12 '.

  • Page 13: Matrix Commands

    The EF2211 has three analog outputs labeled 1, A, and B. 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...
  • Page 14 This yields a total of four physical outputs. The EF2211 has three analog inputs labeled 1, A, and B. Input 1 is mic/line selectable, and inputs A-B are line level only. Input 1 can also have phantom power enabled and contain channel processing, which includes the following DSP algorithms: Acoustic Echo Cancellation, Noise Cancellation, and AGC.
  • Page 15 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

    'S04MGAIN1,*,äzzzxxxxxx' sets the crosspoints of input 1 to 0 dB for output 1, -10 dB for outputs A, B and T, and -12 dB for outputs R1, P, and W-Z. In this case, the EF2211 will respoind with a status message of 'S04MGAIN1,*,äzzzxxxxxx'.
  • Page 17 The Storage column contains one of the following values indicating when and where the parameter is stored. "Global" "Preset" "-" = 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.
  • Page 18 Preset Set Local Maximum Number of Open Mics for Automixer AMNOM Preset Select NOM Attenuation on Each Output AMNOMAT Preset Set Off Attenuation for the Specified Automixer AMOFFAT Preset Set Gating Priority for the Specified Mic AMPRIOR Preset Set Automixer Reference Bias for the Specified Automixer AMREFB Preset Enable Automixer Reference for Specified Automixer...
  • Page 19 Preset Set Input Gain GAINI Preset Set Output Gain GAINO Preset Set Phone Output Gain GAINP Preset Set From Phone User Tone Gain GAINSIT Preset Set To Phone User Tone Gain GAINSOT Query Gating Status Information GATE Preset Enable Automatic Gating Messages GATEEN Preset Mute All Outputs...
  • Page 20 Add Command to Current Macro MACROA Global Delete One or All Macros MACROK List All Commmands in a Macro MACROL Execute Macro Quietly MACROQ Start a New Macro MACROS Global Write Macro to Non-Volatile Memory MACROW Execute Macro MACROX Preset Select which Signal is Displayed on the Front Panel LED Meter METER Preset...

  • Page 21: Command Reference

    Preset Set Slope Parameter for Specified Parametric EQ Output Stage PEQOS Preset Set Type Parameter for Specified Parametric EQ Output Stage PEQOT Preset Enable Phantom Power on Input 1 PHANTOM Take Phone On-Hook or Off-Hook PHONE See Which Devices Are Present PING Global Delete One or All Presets...

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

    This command sets or queries the status of the auto answer feature. 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.

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

    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 S01AEC11 Enable AEC on input channel 1.

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

    1 and T (the telephone input) . Using the wildcard character, '*', to specify the channel with this command is not supported for the EF2211. To set or query the command, the channels must be specified explicitly (e.g., 'S01AGC1?', 'S01AGCT0').

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

    -10 dB of gain to the input signal. Using the wildcard character, '*', to specify the channel with this command is not supported for the EF2211. To set or query the command, the channels must be specified explicitly (e.g., 'S01AGCMIN1?', 'S01AGCMINT-7').

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

    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 ramp rate on input channel S01AGCRATE13...

  • Page 27: Amasgn -- Assign Inputs To An Automixer

    off-hook or busy tones and hangs up the phone if they are detected. The loop drop method looks for a drop in loop current on the phone line and hangs up the phone if a loop current drop is detected. command controls the call progress auto hangup feature.

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

    EF2211's, each of which has its automixer enabled for its microphone input (input 1). Now, if each of these EF2211's sets its automixer to have Bus ID 5, then the three automixers (one from each EF2211) will work as a single automixer containing 3 (3 x 1) microphones.

  • Page 29: Amchair -- Enable Chairman Mode 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 (always 1 for the EF2211) and the second argument specifies whether chairman mode should be enabled, disabled, toggled, or queried.

  • Page 30: Amchnum -- Set Chairman Mic

    (always 1 for the EF2211) . The second argument specifies which microphone should be the chairman microphone for the automixer (always 1 for the EF2211) . This command is not particularly useful on the EF2211 and EF2210, however it is provided for consistency with the EF2280 and EF2241.

  • Page 31: Amgatec -- Set Automixer Gating Control Mode

    Increase automixer decay time S01AMDECAY>500 by 500 ms. Query automixer decay time. S01AMDECAY? 8.17. AMGATEC -- Set Automixer Gating Control Mode This command sets the automixer gating control mode for the specified input channel. The possible modes are: 0 - normal gating 1 - microphone forced on 2 - microphone forced off This command is a channel integer command.

  • Page 32: Amgatet -- Set Automixer Gate Threshold

    This command is a channel integer command. See on this type of command. The minimum and maximum values for this command are 0 and 100, 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 33: Amgnom -- Set Global Maximum Number Of Open Mics For Bus Automixer

    AMBUSID. In contrast, the the EF2211. The first argument of this command specifies the automixer number (always 1 in the EF2211) 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 34: Amlmm -- Set Last Mic On Mode For Specified Automixer

    This command sets "last mic on" mode for the specified automixer. The first argument specifies which automixer (always 1 on the EF2211) The second parameter specifies the operation of "last mic on" mode and can be one of the following:...

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

    The value of the AMLMN command is only valid when This command is not particularly useful on the EF2211 since there is only one mic on this device. However, it is provided in order to be consistent with the command sets of the other Vortex devices.

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

    This command is not particularly useful on the EF2211 since there is only one mic on this device. However, it is provided in order to be consistent with the command sets of the other Vortex devices.

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

    Enable NOM attenuation on S01AMNOMAT11 output 1 . Disable NOM attenuation on S01AMNOMATA0 output A. Toggle NOM attenuation status on output T (telephone S01AMNOMATT2 output) . Query NOM attenuation status S01AMNOMATB? of output B. Enable NOM attenuation on all S01AMNOMAT*1 outputs (1, A, B, T) .

  • Page 38: Amprior -- Set Gating Priority For The Specified Mic

    The AMREFB command can be used to bias the AEC reference signal to make the automixer even less likely to gate on remote audio. The first argument in this command specifies the automixer number (always 1 on the EF2211) and the second argument specifies the reference bias in dB.

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

    AMREFB the automixer even less likely to gate on remote audio. The first argument in the command specifies the automixer number (always 1 on the EF2211) and the second argument specifies whether automixer reference mode should be enabled, disabled, toggled, or queried.

  • Page 40: Baud -- Set Baud Rate For Rs-232 Port

    Enable automixer reference mode for S01AMREFE11 Automixer 1. Query current setting of automixer S01AMREFE1? reference mode for Automixer 1. 8.30. BAUD -- Set Baud Rate for RS-232 Port This command sets the baud rate for the rear panel RS-232 port. The baud rate is specified in bits per second (bps).

  • Page 41: Bldata -- Request Level Information

    8.32. BLDATA -- Request Level Information This command is used to request "blinking light" data from the EF2211. Blinking light data consists of signal levels for the 5 inputs (1, A, B, T), 4 outputs (1, A, B, T, L), and AEC reference (R1) as well as the room gain level for input 1, AGC gain level for input 1, and AEC state information for input 1.
  • Page 42 translate to AEC states. Byte Value AEC State Value (Byte Value - 132) Here's an example BLDATA message to clear things up. S01BLDATApèppçppppppèä The first four bytes (pèpp) consist of only two values. p = 0x70 = 112 112 - 132 = -20 è...

  • Page 43: Broad2 -- Broadcast Arbitrary Command Strings To Rs-232 Port

    + 1 AEC reference level + 1 room gain level + 1 AGC gain level + 1 AEC state). It is possible to tell the EF2211 to only send a subset of this information. There are two reasons you might want to do this.

  • Page 44: Broada -- Broadcast Commands To Other Connected Devices

    8.35. 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 ' S01BROADA: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 45: Cgate -- Query Camera Gating Status Information

    Example Description Put AEC Reference 1 (R1) on the EF Bus. Set Vortex to not place any AEC reference on the EF Bus. Query which AEC reference this Vortex is S01BUSREF? placing on the EF Bus. 8.37. CGATE -- Query Camera Gating Status Information This command is used to query the gating status of the microphone input.

  • Page 46: Cgatet -- Set Camera Gating Hold Time

    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 Disable automatic camera gating S01CGATEEN0...

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

    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 B to 150 ms (1500 S01DELAYOB1500 tenths of milliseconds). Increase output delay on output channel B by 170 ms (1700 S01DELAYOB>1700 tenths of milliseconds.) Query current output delay on S01DELAYOB? output channel B . 8.42.

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

    Enable output delay on outputs A and B, and disable S01DELAYOE*0110 output delay on outputs 1 and Toggle enabled status of S01DELAYOE*2 output delay on all outputs. Query enabled status of S01DELAYOE*? output delay on all outputs. 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.

  • Page 50: Dspload -- Query Percentage Of Variable Dsp Resources Used

    Query the value of the DSPAUTO S01DSPAUTO? parameter. 8.45. DSPLOAD -- Query Percentage of Variable DSP Resources Used This command queries the current percentage used of the available variable DSP resources. When this number reaches 100 percent, no more variable DSP veatures may ben enabled. An 'ERROR#060' will be generated if a command attempts to exceend 100 percent utilization.
  • Page 51 This error occurs as the result of an command attempts to set a "last mic on" number that does not belong to the ERROR#043 specified automixer while "last mic on" mode is set to manual. This error occurs as the result of an command tries to enable chairman mode, but the chairman microphone is set to a ERROR#044 microphone that does not belong to the specified automixer.

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

    This error indicates an EF Bus ID conflict. See the Vortex user manual for ERROR#092 information on valid device IDs. This error indicates an EF Bus reference conflict. This error occurs when more than one Vortex is placing its AEC reference on the bus. Use the ERROR#093 remove the extra reference(s) in order to resolve the conflict.

  • Page 53: Faderi -- Set Input Gain Fader

    Increase fader gains on all line S01FADERGIL>3 inputs by 3 dB. S01FADERGIL? Query fader gains on all line inputs. 8.48. 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 54: Flash -- Execute Hook Flash

    Query the fader gain on input S01FADERIA? Set fader gain on all inputs (1, S01FADERI*6 A, B, T) to 6 dB. Set fader gain on input channels A and B to 0 dB and S01FADERI*ìääì gain on input channels 1 and T to 9 dB.

  • Page 55: Fplock -- Lock/Unlock Front Panel

    We recommend using hardware flow control whenever possible, especially when using higher baud rates. 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 56: Fppswd -- Change Front Panel Password

    8.52. FPPSWD -- Change Front Panel Password This command sets or queries the front panel password. This password is used in conjunction with the command. The front panel must be unlocked ('FPLOCK0') in order to use this command to FPLOCK set or query the front panel password.

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

    This command is an integer command. See command. The 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. 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: Gaingil -- Set Gain Of Line Inputs As A Group

    This command sets the gain of the dial tone received from the phone interface. This command is an integer command. See command. The 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. 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 59: Gaini -- Set Input Gain

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

  • Page 60: Gaino -- Set Output Gain

    Example Description Status Message Set gain on input A to S01GAINIA10 10 dB. Query the gain on S01GAINIA? input A. Set gain on all inputs (1, S01GAINI*6 A, B, T) to 6 Set gain on input channels A and B to 0 dB and gain S01GAINI*ìääì...

  • Page 61: Gainp -- Set Phone Output Gain

    Set gain on output channels 1 and T to 0 dB, and gain on S01GAINO*äììä output channels A and B to 9 dB. Query gain settings on all output S01GAINO*? channels (1, A, B, T) . 8.60. GAINP -- Set Phone Output Gain This command sets the gain of the output to the phone interface.

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

    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 S01GAINSIT6 Set tone output gain to 6 dB. S01GAINSIT>3 Increase tone output gain by 3 dB. S01GAINSIT? Query tone output gain. 8.62.

  • Page 63: Gateen -- Enable Automatic Gating Messages

    On the EF2211 and EF2210, there is only one microphone, so the wildcard character is of limited use. can be used to have gating information sent automatically instead of having to poll this GATEEN command.

  • Page 64: Id -- Set Device Id

    The name of this command is an abbreviation of "Global Mute Outputs." Enabling this option causes all of the physical outputs to be muted (outputs 1, A, B, T) . This muting is independent of the normal output mute command, MUTEO. This command is provided so that the control program can implement a "saftey mute"...

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

    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). The label specifiers are as follows: Label Specifier I1, IA, IB, IT O1, OA, OB, OT P, W, X, Y, Z...

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

    This command was introduced in firmware version 2.5.0. This command is a channel boolean command. See 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.

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

    preset. Example Description Enable stereo AGC linking on S01LAGCLINKAB1 inputs A and B. Disable stereo AGC linking on S01LAGCLINKAB0 inputs A and B. Toggle stereo AGC linking on S01LAGCLINKAB2 inputs A and B. Query status of stereo AGC S01LAGCLINKAB? linking on inputs A and B. 8.70.

  • Page 68: Lagcrate -- Set Ramp Rate Of Line Input Agc

    LAGCMIN is set to -10, then the AGC for that channel can apply a minimum of -10 dB of gain to the input signal. This command was introduced in firmware version 2.5.0. This command is a channel integer command. See on this type of command.

  • Page 69: Lecmode -- Set Amount Of Double Talk Suppression Used In The Lec

    This command sets or queries the status of the line echo canceller (LEC). 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.

  • Page 70: Lia -- Assign Action For When Logic Input Is Activated

    24 boolean values is returned with the first value indicating the state of the first logic input, the second value indicating the state of the second logic input, and so on. 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 71: Lid -- Assign Action For When Logic Input Is Deactivated

    6 changes from the inactive state to the active state. This command S01LIA6,BROADA:S02MUTEI11 causes the EF2211 at ID 2 to mute its input channel 1 when logic pin 6 on the EF2211 at ID 1 changes from the inactive to active state.

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

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

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

    command. Since up to 256 commands can be stored in each macro, this gives the effect of MACROQ having up to 256 commands execute when the logic pin changes state. The command associated with the state change can also be a different rooms based on external logic settings.

  • Page 74: Lig -- Configure Logic Input Pins Into A Group

    Example Description S01LIEN1 Enable automatic logic input status messages. S01LIEN1 S01LIEN0 Disable automatic logic input status messages. S01LIEN0 S01LIEN2 Toggle automatic logic input status messages. S01LIEN? Query automatic logic input status messages. 8.80. LIG -- Configure Logic Input Pins Into a Group This conmmand configures which logic input pins are in a group.

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

    8.81. LIK -- Delete One or All Logic Input Pin Commands This command "kills" or deletes all commands for a given logic input pin. In other words, the commands associated with LIA, LID, and character can also be specified for the logic input pin, in which case the commands for all logic input pins will be deleted.

  • Page 76: Lin -- Assign Command To Logic Input Group

    S01LIM100101101111011111111111 S01LIM? 8.83. LIN -- Assign Command to Logic Input Group This command assigns a command to be executed when a group of logic input pins is in a certain configuration. Logic groups are defined via the As an example, assume that the command S01LIG2,000001111100000000000000 has been sent to the device.

  • Page 77: Lo -- Query Or Set Status Of Logic Output Pins

    closed switch would ground the input, and a closed switch would normally be considered active. This command affects the operation of the LIA, LID, and polarity is reversed, the operation of these commands is reversed. By default, the polarity for all pins is set to normal (active low). This command is saved to global non-volatile memory and is not part of a preset.
  • Page 78 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. The polarity of the logic output pins can be changed with the The syntax of this command allows one to use one of the boolean channel commands to determine the state of the logic output pin.

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

    Configure the conditions for activation of logic S01LOA10,MUTEI*1+-. output 10 as described in the example above. Delete conditions for activation of logic output S01LOA7, 8.87. LOD -- Define Behavior for Logic Output Deactivated Status This command is used to define the conditions under which a given logic output pin goes into the deactive state.

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

    S01LOEN? Query automatic logic output status messages. 8.89. 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 character can also be 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

    Example S01LOM10010110111101111111 S01LOM? 8.91. 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

    any PRESET command any MACRO command any logic input or output command If an attempt to assign an invalid command to a macro is made (via MACROA), then the error condition ERROR#074 will be generated. An error will be generated if the specified command is not a valid command. However, an error will not be generated if the specified command is valid, but its data is invalid.

  • Page 83: Macrol -- List All Commmands In A Macro

    Delete all the commands associated with all 255 macros. S01MACROK* 8.94. MACROL -- List All Commmands in a Macro This command lists all the commands in a given macro. For example, assume that a macro has been defined via the following command sequence. S01MACROS112 S01MACROA112,MUTEI*0 S01MACROA112,GAINI*0...

  • Page 84: Macrow -- Write Macro To Non-Volatile Memory

    This command is used to start writing a new macro with a specified macro number. This command is used in conjunction with the command is sent while another macro is in the process of being written (before the command is sent), then the macro in progress will be deleted and the new one will be started. See the description of the MACROA 8.97.

  • Page 85: Mgain -- Set Crosspoint Gains In Main Matrix Or Submatrix

    This command selects which signal is displayed on the front panel LED meter. The options correspond to either the telepone input or telephone output. The labels for the the telephone input and output are IT and OT, 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

    S01MGAINWB0,WM0,-3 S01MGAIN1,*,ä{{èäÇÇÇÇÇ S01MGAINB,*,-3 S01MGAINB,*,>12 S01MGAINB,*,? 8.101. 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 Input

    This command is a matrix boolean command. See 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.

  • Page 88: Mini -- Enable Modem Initialization String

    Query enabled status of microphone gain S01MIC1? stage for input channel 1. 8.103. MINI -- Enable Modem Initialization String This command controls whether or not the modem initialization string is sent at power-up. If MINI is 0, then the modem initialization string is not sent. If MINI is 1, then the modem initialization string is sent.

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

    Example S01MINISTRATF1E0&B1S0=2 S01MINISTR? 8.105. MMUTE -- Mute Crosspoint in Main Matrix or Submatrix This command sets or queries the mute status of one or more crosspoints in either the main matrix or one of the EF Bus submatrices. This command is a matrix boolean command. See this type of command.

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

    S01MMUTE1,*,0110100000 S01MMUTEA,*,0 S01MMUTEA,*,2 S01MMUTEA,*,? 8.106. 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, MUTEI while the MUTEGIL sets only the line inputs.

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

    S01MUTEGIL2 Toggle mute status of all line inputs. Query the mute status of all the line S01MUTEGIL? inputs. 8.107. MUTEI -- Mute One or More Inputs This command sets or queries the mute status of the analog inputs (1, A, B, T) . This command is a channel boolean command.

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

    Toggle mute status of all inputs. S01MUTEI*2 Query mute status of all inputs. S01MUTEI*? 8.108. MUTEO -- Mute One or More Outputs This command sets or queries the mute status of the analog outputs (1, A, B, T) . This command is a channel boolean command. See on this type of command.

  • Page 93: Nc -- Enable Noise Cancellation

    S01NC1? Query NC state on input channel 1 . S01NC*1 Enable NC on input channels 1 and T . Disable NC on all microphone input S01NC*0 channels (only input 1 on EF2211) . Toggle NC state on all microphone input S01NC*2 channels (only input 1 on EF2211) .

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

    S01NCL1? channel 1 . Set NC attenuation level on all microphone S01NCL*6 input channels (only 1 on EF2211) to 6 dB. Query NC attenuation level on all microphone S01NCL*? input channels (only 1 on EF2211) . 8.111. NVINIT -- Reinitialize Non-Volatile Memory This command reinitializes (or formats) all non-volatile memory settings.

  • Page 95: 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 96: Peqia -- Set All Parameters For Specified Parametric Eq Input Stage

    Query the current non-volatile memory password. S01NVPSWD? 8.114. 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, A, B, and T input channel T. Each channel has five bands of parametric EQ that can be independently controlled.
  • Page 97 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 98: Peqib -- Set Bandwidth Parameter For Specified Parametric Eq Input Stage

    S01PEQIAB,1,? 8.115. PEQIB -- Set Bandwidth Parameter for Specified Parametric EQ Input Stage This command sets or queries the bandwidth parameter (in 1/100th octaves) for the parametric equalizer (EQ) filters on input channels 1, A, B, and T . Each channel has five bands of parametric EQ that can be independently controlled.

  • Page 99: Peqif -- Set Frequency Parameter For Specified Parametric Eq Input Stage

    the parametric equalizer (EQ) filters on input channels 1, A, B, and T . Each channel has five bands of parametric EQ that can be independently controlled. This command has the same format and restrictions as the parameter, the enabled status, is specified instead of all the parameters. See the more information.

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

    Set frequency of parametric EQ on input 1 , band 2 to S01PEQIF1,2,1250 1250 Hz. Query current frequency setting of parametric EQ on S01PEQIFB,1,? input B , band 1. 8.118. PEQIG -- Set Gain Parameter for Specified Parametric EQ Input Stage This command sets or queries the gain parameter (in dB) for the parametric equalizer (EQ) filters on input channels 1, A, B, and T .

  • Page 101: Peqit -- Set Type Parameter For Specified Parametric Eq Input Stage

    (EQ) filters on input channels 1, A, B, and T . 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 102: Peqoa -- Set All Parameters For Specified Parametric Eq Output Stage

    parameter, the filter type, is specified instead of all the parameters. See the more information. To set the slope parameter for an output parametric EQ filter, use the command. To set 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 Gain -20 - 20 1 - 1.2 * Gain for shelving filters, 12 or 24 for Linkwitz- Slope Riley 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. If an attempt is made to set one of the parameters outside the valid range, the command will fail and return an error message of ERROR#002.

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

    S01PEQOA1,2,1,1250,40,-20,1,1 S01PEQOAB,1,? 8.122. 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, A, B, and T . 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

    preset. Example Description Set bandwidth of parametric EQ on output 1 , band 2 to 40 S01PEQOB1,2,40 1/100th octaves. Query current bandwidth setting of parametric EQ on output B , S01PEQOBB,1,? band 1. 8.123. 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, A, B, and T .

  • Page 106: Peqog -- Set Gain 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, A, B, and T . 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.

  • Page 107: Peqos -- Set Slope Parameter For Specified Parametric Eq Output 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 the gain of the parametric EQ on output 1 , band 2 to -20...

  • Page 108: Peqot -- Set Type Parameter For Specified Parametric Eq Output Stage

    Query current slope setting of parametric EQ on output B , band S01PEQOSB,1,? 8.127. PEQOT -- Set Type Parameter for Specified Parametric EQ Output Stage This command sets or queries the type parameter for the parametric equalizer (EQ) filters on output channels 1, A, B, and T .

  • Page 109: Phantom -- Enable Phantom Power On Input

    Query current type setting of parametric EQ on output B , band S01PEQOT1,2,1 8.128. PHANTOM -- Enable Phantom Power on Input 1 This command sets or queries the status of phantom power on microphone input 1. This command is a channel boolean command. See on this type of command.

  • Page 110: Ping -- See Which Devices Are Present

    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 111: Presetl -- List All Commmands In A Preset

    Example S01PRESETK18 S01PRESETK* 8.132. 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. S01PRESETW18 Now, issuing the command: S01PRESETL18? Will result in a long sequence of status mesages reflecting all the data stored in the preset.

  • Page 112: Presetw -- Save 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 error condition of ERROR#070 will be returned.

  • Page 113: Redial -- Redial The Last Dialed Phone Number

    Example Description S01PRESETX18 Execute preset number 18. 8.137. REDIAL -- Redial the Last Dialed Phone Number Executing this command causes the Vortex to redial the last number. The last number is defined as all the digits that were dialed since the phone was last taken off-hook. Like the phone is not already off-hook, this command will take it off-hook automatically.

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

    REFGAINR1 and REFGAINR2, for controlling the effective output gain of R1 and R2, respectively. There is only one AEC reference on the EF2211 and EF2210, so there is only one command, REFGAINR1 for controlling the effective output gain of R1.

  • Page 115: Sggain -- Set Gain Of Signal Generator

    S01RING1 Enable auto answer mode. S01RING1 S01RING0 Disable auto answer mode. S01RING0 S01RING2 Toggle auto answer mode. S01RING? Query auto answer mode. 8.141. 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.

  • Page 116: Sgtype -- Set Type Of Signal Produced By Signal Generator

    S01SGTYPE? Query current signal generator type. 8.144. 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 SOUNDP through the input from the telephone interface (so they will be heard locally).

  • Page 117: Soundp -- Play Sound To Phone

    S01SOUNDL0 Play "ascending thirds" sound (same as entry tone) locally. 8.145. 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 through the input from the telephone interface (so they will be heard locally).

  • Page 118: Ssen -- Enable Or Disable Screen Saver

    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. See command. The 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: 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 command. The 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 120: Swreset -- Perform Soft Reset Of System

    S01SSTEXT0,1,? 8.150. 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 S01SWRESET Perform a software reset. 8.151. SWVER -- Query Software Version This command is used to query the firmware version of the Vortex.

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

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

    8.155. 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 123 Query status of VTX mode on S01VTXMODOA? output A. Enable VTX mode on outputs 1, S01VTXMODO*1 A-B. Disable VTX mode on outputs 1, S01VTXMODO*0 A-B. Enable VTX mode on output 1 and disable VTX mode on S01VTXMODO*100 output A-B. Toggle status of VTX mode on S01VTXMODO*2 outputs 1, A-B.

Table of Contents