IP Signaling Series 3 Card Configure 0x0100

SwitchKit Name

ServerConfig

Type

EXS API and SwitchKit API message

Description

This message is used to inform the IP Signaling Series 3 card about a Matrix Controller. It sets up all of the information on the IP Signaling Series 3 card side that allows for the connection to the Matrix Controller.

When an alarm.log file is created for this message, the logical node ID, 0xFE, is not shown in the log. Instead, this message shows an API logical node ID in the alarm.log.

Sent by

Host

SwitchKit Code

The syntax for the IP Signaling Series 3 Card Configure message corresponds to the fields of the ServerConfig message.

C Structure

typedef struct {

UBYTE AddrInfo[4];

unsigned short ExpandedNode;

UBYTE reserved23[2];

unsigned short ObjectType;

unsigned short ObjectInstanceID;

UBYTE reserved29[68];

UBYTE TLVCount;

UBYTE TLVData[172];

} XL_ServerConfig;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[11];

UBYTE AddrInfo[4];

unsigned short ExpandedNode;

UBYTE reserved23[2];

unsigned short ObjectType;

unsigned short ObjectInstanceID;

UBYTE reserved29[241];

} XL_ServerConfigAck;

 

C++ Class

class XLC_ServerConfig : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

unsigned short getExpandedNode() const;

void setExpandedNode(unsigned short x);

unsigned short getObjectType() const;

void setObjectType(unsigned short x);

unsigned short getObjectInstanceID() const;

void setObjectInstanceID(unsigned short x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x);

const UBYTE *getTLVData() const;

UBYTE *getTLVData();

void setTLVData(UBYTE *x);

};

C++ Class Response

class XLC_ServerConfigAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

unsigned short getExpandedNode() const;

void setExpandedNode(unsigned short x);

unsigned short getObjectType() const;

void setObjectType(unsigned short x);

unsigned short getObjectInstanceID() const;

void setObjectInstanceID(unsigned short x);

};

 

EXS Hex API 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 (0x0100)

3, 4

Message Type, MSB (0x0100)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Sequence Number (same as message)

7

Logical Node ID (0xFE)

7

Logical Node ID (0xFE)

:

AIB

Address Method

0x00 - Individual AEs

8, 9

Status MSB, LSB

 

Number of AEs to follow

AEs

0x52 IP Signaling Series 3 Card ID or Expanded Logical Node ID

(If you use AIB 0x52, you must also use 0x53)


0x53 Object Type

(You can use 0x53 by itself)

:

Number of TLVs to Follow

10

AIB (Individual AEs)

 

TLVs

0x0001 Add IP Signaling Series 3 Card

0x0002 Remove IP Signaling Series 3 Card

0x0003 Matrix ID

0x0004 Remove Matrix

0x0005 IP Signaling Series 3 Card Slot Number

0x0008 IP Signaling Series 3 Card Compatibility Tag

0x000A Add Poll Interval

0x000C Matrix IP Address

0x000E IP Signaling Series 3 Card Interface Service State

0x000F Link Down Timer

 

0x52 IP Signaling Series 3 Card ID or Expanded Logical Node ID

0x53 Object Type

:

Checksum

:

Checksum