ClearOne comm AP10 operation manual Command structure, Example, Convention Description

Page 26

22	Appendices ~ Appendix C: Serial Commands
Convention	Description
<X>	Parameters enclosed in < > indicate a mandatory parameter.

[X]Parameters enclosed in [ ] indicate an optional parameter.

1-8	Parameters separated by a - indicate a range between the values.
4,7,9	Parameters separated by a , indicate a list of available values.
EREF	Words in uppercase bold indicate command text.
DEVICE	Indicates the device type and device number on the G-Link
	network. It is composed of a device type number and a device
	number. The device type for the AP10 is always 2 and the device
	ID will always be 0–0–9, A–F (where A=10 and F=15), or * (to
	select all AP10 units).

Command structure

Commands can be either UPPERCASE or lowercase. Also, extra spaces or tabs between arguments in text commands is allowed. Return values are always in uppercase. For a command to be recognized by the serial port, the command must be terminated by a carriage return.

The structure of serial commands is as follows: #DEVICE COMMAND [X] [X]

#	indicates the start of a command line
DEVICE	represents the device type and device number
COMMAND	is the command text
[X] [X]	represents any additional options in the order that they appear in
	the command descriptions that follow

Example

A command to enable auto-answer on the AP10 device “0” has the command line: #20 AA 1 1. In this command line, 2=AP10, 0=unit 0, AA=command, 1=Telco channel 1, 1=on state. If a command calls for a “null” value, leave a blank in the command line. For example, “#20 AA” returns the current auto-answer state on device 20.

For a command to be recognized by the serial port, it must be terminated by a carriage return.

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

Image 26

Contents AP10 Telephone Interface Technical Services Group ~ 1-800-283-5936 USA ~ Table of Contents IiiAppendices OperationFeatures IntroductionTechnical Support Professional Services GroupSales and Customer Service ClearOne Communications EuMEA GmbHFront view UnpackingControls and Connections Introduction ~ Controls and ConnectionsAP10 rear-panel connectors Rear viewEquipment placement Before You InstallPower requirements Telephone line requirementsTechnical Services Group ~ 1-800-283-5936 USA ~ Hardware Setup Connect the unitCreating a G-Link network Installation ~ Hardware SetupPhoenix connector Binary DIP Switch Address Position Connecting powerDevice ID DIP switch settings Assigning device ID numbersTechnical Services Group ~ 1-800-283-5936 USA ~ Receive boost DIP Switch SettingsNoise burst/auto-adapt Auto-disconnect Receive AGCAuto-answer Call progression/loopNoise burst adapt Receive reductionCalibration RingingAuto-adapt Transmit level adjustmentReceive level adjustment To make and disconnect a call Using the AP10To answer a call Using the Telco Interface FoundControllers To muteOther telco options Custom control through DB-25 portTechnical Services Group ~ 1-800-283-5936 USA ~ Appendix a Specifications AppendicesAppendices ~ Appendix B Pinouts Remote connector pinoutAppendix B Pinouts Pin DescriptionAppendix C Serial Commands Set connector pinoutLine connector pinout ConventionsConvention Description Command structureExample Command Function AP10 Serial CommandsAppendices ~ Appendix C Serial Commands Command form Device AAExample Command form Device HookCommand form Device Hookd Command form Device LVL CH Command form Device Mute CH ExplanationCommand form Device Terl Return values Command form Device NullCommand form Device TE Return valuesCommand form Device VER Command form Device TerleCommand form Device UID Appendix D Warranty This Warranty is Void ifAppendices ~ Appendix D Warranty FCC Part 68 Compliance Appendix E ComplianceFCC Part 15 Compliance Usoc Jacks This device uses RJ-11C and RJ21X terminal jacksAppendices ~ Appendix E Compliance Safety InformationIC Compliance Appendix F Block Diagram Acoustic Echo Cancellation AEC GlossaryGlossary Index Index