Seaward ClareHAL - Manual (Page 137)

136
3 3. Response Codes
There is a restricted set of response codes that can be generated by
the tester. These response codes are always distinct from command
codes.
SSSRSP_NAK (response code 0x00)
This response code is sent by the tester when a command is properly
formatted in terms of the protocol wrapper (length, CRC, etc), but does
not contain a properly formatted command (incorrect amount of data,
unknown command, incorrect item id or item instance, etc), or if the
command cannot be executed for some reason.
NAK responses sent by the tester always include 1 data byte. For a
NAK this data byte is referred to as the NAK reason code. The following
table describes the possible NAK reason codes:
Mnemonic Value Description
SSSNAK_NO_SESSION
0x01 Cannot execute a command because no session
has been started yet.
SSSNAK_PASSWORD 0x02 Either the password supplied for a session start
request is incorrect, or an attempt has been made
to perform a password protected command within
a restricted session.
SSSNAK_INVALID_CMD 0x03 Unknown SSS protocol command.
SSSNAK_ITEM_ID 0x04 The specified item identifier is unknown or
incorrect.
SSSNAK_INSTANCE 0x05 The specified item instance doesn't exist (instance
number is too large).
SSSNAK_WRONG_CMD_TYPE 0x06 The command/item combination is incorrect (eg
attempt to set a string with an integer value).
SSSNAK_INVALID_SIZE 0x07 Too much string data, wrong number of strings, or
incorrect number of bytes (eg float or struct of
incorrect size).
SSSNAK_INVALID_VALUE 0x08 Value/setting/parameter is outside of legal range,
or bad characters within a string, etc.
SSSNAK_READ_ONLY 0x09 Cannot set item - it is read only.
SSSNAK_FUNCTIONALITY 0x0A Incomplete tester functionality - feature not
implemented yet.
SSSNAK_OPERATION_SEQ 0x0B An operation is being attempted out of sequence
(eg saving a testfile before a testfile
download).
SSSNAK_FULL 0x0C Can't accept testfile entry, results upload, etc
because there is insufficient space remaining.
SSSNAK_EE_FAILED 0x0D EEProm operation failed (eg flash erasure,
programming, etc).
Your HAL tester