You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > DS3 Configure/Query 0x000F

DS3 Configure/Query 0x000F

SwitchKit Name

DS3GenericMessage

Type

EXS API and SwitchKit API message

Description

DS3 Configure/Query 0x000F

Use this message to perform the following:

• Configure Loopback Mode

• Query Loopback Mode

• DS3 Framer Configure and Query

NOTE: You must take a DS3 (Entity 1) or the DS3 spans (Entity 3) out of service before you can place it into local loop back. The DS3 AIB must always be 0.

Sent by

Host

SwitchKit Code

Configuration

DS3GenericMessage (

Node = integer,

Slot = integer,

DS3 = integer,

Entity = integer,

DataLength = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE Slot;

UBYTE DS3;

UBYTE Entity;

UBYTE DataLength;

UBYTE Data[221];

} XL_DS3GenericMessage;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Slot;

UBYTE DS3;

UBYTE Entity;

UBYTE DataLength;

UBYTE Data[219];

} XL_DS3GenericMessageAck;

C++ Class

class XLC_DS3GenericMessage : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDS3() const;

void setDS3(UBYTE x);

UBYTE getEntity() const;

void setEntity(UBYTE x);

UBYTE getDataLength() const;

void setDataLength(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_DS3GenericMessageAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDS3() const;

void setDS3(UBYTE x);

UBYTE getEntity() const;

void setEntity(UBYTE x);

UBYTE getDataLength() const;

void setDataLength(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
--- | ---
Byte | Field Name | Byte | Field Name
0 | Frame (0xFE) | 0 | Frame(0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x00NN)
3, 4 | Message Type (0x000F) | 3, 4 | Message Type (0x000F)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB)
Number of AEs
AEs 0x32 DS3 Offset This value should always be 0.
: | Entity The operation to perform on the DS3: 0x01 Loop Back Configure 0x02 Loop Back Query 0x03 DS1 Loop Back Configure (All spans) 0x04 DS3 Framer Configure 0x05 DS3 Framer Query 0x06 Set DS3 Line Length 0x07 FEAC Acknowledgement 0x08 DS1 Specific Loopback 0x09 DS1 Loopback Query All Spans 0x0a DS1 Loopback Query 0x0b DS3 FEBE Query 0x0c DS3 Status Query 0x0d DS3-Reset FEBE count | 10 | AIB Same as message
: | Data Length | : | Entity
: | Data Length: Variable
: | Data[0-N] This field is dependent on the entity specified: Entity: 0x01, 0x03: Data[0] Loop Back Mode 0x00 Disable Local Loop Back Disable loop back of received stream to the transmit DS3 stream 0x01 Enable Local Loop Back Enable loop back of received stream to the transmit stream 0x02 Cancel Remote Loop Back Cancel the request for the distant end to loop back its received stream to the transmit stream (CBIT only) 0x03 Request Remote Loop Back Request distant end to loop back its received stream to the transmit stream (CBIT only) Entity: 0x02 Data: No data required Entity: 0x04 - DS3 Framer Configure Data [0] 0x00 - CBIT 0x01 - M13 Entity: 0x05 DS3 Framer Query Entity: 0x05 Data: No data required Entity: 0x06 - DS3 Line Length Data [0] 0x00 - 0 to 225 feet 0x01 - 226 to 450 feet | : | Info[0-N] Information returned depends upon the entity specified: Entity: 0x01, 0x03: No information reported. Entity: 0x02: Info[0] Local Loop Back Mode 0x00 Local Loop Back Disabled 0x01 Local Loop Back Enabled Info[1] Remote Loop Back Mode 0x00 Remote Loop Back Requested 0x01 Remote Loop Back Cancelled When the distant end requests that the CSP be placed into loopback mode, an alarm is sent to the host. The host is responsible for initiating the loopback process. Entity: 0x04 - DS3 Framer Configure No information reported. Entity: 0x05 DS3 Framer Query Data[0] 0x00 - CBIT 0x01 - M13 Entity: 0x05 DS3 Framer Query Entity: 0x05 Data: No data required Entity: 0x06 - DS3 Line Length Data [0] 0x00 - 0 to 225 feet 0x01 - 226 to 450 feet
| Entity: 0x07 - FEAC Acknowledgement Data [0] 0x00 - Disable FEAC interrupts 0x01 - Enable FEAC interrupts Entity: 0x08 - DS1 Specific Loopback 0x00 - DS1 specific local loopback disable 0x01 - DS1 specific local loopback enable 0x02 - DS1 specific remote loopback canel 0x03 - DS1 specific remote loopback request Entity: 0x09 - DS1 Loopback Query All Spans 0x00 = No loopback 0x01 = Loopback Entity: 0x0A, 0x0B, 0x0C, 0x0D Data: No data required |  | Entity: 0x07 - FEAC Acknowledgement Data [0] 0x00 - Disable FEAC interrupts 0x01 - Enable FEAC interrupts Entity: 0x08 - DS1 Specific Loopback 0x00 - DS1 specific local loopback disable 0x01 - DS1 specific local loopback enable 0x02 - DS1 specific remote loopback canel 0x03 - DS1 specific remote loopback request Entity: 0x09 - DS1 Loopback Query All Spans 0x00 = No loopback 0x01 = Loopback Entity: 0x0A, 0x0B, 0x0C, 0x0D Data: No data required
: | Checksum | : | Checksum

A type of diagnostic test in which the transmitted signal is returned to the sending device after passing through a data communications link or network.
See Address Information Block.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
Most Significant Bit
Least Significant Bit
Options for line length when configuring a T-1 span on a Excel platform are as follows.
0 - 133 Feet
134 - 166 Feet
167 - 299 Feet
300 - 533 Feet
534 - 655 Feet
G.703 ITU-T