You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > DS3 Configure/Query 0x000F
SwitchKit Name
DS3GenericMessage
Type
EXS API and SwitchKit API message
Description
Use this message to perform the following:
• Configure Loopback Mode
• Query Loopback Mode
• DS3 Framer Configure and Query
NOTE: You must specify the slot number and the DS3 offset. You must take a DS3 span out of service before you can place it into remote loop back.
Sent by
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 |
: |
Address Method 0x00 - Individual AEs |
8, 9 |
|
Number of AEs |
|||
AEs |
|||
: |
Entity The operation to perform on the DS3: 0x01 Loop Back Configure 0x02 Loop Back Query 0x03 DS1 Loop Back Configure 0x04 DS3 Framer Configure 0x05 DS3 Framer Query |
10 |
AIB
|
: |
Data Length |
: |
Entity |
: |
Data Length: Variable |
||
: |
Data[0-N] This field is dependent on the entity specified:
Data[0] Loop Back Mode Request distant end to loop
Entity: 0x02 Data: No data required
Entity: 0x04 - DS3 Framer Configure Data [0] 0x00 - CBIT 0x01 - M13
Entity: 0x05 DS3 Framer Query |
: |
Info[0-N] Information returned depends upon the entity specified:
No information reported.
Info[0] Local Loop Back Mode 0x00 Local Loop Back Disabled 0x01 Local Loop Back Enabled 0x00 Remote Loop Back Disabled 0x01 Remote Loop Back Enabled
Entity: 0x04 - DS3 Framer Configure No information reported.
Entity: 0x05 DS3 Framer Query Data[0] 0x00 - CBIT 0x01 - M13 |
: |
Checksum |
: |
Checksum |