Lexicon MC-12 V4.0 - SERIAL COMMUNICATIONS PROTOCOL DEFINITION REV... Manual de usuario

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

Serial Communications Protocol Definition

Project: Lexicon MC-12/MC-12B

Updated: July 9, 2004

Software Version 4.0

Protocol Version:

Major rev 1

Minor rev 6

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

Manufactured under license from Dolby Laboratories. “Dolby”, “Pro Logic”, and the double-D

symbol are trademarks of Dolby laboratories.

Lucasfilm and THX are trademarks or registered trademarks of Lucasfilm, Ltd.

authorization.

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-

“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.

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: 781-280-0300

Fax: 781-280-0490

www.lexicon.com

Customer Support

Telephone: 781-280-0300

Sales Fax: 781-280-0495

Service Fax: 781-280-0499

Product Shipments

16 Progress Road

Billerica, MA 01821-5730 USA

Harman Specialty Group

Part No. 070-15859 REV 4

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

1Documents 6

1.1 Change List 6

2 Definitions 6

2.1 Protocol Version Cross-reference 6

3 Abbreviations 7

4 General Description 7

5 Physical Layer 9

DB-9 RS232 Connector 9

5.2 Serial Port Driver 9

5.3 Errors 9

5.4 MC-12 Receive Buffer 9

5.5 MC-12 Hardware Verification (V1.10, Not Supported in MC-12 V1.00, V1.01) 9

6 Data Link Layer 10

6.1 Errors 10

7 Application Layer 11

7.1 MC-12 Asynchronous Notification Packets 11

7.1.1 Wakeup Notification (MC-12, MC-1) 11

7.1.2 Sleep Notification (MC-12, MC-1) 11

7.1.3 Front Panel Display (MC-12, MC-1) 11

7.1.4 MC-1 Parameter Change (MC-12, MC-1) 12

7.1.5 MC-12 Parameter Notification by Id (MC-12) 14

7.2 Acknowledgment Packets 15

7.2.1 Acknowledge (MC-12, MC-1) 15

7.2.2 No Acknowledge (MC-12, MC-1) 16

7.3 Host Initiated Command Packets 16

7.3.1 Reset Unit (MC-12, MC-1) 16

7.3.2 Restore (MC-12, MC-1) 16

7.3.3 MC-1 Send IR Command (MC-12, MC-1) 17

7.3.4 Get Unit Configuration (MC-12, MC-1) 17

7.3.5 Get System Status (MC-12, MC-1) 20

7.3.6 Get Zone 2 Status (MC-12, MC-1) 22

7.3.7 Get System Parameter Definition (MC-1) 23

7.3.8 Get System Parameter Values (MC-1) 23

7.3.9 Get Effect Definition by Id (MC-1) 23

7.3.10 Get Effect Parameter Definition (MC-1) 23

7.3.11 Get Effect Parameter Values (MC-1) 23

7.3.12 Get Custom Name (MC-12, MC-1) 23

7.3.13 Get Input Name by Id (MC-12, MC-1) 24

7.3.14 Get FPD Control Registers (MC-1) 24

7.3.15 Set System Parameter Values (MC-1) 25

7.3.16 Set Effect Parameter Values (MC-1) 25

7.3.17 Set Effect Name by Effect Id (MC-1) 25

7.3.18 Set System Volume (MC-12, MC-1) 25

7.3.19 Set Main Balance (MC-12, MC-1) 25

7.3.20 Set Front/Back Balance (MC-12, MC-1) 26

7.3.21 Set Active Effect by Id (MC-12, MC-1) 27

7.3.22 Set Record Input (MC-12, MC-1) 27

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

7.3.23 Clear Record Input (MC-12, MC-1) 28

7.3.24 Set Zone2 Volume (MC-12, MC-1) 28

7.3.25 Set Zone2 Left/Right Balance (MC-12, MC-1) 29

7.3.26 Set Custom Name (MC-12, MC-1) 30

7.3.27 Set Input Name by Id (MC-12, MC-1) 30

7.3.28 Set FPD Control Registers (MC-1) 31

7.3.29 Host Wakeup (MC-12, MC-1) 31

7.3.30 Host Sleep (MC-12, MC-1) 32

7.3.31 Get Communication Configuration (MC-12, MC-1) 32

7.3.32 Set Communication Configuration (MC-12, MC-1) 33

7.3.33 Set Mute (MC-12, MC-1) 33

7.3.34 Set Output Level Adjustments (MC-1) 34

7.3.35 Send Display String Command (MC-12, MC-1) 34

7.3.36 MC-12 Get Parameter Definition by Id (MC-12) 35

7.3.37 MC-12 Set Parameter Value by Id (MC-12) 37

7.3.38 MC-12 Set Parameter Value by Id, No Run (MC-12) 39

7.3.39 MC-12 Get Unit Configuration (MC-12) 39

7.3.40 MC-12 Send IR Command (MC-12) 42

7.3.41 MC-12 Get Parameter Value by Id (MC-12) 42

7.3.42 MC-12 Set Parameter Notification by Id (MC-12) 43

7.3.43 MC-12 Parameter Get Value String by Id (MC-12) 44

7.3.44 MC-12 Clear All Parameter Notifications (MC-12) 45

7.3.45 MC-12 Get System Status (MC-12) 45

7.3.46 MC-12 Get Record Status (MC-12) 47

7.3.47 MC-12 Set System Volume (MC-12) 48

7.3.48 MC-12 Set Main Balance (MC-12) 48

7.3.49 MC-12 Set Front/Back Balance (MC-12) 49

7.3.50 MC-12 Set Active Effect by Id (MC-12) 49

7.3.51 MC-12 Set Record Input (MC-12) 50

7.3.52 MC-12 Set Zone2 Volume (MC-12) 51

7.3.53 MC-12 Set Zone2 Left/Right Balance (MC-12) 51

7.3.54 MC-12 Get Input Name by Id (MC-12) 52

7.3.55 MC-12 Set Input Name by Id (MC-12) 53

Appendix A Command Codes 54

Appendix B Error Codes 56

Appendix C DC-2, MC-1 IR-Codes 57

Appendix D MC-12 IR Codes 58

Appendix E MC-1 Input Id’s 60

Appendix F MC-12 Input Ids 60

Appendix G Protocol Constants 60

Appendix H MC-12 to MC-1 Effect Map 61

Appendix I MC-1 to MC-12 Effect ID Map 62

Appendix J MC-12 Mode Ids 63

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

Application Notes and Examples 64

1.1 Box initializations: 64

1.1.1 MC-12: 64

1.1.2 HOST: 64

1.2 Getting System Wide Status and Setup: 64

1.1 Downloading the System Setup to the 64

1.3 MC-12: 64

1.4 Simple System Control & System Status: 64

1.5 Examples: 65

1.5.1 MC-12 Get Unit Configuration 65

1.5.2 Send MC-1 IR Command Example 66

1.5.3 Send MC-12 IR Command Example 67

1.6 MC12 V2.00 Parameter ID List 67

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

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.

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.

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.

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

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.

The 3 protocol layers are Physical, Data Link, and Application Layers.

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

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

Physical Layer (RS232)

Data Link Layer

Application Layer

CD VOL

Lexicon MC-12

HOST

Rs-232 Serial Link

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

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)

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

5 Physical Layer

5.1 DB-9 RS232 Connector

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:

MC-12

COM1

Transmit Data

Receive Data

Ground

Host

Receive Data

Transmit Data

Ground

9 Pin D-Shell (female) 9 Pin D-Shell (male)

9 Pin D-Shell (male)

9 Pin D-Shell (female)

Lexicon

MC-12 Serial Communications Protocol Printed on: 07/19/04

SERIAL PORT A PASSED

SERIAL PORT B PASSED

This message is displayed for about 2 seconds before entering normal operating mode. If no messages are

displayed, then both wrap tests failed.

6 Data Link Layer

The data link layer is used to define a transmission packet. The layer appends a header and tail that

encloses the transmitted application packet data. The data link header will contain the start of packet byte

and count of bytes to follow. The data link tail will contain the end of packet byte.

6.1 Errors

If the number of DLL data bytes received is the same as the data count and an EOP has not been received,

the MC-12 responds by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET.

The MC-12 then continues to look for a SOP byte and will not process the erroneous application packet.

The HOST can use this as an indicator to retransmit the corrupted packet.

In addition, each byte of a packet must be received sequentially and within the INTER_PACKET_TIME. If

any of the bytes within a packet transmission exceeds the INTER_PACKET_TIME, the MC-12 will

respond by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The MC-12

then continues to look for a SOP byte and will not process the erroneous application packet. The HOST

can use this as an indicator to retransmit the corrupted packet.

Data Link Header:

Byte Number Description Value

First Byte(0) Start of Packet (SOP) 0xF1

Byte(1) DLL Data Count nn

Application Header:

Byte(2) Command nn

Byte(3)

APP Data Count (number of application data bytes to

Follow) nn

Application Data:

Byte(4) Data[0] nn

Byte(5) Data[1] nn

… Data[…] nn

Last Data Byte -1 Data[Data Count -1] nn

Data Link Tail:

Last Byte End of Packet (EOP) 0xF2

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Hardware de computadora de Lexicon

Lexicon

Lexicon PCM 80 Manual de usuario

Lexicon

Lexicon CP-3 Manual de usuario

Lexicon

Lexicon MPX 1 - REV 1 Manual de usuario

Lexicon

Lexicon MPX 500 Manual de usuario

Lexicon

Lexicon MPX 500 V2 - UPGRADE Manual de usuario

Lexicon

Lexicon MPX - ADDENDUM REV 1 Manual de usuario

Lexicon

Lexicon MC-4 V1.00 - SERIAL PROTOCOL DEFINITIONS REV... Manual de usuario

Lexicon

Lexicon PCM 42 Manual de usuario

Lexicon

Lexicon 700t Guía del administrador

Lexicon

Lexicon MC-12 V3.0 - SERIAL COMMUNICATIONS PROTOCOL DEFINITION REV... Manual de usuario

Lexicon

Lexicon MPX - ADDENDUM REV 1 Manual de usuario

Lexicon

Lexicon MPX - ADDENDUM REV 1 Manual de usuario

Lexicon

Lexicon 480L - UPDATE V3.0 Manual de usuario

Lexicon

Lexicon MPX 110 Manual de usuario

Lexicon

Lexicon MX500 Manual de usuario

Lexicon

Lexicon PCM 42 Manual de usuario

Lexicon

Lexicon CP-1 Manual de usuario

Lexicon

Lexicon MPX 110 Manual de usuario

Lexicon

Lexicon LDI 12T - REV 1 Manual de usuario

Lexicon

Lexicon CP-1 Manual de usuario

Lexicon

Lexicon MPX 500 Manual de usuario

Lexicon

Lexicon PCM 96 - V2.1.6 Manual de usuario

Lexicon

Lexicon MPX 1 V1.10 - MIDI IMPLEMENTATION DETAILS Manual de usuario

Lexicon

Lexicon VORTEX Manual de usuario

Manuales populares de Hardware de computadora de otras marcas

EMC2

EMC2 VNX Series Manual del propietario

Panasonic

Panasonic DV0PM20105 Manual de usuario

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 Manual de usuario

Gigabyte

Gigabyte B660M DS3H AX DDR4 Manual de usuario

Raidon

Raidon iT2300 Manual de usuario

National Instruments

National Instruments PXI-8186 Manual de usuario

Hauppauge

Hauppauge WinTV-HVR-2250 Manual de usuario

Kontron

Kontron CP6002 Manual de usuario

Manhattan

Manhattan 702843 Manual de usuario

Aphex

Aphex 230 Manual de usuario

AMD

AMD Phenom II Manual operacional

Intel

Intel NUC 12 Pro Manual de usuario

dbx

dbx Zone Pro 1260 Manual de usuario

Galaxy

Galaxy GHDX2-2430S-24F4D Manual de usuario

Intel

Intel AXXRMFBU4 Manual de usuario

Kontron

Kontron DIMM-PC/MD Manual de usuario

ST X-NUCLEO-SAFEA1B Instrucciones de funcionamiento

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 Manual de usuario