You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > E1 Span Query 0x00DB

E1 Span Query 0x00DB

SwitchKit Name

E1SpanFormatQuery

Type

EXS API and SwitchKit API message

Description

Use this message to retrieve the transmission format and line length of an E1 span.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

} XL_E1SpanFormatQuery;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short Span;

UBYTE Format;

UBYTE LineLength;

UBYTE Slot;

UBYTE Offset;

UBYTE SARegisters;

UBYTE TS16Register;

} XL_E1SpanFormatQueryAck;

C++ Class

class XLC_E1SpanFormatQuery : public XLC_OutboundMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

};

C++ Class Response

class XLC_E1SpanFormatQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getFormat() const;

void setFormat(UBYTE x);

UBYTE getLineLength() const;

void setLineLength(UBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getOffset() const;

void setOffset(UBYTE x);

UBYTE getSARegisters() const;

void setSARegisters(UBYTE x);

UBYTE getTS16Register() const;

void setTS16Register(UBYTE x);

};

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0xNNNN)

1, 2

Length (0xNNNN)

3, 4

Message Type (0x00DB)

3, 4

Message Type (0x00DB)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

Address Method

0x00 - Individual AEs

8, 9

Status MSB,LSB

Number of AEs to follow

AE

0x0C Logical Span

:

Checksum

10

AIB

Same as message

 

Response continued below.

:

Format

This field is a bit mask. The meaning of each bit is described below.
Unless otherwise stated, 0 = Disabled, 1 = Enabled.


Coding Method

Bit 0
0 Alternate Mark Inversion (AMI)

1 High Density Bipolar 3 (HDB3)


Error Checking

Bit 1 CRC-4 Enabled

Bit 2 FEBE Enabled


Signaling Method

Bit 3 Clear Channel

Bit 4 Transmit all zeroes

Bit 5
0 E1 Layer I management (Default)

1 Euro-ISDN E1 Layer I management

Bits 6–7 Reserved

:

Line Length

0x00 G.703 ITU-T (75 Ohm) (Default)

0x04 G.703 ITU-T (120 Ohm)

:

Line Card Slot Number

:

Span Offset

:

SA Register Contents

This field is a bit mask. The meaning of each bit is described as follows.
Unless otherwise stated, 0 = Disabled, 1 = Enabled.


Bits 0–2 Reserved (must be 0)

Bit 3 Value to which all bits in SA Bit 4 Register are set.

Bit 4 Value to which all bits in SA Bit 5 Register are set.

Bit 5 Value to which all bits in SA Bit 6 Register are set.

Bit 6 Value to which all bits in SA Bit 7 Register are set.

Bit 7 Value to which all bits in SA Bit 8 Register are set.

:

TS 16 Register Contents

This field is a bit mask. The meaning of each bit is described below.
Unless otherwise stated, 0 = Disabled, 1 = Enabled.


Bits 0–3 Reserved (must be 0)

Bit 4 Value to which spare bit x 1 in frame 0 of timeslot 16 is set.

Bit 5 Reserved (must be 0)

Bit 6 Value to which spare bit x 3 in frame 0 of timeslot 16 is set.

Bit 7 Value to which spare bit x 4 in frame 0 of timeslot 16 is set.

:

Checksum

NOTES

1. The Excel message bit-numbering format is 0–7, while the SA Register and TS 16 Register formats are 1–8. Therefore, bit 3 of the host message format is bit 4 of the SA Register and TS 16 Register formats, and so on.

2. This message is backward-compatible to previous software releases. If using a System Software 3.X Version 3.09 or earlier, the SA Register and TS 16 Register bits will be set to the default (1), and an E1 Span Query message will return a value of 0xF8 for the SA Register byte and 0xDO for the TS 16 Register byte.