Bose AV20 Montageanleitung

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 1/42 Do Not Redistribute

Installers Guide to the Bose Serial

Interface for Bose AV20, AV35 and

AVM Home Theater Control Consoles

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.

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.

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 2/42 Do Not Redistribute

TABLE OF CONTENTS

1INTRODUCTION______________________________________________ 5

1.1 Controlling the System .................................................................................................... 5

1.2 States of the System ........................................................................................................ 5

2DEFINITIONS ________________________________________________ 7

3THE PHYSICAL CONNECTOR __________________________________ 8

4PACKET FORMAT ____________________________________________ 9

4.1 Packet Fields..................................................................................................................... 9

4.1.1 Length..............................................................................................................................9

4.1.2 Status................................................................................................................................9

4.1.3 OpCode..........................................................................................................................10

4.1.4 Payload ..........................................................................................................................10

4.1.5 Checksum (if present)....................................................................................................11

5THE COMMUNICATION PROTOCOL ____________________________ 12

5.1 Notational Conventions ................................................................................................. 12

5.2 Issuing Commands to the Console .............................................................................. 12

5.3 Interpreting Packets from the Console ........................................................................ 12

5.3.1 Ready Packet..................................................................................................................13

5.3.2 Response Packets...........................................................................................................13

5.3.3 Error Packets..................................................................................................................13

5.3.4 Notification Packets.......................................................................................................14

5.4 Protocol Timings ............................................................................................................ 17

5.4.1 MAX_PACKET_TIME.................................................................................................17

5.4.2 REBOOT_TIME............................................................................................................17

5.4.3 NOT_AVAILABLE_TIME...........................................................................................17

5.4.4 TURN_ON_TIME.........................................................................................................17

5.4.5 ALL_OFF_TIME...........................................................................................................17

5.4.6 INACTIVITY_TIME.....................................................................................................17

5.4.7 INTER_COMMAND_TIME.........................................................................................17

5.4.8 LOW_POWER_POLL_TIME.......................................................................................17

5.5 Low Power Mode ............................................................................................................ 18

5.6 Autonomous Console State Changes.......................................................................... 18

5.6.1 The Console Experiences a Power Interruption.............................................................18

5.6.2 The Source is changed To the INPUT_ID_INSTALLIQ or INPUT_ID_PTS Source ..18

5.6.3 The Console Transitions To/From Low Power Mode ...................................................19

5.6.4 The Console Turns Off Due To Inactivity.....................................................................19

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 3/42 Do Not Redistribute

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

6CLIENT COMMANDS AND CONSOLE RESPONSES _______________ 22

6.1 VR - Query Version........................................................................................................ 22

6.2 VO - Set/Query Main Room Volume............................................................................. 23

6.2.1 Set Main Room Volume ................................................................................................23

6.2.2 Query Main Room Volume ...........................................................................................23

6.3 Echo - Hard and Soft Key Press Notifications........................................................... 25

6.3.1 Hard Key Press Notifications.........................................................................................25

6.3.2 Soft Key Press Notifications..........................................................................................26

6.4 KP - Simulate a Key Press........................................................................................... 28

6.5 TS - Set Tuner Station.................................................................................................. 29

6.6 QS - Query Tuner Station............................................................................................. 29

6.6.1 Converting between frequency and station number.......................................................30

6.6.2 Sample Conversions ......................................................................................................31

6.7 Query Current Tuner Preset .......................................................................................... 31

6.8 SR - Query Zone Source .............................................................................................. 32

6.9 RDS PS - Query RDS Program Service ...................................................................... 33

6.10 RDS RT - Query RDS Radio Text......................................................................... 33

6.11 SysRdy - Query System Ready ........................................................................... 34

6.12 UpTime - Query System Up Time....................................................................... 34

6.13 RmStatus - Query Room Status .......................................................................... 35

7APPENDIX _________________________________________________ 37

7.1 Source Enumerators ...................................................................................................... 37

7.1.1 Source Enumerator Notes ..............................................................................................37

7.2 Key Press Codes ............................................................................................................ 38

7.2.1 Hard Key Press Codes ...................................................................................................38

7.2.2 Soft Key Press Codes.....................................................................................................40

7.2.3 Key Press Notes.............................................................................................................41

8RELEASE NOTES ___________________________________________ 42

8.1 Known Problems ............................................................................................................ 42

9DOCUMENT REVISION HISTORY_______________________________ 42

LIST OF TABLES

Table 1-1 System States ................................................................................................................. 6

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 4/42 Do Not Redistribute

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

Table 5-3 Error Packet Error Codes.............................................................................................. 14

Table 5-4 Notification Packet Format............................................................................................ 15

Table 5-5 Notification Packet Notification-Types........................................................................... 15

Table 5-6 Key Press Notification Packet Format........................................................................... 16

Table 5-7 Assert Notification Packet Format................................................................................. 16

Table 5-8 Debug Packet Format ................................................................................................... 16

Table 5-9 Sample Volume Query.................................................................................................. 19

Table 5-10 Sample Checksum Calculation ................................................................................... 20

Table 5-11 Sample Response for Volume Query.......................................................................... 20

Table 5-12 Sample Key Press Command..................................................................................... 21

Table 5-13 Sample Checksum Calculation for Key Press............................................................. 21

Table 6-1 Query Version Command Format ................................................................................. 22

Table 6-2 Query Version Response Format.................................................................................. 22

Table 6-3 Version String Format ................................................................................................... 22

Table 6-4 Set Main Room Volume Command Format.................................................................. 23

Table 6-5 Query Main Room Volume Command Format.............................................................. 23

Table 6-6 Query Main Room Volume Response Format.............................................................. 24

Table 6-7 Enable Hard Key Press Notifications Command Format.............................................. 25

Table 6-8 Disable Hard Key Press Notifications Command Format............................................. 25

Table 6-9 Query Hard Key Press Notification State Format ......................................................... 26

Table 6-10 Query Hard Key Press Notification State Response Format...................................... 26

Table 6-11 Enable Soft Key Press Notifications Command Format ............................................. 26

Table 6-12 Enable/Disable Soft Key Press Notifications Accepted Response Format................. 27

Table 6-13 Enable/Disable Soft Key Press Notifications Invalid Response Format ..................... 27

Table 6-14 Disable Soft Key Press Notifications Command Format............................................. 28

Table 6-15 Key Press Command Format...................................................................................... 28

Table 6-16 Set Tuner Station Command Format.......................................................................... 29

Table 6-17 Query Tuner Station Command Format...................................................................... 30

Table 6-18 Query Tuner Station Response Format...................................................................... 30

Table 6-19 Converting between frequency and station number ................................................... 30

Table 6-20 Query Current Tuner Preset Command Format ......................................................... 31

Table 6-21 Query Current Tuner Preset Response Format.......................................................... 32

Table 6-22 Query Zone Source Command Format....................................................................... 32

Table 6-23 Query Zone Source Response Format....................................................................... 32

Table 6-24 Query RDS Program Service Command Format........................................................ 33

Table 6-25 Query RDS Program Service Command Response Format....................................... 33

Table 6-26 Query RDS Radio Text Command Format ................................................................. 33

Table 6-27 Query RDS Radio Text Response Format.................................................................. 34

Table 6-28 SysRdy Command Format.......................................................................................... 34

Table 6-29 SysRdy Response Format .......................................................................................... 34

Table 6-30 UpTime Command Format.......................................................................................... 35

Table 6-31 UpTime Response Format.......................................................................................... 35

Table 6-32 Query Room Status Command Format....................................................................... 36

Table 6-33 Query Room Status Response Format....................................................................... 36

Table 6-34 Room Status Speaker State........................................................................................ 36

Table 7-1 Source Enumerators ..................................................................................................... 37

Table 7-2 Hard Key Press Codes.................................................................................................. 38

Table 7-3 Soft Key Press Codes................................................................................................... 40

Table 9-1 Revision History ............................................................................................................ 42

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 5/42 Do Not Redistribute

1 Introduction

This document specifies how to use the serial communications interface to control the following

control consoles: Bose AV20, AV35 and AVM control consoles. The AV20 is currently used in

Lifestyle T10/T20 systems. The AV35 is currently used in the Lifestyle 235, V25 and V35

systems. The AVM is currently used on the Bose VideoWave System.

The interaction between a computer and the Bose control console consists of Commands,

Responses, and event Notifications.

In previous generation Bose Lifestyle products, the interactions were sequences of printable

ASCII bytes which could be sent and received using a Terminal Emulator program.

The new control consoles interact with an external computer using a binary protocol, which

consists of sequences of bytes that transmit data which is not printable characters. The

sequences of bytes are structured and individual bytes generally hold numeric data. Thus the

interaction requires an application program on the computer. The rules and formats that describe

this interaction are called a protocol, which is described in this document.

1.1 Controlling the System

The system is normally controlled using key presses on the remote controls. The system can also

be controlled using the serial communication interface on the rear of the console and the protocol

described in this guide. The primary means of controlling the system is by simulating user key

presses using the Key Press command (see section 6.4). Other commands can query and/or

modify the states of the system.

The states of the system that can be set or queried are listed below. Later sections describe the

physical connection, the general format of the messages (packets) sent, the rules describing the

order and timing of these packets, and the specific packet format of the Commands, Responses,

and 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® link room speakers (Rooms B-O).

The states of the system that can by queried or modified are listed in Table 1-1 System States.

The commands to query or set these states are listed in section 6 Client Commands and Console

Responses. The value for each state is described with the Command which sets or modifies the

value.

In addition to these states, several types of events can occur in the Console. The Console alerts

the Client to these events by sending Notifications. (see section 5.3.4 Notification Packets).

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 6/42 Do Not Redistribute

Table 1-1 System States

State

Value

Command

to Set

Command

to Query

Available

in Low

Power

Mode

Main Room Speakers On

True/False

RoomStatus

Yes

Main Room Speakers Muted

True/False

RoomStatus

Yes

Main Room Speaker Source

Source Enumerators

Yes

Main Room Speaker Volume

0-100

KP, VO

Yes

Bose® link Room Speakers

True/False

RoomStatus

Yes

Bose® link Room Speakers

Muted

True/False

RoomStatus

Yes

Bose® link Room Speaker

Stream

Zone2/Local

RoomStatus

Yes

Bose® link Room Speaker

Volume

0-100

RoomStatus

Yes

Zone1 Source

Source Enumerators

Yes

Zone 2 Source

Source Enumerators

Yes

Lower Power Mode

True/False

TimeOut

SysRdy

Yes

Hard Key Press Notifications

True/False

Echo

Yes

Soft Key Press Notifications

True/False

Echo

Not

Available

Version

Text

Read Only

Tuner Station

0-65535

Yes

Tuner RDS Name

Text

Read Only

RDS PS

Yes

Tuner RDS Text

Text

Read Only

RDS RT

Yes

Tuner Current Preset

0-25

Read-Only

SysInfo

Time (msec) since Boot

0- 4294967295

Timer

Uptime

Yes

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 7/42 Do Not Redistribute

2 Definitions

Table 2-1 Definitions

Name

Meaning

Client

The external computer and software controlling

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.

LSB

Least significant byte. The byte of a numeric

field which holds the smallest portion of the

number. For example the number 300 decimal

is represented in hexadecimal as 0x012c. The

least significant byte is 0x2c.

MSB

Most significant byte. The byte of a numeric

field which holds the largest portion of the

number. For example the number 1000

decimal is represented in hexadecimal as

0x03e8. The most significant byte is 0x03.

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 8/42 Do Not Redistribute

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.

The DB-9 male connector (e.g. on a PC) has pins labeled 1-5 in the top row and 6-9 in the bottom

row. Pin 2 (Receive) goes to tip, Pin 3 (Transmit) goes to Ring, and pin 5 (Ground) connects to

sleeve. See cable figure 1 below.

The physical signaling uses the standard RS232 serial communication electrical specifications

with communication parameters of: 19200 Bits per second, 8 Data bits, No parity, 1 Stop bit, and

No Flow control. Note that the Console voltage is zero when the communications link is not

actively transmitting a packet.

Figure 1 The Serial Connection Cable

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 9/42 Do Not Redistribute

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. The Payload field contains any required parameters. Packets from the Client must also

include a Checksum field.

<Header> [ <Payload> ] <Checksum> Client to Console

<Header> [ <Payload> ] Console to Client -- Note: no Checksum

Note: Packets are NOT terminated with a Carriage Return or Line Feed.

4.1 Packet Fields

Table 4-1 General Packet Format

Byte

Number

Name

Number

of Bytes

Description

Length

Length of packet including this byte and the

Checksum byte (if present)

Status

Packet Flags. (Table 4-2 Packet Status Flags.)

2-3

Opcode

Operation to be performed

4—

Payload

Variable

Contains OpCode parameters if needed

Last

Checksum

Contains a checksum. Only sent by Client.

4.1.1 Length

Count of the total number of bytes in this packet including this Length byte, the Status, OpCode,

and Payload if present, and Checksum if present.

4.1.2 Status

The status byte consists of single bit flags. The bits of this byte are numbered from 7 the most

significant bit, to 0 the least significant bit. This byte must be set to 0 when sent by the Client.

When received by the Client, these flags are interpreted as indicated in Table 4-2 Packet Status

Flags.

Only two bits in the Status byte are relevant to the Client: the Error and Notification bits. The

Direction flag will always be set to 1 for all packets received by the Client and can be ignored. As

noted above, the Direction bit (and all other flags in the Status Byte) should be set to 0 in packets

sent by the Client.

The Error and Notification bits, as well as the OpCode field, must always be examined by the

Client to determine the type of packet it has received.

Installers Guide to the Bose® Serial interface June 28, 2011

Bose Confidential Information Page 10/42 Do Not Redistribute

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

Client must ignore

Reserved

Client must ignore

Reserved

Client must ignore

Notification

0 - This is not a notification packet

1 - This is a notification packet

(See Section 5.3.4 Notification Packets.)

Reserved

Client must ignore

Direction

0 - For packets sent by the Client

1 - For packets sent by the Console

Reserved

Client must ignore

4.1.2.1 The Error Bit

On packets from the Console, the Error bit and Notification bit will never both be set. If the Error

bit is set, a protocol error has occurred (See section 5.3.3 Error Packets ).

The only protocol error possible on a debugged Client would be due to packet data corruption,

loss, or timeout. When the Console sends an error packet indicating corruption, the Client should

simply retry the command.

4.1.2.2 The Notification Bit

The Console occasionally sends Notification packets to indicate internal Console states, which

are normally not of interest to the Client. Thus if the Notification flag (bit 3) is set, then the packet

contents should normally be ignored by the Client. One Notification packet that could be useful to

a Client is notification that a key has been pressed on the Console or a remote. This notification

packet is only sent if the Client has enabled Key Press notifications (See section 5.3.4.1 Key

Press Notification Packets).

4.1.3 OpCode

The Operation code is always two bytes and indicates the operation requested of the Console.

See the value listed for individual commands in section 6 Client Commands and Console

Responses.

4.1.4 Payload

Content and length varies. See individual commands in section 6 Client Commands and Console

Responses for details.

Dieses Handbuch passt für folgende Modelle

Inhaltsverzeichnis

Andere Bose Musikmixer Handbücher

Bose

Bose ToneMatch T4S Bedienungsanleitung

Bose

Bose ToneMatch T4S Bedienungsanleitung

Bose

Bose FreeSpace DXA 2120 Betriebsanleitung

Beliebte Musikmixer Handbücher anderer Marken

Neve

Neve 8816 Bedienungsanleitung

Mackie

Mackie Onyx Analogue Mixer Bedienungsanleitung

Behringer

Behringer EUROPOWER PMP518M Bedienungsanleitung

Peavey

Peavey S-32 Sanctuary Series Bedienungsanleitung

Rane

Rane MP 4 Bedienungsanleitung

True

True T9 Touchscreen Console Bedienungsanleitung

Studiomaster

Studiomaster Air Pro 24 Bedienungsanleitung

Pioneer

Pioneer SVM 1000 - Audio/Video Mixer Bedienungsanleitung

Roland

Roland M-160 Bedienungsanleitung

Yamaha

Yamaha MR1642 Bedienungsanleitung

Ecler

Ecler MAC40v Bedienungsanleitung

Pioneer

Pioneer DJM 909 - Battle Mixer W/Effects Bedienungsanleitung

Veeder-Root

Veeder-Root TLS-350 Series Bedienungsanleitung

Alto

Alto APM80.QUAD Bedienungsanleitung

Omnitronic

Omnitronic PM-211 Bedienungsanleitung

SoundCraft

SoundCraft B400 Bedienungsanleitung

Roland

Roland SoundCanvas SC-8820 Bedienungsanleitung

CARVIN

CARVIN RX 1200 Bedienungsanleitung