Installers Guide to the Bose® Serial interface
June 28, 2011
Bose Confidential Information
Page 16/42
Do Not Redistribute
Console sends: 08 <Status> 01 04 <Key-State> <Producer> <Key-Code> <Room>
Table 5-6 Key Press Notification Packet Format
Byte
Number
Value
(Hex)
Name
Explanation
0
08
Length
The total number of bytes in this packet is 8
1
<Status>
Status
Error bit = 0, Notification bit = 1
2-3
01 04
OpCode
The OpCode of the Key Press Notification command
4
<Key-
State>
Key State
Pressed = 0, Released = 1
5
<Producer> Key
Producer
Console = 0, RF = 1, IR = 2
6
<Key-
Code>
Key Code
The Key Code of the pressed key (See section 7.2 Key
Press Codes)
7
<Room>
Room
Code
Room where the Key was pressed. Decimal values 0-14
represent rooms A (Main) through O.
Note: The OpCode of a Key Press Notification packet is the same as the OpCode of a Ready
packet, but the length of a Ready packet is always 4 versus 8 for a Key Press Notification packet
and the Ready packet does not have the Notification bit set in the Status Byte.
5.3.4.2 Assert Notification Packets
This packet will only be sent from the Console if a fatal error in the Console has occurred, and it
indicates the Console will reboot. The first four bytes of payload are the Assert code, the rest is a
zero terminated ASCII string.
Console sends: <Length> <Status> 01 02 <Assert-Code> <Msg>
Table 5-7 Assert Notification Packet Format
Byte
Number
Value
(Hex)
Name
Explanation
0
<Length> Length
The total number of bytes in this packet
1
<Status>
Status
Error bit = 0, Notification bit = 1
2-3
01 02
OpCode
4-7
<Assert-
Code>
Assert
Number
Can be used by support to trace the location of the failure
8
—
<Msg>
Message
text
A zero terminated ASCII String
5.3.4.3 Debug Notification Packets
Console sends: <Length> <Status> 01 00 <Msg>
Table 5-8 Debug Packet Format
Byte
Number
Value
(Hex)
Name
Explanation
0
<Length>
Length
The total number of bytes in this packet
1
<Status>
Status
Error bit = 0, Notification bit = 1
2-3
01 00
OpCode
5
—
<Msg>
Message
text
An ASCII String