Lexicon MC-4 V1.00 - SERIAL PROTOCOL DEFINITIONS REV... Manuale utente

Software Version 1.00/1.10

Protocol Version:

Major Rev 1

Minor Rev 6

MC-4

Serial Protocol Definitions

Lexicon MC-4 Serial Communications Protocol

“Lexicon” and the Lexicon logo are registered trademarks of Harman International Industries. U.S. patent

numbers and other worldwide patents issued and pending.

Windows® is a registered trademark of Microsoft Corporation.

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. Harman International Industries, Inc.

assumes no responsibility for errors that may appear within this document.

Lexicon, Inc.

3 Oak Park

Bedford, MA 01730-1413 USA

Tel 781-280-0300

Fax 781-280-0490

www.lexicon.com

Customer Service

Tel 781-280-0300

Fax 781-280-0495 (Sales)

Fax 781-280-0499 (Service)

Lexicon Part No. 070-16304 Rev 0

Lexicon MC-4 Serial Communications Protocol

1Documents 5

1.1 Change List 5

2Definitions 5

3Abbreviations 5

4General Description 5

4.1 Physical Layer 6

4.2 Serial Port Driver 6

4.3 Errors 6

4.4 MC-4 Receive Buffer 7

4.5 MC-4 Hardware Verification 7

5Data Link Layer 7

5.1 Errors 7

6Application Layer 8

6.1 MC-4 Asynchronous Notification Packets 8

6.1.1 Wakeup Notification 8

6.1.2 Sleep Notification 8

6.1.3 Front Panel Display 9

6.1.4 MC-4 Parameter Notification by Id 9

6.2 Acknowledgment Packets 10

6.2.1 Acknowledge 10

6.2.2 No Acknowledge 11

6.3 Host Initiated Command Packets 11

6.3.1 Reset Unit 11

6.3.2 Restore Defaults 12

6.3.3 Get Custom Name 12

6.3.4 Set Custom Name 12

6.3.5 Host Wakeup 13

6.3.6 Host Sleep 14

6.3.7 Get Communication Configuration 14

6.3.8 Set Communication Configuration 15

6.3.9 Set Mute 15

6.3.10 Send Display String Command 16

Definition 16

6.3.11 MC-4 Get Parameter Definition by Id 17

6.3.12 MC-4 Set Parameter Value by Id 19

6.3.13 MC-4 Set Parameter Value by Id, No Run 21

6.3.14 MC-4 Get Unit Configuration 21

6.3.15 MC-4 Send IR Command 24

6.3.16 MC-4 Get Parameter Value by Id 25

6.3.17 MC-4 Set Parameter Notification by Id 26

6.3.18 MC-4 Parameter Get Value String by Id 26

6.3.19 MC-4 Clear All Parameter Notifications 27

6.3.20 MC-4 Get System Status 27

6.3.21 MC-4 Set System Volume 29

6.3.22 MC-4 Set Main Balance 30

6.3.23 MC-4 Set Fader 30

6.3.24 MC-4 Set Active Effect by Id 31

6.3.25 MC-4 Get Input Name by Id 31

Lexicon MC-4 Serial Communications Protocol

6.3.26 MC-4 Set Input Name by Id 32

Appendix A: Command Codes 34

Appendix B: Error Codes 35

Appendix C: MC-4 IR Codes 36

Appendix D: Protocol Constants 38

Appendix E: MC-4 Mode Ids 39

Appendix F: MC-4 Input Ids 40

Application Notes and Examples 40

6.4 Box initializations 40

6.4.1 MC-4 40

6.4.2 HOST 40

6.5 Simple System Control & System Status 40

6.6 Examples: 40

6.6.1 MC-4 Get Unit Configuration 41

6.6.2 Send MC-4 IR Command Example 42

MC-4 V1.00 Parameter Id List 43

Lexicon MC-4 Serial Communications Protocol

1 Documents

The following document should also be used with this document to understand how this protocol can be

used with an MC-4.

070-16329 MC-4 User Guide

1.1 Change List

No changes at this time.

2 Definitions

User Parameter: A user changeable variable that stores a specific value that describes an

operating condition for the MC-4 system.

HOST: The device initiating or receiving the serial communication packets to/from the

MC-4.

MC-4: The Lexicon product receiving or transmitting the serial communication packets

to/from the HOST.

Nonvolatile RAM: The area of memory in a MC-4 that stores users adjustable parameters. The

Nonvolatile RAM is battery backed, to maintain values during MC-4 power down.

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-4 serial port and protocol communication is for an external connected HOST to

control and obtain status from the MC-4. The protocol has been designed to focus on two specific goals.

The first is HOST uploading and downloading of MC-4 configuration, and system/effect setups. The

second is HOST control of basic user adjustable parameters.(i.e. input, volume, balance…)

The MC-4 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-4. The MC-4 Protocol is a 3 layered system. The MC-4 serial

protocol allows for the MC-4, or the HOST, to initiate a communication transaction. Most transactions are

initiated by the HOST. MC-4 then responds to the HOST command with either a response or

acknowledgment packet. There are a few asynchronous notifications that MC-4 initiates indicating

CD VOL

Lexicon MC-4

HOST Rs-232 Serial

Lexicon MC-4 Serial Communications Protocol

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.

4.1 Physical Layer

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.

4.2 Serial Port Driver

MC-4 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

4.3 Errors

The MC-4 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-4 will reset the transaction and begin to look for a

start of packet byte.

MC-4

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)

Physical Layer (RS232)

Data Link Layer

Application Layer

Lexicon MC-4 Serial Communications Protocol

4.4 MC-4 Receive Buffer

The MC-4 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-4 will be ignored. Therefore, making the currently transmitted packet, if partially

transmitted invalid.

4.5 MC-4 Hardware Verification

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-4 transmits a known test signal just following a power up. The MC-4

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-4 labeled “RS232”. The wraparound plug shorts pins

2 to 3, allowing for the MC-4 to receive the signal it is transmitting. Once installed, power cycle the MC-4

and verify the following message is displayed on the FPD:

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.

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

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

5.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-4 responds by transmitting a NAK packet with an error code

DC_ERR_INVALID_PACKET. The MC-4 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.

Lexicon MC-4 Serial Communications Protocol

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-4 will respond

by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The MC-4 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.

6 Application Layer

6.1 MC-4 Asynchronous Notification Packets

MC-4 has been designed to transmit the asynchronous notification packets following these system

changes:

1. Power On

2. Entering Standby

3. Front Panel Display update

4. Parameter Value Changes.

The notification packets are defined as follows:

6.1.1 Wakeup Notification

By transmitting the Wakeup Notification, MC-4 indicates the unit has just “powered on” or reset and is

ready to receive host commands. This notification is primarily for the HOST to know the status of the

MC-4.

6.1.1.1 Notification Packet Description

Application Header:

Command DC_WAKEUP 0x01

Data Count 0 0x00

Application Data:

N/A

6.1.1.2 Host Response

The MC-4 does not expect any response from the HOST.

6.1.2 Sleep Notification

By transmitting the Sleep Notification, MC-4 indicates the unit is shutting down into a standby mode.

Because the hard power switch could be activated independently of the MC-4 system software, hard

power down will not be notified. Acknowledgment of the Sleep Notification is not required. This

notification is primarily for the HOST to know the operating status of the MC-4.

6.1.2.1 Notification Packet Description

Application Header:

Command DC_SLEEP 0x02

Data Count 0 0x00

Application Data:

N/A

Lexicon MC-4 Serial Communications Protocol

6.1.3 Front Panel Display

MC-4 will transmit the front panel display buffer following the update to the MC-4 front panel display. The

MC-4 front panel display is 2 X 20 ASCII character display. The HOST can enable transmission of this

notification message by sending Host Wakeup (6.3.5 page 13). To disable transmission the HOST can

send Host Sleep (6.3.6 page 14). Transmission of the display buffer is asynchronous to other host/MC-4

communication and will only transmit following the completion of any communication exchanges in

progress or pending.

6.1.3.1 Notification Packet Description

Application Header:

Command DC_FPD 0x03

Data Count 42 0x2A

Application Data:

Data[0] - Data[20] Line1 ch ch ch… 0x00

Data[21] - Data[41] Line2 ch ch ch … 0x00

6.1.3.2 Data Description

Line1 Data Type: Null (0x00) terminated ASCII character string.

Max Length: DISP_LINE_LENGTH defined in the Protocol Constants table

(Appendix D page 38).

Line2 Data Type: Null (0x00) terminated ASCII character string.

Max Length: DISP_LINE_LENGTH defined in the Protocol Constants table

(Appendix D page 38).

The MC-4 includes 8 custom characters that are defined to display increments of a display block.

(i.e. Volume Bar) The custom characters are ASCII character codes 8E - 93(hex). The codes

are used as follows:

'8E' - empty cell

'8F' - left 1 bar

'90' - left 2 bars

'91' - left 3 bars

'92' - left 4 bars

'93' - full cell

6.1.3.3 HOST Response

The MC-4 does not expect any response from the HOST.

6.1.4 MC-4 Parameter Notification by Id

MC-4 will transmit parameter change notifications if they are enabled using the command described in

Set Parameter Notification by Id (6.3.17 page 26). If a parameter value is changed due to any user action

or system action the MC-4 will transmit the current value of the parameter that is changing.

Lexicon MC-4 Serial Communications Protocol

6.1.4.1 Command Packet Description

Application Header:

Command MC_PARAM_NOTIFICATION_BY_ID 0x05

Data Count 24 0x18

Application Data:

Data[0] ParamId(LSB) nn

Data[1] ParamId(MSB) nn

Data[2] ParamType nn

Data[3-23] Value[0 -20] nn nn

nn…

6.1.4.2 Data Description

Same as Set Parameter Value by Id: Data Description (6.3.12.2 page 20).

6.1.4.3 HOST Response

The MC-4 does not expect any response from the HOST.

6.1.4.4 Defaults

The following Parameters Notifications are Enabled in the MC-4 default state:

Parameter MC-4 Parameter Name

Current Mode PARAM.MAIN.EFFECT

Main Zone Mute PARAM.MAIN.MUTE

Main Zone Volume PARAM.MAIN.VOLUME

Main Zone Balance PARAM.MAIN.BALANCE

Main Zone Input Selection PARAM.MAIN.INPUT

Bass PARAM.MAIN.BASS

Treble PARAM.MAIN.TREBLE

Loudness PARAM.MAIN.LOUDNESS

Tilt PARAM.MAIN.TILT

Menu Background On/Off PARAM.OSD.BACKGND

See the V1.00 Parameter ID List (page 43) for the Parameter ID definitions.

6.2 Acknowledgment Packets

Acknowledge and No Acknowledge packets are used to communicate transmission, packet and data

validation status. Both the HOST and MC-4 can transmit and receive these packets.

6.2.1 Acknowledge

6.2.1.1 Packet Description

Application Header:

Command DC_ACK 0xE0

Data Count 1 0x01

Application Data:

Data[0] Command nn

Questo manuale è adatto per i seguenti modelli

Indice

Altri manuali Lexicon Hardware per computer

Lexicon

Lexicon MPX 1 - MIDI IMPLEMENTATION DETAILS Manuale utente

Lexicon

Lexicon CP-3 Manuale utente

Lexicon

Lexicon CP-1 Manuale utente

Lexicon

Lexicon MV-5 Manuale utente

Lexicon

Lexicon MX500 Manuale utente

Lexicon

Lexicon MC-12 V4.0 - SERIAL COMMUNICATIONS PROTOCOL DEFINITION REV... Manuale utente

Lexicon

Lexicon MPX 500 V2 - UPGRADE Manuale utente

Lexicon

Lexicon CP-3 PLUS - THEORY AND DESIGN REV 2 Manuale

Lexicon

Lexicon MPX 500 Manuale di istruzioni

Lexicon

Lexicon LDI 12T - REV 1 Manuale utente

Lexicon

Lexicon MPX 200 - REV 1 Manuale utente

Lexicon

Lexicon MV-5 Manuale utente

Lexicon

Lexicon CP-3 PLUS - THEORY AND DESIGN REV 2 Manuale utente

Lexicon

Lexicon MPX 1 - REV 1 Manuale utente

Lexicon

Lexicon MPX 500 Manuale utente

Lexicon

Lexicon MPX 110 Manuale utente

Lexicon

Lexicon MPX 100 Manuale tecnico

Lexicon

Lexicon MV-5 Manuale utente

Lexicon

Lexicon PCM 42 Manuale utente

Lexicon

Lexicon MPX 5 V1.1 - REV Manuale utente

Lexicon

Lexicon CP-1 Manuale utente

Lexicon

Lexicon 480L - UPDATE V3.0 Manuale utente

Lexicon

Lexicon MPX 100 Manuale di riferimento

Lexicon

Lexicon MC-12 V3.0 - SERIAL COMMUNICATIONS PROTOCOL DEFINITION REV... Manuale utente

Manuali Hardware per computer popolari di altre marche

EMC2

EMC2 VNX Series Manuale del proprietario

Panasonic

Panasonic DV0PM20105 Manuale utente

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 Manuale utente

Gigabyte

Gigabyte B660M DS3H AX DDR4 Manuale utente

Raidon

Raidon iT2300 Manuale utente

National Instruments

National Instruments PXI-8186 Manuale utente

Hauppauge

Hauppauge WinTV-HVR-2250 Manuale utente

Kontron

Kontron CP6002 Manuale utente

Manhattan

Manhattan 702843 Manuale utente

Aphex

Aphex 230 Manuale utente

AMD

AMD Phenom II Manuale operativo

Intel

Intel NUC 12 Pro Manuale utente

dbx

dbx Zone Pro 1260 Manuale utente

Galaxy

Galaxy GHDX2-2430S-24F4D Manuale utente

Intel

Intel AXXRMFBU4 Manuale utente

Kontron

Kontron DIMM-PC/MD Manuale utente

ST X-NUCLEO-SAFEA1B Istruzioni operative

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 Manuale utente