Example: Customizing a 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, send three API messages as follows:

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

Tone Type: 0x06

Action: 0x01

Data[0] Tone ID being changed: 0x0F

Data[2] Number of frequencies in tone: 0x01

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

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

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

Update All Flag: 0x01

Pattern ID: 0x17

Action: Add/Replace Pattern: 0x01

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

Data[1] Tone Group ID: 0x00

Data[2] Pattern Configuration: 0x01

Data[3] CPA Report on Pattern Loss: 0x17

Data[4] Interval Cycles to Match: 0x01

Data[5] Interval Cycles to Report: 0x01

Data[7] Interval Descriptor Count: 0x01

Data[8] Tone ID: 0x0F

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

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

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

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

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

Update All Flag: 0x01

Class ID: 0x00

Action: 0x01

Data[0] Pattern ID: 0x17