Multi-Host Configure 0x00E9

SwitchKit Name

MultiHostConfig

Type

EXS API and SwitchKit API message

Description

Use this message to register a host to receive or not receive specific API messages, as well as the PPL components for which PPL Event Indication messages are sent by the Excel platform. You also use this message to query the registration status for a specific host.

Note the following:

You can only send one ICB subtype per message.

Multi-Host Control is disabled by default. You enable it with
Action ICB Subtype 0x33.

Sent by

Host

SwitchKit Code

Configuration

MultiHostConfig (

Node = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE Data[253];

} XL_MultiHostConfig;

C Structure Response

typedef struct {

tus;

UBYTE Data[251];

} XL_MultiHostConfigAck;

C++ Class

class XLC_MultiHostConfig : public XLC_OutboundMessage {

public:

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_MultiHostConfigAck : public XLC_AcknowledgeMessage {

public:

unsunsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

Overview of message

The following table provides an overview of this message. The table following it, provides the detail for each byte.

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

3, 4

Message Type (0x00E9)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

ICB

8, 9

Status MSB, LSB

:

:

10

Data

:

Checksum

:

Checksum

EXS API Hex Format - Detailed

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

3, 4

Message Type (0x00E9)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Number of ICBs to follow (Ignore this field if no ICBs in message.)

8, 9

Status MSB, LSB

:

ICB

All ICBs valid for this message are listed below.

 

0x01 Action ICBs

0x33 Enable Multi-Host *

0x34 Disable Multi-Host *

0x35 Query Host Message Registration

0x36 Query Host Connections *

0x37 Query Multi-Host Status *

0x38 Query Hard-registered PPL Components

0x39 Query Soft-registered PPL Components

 

* The ICB has no data, so you will always use 0x00 for the value of the Data Length field.

 

 

0x02 Data ICBs

0x47 Enable Switch-Initiated Messages

0x48 Disable Switch-Initiated Messages

0x49 Enable PPL Event Indication Messages

0x4A Disable PPL Event Indication Messages

0x4B Deregister Switch-Initiated Messages

0x4C Deregister Switch-Initiated Messages

0x50 Hard Register All Switch-Initiated Messages

0x51 Soft Register All Switch-Initiated Messages

0x52 Deregister All Switch-Initiated Messages

0x53 Hard Register All PPL Component IDs

0x54 Soft Register All PPL Component IDs

0x55 Deregister All PPL Component IDs

10

Data [0]


0x33 Enable Multi-Host (Contains no data)

0x34 Disable Multi-Host (Contains no data)

 

0x35 Query Host Message Registration

Data[0–3] Host ID (4 bytes)

Data[4-5] Number of Messages (2 bytes)

Data[6-7] Message Type 1 (2 bytes)

Data[8-9] Message Type 2 (2 bytes)

: :

Data[:] Message Type N (2 bytes)

 

0x36 Query Host Connections

Data[0–3] Default Host ID (4 bytes)
(00 00 00 00 if not connected)

Data[4-5] Number of hosts connected
(2 bytes)

Data[6-9] Host ID 1
(4 bytes; first connected
additional host)

Data[10-13] Host ID 2 (4 bytes)

: :

Data[:] Host ID N (4 bytes)

 

0x37 Query Multi-Host Status

Data[0-3] Default Host ID (4 bytes)

Data[4] Status

0x00 Disabled

0x01 Enabled

 

0x38 Query PPL Components

Data[0–3] Host ID (4 bytes)

Data[4-5] Number of Components (2 bytes)

Data[6-7] Component ID 1 (2 bytes)

Data[8-9] Component ID 2 (2 bytes)

: :
Data[:] Component ID N (2 bytes)

0x47 Enable Excel platform-Initiated Messages
(Contains no data)

0x48 Disable Excel platform-Initiated Messages
(Contains no data)

0x49 Enable PPL Event Indication Messages
(Contains no data)

0x4A Disable PPL Event Indication Messages
(Contains no data)

 

 

:

Checksum

:

Checksum