You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Span Filter Configure 0x00CD

Span Filter Configure 0x00CD

SwitchKit Name

Span Filter Config

Type

EXS API and SwitchKit API message

Description

Span Filter Configure 0x00CD

This message is used to configure the detection of a Carrier Group Alarm (CGA), such as an AIS (Alarm Indication Signal) or LOF (Loss of Frame).

The "CGA Detected" validation timer determines how long a CGA alarm must be detected before the CSP informs the host with an Alarm message. The default is 2.5 seconds. The host will also receive a DS0 Status Change message of "Out Of Service" for the channels on the span.

The "CGA Cleared" validation timer is initiated after a CGA alarm has been detected and then clears. It determines how long the CSP must go without detecting a CGA alarm before informing the host with an Alarm Cleared message. The default is 12 seconds. The host will also receive a DS0 Status Change message of "In Service" for the channels on the span.

Sent by

Host

SwitchKit Code

Configuration

SpanFilterConfig (

Node = integer,

Span = integer,

Entity = integer,

Value = integer);

C Structure

typedef struct {

unsigned short Span;

UBYTE Entity;

unsigned short Value;

} XL_SpanFilterConfig;

C++ Class

class XLC_SpanFilterConfig : public XLC_SpanMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getEntity() const;

void setEntity(UBYTE x);

unsigned short getValue() const;

void setValue(unsigned short 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 (0x0007)
3, 4 | Message Type (0x00CD) | 3, 4 | Message Type (0x00CD)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
10 | Checksum
Number of AEs to follow
AEs 0x0C Logical Span
: | Entity 0x01 "CGA Cleared" validation timer 0x02 "CGA Detected" validation timer
: | Value MSB, LSB Must be in 10 ms units.
: | Checksum

Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
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.
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.
See Address Information Block.
Most Significant Bit
Least Significant Bit