You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Version Request 0x0002

Version Request 0x0002

SwitchKit Name

VersionRequestQuery

Type

EXS API and SwitchKit API message

Description

Version Request 0x0002

This message is used by the host to determine the versions of both the boot loader and system software. It also reports the timestamp for the system software of the CSP Matrix Series 3 Card(s).

The host can also send this message to the standby CSP Matrix Series 3 Card.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

BaseFields Base;

} XL_VersionRequestQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE BootMajor;

UBYTE BootMinor;

UBYTE SoftwareMajor;

UBYTE SoftwareMinor;

UBYTE SoftwareBuild;

int MatrixStamp;

int AdjMatrixStamp;

} XL_VersionRequestQueryAck;

C++ Class

class XLC_VersionRequestQuery : public XLC_OutboundMessage {

public:

empty class

C++ Class Response

class XLC_VersionRequestQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getBootMajor() const;

void setBootMajor(UBYTE x);

UBYTE getBootMinor() const;

void setBootMinor(UBYTE x);

UBYTE getSoftwareMajor() const;

void setSoftwareMajor(UBYTE x);

UBYTE getSoftwareMinor() const;

void setSoftwareMinor(UBYTE x);

UBYTE getSoftwareBuild() const;

void setSoftwareBuild(UBYTE x);

int getMatrixStamp() const;

void setMatrixStamp(int x);

int getAdjMatrixStamp() const;

void setAdjMatrixStamp(int x);

};

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x0005) | 1, 2 | Length (0x0014)
3, 4 | Message Type (0x0002) | 3, 4 | Message Type (0x0002)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 | Checksum | 8, 9 | Status (MSB, LSB)
|  | 10 | Boot Loader Major Revision
11 | Boot Loader Minor Revision
12 | System Software Major Revision
13 | System Software Minor Revision
14 | System Software Build Number
15-18 | CSP Matrix Series 3 Card Timestamp (4 Bytes)
19-22 | Adjacent CSP Matrix Series 3 Card Timestamp (4 Bytes)
23 | Checksum

Notes:

1. If System Software Major Rev, System Software Minor Rev, and System Software build Number fields are "0," system software is not present.

2. When in the process of downloading, the system software versions reflect the version of the code being downloaded. The version of the code which is being executed by the CSP may differ during download.

3. It is recommended that the host rely on the Poll message to determine when system software must be downloaded.

4. If a second CSP Matrix Series 3 Card is not installed, or if the system software is not present on the second CSP Matrix Series 3 Card, the Adjacent Matrix Controller Timestamp field will show "0."

5. Timestamp equals number of seconds since January 1, 1970.

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.
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.
Most Significant Bit
Least Significant Bit