Polycom RS-232 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

Go to page of

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Polycom RS-232, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Polycom RS-232 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Polycom RS-232. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Polycom RS-232 should contain:
- informations concerning technical data of Polycom RS-232
- name of the manufacturer and a year of construction of the Polycom RS-232 item
- rules of operation, control and maintenance of the Polycom RS-232 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Polycom RS-232 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Polycom RS-232, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Polycom service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Polycom RS-232.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Polycom RS-232 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    Installed Voice Business Group RS-232 Command Set: Vortex EF2211 Programming Guide Copyright © 2003 Polycom, Inc. Polycom  and the Polycom logo are registered trademar ks of Polycom, Inc. ASPI, Vortex, VS4000, Viewstation, and iPower are registered trademarks of Polycom, Inc. All other brand names, product na mes, and trademarks are the sole pr[...]

  • Page 2

    Vortex EF2211 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.[...]

  • Page 3

    8.14. AMCHAIR -- Enable Chairman Mode for Specified Automixer 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 Autom[...]

  • Page 4

    8.59. GAINO -- Set Output Gain 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. ID -- Set Device ID 8.67. LABEL -- Set or Query one of t[...]

  • Page 5

    8.104. MINISTR -- Set Modem Initialization String 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. NCL -- Set Noise Cancellation Attenuation 8.111. NVIN[...]

  • Page 6

    8.149. SSTEXT -- Set Text to be Displayed by Screen Saver 8.150. SWRESET -- Perform Soft Reset of System 8.151. SWVER -- Query Software Version 8.152. TONEE -- Enable or Disable Entry and Exit Tones 8.153. TONER -- Enable or Disable Ring Tones 8.154. VTXMODI -- Enable VTX Mode on Specified Inputs 8.155. VTXMODO -- Enable VTX Mode on Specified Input[...]

  • Page 7

    3.2. 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[...]

  • Page 8

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

  • Page 9

    A single alphanumeric character is used to indicate the device type. The devices in Polycom's EchoFree family have the following device types. 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 [...]

  • Page 10

    chosen as the terminator to allow manually typing commands using a simple text terminal. 4.6. Examples 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[...]

  • Page 11

    6.1. Boolean Commands Boolean commands take one of the three following arguments. ● ' 0 ' indicates that the parameter should be turned off. ● ' 1 ' indicates that the parameter should be turned on. ● ' 2 ' indicates that the parameter should be toggled (i.e., ' 0 ' becomes ' 1 ' and ' 1 [...]

  • 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 &apos[...]

  • Page 13

    Queries using the ' ? ' character are straightforward. For example, ' S04GAINI1? ' might return ' S04GAINI110 ', while ' S04GAINI*? ' might return ' S04GAINI*Äää '. 6.4. Matrix Commands Matrix commands are used for controlling parameters that exist at the crosspoints of the mixing matrices. Typic[...]

  • Page 14

    tied to output 1. Thus the signal routed to output 1 will also be routed to the power amplifier output. 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, [...]

  • 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 defi[...]

  • Page 16

    It is also possible to use the wildcard character (' * ') to specify ranges of crosspoints with the matrix commands. The only restriction is that you can only use a wildcard to specify the input or output, but not both simultaneously. Thus you could specify all the inputs going to a specific output (one column) or the value of an input to[...]

  • 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. Global parameters are written t[...]

  • Page 18

    AMNOM Preset Set Local Maximum Number of Open Mics for Automixer AMNOMAT Preset Select NOM Attenuation on Each Output AMOFFAT Preset Set Off Attenuation for the Specified Automixer AMPRIOR Preset Set Gating Priority for the Specified Mic AMREFB Preset Set Automixer Reference Bias for the Specified Automixer AMREFE Preset Enable Automixer Reference [...]

  • Page 19

    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 GATE - Query Gating Status Information GATEEN Preset Enable Automatic Gating Messages GMUTEO Preset Mute All Outputs ID Global Set Device ID LABEL Global Set or Query one[...]

  • Page 20

    MACROA - Add Command to Current Macro MACROK Global Delete One or All Macros MACROL - List All Commmands in a Macro MACROQ - Execute Macro Quietly MACROS - Start a New Macro MACROW Global Write Macro to Non-Volatile Memory MACROX - Execute Macro METER Preset Select which Signal is Displayed on the Front Panel LED Meter MGAIN Preset Set Crosspoint G[...]

  • Page 21

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

  • Page 22

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

  • Page 23

    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 S01AEC11 Enable AEC on input channel 1. S01AEC11 S01AEC10 Disable AEC on input channel 1. S01AEC10 S01AEC12 To[...]

  • Page 24

    channels 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 '). This command is a channel boolean command. See Section 6.3 an[...]

  • Page 25

    S01AGCMAXT? Query the AGC maximum gain on input channel T . S01AGCMAXTx where x is a number between 0 and 15, depending on the current setting of the AGC maximum gain on input channel T . 8.7. AGCMIN -- Set Minimum Allowed Mic/Line Input AGC Gain This command sets the minimum gain that the AGC can apply on input channels 1 and T (the telephone inpu[...]

  • Page 26

    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 S01AGCRATE13 Set AGC ramp rate on input channel 1 to 3 dB/sec. S01AGCRATE13 S01AGCRATET? Query the AGC ramp ra[...]

  • Page 27

    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. The AHCP command controls the call progress auto hangup feature. The AHLD command controls the loop drop auto hangup feature. These two features are co[...]

  • Page 28

    8.12. AMAUTO -- Select Automatic or Manual Gating for each Automixer Input This command selects or queries the state of automatic or manual automixer gating thresholds for the specified input channel. Automatic thresholds mean that the automixer adaptively determines the gating thresholds based on current speech and noise levels using the gating ra[...]

  • Page 29

    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 8, respectively. This command is saved to non-volatile memory only as part of a preset. The state of this command will be restored after power-up only if a preset is saved[...]

  • Page 30

    8.15. AMCHNUM -- Set Chairman Mic This command sets the chairman microphone for the automixer. The first argument of the command specifies the automixer number (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 us[...]

  • Page 31

    S01AMDECAY>500 Increase automixer decay time by 500 ms. S01AMDECAYx , where x is between 0 and 5000 depending on the current AMDECAY setting. If this command is issued after the above example, then the status message will be S01AMDECAY? Query automixer decay time. S01AMDECAYx , where x is between 0 and 5000 depending on the current AMDECAY setti[...]

  • Page 32

    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 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 sav[...]

  • Page 33

    S01AMGATET1>3 Increase gate threshold for manual gating threshold by 3 dB for input channel 1. S01AMGATET1x , where x is between 0 and 100 depending on the current setting of the gate threshold for input channel 1. If this command is issued after the example above, then the status message will be S01AMGATET315 . S01AMGATET1? Query gate threshold[...]

  • Page 34

    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 0 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 saved and that preset is [...]

  • Page 35

    S01AMLMM10 Disable "last mic on" mode for automixer 1. S01AMLMM10 S01AMLMM11 Set "last mic on" mode to manual for automixer 1. S01AMLMM11 S01AMLMM12 Set "last mic on" mode to automatic for automixer 1. S01AMLMM12 S01AMLMM1? Query the current setting of "last mic on" mode for automixer 1. S01AMLMM1x , where x [...]

  • Page 36

    for Automixer This command sets the local maximum number of open mics (NOM) allowed for the specified automixer. The NOM limit is a local limit, meaning that this limit applies only to the specific Vortex that is is set on. In contrast, the AMGNOM command is a global limit that applies to all linked Vortex automixers with the same AMBUSID . The fir[...]

  • Page 37

    S01AMNOMAT11 Enable NOM attenuation on output 1 . S01AMNOMAT11 S01AMNOMATA0 Disable NOM attenuation on output A. S01AMNOMATA0 S01AMNOMATT2 Toggle NOM attenuation status on output T (telephone output) . S01AMNOMATTx , where x is either 0 or 1 depending on the current mute status of NOM attenuation on the ouptut. S01AMNOMATB? Query NOM attenuation st[...]

  • Page 38

    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 S01AMOFFAT118 Set off attenuation for automixer 1 to 18 dB. S01AMOFFAT118 S01AMOFFAT1? Query current off atten[...]

  • Page 39

    Even though this is a channel integer command, use of the wildcard character for the automixer number is not supported. 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 20, respectively. This command is saved to non-vola[...]

  • Page 40

    S01AMREFE11 Enable automixer reference mode for Automixer 1. S01AMREFE11 S01AMREFE1? Query current setting of automixer reference mode for Automixer 1. S01AMREFE1x , where x is 0 or 1 depending on the current setting of automixer reference mode for Automixer 1. 8.30. BAUD -- Set Baud Rate for RS-232 Port This command sets the baud rate for the rear[...]

  • Page 41

    S01BLAUTO? Query enabled status of automatic BLDATA messages. S01BLAUTOx , where x is 0 or 1 depending on the current setting of BLAUTO . 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[...]

  • Page 42

    translate to AEC states. Byte Value AEC State Value (Byte Value - 132) AEC State Description 132 0 Idle 133 1 Transmit 134 2 Receive 135 3 Double Talk 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 è = 0x8A = 138 → 13[...]

  • Page 43

    The last byte (ä) consists of only one value. ä = 0x84 = 132 → 132 - 132 = 0 = Idle So, we know that the AEC on input 1 is in idle mode. In the above description, the data in the BLDATA command consists of 13 bytes (4 input levels + 5 output levels + 1 AEC reference level + 1 room gain level + 1 AGC gain level + 1 AEC state). It is possible to [...]

  • Page 44

    Voice Business Group in Atlanta. Example Description Status Message S01BROAD2:ATDT4048921180 Sends the string ATDT4048921180 out the RS- 232 port. S01BROAD2 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 comm[...]

  • Page 45

    Example Description Status Message Put AEC Reference 1 (R1) on the EF Bus. Set Vortex to not place any AEC reference on the EF Bus. S01BUSREF? Query which AEC reference this Vortex is placing on the EF Bus. , where x is 0 or 1 depending on which AEC reference (if any) is currently being placed on EF Bus. 8.37. CGATE -- Query Camera Gating Status In[...]

  • Page 46

    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 S01CGATEEN0 Disable automatic camera gating messages. S01CGATEEN0 S01CGATEEN1 Enable automatic camera gating m[...]

  • Page 47

    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 loo[...]

  • Page 48

    S01DELAYOB1500 Set output delay on output channel B to 150 ms (1500 tenths of milliseconds). S01DELAYOB1500 S01DELAYOB>1700 Increase output delay on output channel B by 170 ms (1700 tenths of milliseconds.) S01DELAYOBx , where x is between 0 and 3400 depending on the current output delay setting for output channel B . If this command is issued a[...]

  • Page 49

    S01DELAYOE*0110 Enable output delay on outputs A and B, and disable output delay on outputs 1 and T. S01DELAYOE*0110 S01DELAYOE*2 Toggle enabled status of output delay on all outputs. S01DELAYOE*abcd , where each of the letters (a, b, etc.) is either 0 or 1 depending of the current enabled status of the output delay on the corresponding output. If [...]

  • Page 50

    S01DSPAUTO? Query the value of the DSPAUTO parameter. S01DSPAUTOx , where x is 0 or 1 depending on the current setting of the DSPAUTO paramter. 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 varia[...]

  • Page 51

    ERROR#043 This error occurs as the result of an AMLMN command. It happens when the command attempts to set a "last mic on" number that does not belong to the specified automixer while "last mic on" mode is set to manual. ERROR#044 This error occurs as the result of an AMCHAIR command. It happens when the command tries to enable [...]

  • Page 52

    ERROR#092 This error indicates an EF Bus ID conflict. See the Vortex user manual for information on valid device IDs. ERROR#093 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 BUSREF command to remove the extra reference(s) in order to resolve the confli[...]

  • Page 53

    S01FADERGIL>3 Increase fader gains on all line inputs by 3 dB. S01FADERIAa S01FADERIBb , where a and b are the new values of the fader gains for each of the line inputs. If this command was issued after the example above, then the status messages would be: S01FADERIA10 S01FADERIB10 . S01FADERGIL? Query fader gains on all line inputs. S01FADERIAa[...]

  • Page 54

    S01FADERIA? Query the fader gain on input A. S01FADERIAx , where x is a number between 0 and 30, depending on the current setting of the fader gain on input channel A. S01FADERI*6 Set fader gain on all inputs (1, A, B, T) to 6 dB. S01FADERI*èèèè S01FADERI*ìääì Set fader gain on input channels A and B to 0 dB and gain on input channels 1 and[...]

  • Page 55

    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 a[...]

  • Page 56

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

  • Page 57

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

  • Page 58

    This command sets the gain of the dial tone received from the phone interface. 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 comman[...]

  • Page 59

    S01GAINGIL>3 Increase incoming gain on all line inputs by 3 dB. S01GAINIAa S01GAINIBb , where a and b are the new values of each of the line inputs. If this command was issued after the example above, then the status messages would be: S01GAINIA10 S01GAINIB10 . S01GAINGIL? Query gains on all line inputs. S01GAINIAa S01GAINIBb , where a and b are[...]

  • Page 60

    Example Description Status Message S01GAINIA10 Set gain on input A to 10 dB. S01GAINIA10 S01GAINIA? Query the gain on input A. F01GAINI2xB01GAINITxS01GAINIAxQ01GAINIAxT01GAINITx , where x is a number between 0 and 30, depending on the current setting of the gain on input channel A. S01GAINI*6 Set gain on all inputs (1, A, B, T) to 6 dB. S01GAINI*è[...]

  • Page 61

    S01GAINO*äììä Set gain on output channels 1 and T to 0 dB, and gain on output channels A and B to 9 dB. S01GAINO*äììä S01GAINO*? Query gain settings on all output channels (1, A, B, T) . S01GAINO*abcd , where a - d are each between <space> and ÿ , depending on the current setting of the gains for each of the ten output channels (1, A[...]

  • Page 62

    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 S01GAINSIT6 Set tone output gain to 6 dB. S01GAINSIT6 S01GAINSIT>3 Increase tone output gain by 3 dB. S01GAINSITx where x is the new value of the tone output gain. If this command was issued after the exa[...]

  • Page 63

    status of all the microphone inputs. On the EF2211 and EF2210, there is only one microphone, so the wildcard character is of limited use. The GATEEN can be used to have gating information sent automatically instead of having to poll this command. Also see the CGATE command, which only reports microphones that have been gated on for a specified hold[...]

  • Page 64

    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" feature. The ide[...]

  • Page 65

    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 Description D A label for the device itself. SG A label for the signal generator. I1, IA, IB, IT Labels for the input channels. O1, OA, OB, OT L[...]

  • Page 66

    This command was introduced in firmware version 2.5.0. 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 [...]

  • Page 67

    preset. Example Description Status Message S01LAGCLINKAB1 Enable stereo AGC linking on inputs A and B. S01LAGCLINKAB1 S01LAGCLINKAB0 Disable stereo AGC linking on inputs A and B. S01LAGCLINKAB0 S01LAGCLINKAB2 Toggle stereo AGC linking on inputs A and B. S01LAGCLINKABx , where x is 0 or 1 depending on the current state of stereo AGC linking on input[...]

  • Page 68

    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 Section 6.3 and Section 6.2 for more information on this type of command. The minimum and maximum values for this command are -15 and 0[...]

  • Page 69

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

  • Page 70

    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. It will retain its value after power-down. Since th[...]

  • Page 71

    S01LIA4,MUTEI11 Assign the command MUTEI11 to occur when logic input pin 4 changes from the inactive to active state. The MUTEI11 mutes input channel 1 S01LIA4,MUTEI11 S01LIA5,MACROX23 Assign the command MACROX23 to occur when logic input pin 5 changes from the inactive state to the active state. The MACROX23 command executes macro 23, which can co[...]

  • Page 72

    This function assigns a single command to be executed when a given logic input changes from the active state to the inactive state. Typically, the inactive state is logic high ('1') and the active state is logic low ('0'). This is commonly referred to as active low. Acitve low is considered normal because a closed switch would g[...]

  • Page 73

    MACROQ command. Since up to 256 commands can be stored in each macro, this gives the effect of having up to 256 commands execute when the logic pin changes state. The command associated with the state change can also be a PRESETX or PRESETQ . This makes it easy to reconfigure the device for different rooms based on external logic settings. The BROA[...]

  • Page 74

    Example Description Status Message S01LIEN1 Enable automatic logic input status messages. S01LIEN1 S01LIEN0 Disable automatic logic input status messages. S01LIEN0 S01LIEN2 Toggle automatic logic input status messages. S01LIENx , where x is 0 or 1 depending on the current setting of LIEN . S01LIEN? Query automatic logic input status messages. S01LI[...]

  • Page 75

    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 LIH will be deleted for the specified logic input. A wildcard character can also be specified for the logic input pin, in which case the commands for[...]

  • Page 76

    S01LIM100101101111011111111111 Mask (disable) logic inputs 2, 3, 5, 8, and 13. S01LIM100101101111011111111111 S01LIM? Query current logic input mask. S01LIMabcdefghijklmnopqrstuvwx where a - x are each 0 or 1 depending on the current state of the logic input mask. 8.83. LIN -- Assign Command to Logic Input Group This command assigns a command to be[...]

  • Page 77

    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 LIH commands. If a logic input pin's 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 sav[...]

  • 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[...]

  • Page 79

    S01LOA10,MUTEI*1+-. Configure the conditions for activation of logic output 10 as described in the example above. S01LOA10,MUTEI*1+-. S01LOA7, Delete conditions for activation of logic output 7. 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 pi[...]

  • Page 80

    S01LOEN? Query automatic logic output status messages. S01LOENx , where x is 0 or 1 depending on the current setting of LOEN . 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 LOA and LOD will be deleted for the [...]

  • Page 81

    Example Description Status Message S01LOM10010110111101111111 Mask (disable) logic outputs 2, 3, 5, 8, and 13. S01LOM10010110111101111111 S01LOM? Query current logic output mask. S01LOMabcdefghijklmnopqrst , where a - t are each 0 or 1 depending on the current state of the logic output mask. 8.91. LOP -- Set Polarity for Logic Outputs This command [...]

  • Page 82

    ● 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 com[...]

  • Page 83

    S01MACROK* 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 S01MACROA112,MUTEO*0 S01MACROW1[...]

  • Page 84

    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. If this command is sent while another macro is in the process of being written (before the MACROW command is sent), then the macro in progress will be deleted and the new one[...]

  • Page 85

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

  • Page 86

    S01MGAINWB0,WM0,-3 Set crosspoint gain in EF Bus submatrix on crosspoint that routes the W bus signal from the device at ID0 (WB0) to W submatrix output 0 (WM0). S01MGAINWB0,WM0,-3 S01MGAIN1,*,ä{{èäÇÇÇÇÇ Set all crosspoint gains for input channel 1. Set the gain to output 1 to 0 dB ( ä ), the gain to outputs A-B to -9 dB ( { ), the gain to[...]

  • Page 87

    This command is a matrix boolean command. See Section 6.4 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 Statu[...]

  • Page 88

    S01MIC1? Query enabled status of microphone gain stage for input channel 1. S01MIC1x , where x is 0 or 1 depending on the current enabled state of the microphone gain stage on 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 , th[...]

  • Page 89

    Example Description Status Message S01MINISTRATF1E0&B1S0=2 Set modem initialization string to ATF1E0&B1S0=2 . S01MINISTRATF1E0&B1S0=2 S01MINISTR? Query current modem initialization string. S01MINISTR<string> , where <string> is the current modem initialization string. If this command was sent after the above example, then th[...]

  • Page 90

    S01MMUTE1,*,0110100000 Set all crosspoint mutes for input channel 1. Mute the paths from input 1 to outputs A, B, and P and unmute the paths from input 1 to outputs 1, T, R1, and W-Z. S01MMUTE1,*,0110100000 S01MMUTEA,*,0 Unmute all crosspoints for input channel A . S01MMUTEA,*,0000000000 S01MMUTEA,*,2 Toggle all crosspoint mutes for input channel A[...]

  • Page 91

    S01MUTEGIL2 Toggle mute status of all line inputs. S01MUTEIAa S01MUTEIBb , where a and b reflect the mute status ( 0 or 1 ) of each of the line inputs. If this command was issued after the example above, then the status messages would be: S01MUTEIA0 S01MUTEIB0 . S01MUTEGIL? Query the mute status of all the line inputs. S01MUTEIAa S01MUTEIBb , where[...]

  • Page 92

    S01MUTEI*2 Toggle mute status of all inputs. S01MUTEI*abcd , where each of the letters (a, b, etc.) is either 0 or 1 depending of the current status of the mute on the corresponding input. If this command was sent after the example above, then the status message would be S01MUTEI*0110 . S01MUTEI*? Query mute status of all inputs. S01MUTEI*abcd wher[...]

  • Page 93

    S01MUTEO*? Query mute status of all outputs. S01MUTEO*abcd , where each of the letters (a, b, etc.) 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 S01MUTEO*0110 8.109. NC -- Enable Noise Cancellation This command sets or que[...]

  • Page 94

    cancel 10 dB of noise. Higher numbers mean more cancellation will be applied, but may result in slight artifacts depending on the characteristics of the noise. Typical settings are 10 dB for normal cancellation and 6 dB for light cancellation. When the wildcard character, ' * ', is used to specify the channel in this command, it only affe[...]

  • Page 95

    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

    S01NVPSWD? Query the current non-volatile memory password. S01NVPSWDlemur 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 i[...]

  • Page 97

    Parametric (1) Yes Yes Yes No Low Shelf (2) No 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 valu[...]

  • Page 98

    S01PEQIAB,1,? Query the current parameter settings for the parametric eq filter on input B , band 1. S01PEQIAB,1,t,f,b,g,s,e , where the parameters t , f , b , g , s , and e correspond to the current settings of the type, frequency, bandwidth, gain, slope, and enabled parameters, respectively. If this filter was set to the same parameters as given [...]

  • Page 99

    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 PEQIA command except that only one parameter, the enabled status, is specified instead of all the parameters. See the PEQIA command for m[...]

  • Page 100

    S01PEQIF1,2,1250 Set frequency of parametric EQ on input 1 , band 2 to 1250 Hz. S01PEQIF1,2,1250 S01PEQIFB,1,? Query current frequency setting of parametric EQ on input B , band 1. S01PEQIFB,1,f , where f is the current setting of the frequency parameter for the parametric EQ on input B , band 1. If the frequency parameter of this filter is set to [...]

  • Page 101

    (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[...]

  • Page 102

    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. This command is saved to non-volatile memory only as part of a [...]

  • Page 103

    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 disabled 1 = filter enabled 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 se[...]

  • Page 104

    S01PEQOA1,2,1,1250,40,-20,1,1 Set the parametric EQ on output 1 , band 2 to the following parameters: type = parametric filter, frequency = 1250 Hz, bandwidth = 40 1/100th octaves, 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. S01PEQOA[...]

  • Page 105

    preset. Example Description Status Message S01PEQOB1,2,40 Set bandwidth of parametric EQ on output 1 , band 2 to 40 1/100th octaves. S01PEQOB1,2,40 S01PEQOBB,1,? Query current bandwidth setting of parametric EQ on output B , band 1. S01PEQOBB,1,b , where b is the current setting of the bandwidth parameter for the parametric EQ on output B , band 1.[...]

  • Page 106

    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 f[...]

  • Page 107

    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 S01PEQOG1,2,-20 Set the gain of the parametric EQ on output 1 , band 2 to -20 dB. S01PEQOG1,2,-20 S01PEQOGB,1,[...]

  • Page 108

    S01PEQOSB,1,? Query current slope setting of parametric EQ on output B , band 1. S01PEQOSB,1,s , where s is the current setting of the slope parameter for the parametric EQ on output B , band 1. If the slope parameter of this filter is set to the same value given in the example above, then the status message will be S01PEQOSB,1,1 . 8.127. PEQOT -- [...]

  • Page 109

    S01PEQOT1,2,1 Query current type setting of parametric EQ on output B , band 1. S01PEQOTB,1,t , where t is the current setting of the type parameter for the parametric EQ on output B , band 1. If the type parameter of this filter is set to the same value given in the example above, then the status message will be S01PEQOTB,1,1 . 8.128. PHANTOM -- E[...]

  • Page 110

    S01PHONE2 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. S01PHONEx , where x is either 0 or 1 depending on the current hook status of the phone interface. S01PHONE? Query the hook status of phone interface. S01PHONEx , where x is eit[...]

  • Page 111

    Example Description Status Message S01PRESETK18 Delete preset number 18. S01PRESETK18 S01PRESETK* Delete all presets. 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, issu[...]

  • Page 112

    This command executes the preset corresponding to the specified number, which must be between 0 and 47. The preset must either be a pre-defined factory preset (0 - 15) or a user preset (16 - 47) that has been previously defined via the PRESETW command. If the specified preset is empty, then an error condition of ERROR#070 will be returned. If one o[...]

  • Page 113

    Example Description Status Message S01PRESETX18 Execute preset number 18. Status messages for all the commands in the preset will be generated first, followed by the message: S01PRESETX18 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 dig[...]

  • Page 114

    This command sets the effective output gain of the corresponding AEC reference. When doing volume control of room speakers, it is a good idea to adjust this reference gain along with the speaker output gain so that the AEC is aware of any volume changes. This will help prevent short echoes when volume changes are made. There are two AEC references [...]

  • Page 115

    S01RING1 Enable auto answer mode. S01RING1 S01RING0 Disable auto answer mode. S01RING0 S01RING2 Toggle auto answer mode. S01RINGx , where x is 0 or 1 depending on the current state of auto answer mode. S01RING? Query auto answer mode. S01RINGx , where x is 0 or 1 depending on the current state of auto answer mode. 8.141. SGGAIN -- Set Gain of Signa[...]

  • Page 116

    S01SGMUTE2 Toggle mute on signal generator. S01SGMUTEx , where x is 0 or 1 depending on the current state of the signal generator mute. S01SGMUTE? Query signal generator mute. S01SGMUTEx , where x is 0 or 1 depending on the current state of the signal generator mute. 8.143. SGTYPE -- Set Type of Signal Produced by Signal Generator This command sets[...]

  • Page 117

    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. Example Description Sta[...]

  • Page 118

    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 Section 6.2 for more information on this type of command. The minimum and maximum values for this command are 500 and 600000, respectively. This command is saved to non-volatile memory only as pa[...]

  • Page 119

    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 Section 6.2 for more information on this type of command. The minimum and maximum values for this command are 500 and 600000, respectively. This command is saved to non-v[...]

  • Page 120

    S01SSTEXT0,1,? Query the text of the second line of the first screen. S01SSTEXT0,1,<string> , where <string> is the text of the second line of the first screen. If this command was issued after the example above, then the status message would be S01SSTEXT0,1,funky music . 8.150. SWRESET -- Perform Soft Reset of System Executing this com[...]

  • Page 121

    S01TONEE2 Toggle enabled status of entry and exit tones. S01TONEEx , where x is 0 or 1 depending on the current enabled state of entry and exit tones. S01TONEE? Query enabled state of entry and exit tones. S01TONEEx , where x is 0 or 1 depending on the current enabled state of entry and exit tones. 8.153. TONER -- Enable or Disable Ring Tones This [...]

  • Page 122

    S01VTXMODIB0 Disable VTX mode on input B. S01VTXMODIB0 S01VTXMODIB2 Toggle status VTX mode on input B. S01VTXMODIBx , where x is either 0 or 1 depending on the current status of VTX mode on input B. S01VTXMODIA? Query status of VTX mode on input A. S01VTXMODIAx , where x is either 0 or 1 depending on the current status of VTX mode on input A. S01VT[...]

  • Page 123

    S01VTXMODOA? Query status of VTX mode on output A. S01VTXMODOAx , where x is either 0 or 1 depending on the current status of VTX mode on output A. S01VTXMODO*1 Enable VTX mode on outputs 1, A-B. S01VTXMODO*111 S01VTXMODO*0 Disable VTX mode on outputs 1, A-B. S01VTXMODO*000 S01VTXMODO*100 Enable VTX mode on output 1 and disable VTX mode on output A[...]