PPL Assign 0x00D1
SwitchKit Name
PPLAssign
Type
EXS API and SwitchKit API message
Description
This message assigns a custom protocol to a channel. Before you can assign a custom protocol to a channel, you must:
• Create and download all tables used by the custom protocol.
• Take the channel out-of-service.
When a new load of system software is downloaded to the Excel platform, you must re-download and reassign protocols.
Sent by
SwitchKit Code
Configuration
PPLAssign (
Node = integer,
StartSpan = integer,
StartChannel = integer,
EndSpan = integer,
Range = StartSpan:StartChan - EndSpan:EndChan,
EndChannel = integer,
= integer,
Channel = integer,
Subrate = integer,
StackID = integer,
LinkID = integer,
Destination = integer,
Route = integer,
SSLGroupID = integer,
SSLProfileID = integer,
SSLServiceNumber = integer,
V5ID = integer,
ComponentID = integer,
ProtocolID = integer);
C Structure
typedef struct {
UBYTE AddrInfo[30];
unsigned short ComponentID;
UBYTE ProtocolID;
} XL_PPLAssign;
C++ Class
class XLC_PPLAssign : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
XBYTE getStartSpan() const;
void setStartSpan(XBYTE x);
UBYTE getStartChannel() const;
void setStartChannel(UBYTE x);
XBYTE getEndSpan() const;
void setEndSpan(XBYTE x);
UBYTE getEndChannel() const;
void setEndChannel(UBYTE x);
XBYTE getSpan() const;
void setSpan(XBYTE x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
XBYTE getV5ID() const;
void setV5ID(XBYTE x);
unsigned short getComponentID() const;
void setComponentID(unsigned short x);
UBYTE getProtocolID() const;
void setProtocolID(UBYTE x);
};
EXS API Hex Format
|
MESSAGE (White)
|
RESPONSE (Gray)
|
|
Byte
|
Field Description
|
Byte
|
Field Description
|
|
0
|
(0xFE)
|
0
|
Frame (0xFE)
|
|
1, 2
|
Length (0xNNNN)
|
1, 2
|
Length (0x0007)
|
|
3, 4
|
Message Type (0x00D1)
|
3, 4
|
Message Type (0x00D1)
|
|
5
|
Reserved (0x00)
|
5
|
Reserved (0x00)
|
|
6
|
Sequence Number
|
6
|
Same Sequence Number
|
|
7
|
Logical Node ID
|
7
|
Logical Node ID
|
|
:
|
Address Method
Depends on component being addressed.
|
|
Number of AEs to follow
|
|
AE
The AE used depends on the component being addressed.
See PPL Component Addressing
in the API Reference.
|
8, 9
|
Status ,
|
|
10
|
Checksum
|
|
:
|
Component ID MSB, LSB
See PPL Component IDs in the API Reference.
|
|
:
|
PPL Protocol ID
Protocol IDs 1 - 10 are reserved per component for custom protocols. Shown below are two components and their default protocols that are included on the Excel platform. Default protocols are assigned through other methods such as Trunk Type Configure for the protocols.
|
|
:
|
Checksum
|
