Bose AV20, Installer'S Manual

Page: 14 / 42

Installers Guide to the Bose® Serial interface June 28, 2011
Bose Confidential Information Page 14/42 Do Not Redistribute
An Error packet has the form:
Console sends: 07 <Status> 01 <Cmd> <Error-Code> <01>
Table 5-2 Error Packet Format
Byte
Number Value (Hex) Name Explanation
0 07 Length The total number of bytes in this packet is 7
1 <Status> Status Error bit = 1, Notification = 0
2 01 OpCode1 The value 1
3 <Cmd> OpCode2 The second byte of the OpCode of the failed
command.
4-5 <Error-code> Error Code A two byte error code. LSB followed by MSB
6 01 Payload The value 1
The two byte Error-code values appear below. Note since the code appears in the packet as
Least significant byte followed by Most significant byte, the two bytes in the packet appear in
reverse order from this list.
Table 5-3 Error Packet Error Codes
Two Byte Error
Code
(Hexadecimal)
Name Explanation
0xfffe PACKET_TIMEOUT Time between characters exceeded
0xfffc INVALID_STATUS_BYTE Nonzero Status byte received by Console
0xfffb NOT_AVAILABLE Function not available in Low Power Mode
0xfffa PACKET_CHECKSUM Invalid Checksum received by Console
0xffef INVALID_OPCODE Unknown OpCode
0xffee ARGUMENT Incorrect Payload value
0xffed HARDWARE Internal Hardware error
With the exception of a HARDWARE error they indicate an invalid packet was received by the
Console. The packet was invalid because the Console detected a format error, or a command not
available in Low Power Mode was sent while the Console was in Low Power Mode.
In a debugged client an error (except HARDWARE) is generally due to a transmission error or a
Console reboot. The Client can determine if the Console has rebooted using the Uptime
Command (see section 6.12 UpTime - Query System Up Time). A transmission error should
simply be retried.
When a command which is not available in Low Power Mode is sent when the Console is in Low
Power Mode, the console delays NOT_AVAILABLE_TIME (see section 5.4 -- Protocol Timings)
and then returns an error packet with the Error Code NOT_AVAILABLE. The Client can
determine if the Console is in Low Power Mode by using the SysRdy Command (see section 6.11
SysRdy - Query System Ready).
5.3.4 Notification Packets
Notification packets can be sent by the Console at any time
– even while the Client is waiting for
a response or Ready packet. The most useful notification packets are the Key Press notifications.
These notifications will only be sent by the Console when a Hard or Soft key press notification
state has been enabled via the Echo command (See Section
6.3 Echo - Hard and Soft Key
Press Notification). Note that the Hard Key Press Notification State is reset to False when the
Console reboots and the Soft Key Press Notification state is reset when the Console enters Low
Power Mode (see section 5.5 Low Power Mode).