Lexicon MC-12 Balanced User manual

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
Serial Communications Protocol Definition
Project: Lexicon MC-12/MC-12B/MC-12 Room EQ
Updated: July 13, 2005
Software Version 5.0
Protocol Version:
Major rev 1
Minor rev 6
© 2005 Harman Specialty Group All rights reserved. 1 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
© 2005 Harman Specialty Group All rights reserved. 2 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
Manufactured under license from Dolby Laboratories. “Dolby”, “Pro Logic”, and the double-D
symbol are trademarks of Dolby laboratories.
THX and the THX logo are trademarks of THX Ltd. which may be
registered in some jurisdictions. All rights reserved.
The THX logo is a trademark of THX Ltd. which may be registered in
some jurisdictions. All rights reserved.
THX and Ultra2 are trademarks of THX Ltd. THX may be registered in some jurisdictions.
All rights reserved.
Manufactured under license from Digital Theater Systems, Inc. U.S. Pat. No. 5,451,942;
5,956,674; 5,974,380; 5,978,762 and other world-wide patents issued and pending. “DTS”, “DTS-
ES Extended Surround” and “Neo:6” are trademarks of Digital Theater Systems, Inc. © 1996,
2000 Digital Theater Systems, Inc. All rights reserved.
“Lexicon” and the Lexicon logo are registered trademarks of Harman International Industries.
U.S. patent numbers and other worldwide patents issued and pending.
“LOGIC7” and the L7 logo are registered trademarks of Harman International Industries. U.S.
patent numbers and other worldwide patents issued and pending.
© 2005 Harman Specialty Group All rights reserved.
This document should not be construed as a commitment on the part of Harman Specialty Group.
The information it contains is subject to change without notice. Harman Specialty Group assumes
no responsibility for errors that may appear within this document.
Lexicon
3 Oak Park
Bedford, MA 01730-1413 USA
Telephone: [phone]
Fax: [phone]
www.lexicon.com
Customer Support
Telephone: [phone]
Sales Fax: [phone]
Service Fax: [phone]
Product Shipments
16 Progress Road
Billerica, MA 01821-5730 USA
Harman Specialty Group
Part No. 070-15859 REV 5
© 2005 Harman Specialty Group All rights reserved. 3 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
1 Documents 7
1.1 Change List 7
2 Definitions 7
2.1 Protocol Version Cross-reference 8
3 Abbreviations 8
4 General Description 8
5 Physical Layer 10
DB-9 RS232 Connector 10
5.2 Serial Port Driver 10
5.3 Errors 10
5.4 MC-12 Receive Buffer 10
5.5 MC-12 Hardware Verification (V1.10, Not Supported in MC-12 V1.00, V1.01) 10
6 Data Link Layer 11
6.1 Errors 11
7 Application Layer 12
7.1 MC-12 Asynchronous Notification Packets 12
7.1.1 Wakeup Notification (MC-12, MC-1) 12
7.1.2 Sleep Notification (MC-12, MC-1) 12
7.1.3 Front Panel Display (MC-12, MC-1) 12
7.1.4 MC-1 Parameter Change (MC-12, MC-1) 13
7.1.5 MC-12 Parameter Notification by Id (MC-12) 15
7.2 Acknowledgment Packets 16
7.2.1 Acknowledge (MC-12, MC-1) 16
7.2.2 No Acknowledge (MC-12, MC-1) 17
7.3 Host Initiated Command Packets 17
7.3.1 Reset Unit (MC-12, MC-1) 17
7.3.2 Restore (MC-12, MC-1) 17
7.3.3 MC-1 Send IR Command (MC-12, MC-1) 18
7.3.4 Get Unit Configuration (MC-12, MC-1) 18
7.3.5 Get System Status (MC-12, MC-1) 21
7.3.6 Get Zone 2 Status (MC-12, MC-1) 23
7.3.7 Get System Parameter Definition (MC-1) 24
7.3.8 Get System Parameter Values (MC-1) 24
7.3.9 Get Effect Definition by Id (MC-1) 24
7.3.10 Get Effect Parameter Definition (MC-1) 24
7.3.11 Get Effect Parameter Values (MC-1) 24
7.3.12 Get Custom Name (MC-12, MC-1) 24
7.3.13 Get Input Name by Id (MC-12, MC-1) 25
7.3.14 Get FPD Control Registers (MC-1) 25
7.3.15 Set System Parameter Values (MC-1) 26
7.3.16 Set Effect Parameter Values (MC-1) 26
7.3.17 Set Effect Name by Effect Id (MC-1) 26
7.3.18 Set System Volume (MC-12, MC-1) 26
7.3.19 Set Main Balance (MC-12, MC-1) 26
7.3.20 Set Front/Back Balance (MC-12, MC-1) 27
7.3.21 Set Active Effect by Id (MC-12, MC-1) 28
7.3.22 Set Record Input (MC-12, MC-1) 28
© 2005 Harman Specialty Group All rights reserved. 4 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
7.3.23 Clear Record Input (MC-12, MC-1) 29
7.3.24 Set Zone2 Volume (MC-12, MC-1) 29
7.3.25 Set Zone2 Left/Right Balance (MC-12, MC-1) 30
7.3.26 Set Custom Name (MC-12, MC-1) 31
7.3.27 Set Input Name by Id (MC-12, MC-1) 31
7.3.28 Set FPD Control Registers (MC-1) 32
7.3.29 Host Wakeup (MC-12, MC-1) 32
7.3.30 Host Sleep (MC-12, MC-1) 33
7.3.31 Get Communication Configuration (MC-12, MC-1) 33
7.3.32 Set Communication Configuration (MC-12, MC-1) 34
7.3.33 Set Mute (MC-12, MC-1) 34
7.3.34 Set Output Level Adjustments (MC-1) 35
7.3.35 Send Display String Command (MC-12, MC-1) 35
7.3.36 MC-12 Get Parameter Definition by Id (MC-12) 36
7.3.37 MC-12 Set Parameter Value by Id (MC-12) 38
7.3.38 MC-12 Set Parameter Value by Id, No Run (MC-12) 40
7.3.39 MC-12 Get Unit Configuration (MC-12) 40
7.3.40 MC-12 Send IR Command (MC-12) 43
7.3.41 MC-12 Get Parameter Value by Id (MC-12) 43
7.3.42 MC-12 Set Parameter Notification by Id (MC-12) 44
7.3.43 MC-12 Parameter Get Value String by Id (MC-12) 45
7.3.44 MC-12 Clear All Parameter Notifications (MC-12) 46
7.3.45 MC-12 Get System Status (MC-12) 46
7.3.46 MC-12 Get Record Status (MC-12) 48
7.3.47 MC-12 Set System Volume (MC-12) 49
7.3.48 MC-12 Set Main Balance (MC-12) 49
7.3.49 MC-12 Set Front/Back Balance (MC-12) 50
7.3.50 MC-12 Set Active Effect by Id (MC-12) 50
7.3.51 MC-12 Set Record Input (MC-12) 51
7.3.52 MC-12 Set Zone2 Volume (MC-12) 52
7.3.53 MC-12 Set Zone2 Left/Right Balance (MC-12) 52
7.3.54 MC-12 Get Input Name by Id (MC-12) 53
7.3.55 MC-12 Set Input Name by Id (MC-12) 54
Appendix A Command Codes 55
Appendix B Error Codes 57
Appendix C DC-2, MC-1 IR-Codes 58
Appendix D MC-12 IR Codes 59
Appendix E MC-1 Input Id’s 60
Appendix F MC-12 Input Ids 60
Appendix G Protocol Constants 61
Appendix H MC-12 to MC-1 Effect Map 62
Appendix I MC-1 to MC-12 Effect ID Map 63
Appendix J MC-12 Mode Ids 64
Application Notes and Examples 65
© 2005 Harman Specialty Group All rights reserved. 5 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
1.1 Box initializations: 65
1.1.1 MC-12: 65
1.1.2 HOST: 65
1.2 Getting System Wide Status and Setup: 65
1.1 Downloading the System Setup to the 65
1.3 MC-12: 65
1.4 Simple System Control & System Status: 65
1.5 Examples: 67
1.5.1 MC-12 Get Unit Configuration 67
1.5.2 Send MC-1 IR Command Example 68
1.5.3 Send MC-12 IR Command Example 69
1.6 MC12 V2.00 Parameter ID List 69
© 2005 Harman Specialty Group All rights reserved. 6 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
1 Documents
The following documents should also be used with this document to understand how this protocol can be
used with an MC-12.
070-13227 MANUAL,OWNER'S,DC2
070-13278 MANUAL,OWNER'S,MC1
MC1/DC2 Serial Port Definition, Protocol Version 0.5
070-14773 Manual, Owner’s, MC12/MC12B
1.1 Change List
9/23/02 Added this paragraph.
9/23/02 Changed “7.9 MC12 V1.10 Parameter ID List” to “7.9 MC12 V2.00 Parameter ID List”
9/23/02 Updated Parameter Id Reference Table 7.9 MC12 V2.00 Parameter ID List for V2.00 s/w.
9/23/02 Updated Appendix J MC-12 Mode Ids for new V2.00 modes.
9/24/02 Updated 7.3.36.4 Parameter Definition Response Packet for correct CurrentValue length.
9/24/02 The range of the PARAM_TYPE_UINT32 parameter type has been corrected.
9/24/02 Updated Appendix H MC-12 to MC-1 Effect Map to reflect added modes in V2.0.
9/24/02 Updated Appendix I MC-1 to MC-12 Effect Map to reflect added modes in V2.0.
10/2/02 Updated Appendix D MC-12 IR Codes to reflect added button functionality for V2.0.
6/10/03 Updated Parameter Id Reference Table 7.9 MC12 V3.00 Parameter ID List for V3.00 s/w.
6/10/03 Updated Appendix J MC-12 Mode Ids for new V3.00 modes.
6/10/03 Updated 7.1.4 MC-1 Parameter Change (MC-12, MC-1) to reflect the disabled default state.
6/10/03 Added paragraph 7.1.5.4 Defaults to show parameters that are defaulted for notification.
2/4/04 Updated Paragraph 7.3.50 to correctly reference the Definition/Conversion: Appendix J MC-12
Mode Ids
7/9/04 Updated Parameter Id Reference Table 7.9 MC12 V4.00 Parameter ID List for V4.00 s/w.
7/9/04 Added Direct Mode Ir code Table. Ir codes are not support by the actual remote control.
6/30/05 Updated Parameter Id Reference Table 7.9 MC12 V5.00 Parameter ID List for V5.00 s/w.
6/30/05 Added Dolby PLIIx Direct Mode Ir codes Table. Ir codes are not support by the actual remote
control.
2 Definitions
User Parameter: A user changeable variable that stores a specific value that describes an
operating condition for the MC-12 system.
HOST: The device initiating or receiving the serial communication packets to/from the
MC-12.
MC-12 ,MC-1,DC-2: The Lexicon product receiving or transmitting the serial communication packets
to/from the HOST.
Nonvolatile RAM: The area of memory in an MC-12 that stores users adjustable parameters. The
Nonvolatile RAM is battery backed, to maintain values during MC-12 power
down.
© 2005 Harman Specialty Group All rights reserved. 7 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
2.1 Protocol Version Cross-reference
All references to MC-12 shall be valid for both the MC-12 and SDP-40 products unless specifically
documented otherwise. All references to MC-1 shall be valid for the MC-1, DC-2 and SDP-3 products
unless specifically documented otherwise.
3 Abbreviations
SOP Start of Packet
EOP End of Packet
ACK Acknowledge
NAK No Acknowledge
FPD Front Panel Display
4 General Description
The intention of the MC-12 serial port and protocol communication is for an external connected HOST to
control and obtain status from the MC-12. The protocol has been designed to focus on two specific goals.
The first is HOST uploading and downloading of MC-12 configuration, and system/effect setups. The
second is HOST control of basic user adjustable parameters.(i.e. input, volume, balance…)
The MC-12 uses simple notification, command, response and acknowledgment packets to have
communication transactions with a given HOST. This protocol is designed for point to point
communication between a HOST and MC-12. The MC-12 Protocol is a 3 layered system. The MC-12
serial protocol allows for the MC-12, or the HOST, to initiate a communication transaction. Most
transactions are initiated by the HOST. MC-12 then responds to the HOST command with either a
response or acknowledgment packet. There are a few asynchronous notifications that MC-12 initiates
indicating system changes. Each transaction initiated must wait for a corresponding response before
initiating the next transmission.
HOST Rs-232 Serial Link
CD VOL
Lexicon MC-12
The 3 protocol layers are Physical, Data Link, and Application Layers.
Application Layer
Data Link Layer
Physical Layer (RS232)
The MC-12 Serial Protocol attempts to be as backward compatible with the MC-1 as possible. This
document will try to inform the user/programmer of the consistencies and differences between the MC-1
protocol and the MC-12 protocol. The basic structure of the protocol has not changed. A number of
© 2005 Harman Specialty Group All rights reserved. 8 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
command/responses/notifications packets have been implemented exactly as they were in the MC-1. These
commands may not fully exercise the functionality of the MC-12 (i.e. Mc-1 has 8 inputs that have been
mapped to 8 of the 12 inputs on the MC-12, MC-1 IR codes are not the same as MC-12 IR codes) In the
case of these commands additional MC-12 commands have been added to fully implement the MC-12
functionality. In addition, some the internal structure of the MC-12 has forced the protocol to be unable to
support some MC-1 commands. These commands have been totally replaced with new commands that
provide more control over the MC-12 than was capable in the MC-1. (Parameter Set/Get commands)
© 2005 Harman Specialty Group All rights reserved. 9 of 106

Lexicon
MC-12 Serial Communications Protocol Printed on: 07/13/05
5 Physical Layer
5.1 DB-9 RS232 Connector
MC-12
COM1
5
3
2
9 Pin D-Shell (male)
Ground
Transmit Data
Receive Data
5
3
2
5
3
2
5
3
2
Host
Receive Data
Transmit Data
9 Pin D-Shell (female)
Ground
9 Pin D-Shell (female) 9 Pin D-Shell (male)
Note: The wiring requirements for a 9 pin to 9 pin serial connection, are a male to female straight through
cable.
5.2 Serial Port Driver
MC-12 serial port has been setup to operate as follows:
Operating Mode: Full Duplex
Baud rate: 19.2K baud
Data Size: 8 bits (1 byte)
Parity: Odd
Stop Bits: 1
Hardware Handshaking: None
5.3 Errors
The MC-12 will detect parity, framing and data overrun errors. If any of the physical layer errors are
detected, the complete packet is corrupted and the MC-12 will reset the transaction and begin to look for a
start of packet byte.
5.4 MC-12 Receive Buffer
The MC-12 has an internal receive buffer. The buffer is 256 Bytes and will transmit a NAK packet with an
error code of DC_ERR_BUFFER_FULL to the HOST if the buffer is full. If the buffer is full, all data
transmitted to the MC-12 will be ignored. Therefore, making the currently transmitted packet, if partially
transmitted invalid.
5.5 MC-12 Hardware Verification (V1.10, Not Supported in MC-12 V1.00, V1.01)
This test verifies the RS232 ports are working by comparing the transmitted signal (at pin 2) to the
received signal (at pin 3). The MC-12 transmits a known test signal just following a power up. The MC-12
monitors the serial port receivers while transmitting the test signal. If the signals are the same, the test
passes. In order to test this circuit, RS232 Wraparound plug(s) are needed and must be installed at the
female D9 connector(s) on the rear panel of the MC-12 labeled “RS232”. The wraparound plug shorts pins
2 to 3, allowing for the MC-12 to receive the signal it is transmitting. Once installed, power cycle the MC-
12 and verify the following message is displayed on the FPD:
© 2005 Harman Specialty Group All rights reserved. 10 of 106