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

Transmit Cadence Pattern Query 0x0059

SwitchKit Name

TransmitCadencePatternQuery

Type

EXS API and SwitchKit API message

Description

This message is used to query any of the configured transmit cadence parameters.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE QueryEntity;

UBYTE Data;

} XL_TransmitCadencePatternQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Data[251];

} XL_TransmitCadencePatternQueryAck;

C++ Class

class XLC_TransmitCadencePatternQuery : public XLC_OutboundMessage {

public:

UBYTE getQueryEntity() const;

void setQueryEntity(UBYTE x);

UBYTE getData() const;

void setData(UBYTE x);

};

C++ Class Response

class XLC_TransmitCadencePatternQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

 

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x0007)

1, 2

Length (0x00NN)

3, 4

Message Type (0x0059)

3, 4

Message Type (0x0059)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Query Entity

0x01 Transmit Cadence Pattern

8, 9

Status (MSB, LSB)

9

Data

0x01–0x3 F Transmit Cadence
Pattern ID (1–63)

10

Checksum

 

Response continued below.

10

Data

The following response data represents the pattern configured for the ID specified.

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, 5] Block 1 On Duration (MSB, LSB)

Data[6, 7] Block 1 Off Duration (MSB, LSB)

Data[8, 9] Number of times to execute this cycle (MSB, LSB)

:

Data[n++] Block n Tone ID

Data[n++] Reserved

Data[n++] Block n On Duration (MSB, LSB)

Data[n++] Block n Off Duration (MSB, LSB)

Data[n++] Number of times to execute this cycle (MSB, LSB)

:

Data[n]

:

Checksum

 

Example

This is an example of a message sent to query a Transmit Cadence Pattern. The pattern queried (ID Number 2) is the one sent in the example for the Transmit Cadence Pattern Configure message.

Byte

Message Field

Value

0

Frame

0xFE

1

Length, MSB

0x00

2

Length, LSB

0x07

3

Message Type, MSB

0x00

4

Message Type, LSB

0x59

5

Reserved

0x00

6

Sequence Number

SN

7

Logical Node ID

0xFF

8

Query Entity

0x01

9

Data[0]

0x02

10

Checksum

CS

Byte

Response Field

Value

0

Message Frame

0xFE

1

Length, MSB

0x00

2

Length, LSB

0x07

3

Message Type, MSB

0x00

4

Message Type, LSB

0x59

5

Reserved

0x00

6

Sequence Number

SN

7

Logical Node ID

0xFF

8

Status, MSB

0x00

9

Status, LSB

0x10

5

Data[0]: Transmit Pattern ID (1-63)

0x02

6

Data[1]: Number of Cycle Blocks

0x02

7

Data[2]: Block 1 Tone ID

0x04

8

Data[3]: Reserved

0x00

9

Data[4]: Block 1 On Duration, MSB

0x00

10

Data[5]: Block 1 On Duration, LSB

0x28

11

Data[6]: Block 1 Off Duration, MSB

0x00

12

Data[7]: Block 1 Off Duration, LSB

0x14

13

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

0x00

14

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

0x01

15

Data[10]: Block 2 Tone ID

0x04

16

Data[11]: Reserved

0x00

17

Data[12]: Block 2 On Duration, MSB

0x00

18

Data[13]: Block 2 On Duration, LSB

0x28

19

Data[14]: Block 2 Off Duration, MSB

0x01

20

Data[15]: Block 2 Off Duration, LSB

0x2C

21

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

0x00

22

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

0x01

23

Checksum

CS