Lexicon RV8 V1.0 - SERIAL COMMUNICATIONS PROTOCOL DEFINITION REV... User manual

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 1 of 74
Serial Communications Protocol Definition
Project: RV8
Software Version 1.0
Protocol Version:
Major rev 1
Minor rev 7

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 2 of 74
Manufactured under license from Dolby Laboratories. "Dolby," "Pro Logic," and the double-D
symbol are trademarks of Dolby Laboratories. "Surround EX" is a jointly developed technology of
THX and Dolby Laboratories, Inc., and is a trademark of Dolby. Used under authorization.
THX, Ultra and Ultra2 are trademarks of THX Ltd., which may be registered in some jurisdictions.
All rights reserved.
Manufactured under license from Lucasfilm Ltd. U.S. Patent Nos. 5,043,970; 5,189,703; and/or
5,222,059. European Patent No. 0323830. Other U.S. and foreign patents pending. Lucasfilm is a
trademark of Lucasfilm Ltd. Surround EX is a trademark of Dolby Laboratories. Used under
authorization.
"DTS," "DTS-ES," "Neo:6, " and “DTS 96/24” are trademarks of Digital Theater Systems, Inc.
"Lexicon," "LOGIC7," and the L7 logo are registered trademarks of Harman International
Industries, Inc. U.S. Patent Nos. D454,553; D454,860; 5,796,844; 5,870,480 and other worldwide
patents issued and pending.
© 2004 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
Lexicon Part No. 070-16402 REV 0

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 3 of 74
1Documents 5
2 Definitions 5
2.1 Protocol Version Cross-reference 5
3 Abbreviations 5
4 General Description 5
5 Physical Layer 6
DB-9 RS232 Connector 6
5.2 Serial Port Driver 6
5.3 Errors 6
5.4 RV8 Receive Buffer 7
5.5 RV8 Hardware Verification 7
6 Data Link Layer 7
6.1 Errors 7
7 Application Layer 8
7.1 RV8 Asynchronous Notification Packets 8
7.1.1 Wakeup Notification 8
7.1.2 Sleep Notification 8
7.1.3 Front Panel Display 9
7.1.4 RV8 Parameter Notification by Id (RV8) 9
7.2 Acknowledgment Packets 11
7.2.1 Acknowledge (RV8, MC-12, MC-1) 11
7.2.2 No Acknowledge (RV8, MC-12, MC-1) 11
7.3 Host Initiated Command Packets 11
7.3.1 Reset Unit (RV8, MC-12, MC-1) 11
7.3.2 Get Custom Name 12
7.3.3 Get ARRAY Definition(RV8) 12
7.3.4 Get ARRAYITEM(RV8) 13
7.3.5 Set ARRAYITEM(RV8) 14
7.3.6 Set Custom Name 14
7.3.7 Host Wakeup 15
7.3.8 Host Sleep 15
7.3.9 Get Communication Configuration 16
7.3.10 Set Communication Configuration 16
7.3.11 Set Mute 17
7.3.12 Send Display String Command 18
7.3.13 Get Parameter Definition by Id 18
7.3.14 Set Parameter Value by Id 21
7.3.15 Set Parameter Value by Id, No Run 22
7.3.16 Get Unit Configuration 23
7.3.17 Send IR Command 26
7.3.18 Get Parameter Value by Id 26
7.3.19 Set Parameter Notification by Id 27
7.3.20 Parameter Get Value String by Id 28
7.3.21 Clear All Parameter Notifications 29
7.3.22 Get System Status 29
7.3.23 Get Record Status 31
7.3.24 Set System Volume 31
7.3.25 Set Main Balance 32
7.3.26 Set Front/Back Balance 32

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 4 of 74
7.3.27 Set Active Effect by Id 33
7.3.28 Set Zone2 Volume 34
7.3.29 Set Zone2 Left/Right Balance 34
7.3.30 Get Input Name by Id 35
7.3.31 Set Input Name by Id Error! Bookmark not defined.
Appendix A Command Codes 366
Appendix B Error Codes 388
Appendix D RV8 IR Codes 41
Appendix F RV8 Input Ids 42
Appendix G Protocol Constants 42
Appendix J RV8 Mode Ids 43
1.1 Examples: 45
1.1.1 Send RV-8 IR Command Example 45
1.2 RV-8 V1.00 Parameter ID List 45

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 5 of 74
1 Documents
The following documents should also be used with this document to understand how this protocol can be
used with an RV8.
070-15838 User Guide, RV-8
2 Definitions
User Parameter: A user changeable variable that stores a specific value that describes an
operating condition for the RV8 system.
HOST: The device initiating or receiving the serial communication packets to/from the
RV8.
RV8: The Lexicon product receiving or transmitting the serial communication packets
to/from the HOST.
Nonvolatile FLASH: The area of memory in an RV8 that stores users adjustable parameters.
2.1 Protocol Version Cross-reference
All references to RV8 shall be valid 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 RV8 serial port and protocol communication is for an external connected HOST to
control and obtain status from the RV8. The protocol has been designed to focus on two specific goals.
The first is HOST uploading and downloading of RV8 configuration, and system/effect setups. The second
is HOST control of basic user adjustable parameters.(i.e. input, volume, balance…)
The RV8 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 RV8. The RV8 Protocol is a 3 layered system. The RV8 serial
protocol allows for the RV8, or the HOST, to initiate a communication transaction. Most transactions are
initiated by the HOST. RV8 then responds to the HOST command with either a response or
acknowledgment packet. There are a few asynchronous notifications that RV8 initiates indicating system
CD VOL
Lexicon RV-8
HOST
Rs-232 Serial Link

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 6 of 74
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
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
RV8 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 RV8 will detect parity, framing and data overrun errors. If any of the physical layer errors are detected,
the complete packet is corrupted and the RV8 will reset the transaction and begin to look for a start of
packet byte.
Physical Layer (RS232)
Data Link Layer
Application Layer
RV8
COM1
Transmit Data
Receive Data
Ground
Host
Receive Data
Transmit Data
Ground
2
3
5
2
3
5
9 Pin D-Shell (female) 9 Pin D-Shell (male)
2
3
5
2
3
5
9 Pin D-Shell (male)
9 Pin D-Shell (female)

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 7 of 74
5.4 RV8 Receive Buffer
The RV8 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 RV8 will be ignored. Therefore, making the currently transmitted packet, if partially
transmitted invalid.
5.5 RV8 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 RV8 transmits a known test signal just following a power up. The RV8 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 RV8 labeled “RS232”. The wraparound plug shorts pins 2 to 3, allowing for the
RV8 to receive the signal it is transmitting. Once installed, power cycle the RV8 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.
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 RV8 responds by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The
RV8 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

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 8 of 74
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 RV8 will respond
by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The RV8 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 RV8 Asynchronous Notification Packets
RV8 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:
7.1.1 Wakeup Notification
By transmitting the Wakeup Notification, RV8 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 RV8.
7.1.1.1 Notification Packet Description
Application Header:
Command DC_WAKEUP 0x01
Data Count 0 0x00
Application Data:
N/A
7.1.1.2 Host Response
The RV8 does not expect any response from the HOST.
7.1.2 Sleep Notification
By transmitting the Sleep Notification, RV8 indicates the unit is shutting down into a standby mode.
Because the hard power switch could be activated independently of the RV8 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 RV8.
7.1.2.1 Notification Packet Description
Application Header:
Command DC_SLEEP 0x02
Data Count 0 0x00
Application Data:
N/A

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 9 of 74
7.1.3 Front Panel Display
RV8 will transmit the front panel display buffer following the update to the RV8 front panel display. The
RV8 front panel display is 2 X 20 ASCII character display. The HOST can enable transmission of this
notification message by sending Host Wakeup (7.3.29). To disable transmission the HOST can send Host
Sleep (7.3.30). Transmission of the display buffer is asynchronous to other host/RV8 communication and
will only transmit following the completion of any communication exchanges in progress or pending.
7.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
7.1.3.2 Data Description
Line1
Data Type: Null (0x00) terminated ASCII character string.
Max Length: DISP_LINE_LENGTH defined in Appendix G Protocol Constants.
Line2
Data Type: Null (0x00) terminated ASCII character string.
Max Length: DISP_LINE_LENGTH defined in Appendix G Protocol Constants.
The RV8 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
7.1.3.3 HOST Response
The RV8 does not expect any response from the HOST.
7.1.4 RV8 Parameter Notification by Id
RV8 will transmit parameter change notifications if they are enabled using the command described in 7.3.42
(MC12_Set_Parameter_Notification_By_Id). If a parameter value is changed due to any user action or
system action the RV8 will transmit the current value of the parameter that is changing.

Lexicon, Inc.
RV-8 Serial Communications Protocol Printed on: 01/18/05
© 2004 Lexicon, Inc. All rights reserved. 10 of 74
7.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…
7.1.4.2 Data Description
Same as Paragraph 7.3.37.2
7.1.4.3 HOST Response
The RV8 does not expect any response from the HOST.
7.1.4.4 Defaults
The following Parameters Notifications are Enabled in the RV8 default state:
Parameter RV8 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
Zone 2 Input PARAM.ZONE.INPUT
Zone 2 Volume PARAM.ZONE.VOLUME
Zone 2 Balance PARAM.ZONE.BALANCE
Zone 2 Mute PARAM.ZONE.MUTE
Bass PARAM.MAIN.BASS
Treble PARAM.MAIN.TREBLE
Loudness PARAM.MAIN.LOUDNESS
Tilt PARAM.MAIN.TILT
Menu Background On/Off PARAM.OSD.BACKGND
See RV-8 V1.00 Parameter ID List for the Parameter ID definitions.