You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Span Filter Configure 0x00CD
SwitchKit Name
Span Filter Config
Type
EXS API and SwitchKit API message
Description
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 Excel platform 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 Excel platform 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
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 : |
Address Method 0x00 - Individual AEs
|
8, 9 |
|
10 |
Checksum |
||
Number of AEs to follow |
|||
AEs |
|||
: |
Entity 0x01 "CGA Cleared" validation timer 0x02 "CGA Detected" validation timer |
||
: |
Value MSB, LSB Must be in 10 ms units. |
||
: |
Checksum |