Lexicon DC-2 Manuale utente

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

1 of 44

Serial Communications Protocol Definition

Project: DC-2/MC-1

Updated: May 15,2000

Major rev 0

Minor rev 5

Lexicon, Inc.

3 Oak Park

Bedford, MA 01730-1441

(781) 280-0300

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

2 of 44

1Documents 4

2 Definitions 4

3 Abbreviations 4

4 General Description 4

5 Physical Layer 5

5.1 DB-9 RS232 Connector 5

5.2 Serial Port Driver 5

5.3 Errors 6

5.4 DC-2/MC-1 Receive Buffer 6

5.5 DC-2/MC-1 Hardware Verification 6

6 Data Link Layer 6

6.1 Errors 7

7 Application Layer 7

7.1 DC-2/MC-1 Asynchronous Notification Packets 7

7.1.1 Wakeup Notification 7

7.1.2 Sleep Notification 8

7.1.3 Front Panel Display Buffer 8

7.1.4 Parameter Change Notification 9

7.2 Acknowledgment Packets 10

7.2.1 Acknowledge 10

7.2.2 No Acknowledge 10

7.3 Host Initiated Command Packets 11

7.3.1 Reset Unit 11

7.3.2 Restore Defaults 11

7.3.3 Send IR Command 11

7.3.4 Get DC-2/MC-1 Unit Configuration 12

7.3.5 Get System Status 14

7.3.6 Get Record/Zone 2 Status 15

7.3.7 Get System Parameter Definition 16

7.3.8 Get System Parameter Values 18

7.3.9 Get Effect Definition by Id 18

7.3.10 Get Effect Parameter Definition 19

7.3.11 Get Effect Parameter Values 20

7.3.12 Get Custom Name 21

7.3.13 Get Input Name by Id 21

7.3.14 Get FPD Control Registers 22

7.3.15 Set System Parameter Values 23

7.3.16 Set Effect Parameter Values 23

7.3.17 Set Effect Name by Effect Id 24

7.3.18 Set System Volume 25

7.3.19 Set Main Balance 25

7.3.20 Set Front/Back Balance 26

7.3.21 Set Active Effect by Id 26

7.3.22 Set Record/Zone2 Input 27

7.3.23 Clear Record/Zone2 Input 27

7.3.24 Set Zone2 Volume 28

7.3.25 Set Zone2 Left/Right Balance 28

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

3 of 44

7.3.26 Set Custom Name 28

7.3.27 Set Input Name by Id 29

7.3.28 Set FPD Control Registers 30

7.3.29 Host Wakeup 30

7.3.30 Host Sleep 31

7.3.31 Get Communication Configuration 31

7.3.32 Set Communication Configuration 32

7.3.33 Set Mute 32

7.3.34 Set Output Level Adjustments 33

7.3.35 Send Display String Command 34

8 Internal Use 35

8.1.1 Debug Character 35

8.1.2 PEEK Command 35

8.1.3 POKE Command 35

9 Appendix A Command Codes 35

10 Appendix B Error Codes 37

11 Appendix C DC-2/MC-1 IR-Codes 38

12 Appendix D Input Id’s 39

13 Appendix E Protocol Constants 39

14 Appendix F FPD Control Registers 40

15 Application Notes and Examples 40

15.1 Box initializations: 40

15.1.1 DC-2/MC-1: 40

15.1.2 HOST: 40

15.2 Getting System Wide Status and Setup: 41

15.3 Downloading the System Setup to the DC-2/MC-1: 41

15.4 Simple System Control & System Status: 41

15.5 Examples: 42

15.5.1 Get Unit Configuration 42

15.5.2 Get Effect Definition 43

15.5.3 Set Input Name 43

15.5.4 Send IR Command Example 44

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

4 of 44

1 Documents

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

used with a DC-2/MC-1.

070-13227 MANUAL,OWNER'S,DC2

070-13278 MANUAL,OWNER'S,MC1

2 Definitions

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

condition for the DC-2/MC-1 system.

Effect: An effect describes a particular type of processing on the audio data stream.

Effect Parameter: A changeable variable that stores a specific state or condition that controls the way the

effect functions or processes the audio.

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

2/MC-1.

DC-2/MC-1: The Lexicon product receiving or transmitting the serial communication packets

to/from the HOST.

Nonvolatile RAM: The area of memory in a DC-2/MC-1 that stores users adjustable parameters. The

Nonvolatile RAM is battery backed, to maintain values during DC-2/MC-1 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 DC-2/MC-1 serial port and protocol communication is for an external connected HOST

to control and obtain status from the DC-2/MC-1. The protocol has been designed to focus on two specific

goals. The first, is HOST uploading and downloading of DC-2/MC-1 configuration, and system/effect

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

CD VOL

Lexicon MC-1

HOST Rs-232 Serial Link

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

5 of 44

The DC-2/MC-1 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 DC-2/MC-1. The DC-2/MC-1 Protocol is a 3 layered system. The

DC-2/MC-1 serial protocol allows for the DC-2/MC-1, or the HOST to initiate a communication

transaction. Most transactions are initiated by the HOST. DC-2/MC-1 then responds to the HOST

command with either a response or acknowledgment packet. There are a few asynchronous notifications

that DC-2/MC-1 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.

5 Physical Layer

5.1 DB-9 RS232 Connector

Dc-2/MC-1 Typical Host

Ch A Transmit Data 2 2 Rx Data

Ch A Receive Data 3 3 Tx Data

Ch A Ground 5 5 Ground

9 Pin D-Shell

(female) lower

connector

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

DC-2/MC-1 serial port has been setup to operate as follows:

Operating Mode: Full Duplex

Baud rate: 19.2K baud

Data Size: 8 bits

Parity: Odd

Stop Bits: 1

Physical Layer (RS232)

Data Link Layer

Application Layer

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

6 of 44

5.3 Errors

The DC-2/MC-1 will detect parity, framing and data overrun errors. If an error is detected by the DC-

2/MC-1, the DC-2/MC-1 will transmit an NAK packet with a error code of: DC_ERR_PARTIY,

DC_ERR_FRAME, DC_ERR_OVER, corresponding to the error detected. If any of the physical layer

errors are detected, the complete packet is corrupted and the DC-2/MC-1 will reset the transaction and

begin to look for a start of packet byte.

All Error codes are listed in Appendix B Error Codes.

5.4 DC-2/MC-1 Receive Buffer

The DC-2/MC-1 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 DC-2/MC-1 will be ignored. Therefore, making the currently transmitted packet, if

partially transmitted invalid.

5.5 DC-2/MC-1 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 DC-2/MC-1 transmits a know test signal just following a power up. The DC-2/MC-1

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, (1 for Dc-2 and 2 for MC-1) RS232 Wraparound plug(s) are needed and

must be installed at the female D9 connector(s) on the rear panel of the DC-2/MC-1/SDP-3 labeled

“RS232”. The wraparound plug shorts pins 2 to 3, allowing for the MC-1 to receive the signal it is

transmitting. Once installed, power cycle the DC-2/MC-1/SDP-3 and verify the following message is

displayed on the VFD about 20 seconds after power up:

SERIAL PORT A PASSED

SERIAL PORT B PASSED

This message is displayed for about 2 seconds before entering normal operating mode. If either or both

messages are not displayed, the test 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.

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

7 of 44

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

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 DC-2/MC-1 responds by transmitting a NAK packet with an error code

DC_ERR_INVALID_PACKET. The DC-2/MC-1 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.

7 Application Layer

7.1 DC-2/MC-1 Asynchronous Notification Packets

DC-2/MC-1 has been designed to transmit the asynchronous notification packets following these system

changes:1. Power On

2. Entering Standby

3. Front Panel Display update and

4. Parameter Value Changes.

The notification packets are defined as follows:

7.1.1 Wakeup Notification

By transmitting the Wakeup Notification, DC-2/MC-1 indicates the unit has just “powered on” or reset and

is ready to receive host commands. If no acknowledgment is received within ACK_TIMEOUT, DC-2/MC-

1 will continue to operate. This notification is primarily for the HOST to know the status of the DC-2/MC-

7.1.1.1 Notification Packet Description

Application Header:

Command DC_WAKEUP 0x01

Data Count 0 0x00

Application Data:

N/A

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

8 of 44

7.1.1.2 Host Response Expected

Following the transmission of the Wakeup notification DC-2/MC-1 will wait for an ACK.

7.1.1.2.1 Actions to Response Codes

ACK DC-2/MC-1 continues to operate.

NAK Error Code DC-2/MC-1 will retransmit the Wakeup Notification until it receives an ACK

or it reaches the RETRANSMIT_COUNT. If the RETRANSMIT_COUNT

is exceeded then DC-2/MC-1 continues to operate.

7.1.2 Sleep Notification

By transmitting the Sleep Notification, DC-2/MC-1 indicates the unit is shutting down into a standby mode.

Because the hard power switch could be activated independently of the DC-2/MC-1 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 DC-2/MC-1.

7.1.2.1 Notification Packet Description

Application Header:

Command DC_SLEEP 0x02

Data Count 0 0x00

Application Data:

N/A

7.1.3 Front Panel Display Buffer

DC-2/MC-1 will transmit the front panel display buffer following the update to the DC-2/MC-1 front panel

display. The DC-2/MC-1 front panel display is 2 X 20 ASCII character display. The HOST can control the

operation of this notification message by FPD internal control registers. Individual notifications can be

enabled or disabled and the minimum transmit interval can be adjusted. Transmission of the display buffer

is asynchronous to other host/DC-2/MC-1 communication and will only transmit following the completion

of any communication exchanges in progress or pending. The FPD control register command packets are

described in section 7.3.14 Get FPD Control Registers.

7.1.3.1 Notification Packet Description

Application Header:

Command DC_FPD 0x03

Data Count 42 0x2A

Application Data:

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

Data[22] - Data[42] Line2 ch ch ch … 0x00

7.1.3.2 Data Description

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

Max Length: DISP_LINE_LENGTH defined in Appendix E Protocol Constants.

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

Max Length: DISP_LINE_LENGTH defined in Appendix E Protocol Constants.

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

9 of 44

The DC-2/MC-1 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 08 - 0F(hex). The codes are used as

follows:

'08' - left 1 bar

'09' - left 2 bars

'0A' - left 3 bars

'0B' - left 4 bars

'0C' - Full Cell

'0D' - Underscore

'0E' - right 3 bars

'0F' - not in use

7.1.3.3 HOST Response

The DC-2/MC-1 does not look for any response from the HOST.

7.1.4 Parameter Change Notification

DC-2/MC-1 will transmit predetermined parameter change notifications. If a parameter value is changed

due to any user action or system action the DC-2/MC-1 will transmit the current value of the parameter that

is changing.

7.1.4.1 Notification Packet Description

Application Header:

Command DC_PARAM_CHG_MSG 0x04

Data Count 2 0x02

Application Data:

Data[0] ParamId nn

Data[1] Value nn

7.1.4.2 Data Description

ParamId:DataType: Unsigned 8 bit integer

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

Value: The Current Value for this system parameter.

Data Type: Unsigned 8 bit integer

Max: Set by the Max Value per the System Parameter Definition response

Packet for the Parameter Id of this packet.

7.1.4.3 HOST Response

The DC-2/MC-1 does not look for any response from the HOST.

7.1.4.4 Supported System Parameters

The following parameters will be supported by this Parameter Change Notification:

Parameter DC-2/MC-1 Parameter Name

Current Effect PROGRAM

Mute MUTE

System Volume VOLUME

Balance LR_BALANCE

Input Selection INPUT

Record/Zone 2 On/Off RECORD_ENABLED

Zone 2 Volume Z2_VOL

Lexicon, Inc.

DC-2/MC-1 Serial Communications Protocol Printed on: 10/19/00

10 of 44

Zone 2 Balance Z2_BAL

Zone 2 Mute Z2_MUTE

Bass BASS

Treble TREBLE

Loudness LOUDNESS

Tilt TILT

Menu Background On/Off MENU_BKGND

The parameter definitions for each of these parameters can be obtained by querying the DC-2/MC-1 with

the DC_CMD_GET_SYS_PARAM_BY_NAME command. The DC_RESP_SYS_PARAM_DEF will

contain the ParamId for each of the parameters. The ParamId may change with s/w version changes, but the

Parameter Name will not.

7.2 Acknowledgment Packets

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

validation status. Both the HOST and DC-2/MC-1 can transmit and receive these packets.

7.2.1 Acknowledge

7.2.1.1 Packet Description

Application Header:

Command DC_ACK 0xE0

Data Count 1 0x01

Application Data:

Data[0] Command nn

7.2.1.2 Data Description

Command:

DataType: Valid DC-2/MC-1 command as defined in Appendix A Command Codes.

7.2.2 No Acknowledge

7.2.2.1 Packet Description

Application Header:

Command DC_NACK 0xE1

Data Count 2 0x02

Application Data:

Data[0] Command nn

Data[1] ErrorCode nn

7.2.2.2 Data Description

Command:

DataType: Valid DC-2/MC-1 command as defined in Appendix A Command Codes.

ErrorCode:

DataType: Error code as defined in Appendix B Error Codes.

Altri manuali per DC-2

Questo manuale è adatto per i seguenti modelli

Indice

Altri manuali Lexicon Apparecchiature di registrazione

Lexicon

Lexicon 960L V2.5 - INSTALLATION AND RELEASE NOTES... Manuale utente

Lexicon

Lexicon LEXICON480LV4 Manuale utente

Lexicon

Lexicon 960L - ADDENDUM Istruzioni per l'installazione e il funzionamento

Lexicon

Lexicon PCM 80 - REV 1 Manuale utente

Lexicon

Lexicon DC-2 Manuale utente

Lexicon

Lexicon PCM 91 - REV 1 Manuale utente

Lexicon

Lexicon MPX G2 Manuale utente

Lexicon

Lexicon Lambda Manuale utente

Lexicon

Lexicon Lambda Manuale utente

Lexicon

Lexicon Alpha Manuale utente

Lexicon

Lexicon 300L - Manuale utente

Lexicon

Lexicon VORTEX Istruzioni per il montaggio

Lexicon

Lexicon MC-12 - REV 1 Manuale utente

Lexicon

Lexicon PCM 80 - V1.1 REV 1 PITCH FX Manuale utente

Lexicon

Lexicon 480L - UPDATE V3.0 Manuale utente

Lexicon

Lexicon PCM 90 - GUIDE REV 1 Manuale utente

Lexicon

Lexicon OMEGA Manuale utente

Lexicon

Lexicon 960L Manuale utente

Lexicon

Lexicon 960L - REV 1 Manuale utente

Lexicon

Lexicon 960L Manuale utente

Lexicon

Lexicon PANTHEON musical instrument Manuale utente

Lexicon

Lexicon OMEGA - MANUAL 2 Manuale utente

Lexicon

Lexicon MPX - ADDENDUM REV 1 Manuale utente

Lexicon

Lexicon I-O|42 Manuale utente

Manuali Apparecchiature di registrazione popolari di altre marche

KV2 Audio

KV2 Audio 500 Series Manuale utente

Robotics Technologies

Robotics Technologies microBus-Cam II Manuale utente

Seca

Seca 460 Manuale utente

Cognex

Cognex MVS-8000 Series Manuale utente

Mect

Mect MPNC006 Series Manuale utente

Bad Caf

Bad Caf THE LEASH Manuale utente

Strymon

Strymon NIGHTSKY Manuale utente

Mitsubishi Electric

Mitsubishi Electric 16CH DIGITAL RECORDER DX-TL5000U Manuale utente

Tews Technologies

Tews Technologies TPMC465 Manuale utente

Honeywell

Honeywell Excel 50 Manuale utente

SeaLevel

SeaLevel COMM+8.LPCI Manuale utente

Arturia

Arturia AUDIOFUSE STUDIO Manuale utente

Rukra

Rukra RK-1240 Manuale utente

Samson

Samson SCOM Manuale utente

Dynacord

Dynacord DPS260 Manuale utente

Nice

Nice Core Manuale utente

Pyle Pro

Pyle Pro PSS8 Manuale utente

RF-System

RF-System TinyGate Manuale per l'uso e la cura