Command packet description, Data description, Dc-2/mc-1 response – Lexicon DC-2 User Manual

Page 24: Data validation, Set effect name by effect id

Advertising
background image

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

Printed on: 10/19/00

24 of 44

7.3.16.1 Command Packet Description

Application Header:
Command

DC_CMD_SET_EFFECT_PARAM_VALUES

0x1F

Data Count

EFFECT_COUNT[EffectId] + 1

nn

Application Data:
Data[0]

EffectId

nn

Data[1]

effect_param_value[0]

nn

Data[…]

effect_param_value[…]

nn

Data[DataCount-1]

effect_param_value[EFFECT_COUNT-1]

nn

7.3.16.2 Data Description

EffectId:

Data Type:

Unsigned 8 bit integer.

Max:

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

effect_param_value:

Data Type:

Unsigned 8 bit integer array.

Max:

Dependent on the parameter definition

7.3.16.3 DC-2/MC-1 Response

The DC-2/MC-1 will assign the values from the packet to the effect parameter values in Nonvolatile RAM.
If the effect is active the DC-2/MC-1 will reload the effect to activate all the parameter values.

7.3.16.4 Data Validation

If a value is passed that exceeds the maximum value of that parameter the DC-2/MC-1 will ignore the
command and transmit a DC_NAK command with an error code DC_ERR_INVALID_DATA.

7.3.17 Set Effect Name by Effect Id

Sets an effect name to the transmitted value for a given effect.

7.3.17.1 Command Packet Description

Application Header:
Command

DC_CMD_SET_EFFECT_NAME

0x20

Data Count

strlen(EffectName) + 2

nn

Application Data:
Data[0]

EffectId

nn

Data[1]-Data[DataCount-1]

EffectName

ch ch ch … 0x00

7.3.17.2 Data Description

EffectId:

Data Type:

Unsigned 8 bit integer

Max:

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

EffectName:

Data Type:

Null(0x00) terminated ASCII character string.

Max Length:

EFFECT_NAME_LENGTH defined in Appendix E Protocol Constants.

7.3.17.3 DC-2/MC-1 Response

The DC-2/MC-1 will copy the Effect Name to Nonvolatile RAM. If the effect being adjusted is active the
effect will be reloaded for the changes to be initialized.

7.3.17.4 Data Validation:

Advertising
This manual is related to the following products: