You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Transmit Cadence Pattern Configure 0x0030

Transmit Cadence Pattern Configure 0x0030

SwitchKit Name

TransmitCadencePatternConfig

Type

EXS API and SwitchKit API message

Description

This message is used to allow the host to configure any transmit cadence pattern. The host can create the cadence and the duration of the tone needed.

Each cycle block shown below represents two durations, either of which could be silence (Tone ID=0) or some valid Tone ID. These cycle blocks can be repeated or strung together with different cycle blocks. For tones which are to be continuously on the duration should be set to 0xFFFF.

Sent by

Host

SwitchKit Code

Configuration

TransmitCadencePatternConfig (

Node = integer,

UpdateFlag = integer,

Action = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE UpdateFlag;

UBYTE Action;

UBYTE Data[251];

} XL_TransmitCadencePatternConfig;

C++ Class

class XLC_TransmitCadencePatternConfig : public XLC_OutboundMessage {

public:

UBYTE getUpdateFlag() const;

void setUpdateFlag(UBYTE x);

UBYTE getAction() const;

void setAction(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

 

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

1, 2

Length (0x0007)

3, 4

Message Type (0x0030)

3, 4

Message Type (0x0030)

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

 

9

Action

10

Data[0]

:

:

:

Checksum

 

EXS API Hex Format - Detailed

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x00NN)

1, 2

Length (0x0007)

3, 4

Message Type (0x0030)

3, 4

Message Type (0x0030)

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

A configuration is "engaged" when it is used when the tone is transmitted.

0x00 Store configuration but do not engage it.

This is the normal case for large configuration of parameters.
Configuration will not be engaged until another message has this bit set to 1.

0x01 Engage configuration immediately

This is usually set for the last configuration message so configuration engaging
takes place only once and for all of the new configuration previously sent.

 

NOTE: A Transmit Tone Query message shows the configuration as updated even when the
Update All flag is not set.

9

Action

0x01 Configure Pattern

10

Data[0]

The following data representation uniquely identifies a cadence pattern to be generated
using the Connect Tone Pattern message. This message can be used for an existing pattern
or a new one. The maximum number of cycle blocks in one pattern is three. The cycle block
representation is a generic form in which all transmit cadence patterns could be created.


Durations are expressed in 10 ms units.

 

Data[0] Transmit Cadence Pattern ID

Data[1] Number of Cycle Blocks

Data[2] Block 1 Tone ID

Data[3] Reserved

Data[4] Block 1 On Duration, MSB

Data[5] Block 1 On Duration, LSB

Data[6] Block 1 Off Duration, MSB

Data[7] Block 1 Off Duration, LSB

Data[8] Number of times to execute this on and off cadence within this block, MSB

Data[9] Number of times to execute this on and off cadence within this block, LSB

:

Data[n++] Block n Tone ID

Data[n++] Reserved

Data[n++] Block n On Duration, MSB

Data[n++] Block n On Duration, LSB

Data[n++] Block n Off Duration, MSB

Data[n++] Block n Off Duration, LSB

Data[n++] Number of times to execute this on and off cadence within this block, MSB

Data[n++] Number of times to execute this on and off cadence within this block, LSB

:

Checksum

Example

NOTE: To transmit the pattern continuously, do not set the "Number of times. . ." parameter in this message to 0xFFFF. Instead, set the appropriate parameter in the Connect Tone Pattern message. Please refer to the Connect Tone Pattern message for more information.

The following example shows the message contents that would be sent to configure a specific cadence pattern to be transmitted on any channel.

Durations are expressed in 10 ms units.

Configure Pattern: Pattern ID Number 2 (Ringback)

Cycle Block 1: Tone ID 4, 400 ms On/200 ms Off, execute once

Cycle Block 2: Tone ID 4, 400 ms On/3000 ms Off, execute once

Byte

Message

Value

0

Frame

0xFE

1

Length, MSB

0x00

2

Length, LSB

0x19

3

Message Type, MSB

0x00

4

Message Type, LSB

0x30

5

Reserved

0x00

6

Sequence Number

SN

7

Logical Node ID

0xFF

8

Update All Flag

0x01

9

Action

0x01

10

Data[0]: Transmit Pattern ID (0x01-0x3F)

0x02

11

Data[1]: Number of Cycle Blocks

0x02

12

Data[2]: Block 1 Tone ID

0x04

13

Data[3]: Reserved

0x00

14

Data[4]: Block 1 On Duration, MSB

0x00

15

Data[5]: Block 1 On Duration, LSB

0x28

16

Data[6]: Block 1 Off Duration, MSB

0x00

17

Data[7]: Block 1 Off Duration, LSB

0x14

18

Data[8]: Number of times to execute this cycle, MSB

0x00

19

Data[9]: Number of times to execute this cycle, LSB

0x01

20

Data[10]: Block 2 Tone ID

0x04

21

Data[11]: Reserved

0x00

22

Data[12]: Block 2 On Duration, MSB

0x00

23

Data[13]: Block 2 On Duration, LSB

0x28

24

Data[14]: Block 2 Off Duration, MSB

0x01

25

Data[15]: Block 2 Off Duration, LSB

0x2C

26

Data[16]: Number of times to execute this cycle, MSB

0x00

27

Data[17]: Number of times to execute this cycle, LSB

0x01

28

Checksum

CS