Installed Voice Business Group RS-232 Command Set: Vortex EF2201 Programming Guide Copyright © 2003 Polycom, Inc. Polycom and the Polycom logo are registered trademarks of Polycom, Inc. ASPI, Vortex, VS4000, Viewstation, and iPower are registered trademarks of Polycom, Inc.
Vortex EF2201 Programming Guide Table of Contents 1. Introduction 2. RS-232 Hardware 3. Programming Tips 3.1. Initialization 3.2. Wildcard Characters 3.3. Using Acknowledgements 3.4. Macros and Presets 4. Command Structure 4.1. Device Type 4.2. Device ID 4.3. Command Name 4.4. Command Data 4.5. Command Terminator 4.6. Examples 5. Status Messages 6. Command Types 6.1. Boolean Commands 6.2. Integer Commands 6.3. Channel Commands 6.4. Matrix Commands 6.5. Miscellaneous Commands 7. Command List 8.
8.17. 8.18. 8.19. 8.20. 8.21. 8.22. 8.23. 8.24. 8.25. 8.26. 8.27. 8.28. 8.29. 8.30. 8.31. 8.32. 8.33. 8.34. 8.35. 8.36. 8.37. 8.38. 8.39. 8.40. 8.41. 8.42. 8.43. 8.44. 8.45. 8.46. 8.47. 8.48. 8.49. 8.50. 8.51. 8.52. 8.53. 8.54. 8.55. 8.56. 8.57. 8.58. 8.59. 8.60. 8.61. 8.62.
8.63. MACROS -- Start a New Macro 8.64. MACROW -- Write Macro to Non-Volatile Memory 8.65. MACROX -- Execute Macro 8.66. METER -- Select which Signal is Displayed on the Front Panel LED Meter 8.67. MGAIN -- Set Crosspoint Gains in Main Matrix or Submatrix 8.68. MINI -- Enable Modem Initialization String 8.69. MINISTR -- Set Modem Initialization String 8.70. MMUTE -- Mute Crosspoint in Main Matrix or Submatrix 8.71. MUTEI -- Mute One or More Inputs 8.72. MUTEO -- Mute One or More Outputs 8.73.
8.109. 8.110. 8.111. 8.112. 8.113. 8.114. SSSTART -- Set Idle Time Required for Screen Saver to Start SSTEXT -- Set Text to be Displayed by Screen Saver SWRESET -- Perform Soft Reset of System SWVER -- Query Software Version TONEE -- Enable or Disable Entry and Exit Tones TONER -- Enable or Disable Ring Tones 1. Introduction This document describes the command protocol that is used to communicate with the Vortex EF2201 via its RS-232 port. 2.
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 ACKMOD command). When acknowledgment mode is on, a Vortex device will send an acknowledgment for each command it receives.
3.4. Macros and Presets Although macros and presets are similar, there are times when using one is better than the other. Presets store the absolute values of all of the non-global settings of the device. This includes, but is not limited to, input and output gain settings, matrix settings, algorithm settings, parametric EQ settings, and automixer settings. See Section 7 for a list showing all the commands and which are saved to presets.
Device Device Type EF200 A EF1210 C EF2280 F EF2241 B EF2211 S EF2210 Q EF2201 T Device type '*' can be used to send a command to all device types simultaneously. 4.2. Device ID Two numeric characters are used to indicate the device ID. The Vortex can be configured for device IDs from '00' to '07'. Note that even though the device ID is less than 10, the leading '0' must be included. Device ID '**' can be used to send a command to all device IDs simultaneously.
In the following examples, Vortex commands are enclosed in single quotes, 'like this'. Also, the terminator character is not explicitly shown, but its presence is implied. Consider the command '***PING'. The device type and ID for this command are wildcards, thus the command will be sent to all devices. The command name in this case is 'PING', and there are no data characters (payload).
● ● '1' indicates that the parameter should be turned on. '2' indicates that the parameter should be toggled (i.e., '0' becomes '1' and '1' becomes '0'). Parameters associated with boolean commands can be queried using the '?' character. For example, if input T is muted, and you send ' T04MUTEIT?', the EF2201 will respond with a status message of ' T04MUTEIT1'. 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.
A wildcard character ('*') can be used as the channel specifier for many of the channel commands. If this is the case, there are two options for specifying the values for the channels. The first method is to specify a single value that will be applied to all the channels. Using the wildcard character for channel commands is not common on the EF2201, since it has only one input channel and one output channel.
The EF2201 has only one physical input. This input comes from the telephone interface, and is labeled T. The T input has signal processing which includes the following algorithms: Line Echo Cancellation, Noise Cancellation, and AGC. Vortex devices can be linked together so that they can share control information and digital audio signals. The audio signals are shared on four digital busses labeled P, W, X, Y, and Z. All Vortex devices can receive signals from all of these busses.
Y Submatrix ● ● Inputs: YB0-YB7 Outputs: YM0-YM2 Z Submatrix ● ● Inputs: ZB0-ZB7 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. The reason the matrix is 7 x 2 instead of 8 x 2 is that since we can transmit on the P bus, we do not need to mix our own channels in this matrix. The inputs and outputs for the 7 x 2 P bus matrix are as follows.
method described in Section 6.3. You can also use the wildcard character to set the crosspoints of a row or column individually. For example, 'T04MGAINT,*,äx' sets the crosspoints of input 1 to 0 dB for output T, and -12 dB for output P. In this case, the EF2201 will respoind with a status message of 'T04MGAINT,*,äx'. Queries using the '?' character work in the usual manner. For example, ' T04MGAINT,P,?' might return ' T04MGAINT,P,-6', while ' T04MGAINT,*,?' might return ' T04MGAIN2,*,ää'.
parameters are not saved in non-volatile memory until a PRESETW command is executed. Parameters stored in the power-on preset (see PRESETP) are restored when the power is cycled.
GAINI Preset Set Input Gain GAINO Preset Set Output Gain GAINP Preset Set Phone Output Gain GAINSIT Preset Set From Phone User Tone Gain GAINSOT Preset Set To Phone User Tone Gain GMUTEO Preset Mute All Outputs ID Global Set Device ID LABEL Global Set or Query one of the Device Labels LEC Preset Enable or Disable LEC LECMODE Preset Set Amount of Double Talk Suppression used in the LEC.
MGAIN Preset Set Crosspoint Gains in Main Matrix or Submatrix MINI Global Enable Modem Initialization String MINISTR Global Set Modem Initialization String MMUTE Preset Mute Crosspoint in Main Matrix or Submatrix MUTEI Preset Mute One or More Inputs MUTEO Preset Mute One or More Outputs NC Preset Enable Noise Cancellation NCL Preset Set Noise Cancellation Attenuation NVINIT - Reinitialize Non-Volatile Memory NVLOCK Global Lock/Unlock Non-Volatile Memory NVPSWD - Change Non-Vo
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 for Screen Saver to Start SSTEXT Preset Set Text to be Displayed by Screen Saver SWRESET - Perform Soft Reset of System SWVER - Query Software Vers
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 nonvolatile memory, there will be a delay before an acknowledgment is returned. Example Description Status Message T01ACKMOD1 Enable acknowledgement mode. T01ACKMOD1 T01ACKMOD0 Disable acknowledgement mode.
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 T01AGCMAXT3 Set AGC maximum gain on input channel T to 3 dB. T01AGCMAXT3 T01AGCMAXT? T01AGCMAXTx where x is a number between Query the AGC maximum gain on input 0 and 15, depending on the current setting of channel T.
Example Description Status Message T01AGCRATET3 Set AGC ramp rate on input channel T to 3 dB/sec. T01AGCRATET3 Query the AGC ramp rate on input channel T. T01AGCRATETx where x is a number between 1 and 5, depending on the current setting of the AGC ramp rate on input channel T. T01AGCRATET? 8.7. AHCP -- Enable or Disable Call Progress Based Auto Hangup This command sets or queries the status of the call progress based auto hangup feature.
This command is a boolean command. See Section 6.1 for more information on this type of command. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Status Message T01AHLD1 Enable loop drop based auto hangup mode. T01AHLD1 T01AHLD0 Disable loop drop based auto hangup mode.
Enable NOM attenuation on T01AMNOMAT*10 output A and disable NOM attenuation on output B. T01AMNOMAT*10 T01AMNOMAT*2 T01AMNOMAT*ab, where each of the letters (a, b, etc.) is either 0 or 1 depending of the current Toggle status of NOM attenuation status of NOM attenuation on the corresponding on all outputs. output. If this command was sent after the example above, then the status message would be T01AMNOMAT*01. T01AMNOMAT*? T01AMNOMAT*ab, where each of the letters (a, b, etc.
T01BLAUTO0 Disable automatic BLDATA messages. T01BLAUTO0 T01BLAUTO1 Enable automatic BLDATA messages. T01BLAUTO1 T01BLAUTO2 Toggle enabled status of automatic BLDATA messages. T01BLAUTOx, where x is 0 or 1 depending on the current setting of BLAUTO. T01BLAUTO? Query enabled status of automatic BLDATA messages. T01BLAUTOx, where x is 0 or 1 depending on the current setting of BLAUTO. 8.12. BLDATA -- Request Level Information This command is used to request "blinking light" data from the EF2201.
So, the signal at input T is at 6 dB. The next byte (ç) consists of only one value. ç = 0x87 = 135 → 135 - 132 = 3 So, the signal at output T is at 3 dB. In the above description, the data in the BLDATA command consists of 2 bytes (1 input level + 1 output level). It is possible to tell the EF2201 to only send a subset of this information. Depending on your control system, this could make parsing the data easier since you can ask for only the data that you are interested in.
T01BROAD2:ATDT4048921180 Sends the string ATDT4048921180 out the RS232 port. T01BROAD2 8.15. 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 ' T01BROADA: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.
Example Description Status Message T01COUNTRY1 Set country definition to USA. T01COUNTRY1 T01COUNTRYx, where x is one of the numbers in the T01COUNTRY? Query current country setting. above table that corresponds to the current country setting. 8.17. DELAYO -- Set Output Delay This command sets the amount of output delay (in tenths of milliseconds) on the output channel T. Use of the wildcard character (*) for specifying the channel is not supported for this command.
Example Description Status Message T01DELAYOET1 Enable output delay on output T. T01DELAYOET1 T01DELAYOET0 Disable output delay on output T. T01DELAYOET0 Toggle enabled status of output T01DELAYOET0 delay on output T. T01DELAYOETx, where x is either 0 or 1 depending on the current enabled status of the output delay on the output. Query enabled status of output T01DELAYOET? delay on output T.
Example Description Status Message T01DSPAUTO1 Enable automatic DSPLOAD messages. T01DSPAUTO1 T01DSPAUTO0 Disable automatic DSPLOAD messages. T01DSPAUTO0 T01DSPAUTOx, where x is 0 or 1 depending T01DSPAUTO2 Toggle automatic DSPLOAD messages. on the current setting of the DSPAUTO paramter. T01DSPAUTO? Query the value of the DSPAUTO parameter. T01DSPAUTOx, where x is 0 or 1 depending on the current setting of the DSPAUTO paramter. 8.21.
ERROR#060 This error occurs when the user has attempted to utilize more variable DSP resources than are available. This may occur if too many matrix crosspoints are unmuted or too many parametric EQ filters are enabled. The DSPLOAD command can query the current percentage utilization of DSP resources. ERROR#070 This error occurs as a result of a macro or preset execution command (PRESETX, PRESETQ, MACROX, MACROQ). It indicates that the macro or preset requested was empty.
T01ERROR0 Disable error messages mode. T01ERROR0 T01ERROR2 Toggle error message mode. T01ERRORx, where x is 0 or 1 depending on the current state of error mode. T01ERROR? Query the state of error mode. T01ERRORx, where x is 0 or 1 depending on the current state of error mode. 8.23. FADERI -- Set Input Gain Fader This command adjusts the fader gain of the input signals, which on the EF2201 consist only of the input from the telephone interface.
If the phone is on-hook, no action is performed, and the response will be T01FLASH If the phone is off-hook, the response will be T01FLASH Execute hook flash. T01FLASH T01PHONE0 T01PHONE1 The PHONE status messagges occur when the phone goes on-hook and back off-hook. 8.25. FLOW -- Set Flow Control Mode for RS-232 Port This command sets the flow control mode for the rear panel RS-232 port. The valid settings are: Command Value Description 0 No flow control. 1 Hardware flow control.
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-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 nonvolatile memory, there will be a delay before an acknowledgment is returned.
Example Description Status Message T01GAINA6 Set phone input gain to 6 dB. T01GAINA6 T01GAINAx, where x is the new value of the phone input gain. If this command was issued after T01GAINA>3 Increase phone input gain by 3 dB. the example above, then the status message would be T01GAINA9. T01GAINA? Query phone input gain. T01GAINAx, where x is the new value of the phone input gain. If this command was issued after the example above, then the status message would be T01GAINA9. 8.29.
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 T01GAINDIT6 Set incoming DTMF tone gain to 6 dB. T01GAINDIT6 T01GAINDITx, where x is the new value of the incoming DTMF tone gain. If this Increase incoming DTMF tone gain by T01GAINDIT>3 command was issued after the example 3 dB. above, then the status message would be T01GAINDIT9. T01GAINDIT? Query incoming DTMF tone gain.
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 Set gain on T01GAINIT10 input T to 10 T01GAINIT10 dB. T01GAINIT? F01GAINI2xB01GAINITxS01GAINIAxQ01GAINIAxT01GAINITx, Query the gain on input where x is a number between 0 and 30, depending on the current T. setting of the gain on input channel T .
This command sets the gain of the output to the phone interface. This command is an alias for the GAINOT. It is provided for backwards compatibility with and ease of migration from the EF200. When possible, the GAINOT command should be used instead of this 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 -100 and 20, respectively.
8.36. GAINSOT -- Set To Phone User Tone Gain This command sets the gain of the user tones coming from the phone DSP. User tones include entry and exit tones (see TONEE) and custom tones (see the SOUNDP and SOUNDL commands). In most cases, the tones are played out "locally" and their gains are adjusted by the GAINSIT command. Sometimes, the tones are played out to the phone, and the gain is adjusted by the GAINSOT command. This command is an integer command. See Section 6.
T01GMUTEO? Query acknowledgement mode. T01GMUTEOx, where x is 0 or 1 depending on the current state of the global output mute. 8.38. 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 devices with the same ID linked on EF Bus -- see the Vortex Reference Manual for more details. This command is an integer command. See Section 6.
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 nonvolatile memory, there will be a delay before an acknowledgment is returned.
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-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 T01LECMODE3 Set LEC to Heavy Suppression. T01LECMODE3 T01LECMODE? Query LEC suppression level.
The BROADA is also useful in logic pin assignments. The BROADA command transmits a command to another device on the EF Bus, so you can effectively make a logic pin state change on one device cause an action to occur on another device. ERROR#074 will be generated if the assigned command is one that writes non-volatile memory, and the pin will not actually be assigned. 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.
T01LIA4,? T01LIA4,, where is the command string that Query the command will be executed when logic input 4 is associated with the active activated. If this query was given after state of logic pin 4. the example for logic input 4 above, the response would be T01LIA4,MUTEIT1. 8.44. LID -- Assign Action for when Logic Input is Deactivated This function assigns a single command to be executed when a given logic input changes from the active state to the inactive state.
is commonly referred to as active low. Acitve low is considered normal because a closed switch would ground the input and a closed switch would normally be considered active. This polarity setting can be changed via the LIP command. A single command can be assigned to each of three conditions occurring on the logic pin: a change to the active state, a change to the inactive state, and a repeating command when the pin is held in the active state.
A status message is only generated if there is a state change. This helps keep data traffic to a minimum. This command is a boolean command. See Section 6.1 for more information on this type of command. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Status Message T01LIEN1 Enable automatic logic input status messages.
T01LIG2,01101001000010000000000 Configure Logic Group 2 to contain logic input pins 2, 3, 5, 8, and 13. T01LIG2,01101001000010000000000 Note that the pins in a logic group do not have to be contiguous. T01LIG2,? Query which pins are in logic group 2. T01LIG2,abcdefghijklmnopqrstuvwx, where a-x are each 0 or 1 depending on which logic input pins are assigned to logic group 2. 8.48. LIK -- Delete One or All Logic Input Pin Commands This command "kills" or deletes all commands for a given logic input pin.
is disabled. When a logic input is disabled, any commands assigned to the logic pin via LIA, LID, and LIH will not be executed. If a logic pin is disabled and then re-enabled at some later time and the logic input has changed state from when it was disabled, the command associated with the state change will be executed. For example, if a logic input pin is high when it is disabled, and it is low when it is re-enabled, the command defined via LID (or LIA if the polarity is changed via LIP) will be executed.
Configure logic input group 2 to execute MACROX25 when the T01LIN2,10,MACROX25 T01LIN2,10,MACROX25 pins in logic input group 2 correspond to the decimal value 10. T01LIN1,7,? Query the command associated with decimal configuration 7 on logic input group 1. T01LIN1,7,, where corresponds to the command that is associated with decimal configuration 7 on logic input group 1. 8.51. LIP -- Set Polarity for Logic Inputs This command sets the polarity for the 24 logic input pins.
Example Description Status Message T01LO*00000000000000000000 Set all logic outputs low. T01LO*00000000000000000000 Set even numbered logic output pins low T01LO*10101010101010101010 T01LO*10101010101010101010 and odd numbered logic output pins high. T01LO*? Query current state of logic outputs T01LO*abcdefghijklmnopqrst, where a-t are each 0 or 1 depending on the current state of the corresponding logic output. 8.53.
These two commands set the conditions for activation and deactivation of logic output 10. Under these conditions, logic output 10 will be activated if: ● input T is muted Logic output 10 will be deactivated if: ● input T is unmuted An error condition of ERROR#074 will be generated if the assigned command is invalid. This command is saved to global non-volatile memory and is not part of a preset. Its value is saved each time it is changed. It will retain its value after power-down.
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 T01LOEN1 Enable automatic logic output status messages. T01LOEN1 T01LOEN0 Disable automatic logic output status messages. T01LOEN0 T01LOEN2 Toggle automatic logic output status messages. T01LOENx, where x is 0 or 1 depending on the current setting of LOEN.
changes. However, any changes to that pin caused by setting the values with an LO command will affect the output pin value. For instance, you could disable (mask) a pin and then explicitly set its value to low with the LO command. When a logic output pin is re-enabled, it will be updated to the current status of whatever condition drives it (via (LOA and LOD). This command is saved to non-volatile memory only as part of a preset.
8.59. MACROA -- Add Command to Current Macro This command adds a command to the macro currently in progress. This is used in conjunction with the MACROS and MACROW commands to create a new macro. The syntax of this command specifies a macro number, a comma, and then the command to be added to the macro.
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 nonvolatile memory, there will be a delay before an acknowledgment is returned. Example Description Status Message T01MACROK25 Delete all the commands associated with macro number 25. T01MACROK25 T01MACROK* Delete all the commands associated with all 255 macros. T01MACROK* 8.61.
Example Description Status Message T01MACROQ125 Execute macro number 125 without generating any status messages. T01MACROQ125 8.63. MACROS -- Start a New Macro This command is used to start writing a new macro with a specified macro number. This command is used in conjunction with the MACROA and MACROW commands to create a new macro.
Panel LED Meter 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 T01METERIT Set front panel LED meter to display the signal on input T. T01METERIT Query which signal the front panel LED meter is currently set to monitor. T01METERx, where x is the label corresponding to the signal currently being monitored.
Set crosspoint gain in EF Bus submatrix on crosspoint that routes the T01MGAINWB0,WM0,-3 T01MGAINWB0,WM0,-3 W bus signal from the device at ID0 (WB0) to W submatrix output 0 (WM0). T01MGAINT,*,èÇ Set all crosspoint gains for input channel T. Set the gain to the telephone T01MGAINT,*,èÇ output to 6 dB (è), and the gain to the P bus output to -3 dB (Ç). T01MGAINT,*,-3 Set all crosspoint gains for T01MGAINT,*,ÇÇ input channel T to -3 dB.
T01MINI? Query enabled state of modem initialization string. T01MINIx, where x is 0 or 1 depending on the current enabled state of the modem initialization string. 8.69. MINISTR -- Set Modem Initialization String This command is used to set or query the modem initialization string. The string can be a maximum of 32 characters long. The recommended modem initialization string for the Vortex is: ATF1E0&B1S0=2 This can be set via the following command.
T01MMUTET,P,1 Mute signal path (in main matrix) from the telephone T01MMUTET,P,1 input to the P-Bus output. Mute signal path (in EF Bus W submatrix) from W bus T01MMUTEWB0,WM0,0 signal at device ID0 (WB0) T01MMUTEWB0,WM0,0 to W submatrix output 0 (WM0). T01MMUTET,P,2 Toggle mute status of T01MMUTET,P,x, where x is either 0 or 1 signal path (in main matrix) depending on the current mute status of the from the telephone input to crosspoint. the P-Bus output.
Example Description Status Message T01MUTEIT1 Mute input T. T01MUTEIT1 T01MUTEIT0 Unmute input T. T01MUTEIT0 T01MUTEIT2 Toggle mute status of input T . T01MUTEITx, where x is either 0 or 1 depending on the current mute status of the input. T01MUTEIT? Query mute status of input T. T01MUTEITx, where x is either 0 or 1 depending on the current mute status of the input. T01MUTEI*1 Mute all inputs (only T on the EF2201). T01MUTEI*1 T01MUTEI*0 Unmute all inputs (only T on the EF2201).
T01MUTEO*? Query mute status of all outputs. T01MUTEO*x, where x is either 0 or 1 depending of the current status of the mute on the corresponding output. If this command was sent after the example above, then the status message would be T01MUTEO*0 8.73. NC -- Enable Noise Cancellation This command sets or queries the status of the Noise Cancellation (NC) algorithm on input channel T. This command is a channel boolean command. See Section 6.3 and Section 6.1 for more information on this type of command.
T01NCLT3 T01NCLT? Set NC attenuation level on input channel T to T01NCLT3 3 dB. T01NCLTx, where x is a number between 0 and 20, depending on the current setting of the NC attenuation level on input channel T. Query the NC attenuation level on input channel T. 8.75. NVINIT -- Reinitialize Non-Volatile Memory This command reinitializes (or formats) all non-volatile memory settings. This will effectively erase settings for global settings, user presets, macros, labels, and logic I/O configurations.
T01ERROR#005 -- since an invalid Attempt to unlock the non-volatile password was given, an error message was generated. If error messages have T01NVLOCK0,yumyum memory by using an invalid been disabled (via the ERROR command), password. then no status message will be generated. T01NVLOCK0,aspi Unlock the non-volatile memory by using the correct password. T01NVLOCK0 T01NVLOCK? Query the locked status of the non-volatile memory.
Filter Type 1-5 1 2 3 4 5 6 7 = = = = = = = parametric filter low shelf high shelf lowpass highpass Linkwitz-Riley lowpass 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 dB per octave filters Enable 0-1 0 = filter disabled 1 = filter enabled The paramters are specified in the order shown and are separated by commas.
Set the parametric EQ on input , band 2 to the following parameters: type = parametric filter, frequency = 1250 Hz, bandwidth = 40 1/100th octaves, T01PEQIAT,2,1,1250,40,-20,1,1 T01PEQIAT,2,1,1250,40,-20,1,1 gain = -20 dB, enabled = yes, slope = 1 dB per octave. The value of the slope parameter is irrelevant for this type of filter, we could have set it to anything.
Example Description Status Message Set bandwidth of parametric EQ T01PEQIBT,2,40 on input T, band 2 to 40 T01PEQIBT,2,40 1/100th octaves. T01PEQIBT,1,? T01PEQIBT,1,b, where b is the current setting of the bandwidth parameter for the parametric Query current bandwidth setting EQ on input T, band 1. If the bandwidth of parametric EQ on input T, parameter of this filter is set to the same value band 1. given in the example above, then the status message will be T01PEQIBT,1,40. 8.80.
For filter types that have a center frequency (e.g., parametric), this parameter specifies the center frequency. For filter types that have a cutoff frequency (e.g, highpass, lowpass, etc.), this parameter specifies the cutoff frequency. This command has the same format and restrictions as the PEQIA command except that only one parameter, the frequency, is specified instead of all the parameters. See the PEQIA command for more information.
T01PEQIGT,1,? Query current gain setting of parametric EQ on input T, band 1. T01PEQIGT,1,g, where g is the current setting of the gain parameter for the parametric EQ on input T, band 1. If the gain parameter of this filter is set to the same value given in the example above, then the status message will be T01PEQIGT,1,-20. 8.83.
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 PEQIA command except that only one parameter, the filter type, is specified instead of all the parameters. See the PEQIA command for more information. To set the slope parameter for an output parametric EQ filter, use the PEQOT command. To set all the parameters for an output parametric EQ filter, use the PEQOA command.
Filter Type 1-5 1 2 3 4 5 6 7 = = = = = = = parametric filter low shelf high shelf lowpass highpass Linkwitz-Riley lowpass 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 dB per octave filters Enable 0-1 0 = filter disabled 1 = filter enabled The paramters are specified in the order shown and are separated by commas.
Set the parametric EQ on output , band 2 to the following parameters: type = parametric filter, frequency = 1250 Hz, bandwidth = 40 1/100th octaves, T01PEQOAT,2,1,1250,40,-20,1,1 T01PEQOAT,2,1,1250,40,-20,1,1 gain = -20 dB, enabled = yes, slope = 1 dB per octave. The value of the slope parameter is irrelevant for this type of filter, we could have set it to anything.
Example Description Status Message Set bandwidth of parametric EQ T01PEQOBT,2,40 on output T, band 2 to 40 T01PEQOBT,2,40 1/100th octaves. T01PEQOBT,1,? T01PEQOBT,1,b, where b is the current setting of the bandwidth parameter for the parametric Query current bandwidth setting EQ on output T, band 1. If the bandwidth of parametric EQ on output T, parameter of this filter is set to the same value band 1. given in the example above, then the status message will be T01PEQOBT,1,40. 8.87.
For filter types that have a center frequency (e.g., parametric), this parameter specifies the center frequency. For filter types that have a cutoff frequency (e.g, highpass, lowpass, etc.), this parameter specifies the cutoff frequency. This command has the same format and restrictions as the PEQOA command except that only one parameter, the frequency, is specified instead of all the parameters. See the PEQOA command for more information.
T01PEQOGT,1,? T01PEQOGT,1,g, where g is the current setting of the gain parameter for the Query current gain setting of parametric EQ on output T, band 1. If the gain parametric EQ on output T, band parameter of this filter is set to the same 1. value given in the example above, then the status message will be T01PEQOGT,1,-20. 8.90.
output channel. The different 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 command for more information.
Toggle hook status of phone interface. If the phone was off-hook, then this command puts it on-hook. If the phone was on-hook, then this command takes it off-hook. , where x is either 0 or 1 depending on the current hook status of the phone interface. Query the hook status of phone interface. , where x is either 0 or 1 depending on the current hook status of the phone interface. 8.93.
Example Description Status Message T01PRESETK18 Delete preset number 18. T01PRESETK18 T01PRESETK* Delete all presets. T01PRESETK* 8.95. 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. T01PRESETW18 Now, issuing the command: T01PRESETL18? Will result in a long sequence of status mesages reflecting all the data stored in the preset.
has been previously defined via the PRESETW command. If the specified preset is empty, then an error condition of ERROR#070 will be returned. If one or more of the commands in the preset generated errors, then an error condition of ERROR#072 will be returned. When the PRESETQ command executes, status messages for all of the commands in the preset will not be generated.
Status messages for all the commands in the preset will T01PRESETX18 Execute preset number 18. be generated first, followed by the message: T01PRESETX18 8.100. 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 DIAL command, if the phone is not already off-hook, this command will take it off-hook automatically.
T01SGGAIN6 Set signal generator gain to 6 dB. T01SGGAIN6 T01SGGAINx, where x is the new value of the signal generator gain. If this command T01SGGAIN>3 Increase signal generator gain by 3 dB. was issued after the example above, then the status message would be T01SGGAIN9. T01SGGAIN? T01SGGAINx, 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 T01SGGAIN9. Query signal generator gain. 8.103.
T01SGTYPE? Query current signal generator type. T01SGTYPEx, where x is either 0 or 1 depending on whether the signal generator is currently configured to generate white or pink noise, respectively. 8.105. SOUNDL -- Play Sound Locally 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 SOUNDL command plays sounds through the input from the telephone interface (so they will be heard locally).
0 ascending thirds 1 descending thirds 2 ascending chorus 3 descending chorus 4 ascending doorbell 5 descending doorbell 6 quick double buzz 7 long single buzz The SOUNDL and SOUNDP were originally implemented to allow users to implement custom passcode systems that require users calling in via phone to enter a passcode before entering the conference. The sound commands could be used to provide feedback to the caller as well as the conference.
This command is a boolean command. See Section 6.1 for more information on this type of command. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset. Example Description Status Message T01SSEN1 Enable screen saver. T01SSEN1 T01SSEN0 Disable screen saver. T01SSEN0 T01SSEN2 Toggle screen saver enabled state.
corresponding to the first and second line, respectively. Finally, the text argument is the actual text that will be displayed on the LCD. If the text is '?', then a query will be performed. If the text empty, then the message will be cleared. If both message lines are cleared for a given screen, then that screen will not be displayed by the screen saver. If all screens have been cleared, then the screen saver will never start (although it is easier just to use the SSEN command for this).
hook. A different tone is played whenever the auto-hangup feature puts the phone on-hook. This feature is typically enabled to prevent a caller from entering or exiting a conference unannounced. This command is a boolean command. See Section 6.1 for more information on this type of command. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved and that preset is set to be the power-on preset.
