440B/T-ACE REMOTE CONTROL
COMMAND SET
(P/N IMT-ACERC)
Version 3.0
January 31, 2002
Appliable to SW versions:
- 440B/T-ACE V1.8D (EPROM)
- 440B/T-ACE V3.6X4 (FLASH)
- 52B+ V1.5 and V1.3C (EPROM)
- 52C V1.1B (FLASH)
© 2001 T-COM LLC – All Rights Reserved
440B/T-ACE Remote Control Command SetVersion 3.0
Table of Contents
1.0Introduction......
2.0Scope......
3.0Communication Protocol......
3.1Messaging Format......
3.2Command and Response Structure......
3.2.1Command Structure......
3.2.2Response Messages......
4.0Commmunication Related Commands......
4.1Setting-up the Remote Control Mode......
4.2Returning the 440B/T-ACE to the Local Control Mode......
5.0System Related Commands......
5.1Obtaining Identification of the System under Remote Control......
5.2Resetting the Instrument......
5.3Obtaining a Listing of the Options......
5.4Setting the System Configuration......
5.5Selecting the Default Channel Bank Type......
5.6Setting the System Time......
5.7Setting the System Date......
5.8Setting the Test Time......
5.9Gathering Status Information......
5.10Restoring the Factory Defaults Settings......
6.0DS1 Transmitter Related Commands......
6.1Selecting the Current (or Active) DS1 Transmitter......
6.2Selecting the Clock Source......
6.3Selecting the Framing......
6.4Selecting the Operating Mode......
6.5Selecting the F-T1 Parameter......
6.6Selecting the T1/DS1 Test Pattern......
6.7Selecting the Transmission Line Code......
6.8Setting the THRU Mode......
6.9Injecting DS1 Errors......
6.10Sending Loop Codes......
6.11Sending ESF Data Link Messages......
6.11.1Sending ANSI PRMs......
6.11.2Sending AT&T Maintenance and Control Messages......
6.11.3Sending BOMs......
6.12Sending SLC-96 Data Link Messages......
6.13Commands Applicable to the Transmitter Selected DS0 Channel......
6.13.1Selecting a DS0 Channel......
6.13.2Selecting a DS0 Pattern......
6.13.3Selecting a VF Tone......
6.13.4Setting the Signaling Data......
6.13.5Setting the Telephone Number Configuration Parameters......
6.13.6Setting the Telephone Number Signaling Parameters......
6.13.7Setting the Wink Generation......
6.13.8Sending a Telephone Number......
6.13.9Setting the Telephone ON/OFF Hook......
6.14DDS Transmitters Related Commands......
6.14.1Setting-up the DDS Transmitter......
6.14.2Selecting the active DS0B primary channel number......
6.14.3Selecting the Primary and Secondary Test Patterns......
6.14.4Injecting DDS Errors......
6.14.5Setting-up MJUs......
6.14.6Sending DDS Loop Codes......
6.15SS7 Transmitter Related Commands......
6.15.1Setting the SS7 Transmitter Configuration......
6.15.2Setting-up a Programmed Packet......
6.15.3Setting-up a Custom Packet Sequence......
6.15.4Sending the Current Packet or the Custom Sequence......
7.0DS1 Receiver Related Commands......
7.1Selecting the Current (or active) DS1 Receiver......
7.2Resetting the Current Receiver......
7.3Setting the Current Receiver Operating Mode......
7.4Configuring the DS-1 Input Circuit......
7.5Setting the F-T1 Parameters......
7.6Obtaining the Status for the Current Receiver......
7.7Obtaining the HISTORY Status for the Current Receiver......
7.8Obtaining the Statistics for the Current Receiver......
7.8.1Obtaining the ID of the "SYNC'ed" Pattern......
7.8.2Obtaining Errors Counts and BER......
7.8.3Obtaining Event Seconds......
7.8.4Obtaining the Slip Count......
7.8.5Obtaining T1 Measurements......
7.9Reading ESF Data Link Messages......
7.9.1Obtaining ANSI PRMs......
7.9.2Obtaining AT&T Maintenance and Control Messages......
7.9.3Obtaining Bit Oriented Messages (BOMs)......
7.10Obtaining SLC-96 Data Link Messages......
7.10.1Setting-up the DS1 RCVR Configuratiom......
7.10.2Reading the SLC-96 Messages......
7.11Commands Applicable to the DS0 Receivers......
7.11.1Selecting a DS0 Channel......
7.11.2Obtaining the "SYNC'D" Pattern ID......
7.11.3Obtaining a Reading of the Channel Bit Density......
7.11.4Obtaining VF Tone Measurements......
7.11.5Reading the Signaling Bit States......
7.11.6Reading the Wink Measurements......
7.11.7Setting the Received Telephone Number Configuration......
7.11.8Reading the Received Telephone Number Digit Capture......
7.11.9Reading the Received Telephone Number Signaling......
7.11.10Reading the Telephone Hook Status......
7.11.11Setting the Receiver Call Capture......
7.11.12Getting the Receiver Call Capture Results......
7.12DDS Receiver Related Commands......
7.12.1Setting-up the DDS Receiver......
7.12.2Selecting the active DS0B primary channel number......
7.12.3Reading the Pattern(s) on which the Active RCVR is "SYNC'D......
7.12.4Reading the Detected DDS Error Counts and Rates......
7.12.5Reading the Detected DDS Errored Second Statistics......
7.12.6Reading the response to the last MJU command sent by the......
7.13SS7 Receiver Related Commands......
7.13.1Setting the SS7 Receiver Configuration......
7.13.2Starting/Stopping the Gathering of SS7 Messages......
7.13.3Reading the SS7 Error Counts......
7.13.4Reading the SS7 Statistics......
8.0Round Trip Delay Measurement Related Commands......
8.1Setting-up the Round Trip Measurement Mode......
8.2Reading the Current RTD Measurement Results......
8.3Reading the Stored RTD Measurement Results......
9.0Option 30 Related Commands......
9.1Configuring the Data Input......
9.2Setting-up the DS0 Transmitter......
9.3Setting-up the DS0 Receiver......
10.0Option 31 Related Commands......
10.1Setting the Option 31 Configuration......
10.2Selecting the Operating Mode......
10.3Setting the F-T1 Parameters......
10.4Setting the DDS Parameters......
10.5Setting the Transmitter Test Pattern......
10.6Sending the V.54 Loop Code......
10.7Injecting Errors......
10.8Reading the Bit Error Count......
10.9Reading the Status......
11.052B+ Related Commands......
11.1DS3 Transmitter Related Commands......
11.1.1Selecting the DS3 Transmitter Clock Source......
11.1.2Selecting the Transmitter DS3 Framing Format......
11.1.3Selecting the DS3 Pattern......
11.1.4Injecting DS3 Errors......
11.1.5Selecting the DS3 Output Level......
11.1.6Setting up the DS3 THRU Mode......
11.1.7Selecting the DS1 Group Number......
11.2DS3 Receiver Related Commands......
11.2.1Reading the DS3 Status and Event History......
11.2.2Reading the DS3 Framing......
11.2.3Reading the DS3 "SYNC'D" Pattern......
11.2.4Reading the DS3 Errors......
11.2.5Reading the DS3 Event-Seconds......
11.2.6Setting the DS3 Input Configuration......
11.2.7Reading the DS3 Input Level Measurement......
11.3DS2 Receiver Related Commands......
11.3.1Reading the DS2 Status and Event History......
11.3.2Reading the DS2 Errors......
11.3.3Reading the DS2 Event-Second Counts......
12.052C Related Commands......
12.1STS-1/DS3 Transmitter Related Commands......
12.1.1Selecting the STST-1 Transmitter Clock Source......
12.1.2Selecting the DS3 Transmitter Clock Source......
12.1.4Selecting the DS3 Transmitter Pattern......
12.1.5Selecting the DS1 Signal Source......
12.1.6Selecting the VT1.5 Signal Source......
12.1.7Selecting the DS3 Framing Format......
12.1.8Selecting the DS1 Group No......
12.1.9Selecting the STS-1 Overhead Message......
12.1.10Setting the THRU Mode......
12.1.11Inserting/De-inserting a DS1 Group (in the THRU Mode)......
12.1.12Setting the STS-1/DS-3 Output Level......
12.1.13Injecting single STS-1 Errors......
12.1.14Injecting STS-1 Errors at a Specified Rate......
12.1.15Sending an STS-1 Alarm......
12.1.16Injecting single DS3 Bit Errors......
12.1.17Injecting DS3 Bit Errors at a Specified Rate......
12.1.18Sending a VT1.5 Alarm......
12.1.19Setting the STS1/DS3 Output Level......
12.2STS-1/DS3 Receivers (1 or 2) Related Commands......
12.2.1Selecting a Receiver......
12.2.2Resetting the Current Receiver......
12.2.3Resetting the HISTORY for the Current Receiver......
12.2.4Setting the Current Receiver Input Configuration......
12.2.5Selecting the Current Receiver DS1 DGROUP......
12.2.6Locking the RCVR 1 and RCVR 2 VT Numbering Sequences......
12.2.7Letting each RCVR have a distinct VT Numbering Sequence......
12.2.8Selecting the Current Receiver VT Numbering Sequence......
12.2.9Overriding the 'C2' byte assignment......
12.2.10Reading the Test Pattern Identified by the Current RCVR......
12.2.11Reading the System Test Time (RCVRs 1 and 2)......
12.3Measurement Related Commands......
12.3.1Reading the Slip Counter......
12.3.2Reading the Input Signal Level and Frequency......
12.3.3Reading J1 Messages Decoded by the Current Receiver......
12.3.4Reading APS Messages Decoded by the Current Receiver......
12.3.5Reading SYNC Messages Decoded by the Current Receiver......
12.3.6Reading Path OH Messages Decoded by the Current Receiver......
12.3.7Reading TOH Messages Decoded by the Current Receiver......
12.3.8Reading the C2 Labels Decoded by the Current Receiver......
12.3.9Reading the Current Receiver Event Statistics......
12.3.10Reading the Current Receiver LED Status......
12.3.11Reading the Current Receiver HISTORY Status......
1.0Introduction
When the 440B/T-ACE is equipped with option 01, many functions accessible from the front panel can be controlled remotely. To this end, the instrument communicates with a controller (typically a PC emulating a 'dumb' terminal) using the RS-232-C port located on the rear panel of this instrument. The communication between the controller and the 440B/T-ACE can be made via a cable if the distance is short (up to 50 feet or so), or via a set of modems and a transmission facility when greater distances are required. Refer to the 440B/T-ACE Reference manual for information about the RS-232-C port and cabling.
2.0Scope
This document is intended to be used by engineers who may have to develop programs executed by the PC to control the 440B/T-ACE remotely. It describes the communication protocol as well as the complete set of commands provided as part of the remote control capability for the 440B/T-ACE.The command set covered here includes those commands applicable to the 440B/T-ACE proper as well as to its options 06, 10, 11, 12, 14, 15, 30, 31, 52B+ and 52C.
3.0Communication Protocol
In the communication between the PC and the 440B/T-ACE, the PC acts as the master and the 440B/T-ACE as the slave. Only the PC can initiate communications and issue commands. The instrument, on the other hand, acknowledges receipt of commands and/or responds to them. The communication is synchronous in the sense that the PC is not allowed to issue a second command before it receives a response or an acknowledgement from the 440B/T-ACE to the previously issued command. This ensures an easily managed communication arrangement.
3.1Messaging Format
The message format used by the PC and the 440B/T-ACE consists of strings of ASCII characters making-up commands and acknowledgement/responses. No headers, trailers or checksums are used. Consequently, error checks can be only based on the syntax of commands or acknowledgements/responses.
3.2Command and Response Structure
The next two sections describe the command and the response structures.
3.2.1Command Structure
All commands issued by the PC adhere to the following constructs:
<command_type>[]<domain>[]<context>[]<action parameter list>[] <message delimiter>
Except for the action parameter list field, all other fields have a fixed length. In the command constructs:
- [] : represents any number of spaces
- <command_type> : consists of two ASCII characters (bytes):
- "S;" (for set) or
- "G;" (for get)
- <domain> : consists of 3 ASCII characters representing the command domain (i.e.
"SYS", "DS0", "DS1", "031")
- <context> : indicates whether the commands applies to a transmitter, a receiver or to
another section; it consists of a single ASCII character:
- "T" (for transmitter)
- "R" (for receiver) or
- "-" (for another section)
- <action> : specifies the type of action to be taken by T-ACE. This 3-byte code is used, for
example, to let the transmitter inject errors, to set the time and date or to get
the current error counts from the receiver.
- <parameter list> : is the variable part of the command and consists of a variable number of bytes. It
defines the options and various parameters not specified in the fixed parts. The
number of parameters in the list depends on the command; parameters are
separated from each other by a comma.
- <message delimiter> : consists of the ASCII carriage return <CR> [0DH]. Actually, both <CR> and
<LF> are valid delimiters as well as the <CR> followed by <LF>. [This was
done to accommodate terminals which generate <CR>/<LF> sequence when the
ENTER key is pressed.]
For simplicity, the command descriptions will not show the message delimiters. All characters enclosed with quotes (") are ASCII.
3.2.2Response Messages
The 440B/T-ACE can issue the following types of messages:
- Acknowledgement
- Result
- Wait followed by Result
The structure of these messages is given in the following three sections.
3.2.2.1Acknowledgement Message Structure
An Acknowledgement message is sent by the 440B/T-ACE when it receives a command not requesting any information. This message adheres to the following construct:
<header<code<message delimiter>
<header> : consists of two ASCII characters "A;"
<code> : are three byte long. They are used to identify whether the received command
was accepted/validated or an error was detected. The acceptance code is "000".
Error codes are listed in Appendix I.
<message delimiter> : as defined in paragraph 3.2.1.
Note:
The acceptance code "000" only means that the received command was recognized but not necessarily executed successfully. To ascertain correct execution, one may issue the same command but with the "G;" command_type.
3.2.2.2Result Message Structure
Result messages are sent by the 440B/T-ACE in response to commands requesting information. (These commands have a "G;" command_type). Result messages adhere to the following construct:
<header<data<message delimiter>
<header> : consists of two ASCII characters: "A;"
<data> : this field is specific to each command; it contains a variable number of ASCII
characters. A detailed description of the content of this field is provided in the
following pages.
3.2.2.3WAIT message followed by a Result message
Some commands require time to execute; for example obtaining data from a 440B/T-ACE add-on module. For such commands, the WAIT message is sent immediately upon validation of the command. The Result message follows whenever the data becomes available. The WAIT message has the following construct:
<header<wait<message delimiter>
<header> : consists of two ASCII characters: "A;"
<wait> : "WAIT"
<message delimiter> : as defined in paragraph 3.2.1.
4.0Commmunication Related Commands
This section contains a description of the commands used for setting-up and terminating a remote control session with the 440B/T-ACE.
4.1Setting-up the Remote Control Mode
If the 440B/T-ACE is operating under local control (from commands entered via the front panel) it is placed in the remote control mode with the command:
"REMOTE" followed by a message delimiter [CR]
Note:
This command does adhere to the structure specified in the previous section because it is issued before the 440B/T-ACE operates under remote control.
Upon receipt of this command, the 440B/T-ACE responds as specified in the table below. If a response is not received by the PC, this indicates either a failure of the communication link or a failure of the 440B/T-ACE.
Acknowledgement code / Condition"000" / The 4440B/T-ACE has just switched from the local to the remote control mode.
"100" / The 440B/T-ACE T-ACE was already in the remote control mode and has remained in this mode.
Acknowledgement codes sent by the 440B/T-ACE upon validation of the "REMOTE" command.
4.2Returning the 440B/T-ACE to the Local Control Mode
This is accomplished with the command:
"S;COM-LOC"
Upon receipt of this command, the 440B/T-ACE leaves the remote control mode and its operation is now under the control of the front panel (local mode). Once in the local mode, the 440B/T-ACE does not accept any other commands from the PC except "REMOTE".
5.0System Related Commands
The commands in this section apply to the 440B/T-ACE as a whole system.
5.1Obtaining Identification of the System under Remote Control
This is accomplished with the command:
"G;SYS-SID"
Upon receipt of this command, the 440B/T-ACE responds with a message formatted as follows:
"R;<model_name>,<sw_version>;<addon_name>,<addon_sw_version>; ..."
<model_name> : "T-ACE"
<sw_version> : the software version (e.g. "3.2")
<addon_name> : the name of the add-on modules present
<addon_sw_version> : the SW version of the add-on modules
5.2Resetting the Instrument
This is accomplished with the command:
"S;SYS-RST"
Upon receipt of this command, the 440B/T-ACE is reset and sends an acknowledgement message.
5.3Obtaining a Listing of the Options
This is accomplished with the command:
"G;SYS-OPT"
Upon receipt of this command, the 440B/T-ACE responds with a message formatted as follows:
"R;<option_number>"
<option_number> : the list of all hardware and software options installed in the 440B/T-ACE
5.4Setting the System Configuration
This is accomplished with the command:
"S;SYS-CNF <autosrch>,<autothru>,<ais>,<gt15zeros>,<opt3clk>, <errsec>,<DDSLoopback>"
<autosrch> : "ON" or "OFF"
<autothru> : "ON" or "OFF"
<ais> : "UFR" or "ALL"
<gt15zeros> : "SYNL" or "ALL"
<opt3clk> : "COMB" or "SEP"
<errsec> : "USA" or "CAN*"
<DDSLoopback>: "EXT" or "STD"
The meaning of these selections is given in the 440B/T-ACE instruction manual. The 440B/T-ACE's configuration can be read back by using the command:
"G;SYS-CNF <autosrch>,<autothru>,<ais>,<gt15zeros>,<opt3clk>, <errsec>,<DDSLoopback>"
Upon receipt of this command, the 440B/T-ACE issues a response message formatted as follows:
"R;<autosrch>,<autothru>,<ais>,<gt15zeros>,<opt3clk>, <errsec>,<DDSLoopback>"
5.5Selecting the Default Channel Bank Type
This is accomplished with the command:
"S;SYS-BAN <number>,<frame_type>,<bank_type>"
<number> : "1" = XMTR 1/RCVR 1 pair
"2" = XMTR 2/RCVR 2 pair
<frame_type> : "SF" or "SLC"
<bank_type> : "D1D", "D2" or "D3/D4" ("D2" applies only to "SF")
Notes:
<frame_type> and <bank_type> together specify which channel numbering arrangement is to be used when the XMTR and/or the RCVR frame selection is SF or SLC-96.
Readback command (to 440B/T-ACE): Response message (from 440B/T-ACE):
"G;SYS-BAN" "R;1,<frame_type>,<bank_type>;2,<frame_type>,<bank_type>"
"G;SYS-BAN <number>,<frame_type>" "R;<number>,<frame_type>,<bank_type>"
Note:
The "G;SYS-BAN" and "G;SYS-BAN <number>,<frame_type>" commands elicit the default channel bank selection for the XMTR/RCVR pair(s) as defined above. They do not yield the current setting of the XMTR and/or RCVR pair(s).
5.6Setting the System Time
This is accomplished the command:
"S;SYS-TIM <hours>,<minutes>,<seconds>"
<hours> : "0" to "24"
<minutes> : "0" to "59"
<seconds> : "0" to "59"
Readback command (to 440B/T-ACE): Response message (from 440B/T-ACE):
"G;SYS-TIM" "R;<hours>,<minutes>,<seconds>"
5.7Setting the System Date
This is accomplished with the command:
"S;SYS-DAT <month>,<day>,<year>"
<month> : "1" to "12"
<day> : "1" to "31"
<year> : "0" to "99"
Readback command (to 440B): Response message (from 440B):
"G;SYS-DAT" "R;<month>,<day>,<year>"
5.8Setting the Test Time
This is accomplished with the command:
"S;SYS-TTM <hours>,<minutes>,<seconds>"
<hours> : "0" to "999"
<minutes> : "0" to "59"
<seconds> : "0" to "59"
Readback command (to 440B/T-ACE): Response message (from 440B/T-ACE):
"G;SYS-TTM" - "R;<hours>,<minutes>,<seconds>;
<elapsed_testtime_1>;<elapsed_testtime_2>" (if the test time was set)
- "R;CONT;<elapsed_testtime_1>;
<elapsed_testtime_2>" (if the test time was not set)
<elapsed_testtime_1> : the elapsed test-time for receiver #1
<elapsed_testtime_2> : the elapsed test-time for receiver #2
Notes:
If the test-time is not specified, it is taken to be continuous. The elapsed test-time is in <hours>,<minutes>,<seconds>.
5.9Gathering Status Information
The PC can obtain a global indication of the states of the LEDs in each DS1 receiver section as well as a couple of non-LED indicated states. Two different commands are issued to obtain the current states as opposed to the recorded (HISTORY) states.
"G;SYS-STA"
"G;SYS-HIS"
The format of the response to these two commands is the same:
"R;<byte1>,<byte2>,<byte3>,<byte4>,<byte5>,<byte6>"
<byte1>,<byte2>,<byte3> : apply to the DS1 RCVR #1
<byte4>,<byte5>,<byte6> : apply to the DS1 RCVR #2
The RCVR status bytes are formatted as follows:
byte1/byte4 byte2/byte5 byte3/byte6
bits > 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
states > 0 1 0 0 0 H F L 0 1 B C O I E 9 0 1 R Y A P S N
LED state = 1 state = 0
H = HISTORY lit not lit
F = SF lit not lit
L = LOSS lit not lit
B = FR BIT ERROR lit not lit
C = CRC ERR lit not lit
O = FR LOSS lit not lit
I = BIT ERR lit not lit
E = ESF lit not lit
9 = SLC-96 lit not lit
Y = YEL ALM lit not lit
A = AIS lit not lit
S = SYNC lit green not lit
N = SYNC LOSS lit red not lit
Non-LED indicated states
R = REF LOSS state = LOSS LED state for other RCVR
P = LOOP state = 1 if LOOP condition is detected
Note:
Sections 7.6 and 7.7 provide other commands for gathering this same information selectively for each receiver.
5.10Restoring the Factory Defaults Settings
This is accomplished with the command:
"S; SYS-PWR"
Upon receipt of this command, the 440B/T-ACE is re-initialized and restores all factory default settings. This process takes approximately 30 seconds (2 minutes if equipped with option 31) during which the instrument cannot accept any remote control command.
Note:
The above defined command is supported only by the 440B/T-ACE when running SW 3.3.
6.0DS1 Transmitter Related Commands
The commands in this section apply to either transmitter (1 or 2).
6.1Selecting the Current (or Active) DS1 Transmitter
This is accomplished with the command:
"S;DS1 T CUR <number>"
<number> : "1" or "2"
Readback command (to 440B/T-ACE): Response message (from 440B/T-ACE):
"G;DS1 T CUR" "R;<number>"
After this command was successfully executed, all the DS1 transmitter commands apply to the active transmitter only. This avoids having to specify the applicable transmitter with each transmitter related command.
6.2Selecting the Clock Source
This is accomplished with the command:
"S;DS1 T CLK <source>"
<source> : - "INT" = the internal master clock
- "RCV,<n >" = clock recovered by RCVR n
<n> = "1" (RCVR 1)
= "2" (RCVR 2)
= " " (active RCVR used by default)
- "EXT" = external clock
- "DAT" = Option 30 data clock
Readback command (to 440B/T-ACE): Response message (from 440B/T-ACE):
"G;DS1 T CLK" "R;<source>"
6.3Selecting the Framing
This is accomplished with the command:
"S;DS1 T FRM <frame_type>"
<frame_type> : - "UFR" = unframed
- "SF" = superframe
- "ESF" = extended superframe
- "SLC" = SLC-96