ABC Office DC-2 Get Effect Parameter Definition, Effect Parameter Definition Response Packet

Page 19

Lexicon, Inc.

 

 

 

 

DC-2/MC-1 Serial Communications Protocol

Printed on: 10/19/00

 

 

 

 

 

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

19 of 44

Image 19
Contents Serial Communications Protocol Definition Data Link Layer Internal Use General Description DocumentsDefinitions AbbreviationsPhysical Layer DB-9 RS232 ConnectorSerial Port Driver Data Link Layer ErrorsDC-2/MC-1 Receive Buffer DC-2/MC-1 Hardware VerificationNotification Packet Description Application LayerDC-2/MC-1 Asynchronous Notification Packets Wakeup NotificationData Description Sleep NotificationFront Panel Display Buffer Host Response ExpectedSupported System Parameters Host ResponseAcknowledge Acknowledgment PacketsNo Acknowledge Send IR Command Host Initiated Command PacketsReset Unit Restore DefaultsData Validation Get DC-2/MC-1 Unit Configuration4.2 DC-2/MC-1 Unit Configuration Response Packet 3.3 DC-2/MC-1 ResponseSW Level Product IDSW Type THX AC3 DTSSystem Status Response Packet Get System StatusDcrespsysstatus INSTREAMAC351 Get Record/Zone 2 StatusRateunknown RATE44 RATE48 RATE88 RATE96Dccmdgetrecstatus Get System Parameter Definition by Id Command PacketGet System Parameter Definition Record/Zone2 Status Response PacketDcrespsysparamdef Get System Parameter Definition by Name Command PacketSystem Parameter Definition Response Packet DccmdgetsysparambynameEffect Definition Response Packet Get System Parameter ValuesGet Effect Definition by Id System Parameter Values Response PacketDccmdgeteffectparamdef Get Effect Parameter DefinitionEffect Parameter Definition Response Packet DcrespeffectdefApplicationHeader Get Effect Parameter Values10.5 Data Description Effect Parameter Values Response PacketGet Input Name by Id Get Custom NameData Description Custom Name Response Packet Input Name Response Packet Get FPD Control RegistersFPD Control Register Response Packet Dcrespfpdcontrol Set System Parameter ValuesSet Effect Parameter Values 15.3 DC-2/MC-1 ResponseDccmdseteffectparamvalues Set Effect Name by Effect Id16.3 DC-2/MC-1 Response 17.3 DC-2/MC-1 Response19.3 DC-2/MC-1 Response Set System VolumeSet Main Balance 18.3 DC-2/MC-1 Response20.3 DC-2/MC-1 Response Set Front/Back BalanceSet Active Effect by Id Packet Description23.3 DC-2/MC-1 Response Data Validation Set Record/Zone2 InputClear Record/Zone2 Input 22.3 DC-2/MC-1 Response Data Validation24.3 DC-2/MC-1 Response Set Zone2 VolumeSet Zone2 Left/Right Balance Set Custom NameDccmdsetcustname Set Input Name by Id26.3 DC-2/MC-1 Response 27.3 DC-2/MC-1 ResponseData Description 29.3 DC-2/MC-1 Response Set FPD Control RegistersHost Wakeup 28.3 DC-2/MC-1 ResponseHost Sleep Get Communication Configuration31.3 Data Description 32.2 Data Description Set Communication ConfigurationDccmdsetcomconfig Set MuteDccmdsetmute Set Output Level Adjustments33.3 DC-2/MC-1 Response 34.2 Data Description35.3 DC-2/MC-1 Response Send Display String Command34.3 DC-2/MC-1 Response 35.2 Data DescriptionInternal Use Peek CommandPoke Command Appendix a Command CodesAcknowledgments ResponsesError CodeHex Appendix B Error CodesHex Function Code Shift Functions Hex Code Rec Function Appendix C DC-2/MC-1 IR-CodesConstant ValueDec Appendix D Input Id’sAppendix E Protocol Constants Input Name Input Id15.1.1 DC-2/MC-1 Appendix F FPD Control RegistersApplication Notes and Examples Box initializationsDownloading the System Setup to the DC-2/MC-1 Getting System Wide Status and SetupSimple System Control & System Status DATA0 DATA1 DATA2 DATA3 DATA4 DATA5 DATA6 DATA7 DATA8 Get Unit ConfigurationExamples SOP DLL DC CMD15.5.3 Set Input Name Get Effect DefinitionCmd Send IR Command Example