ABC Office DC-2 Get System Parameter Definition by Name Command Packet, Dccmdgetsysparambyname

Page 17

Lexicon, Inc.

 

 

DC-2/MC-1 Serial Communications Protocol

Printed on: 10/19/00

Max:

Set by the System Parameter Count in the “Unit Configuration Packet”.

7.3.7.3 Data Validation:

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.7.4 Get System Parameter Definition by Name Command Packet

Application Header:

Command

DC_CMD_GET_SYS_PARAM_BY_NAME

0x19

Data Count

strlen(ParamName) + 1

nn

Application Data:

 

 

Data[0]-Data[DataCount-1]

ParamName

ch ch ch … 0x00

7.3.7.5 Data Description

ParamName:

 

Data Type:

Null(0x00) terminated ASCII character string.

Max Length:

PARAM_NAME_LENGTH defined in Appendix E Protocol Constants.

7.3.7.6 Data Validation:

The ParamName must be a valid Parameter name. If it is not the DC-2/MC-1 will respond with a NAK packet and error code DC_ERR_ INVALID_PARAM_NAME.

7.3.7.7 System Parameter Definition Response Packet

This packet describes the defining information for a given system parameter.

Application Header:

Command

DC_RESP_SYS_PARAM_DEF

0x83

Data Count

3 + strlen(ParamName) + 1

nn

Application Data:

 

 

Data[0]

ParamId

nn

Data[1]

MaxValue

nn

Data[2]

Value

nn

Data[3]- Data[DataCount-1]

ParamName

ch ch ch … 0x00

7.3.7.8 Data Description

ParamId:

The Integer Id assigned to this system parameter.

 

Data Type:

Unsigned 8 bit integer

 

Max:

Set by the System Parameter Count in the “Unit Configuration Packet”

MaxValue:

Maximum Value allowed for this system parameter.

 

Data Type:

Unsigned 8 bit integer

 

Max:

255

Value:

The Current Value for this system parameter.

 

Data Type:

Unsigned 8 bit integer

 

Max:

MaxValue(in this Packet)

ParamName:

 

Data Type:

Null(0x00) terminated ASCII character string.

Max Length:

PARAM_NAME_LENGTH defined in Appendix E Protocol Constants.

17 of 44

Image 17
Contents Serial Communications Protocol Definition Data Link Layer Internal Use Definitions DocumentsAbbreviations General DescriptionSerial Port Driver DB-9 RS232 ConnectorPhysical Layer DC-2/MC-1 Receive Buffer ErrorsDC-2/MC-1 Hardware Verification Data Link LayerDC-2/MC-1 Asynchronous Notification Packets Application LayerWakeup Notification Notification Packet DescriptionFront Panel Display Buffer Sleep NotificationHost Response Expected Data DescriptionSupported System Parameters Host ResponseNo Acknowledge Acknowledgment PacketsAcknowledge Reset Unit Host Initiated Command PacketsRestore Defaults Send IR Command4.2 DC-2/MC-1 Unit Configuration Response Packet Get DC-2/MC-1 Unit Configuration3.3 DC-2/MC-1 Response Data ValidationSW Type Product IDTHX AC3 DTS SW LevelDcrespsysstatus Get System StatusSystem Status Response Packet Rateunknown RATE44 RATE48 RATE88 Get Record/Zone 2 StatusRATE96 INSTREAMAC351Get System Parameter Definition Get System Parameter Definition by Id Command PacketRecord/Zone2 Status Response Packet DccmdgetrecstatusSystem Parameter Definition Response Packet Get System Parameter Definition by Name Command PacketDccmdgetsysparambyname DcrespsysparamdefGet Effect Definition by Id Get System Parameter ValuesSystem Parameter Values Response Packet Effect Definition Response PacketEffect Parameter Definition Response Packet Get Effect Parameter DefinitionDcrespeffectdef Dccmdgeteffectparamdef10.5 Data Description Get Effect Parameter ValuesEffect Parameter Values Response Packet ApplicationHeaderData Description Custom Name Response Packet Get Custom NameGet Input Name by Id FPD Control Register Response Packet Get FPD Control RegistersInput Name Response Packet Set Effect Parameter Values Set System Parameter Values15.3 DC-2/MC-1 Response Dcrespfpdcontrol16.3 DC-2/MC-1 Response Set Effect Name by Effect Id17.3 DC-2/MC-1 Response DccmdseteffectparamvaluesSet Main Balance Set System Volume18.3 DC-2/MC-1 Response 19.3 DC-2/MC-1 ResponseSet Active Effect by Id Set Front/Back BalancePacket Description 20.3 DC-2/MC-1 ResponseClear Record/Zone2 Input Set Record/Zone2 Input22.3 DC-2/MC-1 Response Data Validation 23.3 DC-2/MC-1 Response Data ValidationSet Zone2 Left/Right Balance Set Zone2 VolumeSet Custom Name 24.3 DC-2/MC-1 Response26.3 DC-2/MC-1 Response Set Input Name by Id27.3 DC-2/MC-1 Response DccmdsetcustnameHost Wakeup Set FPD Control Registers28.3 DC-2/MC-1 Response Data Description 29.3 DC-2/MC-1 Response31.3 Data Description Get Communication ConfigurationHost Sleep Dccmdsetcomconfig Set Communication ConfigurationSet Mute 32.2 Data Description33.3 DC-2/MC-1 Response Set Output Level Adjustments34.2 Data Description Dccmdsetmute34.3 DC-2/MC-1 Response Send Display String Command35.2 Data Description 35.3 DC-2/MC-1 ResponsePoke Command Peek CommandAppendix a Command Codes Internal UseAcknowledgments ResponsesError CodeHex Appendix B Error CodesHex Function Code Shift Functions Hex Code Rec Function Appendix C DC-2/MC-1 IR-CodesAppendix E Protocol Constants Appendix D Input Id’sInput Name Input Id Constant ValueDecApplication Notes and Examples Appendix F FPD Control RegistersBox initializations 15.1.1 DC-2/MC-1Simple System Control & System Status Getting System Wide Status and SetupDownloading the System Setup to the DC-2/MC-1 Examples Get Unit ConfigurationSOP DLL DC CMD DATA0 DATA1 DATA2 DATA3 DATA4 DATA5 DATA6 DATA7 DATA815.5.3 Set Input Name Get Effect DefinitionCmd Send IR Command Example