Effect definition response packet, Data description, Get effect parameter definition – Lexicon DC-2 User Manual

Page 19: Command packet description, Data validation

Advertising
background image

Lexicon, Inc.
DC-2/MC-1 Serial Communications Protocol

Printed on: 10/19/00

19 of 44

Application Header:
Command

DC_RESP_EFFECT_DEF

0x85

Data Count

2 + strlen(EffectName) + 1

nn

Application Data:
Data[0]

EffectId

nn

Data[1]

MaxParameters

nn

Data[2]- Data[DataCount-1]

EffectName

ch ch ch … 0x00

7.3.9.5 Data Description

EffectId:

Data Type:

Unsigned 8 bit integer

Max:

Set by the Effect Count in the “Unit Configuration Packet”.

MaxParameters: Maximum number of parameters assigned to this effect.

EffectName:

Data Type:

Null(0x00) terminated ASCII character string.

Max Length:

EFFECT_NAME_LENGTH defined in Appendix E Protocol Constants.

7.3.10 Get Effect Parameter Definition

Request to DC-2/MC-1 for an effect parameter definition. DC-2/MC-1 will respond with “Effect Parameter
Definition Packet”.

7.3.10.1 Command Packet Description

Application Header:
Command

DC_CMD_GET_EFFECT_PARAM_DEF

0x1C

Data Count

2

0x02

Application Data:
Data[0]

EffectId

nn

Data[1]

ParamId

nn

7.3.10.2 Data Description

EffectId:

Data Type:

Unsigned 8 bit integer.

Max:

Set by the Effect Count in the “Unit Configuration Packet”.

ParamId:

Data Type:

Unsigned 8 bit integer.

Max:

Set by the Parameter Count in the “Effect Definition Packet”.

7.3.10.3 Data Validation:

The EffectId must be a valid Effect Id. If it is not the DC-2/MC-1 will respond with a NAK packet and
error code DC_ERR_ INVALID_EFFECT_ID. The ParamId must be a valid Parameter number. If it is not
the DC-2/MC-1 will respond with a NAK packet and error code DC_ERR_
INVALID_PARAM_NUMBER.

7.3.10.4 Effect Parameter Definition Response Packet

Advertising
This manual is related to the following products: