Configuring a Sample Pattern ID

Overview

The following example shows how to configure Pattern ID 0x17 to receive a three-second, 400 Hz tone. To perform this task, the host sends three API messages as follows:

1. Tone Configure message to replace the default tone (Tone ID 0x0F, 425 Hz) with the new, 400 Hz tone.

2. CPA Pattern Configure message - create the new Pattern ID 0x17.

3. CPA Class Configure message - add Pattern 0x17 to class 0x00.

Table 9-21 First Message: Tone Configure

Byte

Field Description

0

Message Frame 0xFE

1, 2

Length (2 bytes) 0x0011

3, 4

Message Type (2 bytes) 0x0031

5

Reserved 0x00

6

Sequence Number

7

Logical Node ID 0xFF

8

Update All Flag 0x01

9

Reserved 0x00

10

Tone Type 0x06

11

Action 0x01

12

Data[0] Tone ID being changed 0x0F

13

Data[1] Reserved 0x00

14

Data[2] Number of frequencies in tone 0x01

15

Data[3] Reserved 0x00

16

Data[4] Frequency Value[0], Hz, MSB 0x01

17

Data[5] Frequency Value[0], Hz, LSB 0x90

18

Data[6] Reserved 0x00

19

Data[7] Reserved 0x00

20

Checksum

Table 9-22 Second Message: Call Progress Analysis Pattern Configure

Byte

Field Description

0

Message Frame 0xFE

1, 2

Length (2 bytes) 0x0016

3, 4

Message Type (2 bytes) 0x00B2

5

Reserved 0x00

6

Sequence Number

7

Logical Node ID 0xFF

8

Update All Flag 0x01

9

Pattern ID 0x17

10

Action: Add/Replace Pattern 0x01

11

Data[0] Pattern ID to report on detection 0x17

12

Data[1] Tone Group ID 0x00

13

Data[2] Pattern Configuration 0x01

14

Data[3] CPA Report on Pattern Loss 0x17

15

Data[4] Interval Cycles to Match 0x01

16

Data[5] Interval Cycles to Report 0x01

17

Data[6] Reserved 0x00

18

Data[7] Interval Descriptor Count 0x01

19

Data[8] Tone ID 0x0F

20

Data[9] Reserved 0x00

21

Data[10] Minimum filter (in 10 ms units) MSB 0x00

22

Data[11] Minimum filter (in 10 ms units) LSB 0x50

23

Data[12] Maximum filter (in 10 ms units) MSB 0x00

24

Data[13] Maximum filter (in 10 ms units) LSB 0x00

25

Checksum

 

 

 

Table 9-23 Third Message: Call Progress Analysis Class Configure

Byte

Field Description

0

Message Frame 0xFE

1, 2

Length (2 bytes) 0x0009

3, 4

Message Type (2 bytes) 0x00B3

5

Reserved 0x00

6

Sequence Number

7

Logical Node ID 0xFF

8

Update All Flag 0x01

9

Class ID 0x00

10

Action 0x01

11

Data[0] Pattern ID 0x17

12

Checksum