You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Call Progress Analysis Class Configure 0x00B3

Call Progress Analysis Class Configure 0x00B3

SwitchKit Name

CPAClassConfig

Type

EXS API and SwitchKit API message

Description

Use this message to add a pattern, delete a pattern, or to change the parameters of a pattern in a call progress analysis class.

Sent by

Host

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

3, 4

Message Type (0x00B3)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

Status MSB, LSB

10

Checksum

8

Update All Flag (see also text below this table)

9

Class ID

10

Action

11

Data[0]

:

:

 

 

:

Data[n]

:

Checksum

SwitchKit Code

Configuration

CPAClassConfig (

Node = integer,

UpdateFlag = integer,

Class = integer,

Action = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE UpdateFlag;

UBYTE Class;

UBYTE Action;

UBYTE Data[250];

} XL_CPAClassConfig;

C++ Class

class XLC_CPAClassConfig : public XLC_OutboundMessage {

public:

UBYTE getUpdateFlag() const;

void setUpdateFlag(UBYTE x);

UBYTE getClass() const;

void setClass(UBYTE x);

UBYTE getAction() const;

void setAction(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

 

EXS API Hex Format - Detailed

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1

Length, MSB

Length, LSB (N)

1

Length, MSB (0x00)

Length, LSB (0x07)

2

2

3

Message Type, MSB (0x00)

Message Type, LSB (0xB3)

3

Message Type, MSB (0x00)

Message Type, LSB (0xB3)

4

4

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

Status MSB, LSB

10

Checksum

8

Update All Flag (see also text below this table)

0x00 Store new configuration but do not use it.

Use if you are sending more configuration messages. Use for a new configuration
that changes many parameters. The Excel platform does not use the new configuration
until the last message has 0x01 in this field.

 

0x01 Use new configuration immediately

Use in the last configuration message. When the Excel platform detects this value,
it uses this and all stored configuration commands to define a new call progress
analysis class configuration.

 

This field indicates whether you are going to update all fields with the configuration that you are defining in this and previous messages.

 

For example, suppose you are updating several characteristics of call progress analysis.
To do so, you are sending several of these CPA Class Configure messages.
To prevent the Excel platform from performing a call progress analysis with a half-old and half-new configuration, you store the new configuration commands until the last new command is sent to the Excel platform.

The Call Progress Analysis Configuration Query message reports configuration changes even when the Update All Flag is not set. But detection does not take place until the flag is set to 0x01.

9

Class ID

This field indicates the class number, which contains the information
for detecting one group of patterns.

10

Action

0x01 Add member pattern

0x02 Delete member pattern

0x03 Change class parameter

11 . . .

Data[0-n]

This field or set of fields provides the necessary information to perform the action indicated in the Action field.

 

0x01 Add Member Pattern
Data[0] Pattern ID

 

0x02 Delete Member Pattern

Data[0] Pattern ID

 

0x03 Change Class Parameter

For parameter definitions, refer to the appropriate Developer’s Guide.

Data[0] Parameter

0x01 Mode*

0x02 Start Delay**

0x03 Continuous Silence Timeout**

0x04 Time to Wait for Pattern Confirmation**

0x05 Time to Wait after Confirmation and No Report**

0x06 Minimum Frequency Glitch Time*

0x07 Minimum Silence Glitch Time**

0x08 Maximum On Timer**

0x09 Maximum Off Timer**

0x0A Advanced Answer Detect***

0x0B Mode Specific 1†

0x0C Mode Specific 2‡


*If Data[0] is 0x01, Data[1–2] are as follows:

Data[1] Reserved

Data[2] Mode

This field is a bit mask that defines the mode.
(0 = disabled, 1 = enabled). To enable multiple options, ‘or’ the bits together.

Bit 0 Advanced Answer Detect

Bit 1 Energy Detection

Bits 2–7 Reserved


**If Data[0] is 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, or 0x09, Data[1–2] are as follows:

Data[1] The time in 10-ms units, MSB

Data[2] The time in 10-ms units, LSB


***If Data[0] is 0x0A, Data[1–2] are as follows:

Data[1] 0x00

Data[2] Number of Frequency Bursts in 500 ms before answer is declared

 

†If Data[0] is 0x0B, Data[1–2] are as follows:

Data[1] 0x00 (Reserved)

Data[2] Sensitivity Level (for more information on Energy Detection mode,
refer to the DSP Series 2 Card Product Description in the Developer’s Guide Overview).

0x00 0 dBm

0x01 5 dBm

0x02 10 dBm

0x03 15 dBm

0x04 20 dBm

0x05 25 dBm

0x06 30 dBm


‡If Data[0] is 0x0C, Data[1–2] are as follows:

Data[1] Scan Duration in 20-ms increments, MSB

Data[2] Scan Duration in 20-ms increments, LSB


The value must be expressed in 20 ms increments, using 10 ms units.
For example, you should use 0x0002 = 20 ms, 0x0004 = 40 ms, and so on.

The Excel platform rounds down odd values.
For example, the system rounds down 0x0003 to = 20ms.
For more information on Energy Detection mode, refer to the appropriate Developer’s Guide.

:

Checksum

 

 

Example 1

The table that follows shows a message that changes the number of frequency bursts per 500 ms (before declaring answer) to "5."

MESSAGE

Byte

Field

Field Value

0

Frame

0xFE

1

Length, MSB

0x00

2

Length, LSB

0x0B

3

Message Type, MSB

0x00

4

Message Type, LSB

0xB3

5

Reserved

0x00

6

Sequence Number

0x01

7

Logical Node ID

0xFF

8

Update All Flag

0x01

9

Class ID

0x00

10

Action

0x03 (Change Class Parameter)

11

Data[0] Parameter

0x0A (Advanced Answer Detect)

12

Data[1] Number of Frequency Bursts, MSB

0x00

13

Data[2] Number of Frequency Bursts, LSB

0x05 (5 bursts per 500 ms)

14

Checksum

0xD1

Example 2

This example shows the message sequence you would use to change the mode of Call Progress Analysis Class 3 to Energy Detection, with a sensitivity level of -30 dBm and a scan duration of 60ms.

To change the mode, you send the following three Call Progress Analysis Class Configure messages in this sequence:

Byte

Message Field

Field Value

8

Action

0x03 (Change Class Parameter)

9

Data[0] – Parameter

0x01 (Mode)

10

Data[1] – Reserved

0x00

11

Data[2] – Mode

0x02 (Energy Detection enabled)

Byte

Message Field

Field Value

8

Action

0x03 (Change Class Parameter)

9

Data[0] – Parameter

0x0B (Mode Specific 1)

10

Data[1] – Reserved

0x00

11

Data[2] – Sensitivity Level

0x06 (-30 dBm)

Byte

Message Field

Field Value

8

Action

0x03 (Change Class Parameter)

9

Data[0] – Parameter

0x0C (Mode Specific 2)

10

Data[1] – Reserved

0x00

11

Data[2] – Scan Duration

0x06 (60 ms)