User manual LEXICON MC-4 V1.00 SERIAL PROTOCOL DEFINITIONS REV 1-6

[. . . ] MC-4 Serial Protocol Definitions Software Version 1. 00/1. 10 Protocol Version: Major Rev 1 Minor Rev 6 Lexicon MC-4 Serial Communications Protocol "Lexicon" and the Lexicon logo are registered trademarks of Harman International Industries. patent numbers and other worldwide patents issued and pending. Windows® is a registered trademark of Microsoft Corporation. © 2005 Harman International Industries, Incorporated. This document should not be construed as a commitment on the part of Harman International Industries, Inc. The information it contains is subject to change without notice. [. . . ] The system is fully muted. 6. 3. 9. 3 MC-4 Response The MC-4 will set the mute state according to the value transmitted. The MC-4 may still be full muted if other conditions require the audio path to be muted. This is only a direct access to the user mute state. 6. 3. 9. 4 Data Validation The data value transmitted to the MC-4 will be verified as a valid value. If it is valid, the MC-4 will set/clear the mute and respond with an ACK Packet. If the data value is invalid, the MC-4 will respond with a DC_INVALID_DATA error NAK. 6. 3. 10 Send Display String Command This command allows the Host to send a 40 character string to the MC-4 for display on the OSD and Front Panel Display (FPD). 6. 3. 10. 1 Packet Description Application Header: Command Data Count Application Data: Data[0] Data[1]-Data[DataCount-1] 6. 3. 10. 2 Data Description Display Command Flags: Word 0 0 0 0 0 0 0 0 Bit 0 1 2 3 4 5 6 7 Definition FPD only: If set TRUE, the display string will only be sent to the FPD device for display. 0x00 DC_CMD_SET_DISPLAY_ST R Number of characters in the DisplayStr + 2 0x33 nn 16 Lexicon MC-4 Serial Communications Protocol Display String: Data Type: Max Length: Null (0x00) terminated ASCII character string. 40 Characters. 6. 3. 10. 3 MC-4 Response The display string is sent to the OSD and Front Panel Display. The MC-4 will ACK when completed with this command. 6. 3. 10. 4 Data Validation: If a string length exceeds the 40 character maximum, the string will be truncated before displaying and the MC-4 will transmit a DC_NAK command with an error code DC_INVALID_DATA. 6. 3. 11 MC-4 Get Parameter Definition by Id Request to MC-4 for a Parameter Definition by Parameter Id. MC-4 will respond with "MC-4 Parameter Definition Packet". 6. 3. 11. 1 Command Packet Description Application Header: Command MC_GET_PARAM_BY_ID Data Count 2 Application Data: Data[0] ParamId(LSB) Data[1] ParamId(MSB) 6. 3. 11. 2 Data Description ParamId: Data Type: Max Value: 0x35 0x02 nn nn Unsigned 16 bit Integer Max Parameter Count as reported by the MC-4 Unit Configuration Response Packet (6. 3. 14. 2 page 22). 6. 3. 11. 3 Data Validation: If the ParamId is not a valid Id, the MC-4 will respond with a NAK packet and error code DC_ INVALID_PARAM_ID. 17 Lexicon MC-4 Serial Communications Protocol 6. 3. 11. 4 Parameter Definition Response Packet The following Packet has been defined as follows for the MC-4 V1. 00. Future releases may modify this definition. Application Header: Command Data Count Application Data: Data[0] Data[1] Data[2] Data[3] Data[4] Data[5] Data[6] Data[7-27] Data[28]-Data[108] Data[108] 6. 3. 11. 5 Data Description ParamId: Data Type: Max Value: ParamType: Param Type ID 0 1 2 3 4 5 6 7 8 9 Data Size (Bytes) 1 2 9 14 4 1 1 N/A 2 21 MC_SYS_PARAM_DEF_PKT 110 ParamId(LSB) ParamId(MSB) ParamType MAX Value(LSB) MAX Value(MSB) MIN Value(LSB) MIN Value(MSB) CurrentValue[0 -20] Parameter Path Read Only 0x8F 0x6E nn nn nn nn nn nn nn nn nn nn. . . 0x00 nn Unsigned 16 bit Integer Max Parameter Count as reported by the MC-4 Unit Configuration Response Packet (6. 3. 14. 2 page 22). Param Type Name PARAM_TYPE_UINT8 PARAM_TYPE_UINT16 PARAM_TYPE_CSTR8 PARAM_TYPE_CSTR13 PARAM_TYPE_UINT32 PARAM_TYPE_BOOLEAN PARAM_TYPE_INT8 PARAM_TYPE_BRANCH PARAM_TYPE_INT16 PARAM_TYPE_CSTR20 Data: Type Description Unsigned 8 bit integer (0 to 255) Unsigned 16 bit integer (0 to 65535) Zero terminated string of 8 ASCII characters Zero terminated string of 13 ASCII characters Unsigned 32 bit integer (0 to 4, 294, 967, 295 ) Boolean( 0 to 1) Signed 8 bit integer (-127 to 128) Parameter Branch Signed 16 bit integer (-32, 767 to 32, 768) Zero terminated string of 20 ASCII characters The data value transmitted is dependent on the ParamType, as described above. The CurrentValue is always packed starting at the CurrentValue [0] byte in the packet. For multi-byte data, the values are packed LSB first(CurrentValue [0]) to MSB(CurrentValue [0+(num bytes-1)]). For example: Setting a given signed 16 bit parameter to a value of -300 the data array would be packed as follows: 18 Lexicon MC-4 Serial Communications Protocol Data[0] = 0xd4 Data[1] = 0xfe Data[2 - 13] = don't care. If a parameter's current value is a signed 16 bit parameter with a value of ­3, the data array would be packed as follows: Data[0] = 0xfd Data[1] = 0xff Data[2 - 13] = don't care. All signed values are in the 2's compliment format. Max Value: This is a 16 bit value representing the maximum value for a parameter. [. . . ] INPUT_NAME_LENGTH defined in Protocol Constants table (Appendix D page 38) 6. 3. 26 MC-4 Set Input Name by Id Sets an Input Name to the transmitted value for a given input. 6. 3. 26. 1 Command Packet Description Application Header: Command Data Count Application Data: Data[0] Data[1]-Data[DataCount-1] MC_CMD_SET_INPUT_NAME Number of characters in InputName + 2 InputId InputName 0x48 nn 0 to 7 ch ch ch . . . 0x00 6. 3. 26. 2 Data Description InputId: Data Type: Unsigned 8 bit Integer Description/Conversion: MC-4 Input Ids (Appendix F page 40) InputName: Data Type: Max Length: Null (0x00) terminated ASCII character string. INPUT_NAME_LENGTH defined in Protocol Constants table (Appendix D page 38) 32 Lexicon MC-4 Serial Communications Protocol 6. 3. 26. 3 MC-4 Response MC-4 will copy the InputName to the given input. [. . . ]