You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > PPL Timer Configure 0x00CF
SwitchKit Name
PPLTimerConfig
Type
EXS API and SwitchKit API message
Description
This message allows the host to configure PPL timers.
The 100 generic timers are used as defined by the protocol tables. The protocol designer must specify which timers are used, and how. This message allows the timers to be adjusted without having to modify the PPL State/Event or Primitive Tables.
NOTE: This message does not support the older ST1LC line cards. The correct message to use for these older line cards is the Filter/Timer Configure message (0x12).
Sent by
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 (0x0007) |
|
3, 4 |
Message Type (0x00CF) |
3, 4 |
Message Type (0x00CF) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
8 |
8, 9 |
|
|
|
: |
|
||
|
: |
PPL Component ID MSB, LSB |
10 |
Checksum |
|
: |
PPL Timer Type |
||
|
: |
PPL Timer ID |
||
|
: |
PPL Timer Value MSB, LSB |
||
|
: |
Checksum |
||
SwitchKit Code
Configuration
PPLTimerConfig (
Node = integer,
StartSpan = integer,
StartChannel = integer,
EndSpan = integer,
Range = StartSpan:StartChan - EndSpan:EndChan,
EndChannel = integer,
Span = integer,
Channel = integer,
Subrate = integer,
StackID = integer,
LinkID = integer,
Destination = integer,
Route = integer,
SSLGroupID = integer,
SSLProfileID = integer,
SSLServiceNumber = integer,
V5ID = integer,
ComponentID = integer,
TimerType = integer,
TimerID = integer,
TimerValue = integer);
C Structure
typedef struct {
UBYTE AddrInfo[30];
unsigned short ComponentID;
UBYTE TimerType;
UBYTE TimerID;
unsigned short TimerValue;
} XL_PPLTimerConfig;
C++ Class
class XLC_PPLTimerConfig : 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 getTimerType() const;
void setTimerType(UBYTE x);
UBYTE getTimerID() const;
void setTimerID(UBYTE x);}
unsigned short getTimerValue() const;
void setTimerValue(unsigned short x);
};
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 (0x0007) |
|
3, 4 |
Message Type (0x00CF) |
3, 4 |
Message Type (0x00CF) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
: |
AIB Address Method Depends on component being addressed. |
8, 9 |
Status, MSB, LSB
|
|
10 |
Checksum |
||
|
Number of AEs to follow |
|||
|
AE The AE used depends on the component being addressed.
See PPL Component Addressing |
|||
|
: |
PPL Component ID (MSB, LSB) See PPL Component IDs in the API Reference. |
|
|
|
: |
PPL Timer Type
0x01 Generic Protocol Timer 0x02 R2 Signaling Timer
0x03 DTMF Signaling Timer 0x04 MFR1 Signaling Timer 0x05 Dial Pulse Timer |
||
|
: |
PPL Timer ID The specific timer according to its type. The meaning of the time ID depends on the value of the PPL Timer Type field. Valid entries for this field are listed below by PPL Timer Type field value. The default durations for timers are shown in parenthesis in 10 ms units.
0x01 Generic Protocol Timer IDs Refer to Transmit Signaling Timers in the Timers and Filters chapter for the range of values.
0x02 R2 Signaling Timer 0x01 Pulse Duration (15) The length of time to transmit a pulsed R2 signal. 0x02 Pulse Delay (15) The minimum delay between the end of transmission of the last R2 signal of the compelled cycle and the start of transmission of a pulsed signal. 0x03 Minimum Valid Duration (7) The minimum length of time a signal must be received before it is declared a valid signal. 0x04 Maximum Tone State Change (2000) ń the length of time to scan a receive R2 signal state change.
0x03 DTMF Signaling Timer 0x01 DTMF Transmit Duration (6) 0x02 DTMF Transmit Inter-digit Duration (6) 0x03 DTMF Maximum Receive 1st Digit Detect (2000) 0x04 DTMF Maximum Receive Inter-digit Timeout (2000) 0x05 DTMF Minimum Receive Digit Duration (4) 0x06 DTMF Minimum Receive Inter-digit Timeout (4)
0x04 MFR1 Signaling Timer 0x01 MFR1 Transmit KP Duration (10) 0x02 MFR1 Transmit Digit Duration (6) 0x03 MFR1 Transmit Inter-digit Duration (6) 0x04 MFR1 Minimum Receive KP Duration (5) 0x05 MFR1 Minimum Receive Digit Duration (3) 0x06 MFR1 Maximum Receive KP Detect (1000) 0x07 MFR1 Minimum Receive Inter-digit Timeout (3) 0x08 MFR1 Maximum Receive Inter-digit Timeout (1000)
|
||
|
: |
0x05 Dial Pulse Signaling Timer 0x01 Dial Pulse Transmit Make Duration (4) 0x02 Dial Pulse Transmit Break Duration (6) 0x03 Dial Pulse Transmit Inter-digit Timeout (60) 0x04 Dial Pulse Receive Minimum Make Duration (3) 0x05 Dial Pulse Receive Maximum Make Duration (10) 0x06 Dial Pulse Receive Minimum Break Duration (4) 0x07 Dial Pulse Receive Maximum Break Duration (10) 0x08 Dial Pulse Receive Maximum First Digit Detect (2000) 0x09 Dial Pulse Receive Maximum Inter-digit Timeout (2000) |
||
|
: |
PPL Timer Value MSB, LSB Timers are in 10 millisecond units. See the Timer Conversion Table. Changing the Connection Type with the ISDN Interface Configure message sets all
Note: For Generic Protocol Timer ID 0x04, the PPL Timer Value the preferred value is 0x0078. |
||
|
: |
Checksum |
||