JBL Performance AV1 User manual

Serial Protocol Definitions
AV1
Software Version 1.00/1.10
Protocol Version:
Major Rev 1
Minor Rev 6
Performance™

JBL Performance Series RS-232 Serial Protocol Definitions
2
“JBL” and the JBL logo are registered trademarks of Harman International Industries. U.S. patent
numbers and other worldwide patents issued and pending.
“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.
© 2005 Harman International Industries, Incorporated. All rights reserved.
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.
JBL
8500 Balboa Blvd
Northridge California

JBL Performance Series RS-232 Serial Protocol Definitions
3
1 Documents ....................................................................................................................................... 7
1.1 Change List ............................................................................................................................... 7
2 Definitions ....................................................................................................................................... 7
3 Abbreviations................................................................................................................................... 7
4 General Description ......................................................................................................................... 7
4.1 Physical Layer........................................................................................................................... 8
4.2 Serial Port Driver ...................................................................................................................... 8
4.3 Errors ........................................................................................................................................ 8
4.4 AV1 Receive Buffer ................................................................................................................. 9
4.5 AV1 Hardware Verification...................................................................................................... 9
5 Data Link Layer ............................................................................................................................... 9
5.1 Errors ...................................................................................................................................... 10
6 Application Layer .......................................................................................................................... 10
6.1 AV1 Asynchronous Notification Packets ............................................................................... 10
6.1.1 Wakeup Notification........................................................................................................ 10
6.1.1.1 Notification Packet Description.................................................................................... 10
6.1.1.2 Host Response............................................................................................................... 11
6.1.2 Sleep Notification ............................................................................................................ 11
6.1.2.1 Notification Packet Description........................................................................... 11
6.1.3 Front Panel Display ......................................................................................................... 11
6.1.3.1 Notification Packet Description........................................................................... 11
6.1.3.2 Data Description.................................................................................................... 11
6.1.3.3 HOST Response................................................................................................... 12
6.1.4 AV1 Parameter Notification by Id................................................................................... 12
6.1.4.1 Command Packet Description ............................................................................ 12
6.1.4.2 Data Description.................................................................................................... 12
6.1.4.3 HOST Response................................................................................................... 12
6.1.4.4 Defaults .................................................................................................................. 12
6.2 Acknowledgment Packets....................................................................................................... 13
6.2.1 Acknowledge ................................................................................................................... 13
6.2.1.1 Packet Description................................................................................................ 13
6.2.1.2 Data Description.................................................................................................... 13
6.2.2 No Acknowledge ............................................................................................................. 13
6.2.2.1 Packet Description................................................................................................ 13
6.2.2.2 Data Description.................................................................................................... 13
6.3 Host Initiated Command Packets............................................................................................ 13
6.3.1 Reset Unit ........................................................................................................................ 14
6.3.1.1 Command Packet Description ............................................................................ 14
6.3.1.2 AV1 Response ...................................................................................................... 14
6.3.2 Restore Defaults............................................................................................................... 14
6.3.2.1 Command Packet Description ............................................................................ 14
6.3.2.2 AV1 Response ...................................................................................................... 14
6.3.3 Get Custom Name............................................................................................................ 14
6.3.3.1 Command Packet Description ............................................................................ 14
6.3.3.2 Data Description.................................................................................................... 14
6.3.3.3 Custom Name Response Packet....................................................................... 15
6.3.3.4 Data Description.................................................................................................... 15

JBL Performance Series RS-232 Serial Protocol Definitions
4
6.3.4 Set Custom Name ............................................................................................................ 15
6.3.4.1 Packet Description................................................................................................ 16
6.3.4.2 Data Description.................................................................................................... 16
6.3.4.3 AV1 Response ...................................................................................................... 16
6.3.4.4 Data Validation:..................................................................................................... 16
6.3.5 Host Wakeup.................................................................................................................... 16
6.3.5.1 Command Packet Description ............................................................................ 16
6.3.5.2 Data Description.................................................................................................... 16
6.3.5.3 AV1 Response ...................................................................................................... 17
6.3.6 Host Sleep ........................................................................................................................ 17
6.3.6.1 Packet Description................................................................................................ 17
6.3.6.2 Data Description.................................................................................................... 17
6.3.7 Get Communication Configuration ................................................................................. 17
6.3.7.1 Command Packet Description ............................................................................ 17
6.3.7.2 Communication Configuration Response Packet............................................ 17
6.3.7.3 Data Description.................................................................................................... 17
6.3.8 Set Communication Configuration .................................................................................. 18
6.3.8.1 Command Packet Description ............................................................................ 18
6.3.8.2 Data Description.................................................................................................... 18
6.3.8.3 AV1 Response .......................................................................................................... 18
6.3.9 Set Mute........................................................................................................................... 18
6.3.9.1 Command Packet Description .................................................................................. 18
6.3.9.2 Data Description ....................................................................................................... 19
6.3.9.3 AV1 Response .......................................................................................................... 19
6.3.9.4 Data Validation ......................................................................................................... 19
6.3.10 Send Display String Command...................................................................................... 19
6.3.10.1 Packet Description .................................................................................................. 19
6.3.10.2 Data Description ..................................................................................................... 19
6.3.10.3 AV1 Response ........................................................................................................ 20
6.3.10.4 Data Validation:...................................................................................................... 20
6.3.11 AV1 Get Parameter Definition by Id............................................................................. 20
6.3.11.1 Command Packet Description ................................................................................ 20
6.3.11.2 Data Description ..................................................................................................... 20
6.3.11.3 Data Validation:...................................................................................................... 21
6.3.11.4 Parameter Definition Response Packet................................................................... 21
6.3.11.5 Data Description ..................................................................................................... 21
6.3.12 AV1 Set Parameter Value by Id .................................................................................... 22
6.3.12.1 Command Packet Description ................................................................................ 22
6.3.12.2 Data Description ..................................................................................................... 23
6.3.13 AV1 Set Parameter Value by Id, No Run...................................................................... 23
6.3.13.1 Command Packet Description ................................................................................ 23
6.3.13.2 Data Description ..................................................................................................... 24
6.3.14 AV1 Get Unit Configuration ..................................................................................... 24
6.3.14.1 Command Packet Description ................................................................................ 24
6.3.14.2 AV1 Unit Configuration Response Packet ............................................................. 24
6.3.14.3 Data Description ..................................................................................................... 25
6.3.15 AV1 Send IR Command ................................................................................................ 26
6.3.15.1 Command Packet Description ................................................................................ 26
6.3.15.2 Data Description ..................................................................................................... 27

JBL Performance Series RS-232 Serial Protocol Definitions
5
6.3.15.3 AV1 Response ........................................................................................................ 27
6.3.15.4 Data Validation ....................................................................................................... 27
6.3.16 AV1 Get Parameter Value by Id................................................................................ 27
6.3.16.1 Command Packet Description ................................................................................ 27
6.3.16.2 Data Description ..................................................................................................... 27
6.3.16.3 Data Validation ....................................................................................................... 27
6.3.16.4 AV1 Value String Response Packet ....................................................................... 27
6.3.16.5 Data Description ..................................................................................................... 28
6.3.17 AV1 Set Parameter Notification by Id........................................................................... 28
6.3.17.1 Command Packet Description ................................................................................ 28
6.3.17.2 Data Description ..................................................................................................... 28
6.3.17.3 Data Validation ....................................................................................................... 28
6.3.17.4 AV1 Response ........................................................................................................ 28
6.3.18 AV1 Parameter Get Value String by Id ......................................................................... 28
6.3.18.1 Command Packet Description ................................................................................ 29
6.3.18.2 Data Description ..................................................................................................... 29
6.3.18.3 Data Validation ....................................................................................................... 29
6.3.18.4 AV1 Value String Response Packet ....................................................................... 29
6.3.18.5 Data Description ..................................................................................................... 29
6.3.19 AV1 Clear All Parameter Notifications......................................................................... 29
6.3.19.1 Command Packet Description ................................................................................ 29
6.3.20 AV1 Get System Status ................................................................................................. 30
6.3.20.1 Command Packet Description ................................................................................ 30
6.3.20.2 System Status Response Packet.............................................................................. 30
6.3.20.3 Data Description ..................................................................................................... 30
6.3.21 AV1 Set System Volume............................................................................................... 31
6.3.21.1 Command Packet Description ................................................................................ 31
6.3.21.2 Data Description ..................................................................................................... 31
6.3.21.3 AV1 Response ........................................................................................................ 32
6.3.21.4 Data Validation ....................................................................................................... 32
6.3.22 AV1 Set Main Balance .................................................................................................. 32
6.3.22.1 Command Packet Description ................................................................................ 32
6.3.22.2 Data Description ..................................................................................................... 32
6.3.22.4 Data Validation ....................................................................................................... 32
6.3.23 AV1 Set Fader ............................................................................................................... 32
6.3.23.1 Packet Description .................................................................................................. 32
6.3.23.2 Data Description ..................................................................................................... 33
6.3.23.3 AV1 Response ........................................................................................................ 33
6.3.23.4 Data Validation ....................................................................................................... 33
6.3.24 AV1 Set Active Effect by Id.......................................................................................... 33
6.3.24.1 Command Packet Description ................................................................................ 33
6.3.24.2 Data Description ..................................................................................................... 33
6.3.24.3 AV1 Response ........................................................................................................ 33
6.3.24.4 Data Validation ....................................................................................................... 33
6.3.25 AV1 Get Input Name by Id........................................................................................ 33
6.3.25.1 Command Packet Description ................................................................................ 33
6.3.25.2 Data Description ..................................................................................................... 34
6.3.25.3 Data Validation ....................................................................................................... 34
6.3.25.4 Input Name Response Packet ................................................................................. 34

JBL Performance Series RS-232 Serial Protocol Definitions
6
6.3.25.5 Data Description ..................................................................................................... 34
6.3.26 AV1 Set Input Name by Id ........................................................................................ 34
6.3.26.1 Command Packet Description ................................................................................ 34
6.3.26.2 Data Description ..................................................................................................... 35
6.3.26.3 AV1 Response ........................................................................................................ 35
6.3.26.4 Data Validation ....................................................................................................... 35
Appendix A: Command Codes..................................................................................... 36
Appendix B: Error Codes .............................................................................................. 37
Appendix C: AV1 IR Codes .......................................................................................... 38
Appendix D: Protocol Constants.................................................................................. 40
Appendix E: AV1 Mode Ids........................................................................................... 41
Appendix F: AV1 Input Ids............................................................................................ 42
6.4 Box initializations ................................................................................................................... 42
6.4.1 AV1.................................................................................................................................. 42
6.4.2 HOST ............................................................................................................................... 42
6.5 Simple System Control & System Status ............................................................................... 42
6.6 Examples:................................................................................................................................ 42
6.6.1 AV1 Get Unit Configuration ........................................................................................... 43
6.6.2 Send AV1 IR Command Example................................................................................... 45

JBL Performance Series RS-232 Serial Protocol Definitions
7
1 Documents
The following document should also be used with this document to understand how this protocol can be
used with an AV1.
070-16329 AV1 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 AV1 system. HOST: The device initiating or receiving the serial communication packets
to/from the
AV1. AV1: The JBL product receiving or transmitting the serial communication packets to/from the HOST.
Nonvolatile RAM: The area of memory in a AV1 that stores users adjustable parameters. The Nonvolatile
RAM is battery backed, to maintain values during AV1 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 AV1 serial port and protocol communication is for an external connected HOST to
control and obtain status from the AV1. The protocol has been designed to focus on two specific goals. The
first is HOST uploading and downloading of AV1 configuration, and system/effect setups. The second is
HOST control of basic user adjustable parameters. (i.e. input, volume, balance…)
The AV1 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 AV1. The AV1 Protocol is a 3 layered system. The AV1 serial protocol allows for the
AV1, or the HOST, to initiate a communication transaction. Most transactions are initiated by the HOST.
AV1 then responds to the HOST command with either a response or acknowledgment packet. There are a
few asynchronous notifications that AV1 initiates indicating system changes. Each transaction initiated must
JBL AV1

JBL Performance Series RS-232 Serial Protocol Definitions
8
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
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
AV1 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
AV1
COM1

JBL Performance Series RS-232 Serial Protocol Definitions
9
The AV1 will detect parity, framing, and data overrun errors. If any of the physical layer errors are detected,
the complete packet is corrupted and the AV1 will reset the transaction and begin to look for a start of
packet byte.
4.4 AV1 Receive Buffer
The AV1 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 AV1 will be ignored. Therefore, making the currently transmitted packet, if partially
transmitted invalid.
4.5 AV1 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 AV1 transmits a known test signal just following a power up. The AV1 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 AV1 labeled “RS232”. The wraparound plug shorts pins 2 to 3, allowing for the AV1
to receive the signal it is transmitting. Once installed, power cycle the AV1 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.

JBL Performance Series RS-232 Serial Protocol Definitions
10
Data Link Header:
Byte Number Description Value
First Byte (SOP) 0xF1 (0) Start of Packet
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 AV1 responds by transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The AV1
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 AV1 will respond by
transmitting a NAK packet with an error code DC_ERR_INVALID_PACKET. The AV1 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 AV1 Asynchronous Notification Packets
AV1 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, AV1 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
AV1.
6.1.1.1 Notification Packet Description
Application Header: