Command strings, Control ~ RS-232 Port | ClearOne comm XAP 400

Control ~ RS-232 Port

Command strings

By creating command strings, you can use your XAP 400 to control equipment such as lighting, projectors, and room dividers as well as other ClearOne products. A command string is passed to the connected device via the XAP 400’s RS-232 port. You can create up to eight customized serial command strings (limit 80 characters each) in the Command Strings window. To open the Command Strings window, click the Command Strings toolbar button.

Figure 6.8. Command Strings window

91

Figure 6.7. Command

Strings toolbar button

To create a command string

•Type the serial command string (limit 80 characters) in one of the eight locations. The command string will support special characters. See list at right.

To run a command string

•Use any external control device (e.g. Control Panel, GPIO control) to run the STRING serial command.

– or –

•Incorporate the STRING command into a macro which can be run from G-Ware, the front panel, or any external control device.

For information on creating macros, see page 67. For information on GPIO builder, see page 85. For information on Control Panels, see page 87.

Special characters

\a = alert

\b = backspace \f = formfeed \n = new line

\r = carriage return \t = horizontal tab \v = vertical tab

\\ = backslash

Technical Services Group ~ 1-800-283-5936 (USA) ~ 1-801-974-3760

Image 98

ClearOne comm XAP 400 Command strings, Control ~ RS-232 Port, To create a command string, To run a command string

Contents

Audio Products XAP 400 Audio Conferencing System XAP 400 Audio Conferencing System XAP 400 Installation ClearOne Part No July 2002 Rev Table of Contents Iii Advanced Configuration System Configuration Control Operation Appendices Features Introduction Technical Support Professional Services GroupSales and Customer Service ClearOne Communications EuMEA GmbH Product registration Product returns Unpacking Controls and Connections Front panel Rear panel Introduction ~ Controls and Connections Networking Expansion bus Telephone line PowerOperational Requirements Introduction ~ Operational Requirements Equipment placement Environmental Installation Hardware Setup Installation ~ Hardware Setup To connect the unit Expansion bus connections Installation ~ Networking UnitsNetworking Units To create an expansion bus network Device IDs Mixer modeTo select a mixer mode To assign device IDs LCD menu tree Installation ~ LCD ProgrammingLCD Programming Pressing ESC at the top of the tree does nothing System menu To adjust a parameterSelect Preset RS-232 menu Clear Password Installation ~ LCD Programming Flow Control hardwareEnable Modem Meter menu Telco RX OutputsProcessing Telco TX Outputs menu Default MeterInputs menu Mute Matrix Technical Services Group ~ 1-800-283-5936 USA ~ Windows ME Ware RequirementsWindows Windows NT Creating floppy disk copies Installing G-WareTo install G-Ware Creating a new site Site SetupControl using To create a new site To manually add units Adding a XAPTo auto-detect units File menu Configuring Unit Properties To configure Unit Properties 14. Unit Properties Security tab Ware Screens Flow Screen Status bar Copying and pasting settingsSafety Mute System Configuration ~ G-Ware Screens Matrix Screen Process A-D routing Audio RoutingExpansion bus O-Z routing Cross point attenuation System Configuration ~ Audio Routing Matrix report Inputs and Outputs Inputs PA Adapt and AEC Reference Pwr Phantom PowerTarget To create a virtual reference Click Close to exit the window Meters FiltersNon-linear Processing NLP Active Filter Type 33. Inputs 1-4 Filters window To configure filters Table View Activation PA Adaptive ModeGate Chairman Override Off Attenuation Gate RatioHold Time Ambient Level 39. Virtual Reference window To assign a gating group To configure gating group settingsGating Group Select Click the Gating Group label to change the group names Min/Max limits Meters AGC 48. Gain meters Outputs NOM Optimizing output gain structure To Expansion Bus O-Z Expansion BusesFrom Expansion Bus O-Z Cmprs compressor ProcessingProcessing A-D Threshold GroupPost Compressor Gain Release RatioAttack Input meter Add Filter PhaseBypass Remove Filter Delay Changes you make in the distance and temperature fields 58. Process Gain adjust and meter Optimizing process gain structure Click the Telco Config button on the XAP 400 Flow Screen Telco SetupTo configure telco settings Have System Configuration ~ Telco Setup Telco Transmit System Configuration ~ Telco Transmit and ReceiveTelco Transmit and Receive Signal-to-noise ratio without clipping the signal Green button light illuminates when ALC is enabledFrom 6dB to 15dB. Default is 6dB Telco Receive Overview PresetsCreating Presets Matrix Screen Preset Configuration panePreset password is set in the Unit Properties window see Advanced Configuration ~ Presets To enable Acoustic Echo Assigning virtual references to the preset To create a preset Storage space To run a preset using G-Ware Running presetsRunning multiple presets simultaneously To run a preset using front panel control All presets are ready to run again Room combining example Four macros one for each configuration are set up as follows Creating macros To create a macro using Macro RecorderMacros To create a macro using Macro Editor 16 Macro Name window To edit a macro To add or insert a command lineEditing macros To delete a macro Use the macro command. See Control for more details To run a macro using front panel controlTo run a macro using the Select panel or Gpio Running macros To make and disconnect a call Using the XAPTo answer a call Audible Ring Indication To mute Using the Dial InterfaceTo dial multiple numbers Telephone line Operation ~ Using the Dial Interface Touch-tone dialing Operation~ Utilities Signal GeneratorUtilities To use pink or white noise Document Compare Utility Operation ~ Utilities To compare site files Open window Copying settings Print Preview window Copy and paste settings Print Reports Toolbar To upgrade firmwareGFirm Firmware Utility Button 15. Selecting baud rate Message Log Ware SwitcherTo use G-Ware Switcher Meter Views Monitoring ViewsGate View Operation~ Monitoring Views To configure Meter ViewsTelco meters Telco Echo Return Loss Terl Transmit Input Telco Echo Return Loss Enhancement TerleTotal Telco Echo Reduction Transmit Output Control/Status a To program control/status pinsGpio Builder Remote Builder XAP IR Remote Control ~ Remote Builder To program the XAP IR Remote Select IR Remote default from the Select Remote Type listClearOne Control Panels To program the Volume panel One IR remote can be Control ~ Remote Builder To program the Select panel RS-232 Port Remote Modem AccessSerial commands To run a command string Command stringsTo create a command string Control ~ RS-232 Port Technical Services Group ~ 1-800-283-5936 USA ~ Appendix a Specifications Appendices Appendices ~ Appendix a Specifications Appendices ~ Appendix B Pinouts Appendix B PinoutsRS-232 COM DCE port pinout female Pin Number Control Pin Definable Type Default Description Control/Status connectorsFirst 16 pins on Control/Status a Port Pinout female Control/Status B port pinout Preset select bitPreset select status for Pin Line connector pinout RS-485 Remote Panel a and B connectorsSet connector pinout Pin Description Appendices ~ Appendix C Control Panel Connecting the Control PanelAppendix C Control Panel 100 Appendices ~ Appendix C Control Panel Accessory ClearOne Part Number Appendix D AccessoriesAppendices ~ Appendix D Accessories 101 102 Appendix E Serial CommandsCommand structure Conventions Groups and channels Appendices ~ Appendix E Serial Commands103 Type and device IDs 104 Meter type definitions Serial command error codesError number Text message Explanation/Solution 105 XAP 400 Serial commandsCommand Function 106 107 AA Auto-Answer Enable/ DisableAamb Adaptive Ambient Mode Aconn Audible Connect / Disconnect Indication 108 AD Auto-Disconnect Enable/ DisableAEC Acoustic Echo Canceller Enable/Disable Aconnlvl Audible Connect/Disconnect Level AGC Automatic Gain Control Agcset Automatic Gain Control Adjust109 Channel See Groups and Channels on 7,I,M,L Value ALC Automatic Level Control Amblvl Ambient Level Adjust110 Baud Baud Rate Cgroup Compressor Group Select Chairo Chairman Override Mode111 Compsel Compression Select Compress Compressor Adjust112 Gain of 3dB 113 Decay Decay AdjustDelay Delay Adjust Country Country Selection 114 Delaysel Delay SelectDfltm Default Meter Dial Dtmf Dialing Did Device ID Command form Channel115 Dspver DSP Version Dtonelvl Dial Tone Level Filter Filter Adjust116 Name Description Units Flow Flow Control 117Filtsel Filter Select Examples FPP Front Panel Passcode FMP First Mic Priority Mode118 Button assignment Gate Gate Status Gain Gain Adjustment119 Channel See Groups and Channels, L, M, P, R, T Value 120 GHOLD- Gate Hold Time AdjustGmode Gating Mode Gover Gating Override Greport Gate Report Gratio Gate Ratio Adjust121 Grpsel Gating Group Select Hookd Hook Flash Duration 122Hook Hook Flash Label Label 123 LMO Last Mic On ModeLock Preset and Macro Lock LFP Lock Front Panel 124 Lockprst Apply the lock to a preset or macroLockpwd Set preset/macro password LVL Level Lvlrrate Level Report Rate 125Lvlreport Level Report = Toggle 126 Master Expansion Bus Master ModeMAX Maximum Gain Setting Macro Macro Execution/Reporting Command form Device Mdmode Value Mdmode Modem ModeMIN Minimum Gain Setting 127 Minit Modem Initialization String Minmax Minimum and Maximum Gain Setting128 Command Mline Mic/Line AdjustMpass Modem Password 129 Mtrx Matrix Mtrxlvl Matrix Attenuation Adjustment130 SRC = source Dest = destination Chnl = channel GRP = group 131 NCD Noise Cancellation DepthNcsel Noise Cancellation Select Mute Mute 132 NLP Non-Linear Processing AdjustNOM Number of Open Microphones Mode Null Null the line PP Phantom Power Offa Off Attenuation ModePAA PA Adaptive Mode Command Channel Select mic input Value Prgstring Program String Preset Preset Execution/Reporting134 Supported special characters Redial Dial the last number again Ramp Ramp Gain Adjustment135 Name Description Unit Refsel PA/AEC Reference Select Refset Reference channel setup136 Ring Ring Indication Ringerlvl Audible Ring Level 137Ringer Audible Ring Selection Rxboost Receive Boost Rxrd Telco Receive Reduction Rxbsten Receive Boost Enable138 Serecho Serial Echo Siggen Signal Generator Sermode Serial ModeSftymute Safety mute 139 140 Sigtout Signal Generator Time OutSlvl Speech Level Control Enable/Disable Speeddial Speed Dialing Storedial Store a Number as a Speed Dial Tamode Telco Adapt Mode141 String String Execution Terl Telco Echo Return Loss TE Telco Enable142 Terle Telco Echo Return Loss Enhancement UID Unit ID 143Tout Time Out Select VER Version Appendix F Warranty 144 Appendices ~ Appendix F Warranty 145 FCC Part 15 Compliance 146Appendix G Compliance FCC Part 68 Compliance Appendices ~ Appendix G Compliance 147IC Compliance EC Declaration of Conformity Safety Information European Compliance148 149 Telecommunications Terminal Equipment Glossary 150Glossary 151 152 153 Ware Software The XAP 400’s setup and configuration software 154 155 156 Required to allow remote modem access 157 Signal Delay Used for 158 159 33-35 160Index 161 Index 162 NOM Frequency response Phase 163 164 165