Alarm Cleared 0x00C1

SwitchKit Name

AlarmCleared

Type

EXS API and SwitchKit API message

Description

The Excel platform sends this message to indicate that an alarm previously reported in an Alarm message has been cleared because it has been resolved by a host action or by some external action or series of events.

The following information about the originating alarm is reported:

• Severity

• Alarm Type

• Alarm Number

• Alarm Data

See the Alarm message for Alarm Type, Alarm Number, and Data values. The Data will match that of the alarm that has been cleared, except for a span alarm, for which there is one byte of data indicating that the span status is 0x00 (Receiving Red) (0x000 for SwitchKit).

Related Messages

Alarm 0x00B9

Sent by

Excel platform

SwitchKit Code

C Structure

typedef struct {

UBYTE InfoSize;

UBYTE Severity;

UBYTE Entity;

UBYTE AlarmNum;

UBYTE Info[249];

} XL_AlarmCleared;

C++ Class

class XLC_AlarmCleared : public XLC_InboundMessage {

public:

UBYTE getInfoSize() const;

void setInfoSize(UBYTE x);

UBYTE getSeverity() const;

void setSeverity(UBYTE x);

UBYTE getEntity() const;

void setEntity(UBYTE x);

UBYTE getAlarmNum() const;

void setAlarmNum(UBYTE x);

const UBYTE *getInfo() const;

UBYTE *getInfo();

void setInfo(UBYTE *x);

};

Resent for EXS API

This message is sent once after five seconds.

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 (0x0005)

3, 4

Message Type (0x00C1)

3, 4

Message Type (0x00C1)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Severity

8

Checksum

9

Alarm Type

 

 

10

Alarm Number

 

 

11

Data Length (n)

 

 

12

Data[0]

 

 

:

Data[n]

 

 

:

Checksum