Installers Guide to the Bose® Serial interface
June 28, 2011
Bose Confidential Information
Page 28/42
Do Not Redistribute
Table 6-14 Disable Soft Key Press Notifications Command Format
Byte
Number
Value
(Hex)
Name
Explanation
0
32
Length
The total number of bytes in this packet is 50
1
00
Status
All Status bits must be zero for packets sent by the Client
2-4
04 17
0c
OpCode
The OpCode of the Soft button Echo command
5-16
00
Filler1
Reserved
– must be zero
17
00
Requested
Echo state
Disable (0x00) the Soft Key echo state
18-48
00
Filler 2
Reserved
– must be zero
49
2d
Checksum
XOR of all preceding bytes in message
The Disable Soft Key Press Response Formats are identical to the Enable Soft Key Press
Response format and are listed in Table 6-12 and Table 6-13.
The Soft Key Press notification state cannot be queried.
6.4 KP - Simulate a Key Press
Use this command to simulate pressing a key on the Console or a remote. This is the primary
command for controlling the system.
Client sends: 0b 00 01 04 <K> <P> <H> <R> <Z> <C>
Table 6-15 Key Press Command Format
Byte
Number
Value
(Hex)
Name
Explanation
0
0b
Length
The total number of bytes in this packet is 11
1
00
Status
All Status bits must be zero for packets sent by the Client
2-3
01 04
OpCode
The OpCode of the Key Press command
4
<K>
Payload
The Key Code representing the key. See section 7.2 Key
Press Codes
5
<P>
Producer
A value representing the source of the key press.
0
– Console
1 - RF remote
2
– IR remote
6-7
<H>
Hold Time
The duration in msec for which the key would have been
pressed. Sent in the byte order LSB, MSB
8
<R>
Room Code
Value 0-14 (0x00-0x0e) which represents room A (Main)
through O
9
<Z>
Zone
0
– Zone 1 (Room A (Main))
1
– Zone 2 (Rooms B-O)
10
<C>
Checksum
The exclusive or (XOR) of all bytes in this packet (including
length) which preceded the checksum byte
Note there is no command response from the Console for this command. The Ready packet will
be sent by the Console after the command has been processed as usual. As always, the Ready
Packet must be received by the Console before sending another command.
Note: If Key Press notification is enabled, the Key Press notification for that key will be sent by
the Console and may arrive (as a notification packet) before the Ready packet (See section
5.3.4.1 Key Press Notification Packets.