ClearOne comm XAPTM 800 96, Meter type definitions, Serial command error codes

Appendices ~ Appendix E: Serial Commands

96

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

Meter type definitionsSerial command error codes

Error number Text message Explanation/Solution

1 Memory error The box is out of internal memory. Power cycle the box.

2 No command found A command was not found in the string.

3 Unknown command A command was executed on a different device type that this box

response cannot display. The command dictionary needs to be updated.

4 Not implemented The command is not implemented.

5 Argument error The command had an argument that was out of range.

6 Unknown command The command is unknown to this unit.

7 Bad checksum The binary command’s checksum is wrong.

8 Preset of macro invalid A preset or macro failed to program because it is too large or

because its comand list contained an invalid command.

10 Queue error The internal command queue is full. Enable flow control and use

all five pins on the serial port.

11 Command too big The binary command is too large.

12 Unit is locked Unlock the unit with the proper password.

Contents

Main ii iii XAP 800 Installation and Operation Manual Table of Contents CHAPTER 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . .1 CHAPTER 2: Installation . . . . . . . . . . . . . . . . . . . . . . . . .9 iv CHAPTER 3: System Configuration . . . . . . . . . . . . . . . . . .21 CHAPTER 4: Advanced Configuration . . . . . . . . . . . . . . . . .55 v CHAPTER 5: Operation . . . . . . . . . . . . . . . . . . . . . . . . . . .67 CHAPTER 6: Control . . . . . . . . . . . . . . . . . . . . . . . . . . . .77 APPENDICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85 Page CHAPTER 1: Introduction Product overview Introduction ~ New Features 2 New Features Page Introduction ~ Unpacking 4 Unpacking Front panel Controls and Connections 5 Introduction ~ Controls and Connections Rear panel Introduction ~ Controls and Connections 7 Introduction ~ Networking Networking The latency or propagation delay is <1ms. Expansion bus Page CHAPTER 2: Installation Hardware Setup Installation ~ Hardware Setup 10 To connect the unit 11 Installation ~ Networking Units Expansion bus connections To create an expansion bus network Networking Units 12 Device IDs To assign device IDs Mixer mode To select a mixer mode 13 LCD menu tree LCD Programming 14 To adjust a parameter System menu Select Preset Run Macro 15 Set Passcode Device ID Unit ID Mixer Mode 16 Flow Control (hardware) Enable Modem Clear Password Meter menu 17 Inputs menu 18 Outputs menu Page Page CHAPTER 3: System Configuration G-Ware Requirements System Configuration ~ Installing G-Ware 22 Creating Floppy Disk Copies Installing G-Ware To install G-Ware 23 Site Setup Creating a new site To create a new site Adding a XAP 800 To auto-detect units To manually add units 24 25 Configuring Unit Properties To configure Unit Properties Page Flow Screen 27 G-Ware Screens Copying and pasting settings Safety Mute Status bar Matrix Screen 29 System Configuration ~ Audio Routing 30 Expansion bus OZ routing Process AH routing Cross point attenuation Audio Routing 31 System Configuration ~ Audio Routing Matrix report 32 Inputs 18 AGC/SL Inputs and Outputs P Pwr (Phantom Power) AEC PA Adapt and AEC Reference Page Non-linear Processing (NLP) Meters NC Filters Active Filter Type Frequency. Gain. Q, or Quality factor. Page Gate Activation Chairman Override Adaptive Ambient PA Adaptive Mode Page Page Gating Group Select To configure gating group settings Page Optimizing input gain structure Meters Pre Gain Post Gain Post Processing Post Gating 44 Inputs 912 AGC Optimizing input gain structure Meters Pre Gain Post Gain 46 Outputs 112 NOM Optimizing output gain structure System Configuration ~ Expansion Buses 48 From Expansion Bus OZ To Expansion Bus OZ Expansion Buses 49 Processing AH Processing Cmprs (compressor) Filters Page Delay Optimizing process gain structure CHAPTER 4: Advanced Configuration Presets Overview Creating Presets Matrix Screen Preset Configuration pane Preset Selection. Protected. Preset Description. Preset Mask Control/Status B. Change Preset Label. Gating Controls. Macro Selection. Page To create a preset Storage space 60 Running presets To run a preset using G-Ware To run a preset using front panel control Running multiple presets simultaneously Room combining example Page 63 Creating macros To create a macro using Macro Recorder Macros To create a macro using Macro Editor 65 Editing macros To edit a macro To delete a macro To add or insert a command line 66 Running macros To run a macro using G-Ware To run a macro using front panel control To run a macro using the Select panel or GPIO CHAPTER 5: Operation Utilities The Signal Generator window can also be opened by selecting Signal Generator from the Tools menu. Signal Generator To use pink or white noise 68 To use tone Document Compare Utility To compare site files Page Copying settings Print the comparison for a detailed list of differences between the two sites. 71 Print Reports 72 GFirm Firmware Utility To upgrade firmware Page 74 G-Ware Switcher To use G-Ware Switcher Copy and paste settings Page 76 Meter Views To configure Meter Views Control/Status A To program control/status pins CHAPTER 6: Control GPIO Builder 78 XAP IR Remote Remote Builder 79 To program the XAP IR Remote ClearOne Control Panels To program the Volume panel To program the Select panel Control ~ RS-232 Port 82 Remote Modem Access Serial commands RS-232 Port 83 Control ~ RS-232 Port Command strings To create a command string To run a command string Page APPENDICES Appendix A: Specifications Appendices ~ Appendix A: Specifications 87 Technical Services Group ~ 1-800-283-5936 (USA) ~ 1-801-974-3760 Appendix B: Pinouts RS-232 COM DCE port pinout (female) Figure B.4. XAP 800 to AMX RS-232 Connections Pin 3 88 Control/Status A Port Pinout (female) Control/Status connectors The first 16 pins on the Control/Status Port A are can be programmed using G-Ware software. Control/Status B port pinout Page 91 Appendices ~ Appendix C: Control Panel Connecting the Control Panel This equipment must be installed according to applicable local electrical codes. Appendix C: Control Panel Appendices ~ Appendix C: Control Panel 93 Appendices ~ Appendix D: Accessories Appendix D: Accessories Accessory ClearOne Part Number 94 Appendix E: Serial Commands Conventions Convention Description Command structure Page 96 Meter type definitions Serial command error codes 97 XAP 800 Serial commands Page 99 AAMB - Adaptive Ambient Mode AEC - Acoustic Echo Canceller Enable/Disable AGC - Automatic Gain Control 100 AGCSET - Automatic Gain Control Adjust AMBLVL - Ambient Level Adjust 101 BAUD - Baud Rate CGROUP - Compressor Group Select CHAIRO - Chairman Override Mode 102 COMPRESS - Compressor Adjust COMPSEL - Compression Select 103 DECAY - Decay Adjust DELAY - Delay Adjust DELAYSEL - Delay Select 104 DFLTM - Default Meter DID - Device ID DSPVER - DSP Version 105 FILTER - Filter Adjust Examples 106 FILTSEL - Filter Select Command form: DEVICE FLOW - Flow Control Example: 107 FPP - Front Panel Passcode Button assignment GAIN - Gain Adjustment 108 GATE - Gate Status GHOLD- Gate Hold Time Adjust 109 GMODE - Gating Mode GOVER - Gating Override GRATIO - Gate Ratio Adjust 110 GREPORT - Gate Report GRPSEL - Gating Group Select LABEL - Label 111 LFP - Lock Front Panel LMO - Last Mic On Mode LOCK - Preset and Macro Lock LOCKPRST - Apply the lock to a preset or macro LOCKPWD - Set preset/macro password LVL - Level 112 113 LVLREPORT - Level Report LVLRRATE - Level Report Rate MACRO - Macro Execution/Reporting MASTER - Expansion Bus Master Mode MAX - Maximum Gain Setting 114 This setting will affect all relative gain adjustments. 115 MDMODE - Modem Mode MIN - Minimum Gain Setting MINIT - Modem Initialization String MINMAX - Minimum and Maximum Gain Setting 116 117 MLINE - Mic/Line Adjust MMAX - Maximum Number of Microphones MPASS - Modem Password MTRX - Matrix MTRXLVL - Matrix Attenuation Adjustment 118 SRC = source DEST = destination CHNL = channel GRP = group 119 MUTE - Mute NCD - Noise Cancellation Depth NCSEL - Noise Cancellation Select Noise cancellation must be enabled for this command to have any effect on audio quality. 120 NLP - Non-Linear Processing Adjust NOM - Number of Open Microphones Mode OFFA - Off Attenuation Mode This setting is not affected by the echo canceller settings. 121 PAA - PA Adaptive Mode PP - Phantom Power PRESET - Preset Execution/Reporting 122 PRGSTRING - Program String Supported special characters 123 RAMP Ramp Gain Adjustment Example: B/sec until the will increase at a rate of 124 REFSET - Reference channel setup SERECHO - Serial Echo SERMODE - Serial Mode 125 SFTYMUTE - Safety mute SIGGEN - Signal Generator 126 SIGTOUT - Signal Generator Time Out SLVL - Speech Level Control Enable/Disable STRING - String Execution The serial command to create a string is PRGSTRING (Program String). See page 122. 127 TOUT - Time Out Select UID - Unit ID VER - Version Appendices ~ Appendix F: Warranty 128 Appendix F: Warranty THIS WARRANTY IS VOID IF: Appendices ~ Appendix F: Warranty Appendices ~ Appendix G: Compliance 130 Appendix G: Compliance FCC Part 15 Compliance Safety Information Glossary 131 Glossary Page Glossary 133 Page Glossary 135 Page Glossary 137 Page Glossary 139 140 Index A AEC settings 3335 B F G H I L 142 N frequency response 52 O P 143 phase 52 R S T