Polycom Vortex EF2211, Programming Manual

Page 1: ...e 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 ...

Page 2: ... Enable or Disable Auto Answer Mode 8 2 ACKMOD Enable or Disable Acknowledgment Mode 8 3 AEC Enable or Disable Acoustic Echo Cancellation 8 4 AECMODE Set Amount of Double Talk Suppression used in the AEC 8 5 AGC Enable or Disable Mic Line Input Automatic Gain Control 8 6 AGCMAX Set Maximum Allowed Mic Line Input AGC Gain 8 7 AGCMIN Set Minimum Allowed Mic Line Input AGC Gain 8 8 AGCRATE Set Ramp R...

Page 3: ...ion 8 33 BLINFO Select Information to be Reported in BLDATA 8 34 BROAD2 Broadcast Arbitrary Command Strings to RS 232 Port 8 35 BROADA Broadcast Commands to Other Connected Devices 8 36 BUSREF Set Which AEC Reference is Placed on EF Bus 8 37 CGATE Query Camera Gating Status Information 8 38 CGATEEN Enable Automatic Camera Gating Messages 8 39 CGATET Set Camera Gating Hold Time 8 40 COUNTRY Specify...

Page 4: ...c Logic Input Status Messages 8 80 LIG Configure Logic Input Pins Into a Group 8 81 LIK Delete One or All Logic Input Pin Commands 8 82 LIM Mask Logic Input Pins 8 83 LIN Assign Command to Logic Input Group 8 84 LIP Set Polarity for Logic Inputs 8 85 LO Query or Set Status of Logic Output Pins 8 86 LOA Define Behavior for Logic Output Activated State 8 87 LOD Define Behavior for Logic Output Deact...

Page 5: ...Output Stage 8 123 PEQOE Set Enabled Parameter for Specified Parametric EQ Output Stage 8 124 PEQOF Set Frequency Parameter for Specified Parametric EQ Output Stage 8 125 PEQOG Set Gain Parameter for Specified Parametric EQ Output Stage 8 126 PEQOS Set Slope Parameter for Specified Parametric EQ Output Stage 8 127 PEQOT Set Type Parameter for Specified Parametric EQ Output Stage 8 128 PHANTOM Enab...

Page 6: ... for control of the Vortex the minimum cable for updating firmware should contain 5 wires RX TX RTS CTS GND 3 Programming Tips 3 1 Initialization During power up of the Vortex device or initialization of the host program electrical fluctuations on the RS 232 lines may cause the Vortex to receive spurious data After initialization the host program should send a few carriage return characters M ASCI...

Page 7: ...nts received from the Vortex device To implement this organize your code so that the functions that send commands are totally separate from the functions that receive responses from the Vortex devices This also enables your host program to support the presence of multiple host controllers For example consider the following sequence of events 1 Another host sends a command to a Vortex device 2 The ...

Page 8: ...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 Then by calling that macro you can ramp the stereo outputs A similar thing can be done with decreasing the volume Another thing to consider when using macros and presets is to use the MACROQ and PRESETQ commands instead of the MACROX a...

Page 9: ...ice ID 07 this format is not commonly used broadcasts to all devices that are linked together 4 3 Command Name The command name can be from 1 to 7 characters long Command names will be specific to device types In other words the EF2280 has its own command set which is different from the EF2241 s which is different from the EF1210 s etc There are some commands such as PING that are common among all...

Page 10: ...ected EF2211 devices to 10 dB 5 Status Messages The Vortex sends status messages via RS 232 and EF Bus any time one of its internal parameters changes This means that the host program does not need to continually poll the Vortex in order to detect status changes Status messages are in the same format as the commands used to set the corresponding parameter For example suppose you send the command S...

Page 11: ...r example S04GAINIA 3 increments the gain on input A by 3 dB If the input s gain was previously set to 6 dB then it would now be set to 9 dB In this case the device would respond with a status message of S04GAINIA9 The numeric part of both the absolute and relative arguments can contain a or to indicate the algebraic sign of the argument If no sign is given is assumed The parameters associated wit...

Page 12: ...e straightforward For example S04MUTEI1 might return S04MUTEI11 while S04MUTEI might return S04MUTEI 100 Using the wildcard character with integer channel commands is similar to using it with boolean commands but there are some differences If we sent S04GAINI 10 the input gains on channels 1 and A B will all be set to 10 dB The device will respond with a status message of S04GAINI ÄÄÄ Those weird ...

Page 13: ...the matrix commands it is necessary to give a description of the matrices involved During the following discussion it will be helpful to refer to the figure below which shows all the matrices with their input and output labels 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 an...

Page 14: ...evices The W X Y and Z busses are meant for routing microphone and auxiliary audio between the devices The W X Y and Z busses also carry NOM Number of Open Microphones information from the automixer so that outputs created from these busses can be appropriately attenuated for the number of open microphones The digital inputs consist of all of the signals placed on the EF Bus by the other connected...

Page 15: ...M2 XM0 XM2 YM0 YM2 and ZM0 ZM2 This is a total of 19 inputs The main matrix consists of the following outputs analog outputs 1 A and B the output to the telephone interface T AEC reference signal R1 and the EF bus outputs P W X Y and Z This is a total of 10 outputs The matrix commands can adjust two types of parameters integer and boolean We will introduce the matrix commands by using the MGAIN co...

Page 16: ...04MGAIN1 A might return S04MGAIN1 A 6 while S04MGAIN1 might return S04MGAIN2 ääääääääää Boolean matrix commands work as you would expect They use the characters 0 1 and 2 as described in Section 6 1 Here are some examples S04MMUTE1 A 1 mutes crosspoint 1 A of the main matrix In other words the signal at input 1 will not be heard on output A A status message will be generated of the form S04MMUTE1 ...

Page 17: ... Amount of Double Talk Suppression used in the AEC AGC Preset Enable or Disable Mic Line Input Automatic Gain Control AGCMAX Preset Set Maximum Allowed Mic Line Input AGC Gain AGCMIN Preset Set Minimum Allowed Mic Line Input AGC Gain AGCRATE Preset Set Ramp Rate of Mic Line Input AGC AHCP Preset Enable or Disable Call Progress Based Auto Hangup AHLD Preset Enable or Disable Loop Drop Based Auto Ha...

Page 18: ...EF Bus CGATE Query Camera Gating Status Information CGATEEN Preset Enable Automatic Camera Gating Messages CGATET Preset Set Camera Gating Hold Time COUNTRY Global Specify Country Definitions for Phone Interface DELAYO Preset Set Output Delay DELAYOE Preset Enable Output Delay DIAL Send DTMF Digits to Phone Interface DSPAUTO Enable Automatic DSPLOAD Status Messages DSPLOAD Query Percentage of Vari...

Page 19: ...eset Set Amount of Double Talk Suppression used in the LEC LI Global Query State of Logic Inputs LIA Global Assign Action for when Logic Input is Activated LID Global Assign Action for when Logic Input is Deactivated LIH Global Assign Action for when Logic Input is Held LIEN Preset Enable Automatic Logic Input Status Messages LIG Global Configure Logic Input Pins Into a Group LIK Global Delete One...

Page 20: ...ion Attenuation NVINIT Reinitialize Non Volatile Memory NVLOCK Global Lock Unlock Non Volatile Memory NVPSWD Change Non Volatile Memory Password PEQIA Preset Set All Parameters for Specified Parametric EQ Input Stage PEQIB Preset Set Bandwidth Parameter for Specified Parametric EQ Input Stage PEQIE Preset Set Enabled Parameter for Specified Parametric EQ Input Stage PEQIF Preset Set Frequency Para...

Page 21: ...t Set Reference Output Gain RING Preset Enable or Disable Ring Messages SGGAIN Preset Set Gain of Signal Generator SGMUTE Preset Mute Signal Generator SGTYPE Preset Set Type of Signal Produced by Signal Generator SOUNDL Play Sound Locally SOUNDP Play Sound to Phone SSDELAY Preset Set Delay Between Screen Saver Screens SSEN Preset Enable or Disable Screen Saver SSSTART Preset Set Idle Time Required...

Page 22: ...default and it is rarely turned off by the host controller This command is a boolean command See Section 6 1 for more information on this type of command This command is saved to global non volatile memory and is not part of a preset Its value is saved each time it is changed It will retain its value after power down Since this command writes to non volatile memory there will be a delay before an ...

Page 23: ...1 The values correspond to the following settings 1 No Suppression 2 Light Suppression 3 Heavy Suppression 4 Half Duplex This command is a channel integer command See Section 6 3 and Section 6 2 for more information on this type of command The minimum and maximum values for this command are 1 and 4 respectively This command is saved to non volatile memory only as part of a preset The state of this...

Page 24: ...GCTx where x is 0 or 1 depending on the current state of the AGC on input channel T 8 6 AGCMAX Set Maximum Allowed Mic Line Input AGC Gain This command sets the maximum gain that the AGC can apply on input channels 1 and T the telephone input For example if AGCMAX is set to 10 then the AGC for that channel can apply a maximum of 10 dB of gain to the input signal Using the wildcard character to spe...

Page 25: ...e 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 S01AGCMIN1 3 Set AGC minimum gain on input channel 1 to 3 dB S01AGCMIN1 3 S01AGCMINT Query the AGC minimum gain on input channel T S01AGCMINTx where x is a number between 15 and 0 depending on the c...

Page 26: ...ntrols the call progress auto hangup feature The AHLD command controls the loop drop auto hangup feature These two features are controlled and implemented independently This command is a boolean command See Section 6 1 for more information on this type of command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if ...

Page 27: ...ngup mode S01AHLDx where x is 0 or 1 depending on the current state of the loop drop based auto hangup mode 8 11 AMASGN Assign Inputs to an Automixer This command is used to assign the mic line inputs 1 to an internal automixers Setting AMASGN to 0 for a given input channel corresponds to no automixer and 1 corresponds to Automixer 1 Although this command is a channel integer command the increment...

Page 28: ...1x where x is 0 or 1 depending on whether input channel 1 is currently set for manual or automatic thresholds S01AMAUTO1 Query AMAUTO state on input channel 1 S01AMAUTO1x where x is 0 or 1 depending on whether input channel 1 is currently set for manual or automatic thresholds 8 13 AMBUSID Set Automixer Groupings for EF Bus This command is used to assign the internal automixer to one of the EF Bus...

Page 29: ...pecified 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 Even though this is a channel boolean command use of the wildcard character for the automixer n...

Page 30: ...e 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 S01AMCHNUM11 Set microphone 1 as the chairman mic for the automixer S01AMCHNUM11 S01AMCHNUM1 Query the current chairman mic for the automixer S01AMCHNUM11 querying the chairman mic number will always return 1 since there is only one m...

Page 31: ...and maximum values for this command are 0 and 2 respectively This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is saved and that preset is set to be the power on preset Example Description Status Message S01AMGATEC10 Configure microphone input 1 for normal gating S01AMGATEC10 S01AMGATEC11 Configure micro...

Page 32: ...g threshold for input channel 1 S01AMGATER1x where x is between 0 and 100 depending on the current setting of the gate ratio for input channel 1 If this command is issued after the example above then the status message will be S01AMGATER115 8 19 AMGATET Set Automixer Gate Threshold This command sets the automixer gate threshold in dB for the specified input channel The gate threshold is the level ...

Page 33: ...it that applies to the local automixer in 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 This command is a channel integer command See Section 6 3 and Section 6 2 for mo...

Page 34: ...s command is issued after the above example then the status message will be S01AMHOLD1000 8 22 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 0 last mic mode is off 1 m...

Page 35: ...o manual The value of the AMLMN command is only valid when AMLMM is set to manual 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 Even though this is a channel integer command use of the wildcard character for the automixer number is not supported This...

Page 36: ...emory 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 S01AMNOM11 Set local NOM for automixer 1 to a maximum of 1 mics S01AMNOM11 S01AMNOM1 Query current local NOM limit for automixer 1 S01AMNOM1x where x is always 1 since there is only 1 mic on this devic...

Page 37: ... this command was sent after the example above then the status message would be S01AMNOMAT 0011 S01AMNOMAT Query NOM attenuation status of all outputs S01AMNOMAT abcd where each of the letters a b etc is either 0 or 1 depending of the current status of the NOM attenuation on the corresponding output If this command was sent after the example above then the status message would be S01AMNOMAT 0011 8...

Page 38: ... 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 S01AMPRIOR11 Set microphone input 1 to gating priority 1 S01AMPRIOR11 S01AMPRIOR1 Query current gating priority for microphone input 1 S01AMPRIOR1x where x is between 1 and 4 dependin...

Page 39: ...eature 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 AMREFE command controls the enabled status 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 The first argument in the command sp...

Page 40: ...ince this command writes to non volatile memory there will be a delay before an acknowledgment is returned Example Description Status Message S01BAUD38400 Set baud rate of rear panel RS 232 port to 38400 bps S01BAUD38400 S01BAUD Query current baud rate of rear panel RS 232 port S01BAUDx where x is 9600 19200 or 38400 depending on the current baud rate setting 8 31 BLAUTO Enable Automatic BLDATA Me...

Page 41: ...1 A B T ooooo output levels 1 A B T L r AEC reference level R1 g room gain 1 a AGC gain 1 s AEC state 1 Each of the i bytes correspond to signal levels on the 4 inputs in the following order from left to right 1 A B T The o bytes correspond to signal levels on the 5 outputs in the following order from left to right 1 A B T L The r byte indicates the signal level for AEC reference R1 The the g byte...

Page 42: ...t the rest of the inputs are at 20 dB The next five bytes çpppp consist of only two values p 0x70 112 112 132 20 ç 0x87 135 135 132 3 So the signal at output 1 is at 3 dB while the signals at the rest of the outputs are at 20 dB The next byte p consists of only one value p 0x70 112 112 132 20 So the signal level of the AEC reference is 20 dB The next byte p consists of only one value p 0x70 112 11...

Page 43: ...above BLINFO command there are 1 s in the positions of the data that we want and 0 s in the positions of the data that we don t want Now when we send a BLDATA command or enable BLAUTO the Vortex sends messages of the form S01BLDATAii Where the ii bytes are the signal levels for inputs A B 8 33 BLINFO Select Information to be Reported in BLDATA This command controls which bytes are sent in the BLDA...

Page 44: ...the digital bus S01BROADA B02PHONE1 this second status message is from the EF2241 at device ID 2 when it takes its phone off hook 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 ...

Page 45: ...command The CGATEEN can be used to have gating information sent automatically instead of having to poll this command Example Description Status Message S01CGATE1 Query camera gating status of microphone input 1 S01CGATE1x where x is 0 or 1 depending on whether the input is gated off or gated on respectively S01CGATE Query camera gating status of all microphone inputs S01CGATE x where x is either 0...

Page 46: ...command sets the hold time in milliseconds for the camera gating CGATE feature This command is an integer command See Section 6 2 for more information on this type of command The minimum and maximum values for this command are 100 and 5000 respectively This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is...

Page 47: ... it is changed It will retain its value after power down Since this command writes to non volatile memory there will be a delay before an acknowledgment is returned Example Description Status Message S01COUNTRY1 Set country definition to USA S01COUNTRY1 S01COUNTRY Query current country setting S01COUNTRYx where x is one of the numbers in the above table that corresponds to the current country sett...

Page 48: ...r output channels 1 A B T This command is a channel boolean command See Section 6 3 and Section 6 1 for more information on this type of command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is saved and that preset is set to be the power on preset Example Description Status Message S01DELAYOEB1 Enab...

Page 49: ...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 Example Description Status Message S01DIAL9 4048921180 Dial 9 to get an outside line then pause the three commas then dial 4048921180 ...

Page 50: ...is generated and error messages are enabled a status message will be automatically generated of the form S01ERROR xxx where xxx is a three digit number indicating the error code The following table lists the non fatal error messages that can be generated by the Vortex Error Number Description ERROR 001 Unrecognized command ERROR 002 Syntax error in command ERROR 004 Attempt to change parameter tha...

Page 51: ...ich is not allowed ERROR 072 This error occurs as a result of a PRESETQ command It indicates that one or more commands in the preset had errors during execution ERROR 073 This error occurs as a result of a MACROA command when there are already too many commands in the macro The limit is 256 commands per macro ERROR 074 This error occurs in response to a MACROA or a logic pin LIA LIH etc command If...

Page 52: ...ssage mode S01ERRORx where x is 0 or 1 depending on the current state of error mode S01ERROR Query the state of error mode S01ERRORx where x is 0 or 1 depending on the current 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 FADERI command because that ...

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

Page 54: ...f hook after a delay The amount of time between on hook and off hook is controlled by the COUNTRY setting and has be set for each country to meet each country s specific compliance requirements If the phone is on hook when this command is given then no action is performed Example Description Status Message S01FLASH Execute hook flash If the phone is on hook no action is performed and the response ...

Page 55: ...mmands see Section 6 1 except that when disabling this feature the password must be supplied for the command to work If an incorrect password is supplied ERROR 005 will be generated The examples below illustrate the correct usage The examples assume that the password has been set to aspi the default The front panel password can be changed via the FPPSWD command This command is saved to global non ...

Page 56: ...ommand The minimum and maximum values for this command are 100 and 20 respectively This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is saved and that preset is set to be the power on preset Example Description Status Message S01GAINA6 Set phone input gain to 6 dB S01GAINA6 S01GAINA 3 Increase phone inpu...

Page 57: ...ones 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 integer command See Section 6 2 for more information on this type of 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 o...

Page 58: ... x is the new value of the dial tone gain If this command was issued after the example above then the status message would be S01GAINDT9 8 57 GAINGIL Set Gain of Line Inputs as a Group This command sets the gains of all the line inputs simultaneously This is different from using a wildcard with the GAINI command because that command sets all the mic and line inputs together while the GAINGIL sets ...

Page 59: ...ter This command lets you adjust the gain of these input gain stages For volume control the FADERI command can be used to adjust the signal level in the digital domain without affecting the calibration This command also adjusts the gain of the input signal coming from the telephone interface The following table shows the relationship between the input gain settings via GAINI and MIC and the nomina...

Page 60: ...GAINO Set Output Gain This command sets or queries the gain in dB of the four output channels 1 A B T This command is a channel integer command See Section 6 3 and Section 6 2 for more information on this type of command The minimum and maximum values for this command are 100 and 20 respectively This command is saved to non volatile memory only as part of a preset The state of this command will be...

Page 61: ...the power on preset Example Description Status Message S01GAINP6 Set phone output gain to 6 dB S01GAINP6 S01GAINP 3 Increase phone output gain by 3 dB S01GAINPx where x is the new value of the phone output gain If this command was issued after the example above then the status message would be S01GAINP9 S01GAINP Query phone output gain S01GAINPx where x is the new value of the phone output gain If...

Page 62: ...phone and the gain is adjusted by the GAINSOT command This command is an integer command See Section 6 2 for more information on this type of command The minimum and maximum values for this command are 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 se...

Page 63: ...ntly gated on and GATEEN is enabled then if microphone input 1 gates on the following status message will be automatically generated S01GATE 1 See the GATE command for more information This command is a boolean command See Section 6 1 for more information on this type of command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after p...

Page 64: ...ng on the current state of the global output mute S01GMUTEO Query acknowledgement mode S01GMUTEOx where x is 0 or 1 depending on the current state of the global output mute 8 66 ID Set Device ID This command sets or queries the Device ID for the Vortex Typically the device ID is set from the front panel of the Vortex so this command is not normally used There are restrictions involving having devi...

Page 65: ...input pins LO1 LO20 Labels for logic output pins P0 P47 Labels for user presets M0 M255 Labels for user macros 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 It will retain its value after power down Since this command writes to no...

Page 66: ...ine input channels S01LAGC Query AGC state on input channels A B S01LAGC ab where a and b are each 0 or 1 depending on the current state of the AGC for each of the line input channels 8 69 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...

Page 67: ... maximum 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 Section 6 3 and Section 6 2 for more information on this type of command The minimum and maximum values for this command are 0 and 15 respectively This command is saved to non volatile memory only as part of a preset The state of this command will be res...

Page 68: ...C minimum gain on input channel B 8 72 LAGCRATE Set Ramp Rate of Line Input AGC This command sets or queries the maximum rate at which the AGC can increase or decrease the gain of the signals on input channels A B The ramp rate is expressed in dB sec This command was introduced in firmware version 2 5 0 This command is a channel integer command See Section 6 3 and Section 6 2 for more information ...

Page 69: ... the amount of double talk suppression used in the LEC on the telephone input T The values correspond to the following settings 1 No Suppression 2 Light Suppression 3 Heavy Suppression 4 Half Duplex This command is an integer command See Section 6 2 for more information on this type of command The minimum and maximum values for this command are 1 and 4 respectively This command is saved to non vol...

Page 70: ... of three conditions occurring on the logic pin a change to the active state a change to the inactive state and a repeating command when the pin is held in the active state The LIA command assigns a single command to the logic pin that is executed when the logic pin changes to the active state Although only one command can be assigned to the state change the command may be a MACROX or MACROQ comma...

Page 71: ...e state This command 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 S01LIA6 BROADA S02MUTEI11 S01LIA7 Assign a blank command to occur when logic input pin 7 changes from the inactive state to the active state Assigning a blank command means no action will take place as a result of this state change S01LIA7 S01L...

Page 72: ... 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 See the description of the LIA for examples on how to use the LID command The syntax for this command is exactly the same This command is saved to global non volatile memory and is not part of a preset Its value is saved each time it is chang...

Page 73: ...ower down Since this command writes to non volatile memory there will be a delay before an acknowledgment is returned Example Description Status Message S01LIH8 GAINIA 3 Assign the command GAINIA 3 to occur repeatedly when logic pin 8 is held in the active state The GAINIA 3 command causes the gain on input channel A to increase by 3 dB each time the command is executed S01LIH8 GAINIA 3 8 79 LIEN ...

Page 74: ...signed to each combination This feature is particularly useful in room combining applications It can also be used to make controls based on rotary switches that output binary BCD or Gray codes Commands can be assigned to the configurations of a logic group via the LIN command This command is saved to global non volatile memory and is not part of a preset Its value is saved each time it is changed ...

Page 75: ...ds S01LIA1 S01LID1 and S01LIH1 for each logic input except that this command is much more efficient S01LIK 8 82 LIM Mask Logic Input Pins This command is used to mask i e disable logic input pins The mask consists of 24 fields one for each logic input that can each be set to 0 or 1 If the mask bit for a given logic input is set to 1 then the logic input pin works normally If the mask bit for a giv...

Page 76: ...ts these correspond to logic inputs 6 8 and 10 for our case Similarly the ones in the second and fourth positions correspond to bits 7 and 9 The last part of the command specifies the command to be executed with the pins enter this configuration 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 ...

Page 77: ...Output Pins This command sets or queries the current state of the logic outputs There are 20 logic outputs so an array of 20 boolean values is required or returned with the first value indicating the state of the first logic output the second value indicating the state of the second logic output and so on If a logic output pin has conditions driving it via the LOA and LOD commands those conditions...

Page 78: ...rks as an OR function with corresponding to a 1 in the channel status and corresponding to a 0 If any or characters are in the string at least one channel s status must match for the condition to be true Consider the following example In this example we also use the LOD command which is just like the LOA command except that it sets the condition for the logic output to be in the deactivated state ...

Page 79: ...trols whether or not logic output status messages are sent automatically If LOEN is enabled then a logic output query LO is performed any time any of the states change on the logic output pins For example if all logic outputs are currently in the low state 0 and LOEN is enabled then if logic output 12 changes state to 1 the following status message will be generated S01LO 00000000000100000000 A st...

Page 80: ...ore efficient S01LOK5 S01LOK Delete all the commands associated with all logic output pins This one command is equivalent to executing the commands S01LOA1 and S01LOD1 for each logic output except that this command is much more efficient S01LOK 8 90 LOM Mask Logic Output Pins This command is used to mask i e disable logic output pins The mask consists of 20 fields one for each logic output that ca...

Page 81: ... for all pins is set to normal active high This command is saved to global non volatile memory and is not part of a preset Its value is saved each time it is changed It will retain its value after power down Since this command writes to non volatile memory there will be a delay before an acknowledgment is returned Example Description Status Message S01LOP11111111111111110000 Set logic outputs 1 16...

Page 82: ...01MACROA112 GAINI 0 S01MACROA112 MUTEO 0 S01MACROW112 This defines macro number 112 to unmute all inputs set all input gains to 0 dB and unmute all outputs It is acceptable if another command is sent in between these commands such as S01NC as long as it isn t another non volatile memory command which could interfere with the storage of the macro 8 93 MACROK Delete One or All Macros This command ki...

Page 83: ... the specified number The macro must have been previously defined and stored in non volatile memory via the MACROS MACROA and MACROW commands If the specified macro is empty then an error condition of ERROR 070 will be generated When the MACROQ command executes status messages for all of the commands in the macro will not be generated The MACROQ is provided so that a control system can execute a m...

Page 84: ...Since this command writes to non volatile memory there will be a delay before an acknowledgment is returned 8 98 MACROX Execute Macro This command executes the macro corresponding to the specified number The macro must have been previously defined and stored in non volatile memory via the MACROS MACROA and MACROW commands If the specified macro is empty then an error condition of ERROR 070 will be...

Page 85: ...mmand sets or queries one or more crosspoint gains in either the main matrix or one of the EF Bus submatrices This command is a matrix integer command See Section 6 4 and Section 6 2 for more information on this type of command The minimum and maximum values for this command are 100 and 20 respectively This command is saved to non volatile memory only as part of a preset The state of this command ...

Page 86: ...each of the crosspoint gains If this command was issued after the example above then the status message would be S01MGAINB èèèèèèèèèè S01MGAINB Query the gains for all crosspoints of input channel B S01MGAINB abcdefghij where the value of each of letters a b etc depends on the current state of each of the crosspoint gains If this command was issued after the example above then the status message w...

Page 87: ... depending on the current gated status of the crosspoint 8 102 MIC Enable Microphone Gain Stage on Input 1 This command sets or queries the enabled state of the microphone gain stages on the microphone input Enabling the gain stage adds an extra 33 dB of gain in the input signal path See the description of the GAINI command for information on how the MIC and GAINI commands relate to nominal input ...

Page 88: ...ssage S01MINI1 Enable modem initialization string S01MINI1 S01MINI0 Disable modem initialization string S01MINI0 S01MINI2 Toggle enabled state of modem initialization string S01MINIx where x is 0 or 1 depending on the current enabled state of the modem initialization string S01MINI Query enabled state of modem initialization string S01MINIx where x is 0 or 1 depending on the current enabled state ...

Page 89: ...s type of command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is saved and that preset is set to be the power on preset Example Description Status Message S01MMUTEB R1 1 Mute signal path in main matrix from input B to AEC reference 1 S01MMUTEB R1 1 S01MMUTEWB0 WM0 0 Mute signal path in EF Bus W sub...

Page 90: ...g on the current state of each of the crosspoint mutes If this command was issued after the example above then the status message would be S01MMUTEA 0000000000 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 MUTEI command because that command sets all the mic and line in...

Page 91: ... channel boolean command See Section 6 3 and Section 6 1 for more information on this type of command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a preset is saved and that preset is set to be the power on preset Example Description Status Message S01MUTEI11 Mute input 1 S01MUTEI11 S01MUTEIA0 Unmute input A...

Page 92: ...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 S01MUTEO11 Mute output 1 S01MUTEO11 S01MUTEOA0 Unmute output A S01MUTEOA0 S01MUTEOT2 S01MUTEOTx where x is either 0 or 1 depending on the current mute status of the ou...

Page 93: ...e power on preset Example Description Status Message S01NC11 Enable NC on input channel 1 S01NC11 S01NCT0 Disable NC on input channel T S01NCT0 S01NC12 Toggle NC state on input channel 1 S01NC1x where x is 0 or 1 depending on the current state of NC on input channel 1 S01NC1 Query NC state on input channel 1 S01NC1x where x is 0 or 1 depending on the current state of NC on the input channel S01NC ...

Page 94: ...between 0 and 20 depending on the current setting of the NC attenuation level on input channel 1 S01NCL 6 Set NC attenuation level on all microphone input channels only 1 on EF2211 to 6 dB S01NCL è S01NCL Query NC attenuation level on all microphone input channels only 1 on EF2211 S01NCL x where x is between ä and ÿ depending on the current setting of the NC attenuation level for input 1 8 111 NVI...

Page 95: ...wn Since this command writes to non volatile memory there will be a delay before an acknowledgment is returned Example Description Status Message S01NVLOCK1 Lock the non volatile memory to prevent users from changing the settings S01NVLOCK1 S01NVLOCK0 yumyum Attempt to unlock the non volatile memory by using an invalid password S01ERROR 005 since an invalid password was given an error message was ...

Page 96: ...he following parameters Description Value Range Units Channel 1 A B T N A Band 1 5 N A Filter Type 1 5 1 parametric filter 2 low shelf 3 high shelf 4 lowpass 5 highpass 6 Linkwitz Riley lowpass 7 Linkwitz Riley highpass Frequency 20 20000 Hz Bandwidth 5 200 1 100th octave Gain 20 20 dB Slope 1 1 2 Gain for shelving filters 12 or 24 for Linkwitz Riley filters dB per octave Enable 0 1 0 filter disab...

Page 97: ...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 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 S01PEQIA1 2 1 ...

Page 98: ...idth is specified instead of all the parameters See the PEQIA command for more information To set the bandwidth parameter for an output parametric EQ filter use the PEQOB command To set all the parameters for an output parametric EQ filter use the PEQOA command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up only if a ...

Page 99: ... in the example above then the status message will be S01PEQIEB 1 1 8 117 PEQIF Set Frequency Parameter for Specified Parametric EQ Input Stage This command sets or queries the frequency parameter in Hz 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 The minimum and maximum values for the freque...

Page 100: ...rameter the gain is specified instead of all the parameters See the PEQIA command for more information To set the gain parameter for an output parametric EQ filter use the PEQOG command To set all the parameters for an output parametric EQ filter use the PEQOA command This command is saved to non volatile memory only as part of a preset The state of this command will be restored after power up onl...

Page 101: ...mmand 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 S01PEQIS1 2 1 Set the slope of the parametric EQ on input 1 band 2 to 1 dB per octave S01PEQIS1 2 1 S01PEQISB 1 Query current slope setting of parametric EQ on input B band 1 S01PEQISB 1 s where s is the current setting of the slope parameter for the p...

Page 102: ...of this filter is set to the same value given in the example above then the status message will be S01PEQITB 1 1 8 121 PEQOA Set All Parameters for Specified Parametric EQ Output Stage This command sets or queries all of the parameters for the parametric equalizer EQ filters on output channels 1 A B and T output channel T Each channel has five bands of parametric EQ that can be independently contr...

Page 103: ... Yes Yes Yes High Shelf 3 No Yes Yes Yes Lowpass 4 No Yes No No Highpass 5 No Yes No No Linkwitz Riley Lowpass 6 No Yes No Yes Linkwitz Riley Highpass 7 No Yes No Yes When a parameter is invalid for a given filter type the parametric EQ commands will still set that parameter however its value will not be used for filter computations This valid invalid parameter information above is provided mainly...

Page 104: ... 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 The minimum and maximum values for the bandwidth parameter are 5 and 200 respectively This command ...

Page 105: ...estrictions as the PEQOA command except that only one parameter the enabled status is specified instead of all the parameters See the PEQOA command for more information To set the enabled parameter for an input parametric EQ filter use the PEQIE command To set all the parameters for an intput parametric EQ filter use the PEQIA command This command is saved to non volatile memory only as part of a ...

Page 106: ...s saved and that preset is set to be the power on preset Example Description Status Message S01PEQOF1 2 1250 Set frequency of parametric EQ on output 1 band 2 to 1250 Hz S01PEQOF1 2 1250 S01PEQOFB 1 Query current frequency setting of parametric EQ on output B band 1 S01PEQOFB 1 f where f is the current setting of the frequency parameter for the parametric EQ on output B band 1 If the frequency par...

Page 107: ...el has five bands of parametric EQ that can be independently controlled For the Linkwitz Riley filters the slope can either be 12 or 24 dB Octave For the low shelf and high shelf filters the minimum value for the slope parameter is 1 and the maximum value is 1 2 times the current value of the gain parameter See the PEQIG command for information on the gain parameter This command has the same forma...

Page 108: ...nt filter types and their corresponding values are shown in the table below Filter Type Value of Type Parameter Parametric 1 Low Shelf 2 High Shelf 3 Lowpass 4 Highpass 5 Linkwitz Riley Lowpass 6 Linkwitz Riley Highpass 7 This command has the same format and restrictions as the PEQOA command except that only one parameter the filter type is specified instead of all the parameters See the PEQOA com...

Page 109: ... that preset is set to be the power on preset Example Description Status Message S01PHANTOM11 Enable phantom power for input channel 1 S01PHANTOM11 S01PHANTOM10 Disable phantom power for input channel 1 S01PHANTOM10 S01PHANTOM12 Toggle phantom power state for input channel 1 S01PHANTOM1x where x is 0 or 1 depending on the current state of phantom power on input channel 1 S01PHANTOM1 Query state of...

Page 110: ... 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 Example Description Status Message PING Ping all connected device to determine the number type and ID of the connected devices F00PONG F01PONG B02PONG B03PONG S04PONG S05PONG Q06PONG Q07PONG T00PONG T01PONG 8 131 PRESETK Delete On...

Page 111: ... Activated At Power Up 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 Its value is saved each time it is changed It will retain its value after power down Since this command wr...

Page 112: ...OR 071 will be generated if they are specified in the PRESETW command Once a preset it saved it can be recalled via the PRESETX and PRESETQ commands The preset can also be set to be executed automatically at power up via the PRESETP command This command is saved to global non volatile memory and is not part of a preset Its value is saved each time it is changed It will retain its value after power...

Page 113: ...laced on the EF Bus by one and only one of the linked Vortexes See the BUSREF command for more information about the EF Bus reference Assigning REFASGN a value of 2 is not supported on this device The value of 2 is only supported on devices that can build a second AEC reference i e the EF2280 EF2241 Although this command is a channel integer command the increment and decrement operators and are no...

Page 114: ...ill 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 S01REFGAINR16 Set effective output gain of AEC reference 1 R1 to 6 dB S01REFGAINR16 S01GAINP 3 Increase phone output gain by 3 dB S01GAINPx where x is the new value of the phone output gain If this command was issued after the example above then the status me...

Page 115: ...saved and that preset is set to be the power on preset Example Description Status Message S01SGGAIN6 Set signal generator gain to 6 dB S01SGGAIN6 S01SGGAIN 3 Increase signal generator gain by 3 dB S01SGGAINx where x is the new value of the signal generator gain If this command was issued after the example above then the status message would be S01SGGAIN9 S01SGGAIN Query signal generator gain S01SG...

Page 116: ...S01SGTYPE0 S01SGTYPE1 Configure signal generator to produce pink noise S01SGTYPE1 S01SGTYPE Query current signal generator type S01SGTYPEx where x is either 0 or 1 depending on whether the signal generator is currently configured to generate white or pink noise respectively 8 144 SOUNDL Play Sound Locally This command can be used to play sounds from the telephone interface to serve as audio cues T...

Page 117: ...y The same sound generator is also used for playing entry and exit tones for the auto answer and auto hangup features This command takes a single argument that indicates the sound to be played The following table lists the sound numbers and a description of the generated sound Sound Number Sound Description 0 ascending thirds 1 descending thirds 2 ascending chorus 3 descending chorus 4 ascending d...

Page 118: ...SDELAY Query screen saver delay S01SSDELAYx where x is the new value of the screen saver delay If this command was issued after the example above then the status message would be S01SSDELAY2500 8 147 SSEN Enable or Disable Screen Saver This command controls whether or not the LCD screen saver is enabled This command is a boolean command See Section 6 1 for more information on this type of command ...

Page 119: ...messages displayed by the screen saver The arguments of this command are the screen number the line number and the text to be displayed The screen number must be between 0 and 3 It indicates which message screen we are trying to set or query Each message screen consists of two lines of text that can be up to 16 characters long The second number indicates which line of the message we are tring to s...

Page 120: ...g is the current sofware version If the software version was 2 5 0 then the status message would be S01SWVER2 5 0 8 152 TONEE Enable or Disable Entry and Exit Tones This command sets or queries the enabled status of the entry and exit tone feature If entry and exit tones are enabled a specific tone is played whenever the auto answer feature takes the phone off hook A different tone is played whene...

Page 121: ...ng tones S01TONER0 S01TONER2 Toggle enabled status of ring tones S01TONERx where x is 0 or 1 depending on the current enabled state of ring tones S01TONER Query enabled state of ring tones S01TONERx where x is 0 or 1 depending on the current enabled state of 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 wideba...

Page 122: ...ing of the current status VTX mode on the corresponding input If this command was sent after the example above then the status message would be S01VTXMODI 01 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 ...

Page 123: ...MODO 2 Toggle status of VTX mode on outputs 1 A B S01VTXMODO abc where each of the letters a b etc is either 0 or 1 depending of the current status VTX mode on the corresponding output If this command was sent after the example above then the status message would be S01VTXMODO 011 S01VTXMODO Query status of VTX mode on outputs 1 A B S01VTXMODO abc where each of the letters a b etc is either 0 or 1...