Installers Guide to the Bose® Serial interface
June 28, 2011
Bose Confidential Information
Page 25/42
Do Not Redistribute
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.
Note that the Console responds to both IR (Infrared) as well as RF (radio frequency) remotes.
There are two forms of this command:
The Hard Key press echo command enables/disables notification for the press/release of
a physical button on a remote or the console.
The Soft Key press echo command enables/disables notification for the press/release of
the click pad for the selected control on the control frame of a VideoWave.
Enabling key press notifications allows the Client to monitor when keys are pressed on the
Console or any remote. If key press notifications are enabled, key presses sent by the Client
using the Key Press command (See 6.4 KP - Simulate a Key Press) also cause the Console to
send a Key Press Notification packet.
Note if the Console reboots both Key Press Notification states are reset to disabled.
6.3.1 Hard Key Press Notifications
6.3.1.1 Enabling Hard Key Press Notifications
To enable Key Press Notification packets whenever hard (physical) keys are pressed, the Client
sends the following packet:
Client sends: 07 00 01 1b 01 0d 11
Table 6-7 Enable Hard Key Press Notifications Command Format
Byte
Number
Value
(Hex)
Name
Explanation
0
07
Length
The total number of bytes in this packet is 7
1
00
Status
All Status bits must be zero for packets sent by the Client
2-3
01 1b
OpCode
The OpCode of the Echo command
4-5
01 0d
Payload
Payload for Key Press notification from Client
6
11
Checksum
0x11 = 0x07 ^ 0x00 ^ 0x01 ^ 0x1b ^ 0x01 ^ 0x0d
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.2 Disabling Hard Key Press Notifications
To disable Hard Key Press Notification packets the client sends the following packet:
Client sends: 07 00 01 1b 01 00 1C
Table 6-8 Disable Hard Key Press Notifications Command Format
Byte
Number
Value
(Hex)
Name
Explanation
0
07
Length
The total number of bytes in this packet is 7
1
00
Status
All Status bits must be zero for packets sent by the Client
2-3
01 1b
OpCode
The OpCode of the Echo Command
4-5
01 00
Payload
Payload for Key Press notification from Client
6
1c
Checksum
0x11 = 0x07 ^ 0x00 ^ 0x01 ^ 0x1b ^ 0x01 ^ 0x00