Table of Contents
Advertisement
Installers Guide to the Bose® Serial interface
Installers Guide to the Bose Serial
Interface for Bose AV20, AV35 and
AVM Home Theater Control Consoles
Summary
An interface exists in the rear of Bose AV20, AV35 and
:
AVM control consoles which allows some control of the console by an
external computer. This document describes the current capabilities
and the format of the interactions over that interface for
01.05.00 or later of the console software.
ALL INFORMATION FURNISHED BY OR ON BEHALF OF BOSE IN oR IN
CONNECTION WITH THIS DOCUMENT IS PROVIDED EXCLUSIVELY ON AN
"AS IS" BASIS, AND BOSE AND ITS AFFILIATES EXPRESSLY DISCLAIM ALL
WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,
INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF PERFORMANCE,
ACCURACY, COMPLETENESS, MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT. WITHOUT
LIMITATION OF THE ABOVE, BOSE GRANTS NO WARRANTY THAT THE
INFORMATION FURNISHED BY OR ON BEHALF OF BOSE IN oR IN
CONNECTION WITH THIS DOCUMENT IS ERROR-FREE OR WILL OPERATE
WITHOUT INTERRUPTION, AND GRANTS NO WARRANTY REGARDING ITS
USE OR THE RESULTS THEREFROM INCLUDING, WITHOUT LIMITATION, ITS
CORRECTNESS, ACCURACY OR RELIABILITY.
Bose Confidential Information
Document Version 1.04
Issued June 28, 2011
Page 1/42
June 28, 2011
Version
Do Not Redistribute
Advertisement
Table of Contents
Subscribe to Our Youtube Channel
Related Manuals for Bose AV20
Summary of Contents for Bose AV20
- Page 1 Document Version 1.04 Issued June 28, 2011 Summary An interface exists in the rear of Bose AV20, AV35 and AVM control consoles which allows some control of the console by an external computer. This document describes the current capabilities and the format of the interactions over that interface for Version 01.05.00 or later of the console software.
-
Page 2: Table Of Contents
Installers Guide to the Bose® Serial interface June 28, 2011 TABLE OF CONTENTS 1 INTRODUCTION ______________________________________________ 5 1.1 Controlling the System ....................5 1.2 States of the System ......................5 2 DEFINITIONS ________________________________________________ 7 3 THE PHYSICAL CONNECTOR __________________________________ 8 4 PACKET FORMAT ____________________________________________ 9 4.1 Packet Fields ........................ - Page 3 Installers Guide to the Bose® Serial interface June 28, 2011 5.7 Sample Command/Response Interaction ..............19 5.7.1 Sample 1 Query Main Room Volume ................19 5.7.2 Sample 2 Key Press Command ..................20 6 CLIENT COMMANDS AND CONSOLE RESPONSES _______________ 22 6.1 VR - Query Version ......................
- Page 4 Installers Guide to the Bose® Serial interface June 28, 2011 Table 2-1 Definitions ........................7 Table 4-1 General Packet Format ....................9 Table 4-2 Packet Status Flags ...................... 10 Table 4-3 The XOR Operator ......................11 Table 5-1 Ready Packet Format ....................13 Table 5-2 Error Packet Format ......................
-
Page 5: Introduction
Notifications. 1.2 States of the System Systems based on the AV20, AV35 or AVM consist of a Console (referred to hereafter as ―the Console‖) and powered speakers in the Main Room, also known as Room A. The AV35 also supports up to 14 separately controllable Bose®... -
Page 6: Table 1-1 System States
Installers Guide to the Bose® Serial interface June 28, 2011 Table 1-1 System States State Value Command Command Available to Set to Query in Low Power Mode Main Room Speakers On True/False RoomStatus Main Room Speakers Muted True/False RoomStatus Main Room Speaker Source... -
Page 7: Definitions
The external computer and software controlling Client the interaction with the Bose product. Console The AV20, AV35 or AVM Control Console Packet A series of bytes with a well defined structure. The Client and Console communicate by sending packets. The format of each packet is described in section 4 Packet Format. -
Page 8: The Physical Connector
Installers Guide to the Bose® Serial interface June 28, 2011 3 The Physical Connector The interface is a 3.5mm stereo connector located on the rear of the Console at the same height as the power connector. The cable that connects the computer (for example a PC) to the Console connects the receive, transmit, and ground wires of a DB-9 connector to the tip, ring, and ground connections of the Console connector. -
Page 9: Packet Format
Installers Guide to the Bose® Serial interface June 28, 2011 4 Packet Format All interactions between the Client and the Console are in the form of complete packets. A Packet always begins with a Header field which contains the Length, Status, and Operation Code. -
Page 10: Opcode
Installers Guide to the Bose® Serial interface June 28, 2011 Table 4-2 Packet Status Flags Bit Number Name Meaning Error 0 - No Error 1 - Error has occurred. Payload contains the error information. (See Section 5.3.3 Error Packets Reserved... -
Page 11: Checksum (If Present)
Installers Guide to the Bose® Serial interface June 28, 2011 4.1.5 Checksum (if present) The Checksum byte is used to help detect packet corruption during transit. The Checksum byte is computed by the Client by XOR-ing all bytes in the packet to be sent that precede the Checksum byte. -
Page 12: The Communication Protocol
Installers Guide to the Bose® Serial interface June 28, 2011 5 The Communication Protocol The Client only sends Command packets, which are of two types: 1) A Control packet which requests the Console to do something 2) A Query packet which requests information from the Console The Console sends four types of packets: 1) A Ready packet which indicates the Client can send another packet. -
Page 13: Ready Packet
Installers Guide to the Bose® Serial interface June 28, 2011 received within MAX_PACKET_TIME (see section 5.4 Protocol Timings) there has been a communication error. The console may also have lost power. See section 5.6 Autonomous Console State Changes. The Client should interpret a packet using the following algorithm: 1) If the Error bit is set in the Status byte this is an Error packet. -
Page 14: Notification Packets
Installers Guide to the Bose® Serial interface June 28, 2011 An Error packet has the form: Console sends: 07 <Status> 01 <Cmd> <Error-Code> <01> Table 5-2 Error Packet Format Byte Value (Hex) Name Explanation Number Length The total number of bytes in this packet is 7 <Status>... -
Page 15: Table 5-4 Notification Packet Format
Installers Guide to the Bose® Serial interface June 28, 2011 A rare but important notification packet is the Assert packet which indicates the Console encountered a fatal internal condition and will reboot. The other notification packets indicate various internal events of the Console (debug messages) and should be ignored by the Client. -
Page 16: Table 5-6 Key Press Notification Packet Format
Installers Guide to the Bose® Serial interface June 28, 2011 Console sends: 08 <Status> 01 04 <Key-State> <Producer> <Key-Code> <Room> Table 5-6 Key Press Notification Packet Format Byte Value Number (Hex) Name Explanation Length The total number of bytes in this packet is 8 <Status>... -
Page 17: Protocol Timings
ALL_OFF_TIME. 5.4.7 INTER_COMMAND_TIME Bose recommends that a client delays at least 100msec between receiving the Ready packet for the previous command and sending the next command. For the Key Press command however the delay should be at least 100msec longer than the key press hold time (see 6.4 KP - Simulate a Key Press) and longer for some commands like source change. -
Page 18: Low Power Mode
The INPUT_ID_PTS source is an information screen used by Bose for diagnostics. Querying the current sources will detect if the system is in the INPUT_ID_INSTALLIQ or... -
Page 19: The Console Transitions To/From Low Power Mode
Installers Guide to the Bose® Serial interface June 28, 2011 INPUT_ID_PTS source. When the Console is in either of these sources, some commands do not operate normally. For example the volume cannot be controlled and another source cannot be selected. When the system is in either of these sources, manual intervention may be necessary to exit the source. -
Page 20: Sample 2 Key Press Command
Installers Guide to the Bose® Serial interface June 28, 2011 Table 5-10 Sample Checksum Calculation Number of 1’s in Byte 6 (Checksum) Number corresponding bit in preceding bytes Value(Hex) Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2... -
Page 21: Table 5-12 Sample Key Press Command
Installers Guide to the Bose® Serial interface June 28, 2011 The Client sends the following bytes (shown in hexadecimal) to the Console: Client sends: 0b 00 01 04 b3 01 2c 01 01 01 91 Table 5-12 Sample Key Press Command... -
Page 22: Client Commands And Console Responses
Installers Guide to the Bose® Serial interface June 28, 2011 6 Client Commands and Console Responses 6.1 VR - Query Version The version command requests the Software version of the Console. Note the Console must not be in Low Power Mode (see section 5.5 Low Power Mode) to get a valid response. Otherwise an Error packet will be sent. -
Page 23: Vo - Set/Query Main Room Volume
Only the volume of the Main room can be set with this command. The volume of the main room and of the Bose® link rooms can also be varied by using the Key Press command to send the BOSE_VOLUME_UP or BOSE_VOLUME_DOWN keys. -
Page 24: Table 6-6 Query Main Room Volume Response Format
Installers Guide to the Bose® Serial interface June 28, 2011 Console responds: 05 <Status> 01 15 <V> Table 6-6 Query Main Room Volume Response Format Byte Value Number (Hex) Name Explanation Length The total number of bytes in this packet is 5. -
Page 25: Echo - Hard And Soft Key Press Notifications
Installers Guide to the Bose® Serial interface June 28, 2011 6.3 Echo - Hard and Soft Key Press Notifications The Echo commands allow the state of key press notifications to be enabled/disabled or queried. When Key Press notifications are enabled, a Key Press Notification packet (See 5.3.4.1 Key Press Notification Packets) is sent by the Console whenever a key is pressed or released on the Console, a remote, the VideoWave control frame, or a Key Press command is sent by the Client. -
Page 26: Soft Key Press Notifications
Installers Guide to the Bose® Serial interface June 28, 2011 Note there is no response for this command. The Ready packet must be received from the Console before the Client can send another command. 6.3.1.3 Query Hard Key Press Notification State Use this command to query the hard key press notification state. -
Page 27: Table 6-12 Enable/Disable Soft Key Press Notifications Accepted Response Format
Installers Guide to the Bose® Serial interface June 28, 2011 This command is not available in Low Power Mode. The Soft Key Press Notifications state is set to false when the console enters Low Power Mode. Note if the Hard Key Press Notification state is enabled, a key press notification for the BOSE_TOUCH key will also be sent when the soft button is selected. -
Page 28: Kp - Simulate A Key Press
Installers Guide to the Bose® Serial interface June 28, 2011 Table 6-14 Disable Soft Key Press Notifications Command Format Byte Value Number (Hex) Name Explanation Length The total number of bytes in this packet is 50 Status All Status bits must be zero for packets sent by the Client... -
Page 29: Ts - Set Tuner Station
Installers Guide to the Bose® Serial interface June 28, 2011 Note that the OpCode in a Key Press Notification packet (see section 5.3.4.1 Key Press Notification Packets) identifies the key which was pressed. However only opcodes associated with Hard Key presses can be sent via the Key Press Command and only a subset of the Hard Key presses codes (see Table 7-2 Hard Key Press Codes) are appropriate when the console is in Low Power Mode or when a particular device type is the active source. -
Page 30: Converting Between Frequency And Station Number
Installers Guide to the Bose® Serial interface June 28, 2011 Client sends: 05 00 01 49 4d Table 6-17 Query Tuner Station Command Format Byte Value Number (Hex) Name Explanation Length The total number of bytes in this packet is 5... -
Page 31: Sample Conversions
Installers Guide to the Bose® Serial interface June 28, 2011 In the formulas below the Frequency is expressed in kilohertz. For example for the USA FM value displayed on the radio as 87.7 the corresponding actual frequency is 87700 kHz. -
Page 32: Sr - Query Zone Source
Installers Guide to the Bose® Serial interface June 28, 2011 Console Responds: <Length> <Status> 04 03 <Preset-Value> 0a 00 Table 6-21 Query Current Tuner Preset Response Format Byte Value Number (Hex) Name Explanation <Length> Length The total number of bytes in this packet including this byte <Status>... -
Page 33: Rds Ps - Query Rds Program Service
Installers Guide to the Bose® Serial interface June 28, 2011 6.9 RDS PS - Query RDS Program Service This is an eight-byte value that represents the call letters or station identity name. Client sends: 06 00 01 4f 00 48... -
Page 34: Sysrdy - Query System Ready
Installers Guide to the Bose® Serial interface June 28, 2011 Console responds: 44 <Status> 01 4f <T0> … <T63> Table 6-27 Query RDS Radio Text Response Format Byte Value Number (Hex) Name Explanation Length The total number of bytes in this packet is 68 <Status>... -
Page 35: Rmstatus - Query Room Status
Note that this value wraps to zero approximately every 50 days of continuous power. Bose recommends not issuing the UpTime command more often than LOW_POWER_POLL_TIME (see section 5.4 Protocol Timings) -
Page 36: Table 6-32 Query Room Status Command Format
Only the Bose LSA2 and LSA3 amplifiers use attenuated volume. To determine if the value is true volume or attenuated volume, the Client can query the current volume and then send a volume up or volume down key press to change the room volume and query the room information again. -
Page 37: Appendix
Installers Guide to the Bose® Serial interface June 28, 2011 7 Appendix 7.1 Source Enumerators These are the values returned by the SR command (see Section 6.8 SR -Query Zone Source.) Table 7-1 Source Enumerators Source Name Value) Explanation 0x00... -
Page 38: Key Press Codes
Installers Guide to the Bose® Serial interface June 28, 2011 7.2 Key Press Codes 7.2.1 Hard Key Press Codes These keys can be sent using the KP command. They will also be the values listed in Key Press notification packets. These are also the codes received from an Infrared (IR) remote. - Page 39 Installers Guide to the Bose® Serial interface June 28, 2011 Supported Rooms Key Name Value Explanation BOSE_ON_OFF 0x4C Toggles Room On/Off BOSE_MUTE_ALL 0x4D Toggles Mute Mode in all rooms Source Selection Input 5 Component Video BOSE_INPUT_5 0x52 Select ―Disc‖ Sources...
-
Page 40: Soft Key Press Codes
Installers Guide to the Bose® Serial interface June 28, 2011 7.2.2 Soft Key Press Codes The VideoWave Control Frame allows buttons on the video display to be selected with the click pad. When the click pad is pressed a Key Press Notification (section 5.3.4.1) will be sent if Soft Key Press echo has been enabled (See section 6.3.2 Soft Key Press... -
Page 41: Key Press Notes
0xFF 7.2.3 Key Press Notes There is only one digital audio decoder in the console so for multi-room configurations Bose recommends connecting the analog inputs for each source. Otherwise when the room A (Main Room) source is digital (e.g. HDMI) rooms B-O will hear silence if they are listening to a different digital source. -
Page 42: Release Notes
Status: Resolved in 01.05.00. TrackWeb 6151. After a reboot, (e.g. a power failure) if a Bose® link room (B-O) is turned on and then a source key is sent to turn on the main room (A), the main room will come up in the selected source but will be muted.
Need help?
Do you have a question about the AV20 and is the answer not in the manual?
Questions and answers