PPL Table Download Initiate 0x00D5

SwitchKit Name

PPLInitiateDownload

Type

EXS API and SwitchKit API message

Description

This message allows the host to initiate the download of a primitive table or a state/event table for use in a protocol.

This message results in the Excel platform allocating space for the specified table, which is then downloaded using the PPL Table Download message. The host assigns a Table ID to identify the table in subsequent messages. The host must manage the use of all PPL Table IDs.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short ComponentID;

UBYTE TableType;

UBYTE TableID;

int TableSize;

char TableName[20];

} XL_PPLInitiateDownload;

C++ Class

class XLC_PPLInitiateDownload : public XLC_OutboundMessage {

public:

unsigned short getComponentID() const;

void setComponentID(unsigned short x);

UBYTE getTableType() const;

void setTableType(UBYTE x);

UBYTE getTableID() const;

void setTableID(UBYTE x);

int getTableSize() const;

void setTableSize(int x);

const char *getTableName() const;

void setTableName(const char *x);

};

 

 

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x0021)

1, 2

Length (0x0007)

3, 4

Message Type (0x00D5)

3, 4

Message Type (0x00D5)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

PPL Component ID MSB, LSB

8, 9

Status MSB, LSB

See PPL Component IDs in the API Reference.

10

Checksum

10

Table Type

0x01 Primitive Table

0x02 State/Event Table

0x03 Route Table

0x04 Resource Group Table

0x07 Extended State/Event Tables

11

Table ID

Number assigned to the table by the host (0x01–0x0A).

12-15

Table Size (4 Bytes)
(total bytes in table to download)

16–35

Table Name

This field is a NULL-terminated ASCII string of up to 20 characters describing the table.
Remaining byte offsets up to 20 should be padded with 0x00.

36

Checksum