com.etherios.connector.core.facilities.firmware

Interface FirmwareConstants

All Known Subinterfaces:

IFirmwareUpdateImplementation

All Known Implementing Classes:

GeneralFirmwareManager

public interface FirmwareConstants

This interface is used to centralize all of the Firmware Upgrade constants used by the Firmware Upgrade modules.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORT_DOWNLOAD_ERROR Error during firmware download.
static int	ABORT_HARDWARE_ERROR Hardware error.
static int	ABORT_INVALID_OFFSET Invalid offset.
static int	ABORT_SERVER_CLIENT User aborts firmware download.
static int	ABORT_UNEXPECTED_BINARY_BLOCK Unexpected binary block.
static int	ACKNOWLEDGE_LENGTH
static int	BINARY_BLOCK_ACK_FLAG_OFFSET Binary block.
static int	BINARY_BLOCK_ACK_OFFSET_OFFSET Binary block ACK.
static int	BINARY_BLOCK_ACK_STATUS_OFFSET
static int	BINARY_BLOCK_DATA_OFFSET
static int	BINARY_BLOCK_OFFSET_OFFSET
static int	BLOCK_OFFSET_LENGTH
static int	CHECKSUM_LENGTH
static int	CODESIZE_LENGTH
static int	DOWNLOAD_ABORT_STATUS_OFFSET Download abort.
static int	DOWNLOAD_COMPLETE_CHECKSUM_OFFSET
static int	DOWNLOAD_COMPLETE_CODESIZE_OFFSET Download complete.
static int	DOWNLOAD_COMPLETE_RESPONSE_CHECKSUM_OFFSET Download complete response.
static int	DOWNLOAD_COMPLETE_RESPONSE_STATUS_OFFSET
static int	DOWNLOAD_COMPLETE_STATUS_CHECKSUM_ERROR Download completed successfully, but the calculated checksum did not match the checksum sent in the Download Complete message.
static int	DOWNLOAD_COMPLETE_STATUS_ERROR The Download did not complete successfully.
static int	DOWNLOAD_COMPLETE_STATUS_OK Download finished successfully and the calculated checksum matched the checksum sent in the Download Complete message.
static int	DOWNLOAD_REQUEST_CODESIZE_OFFSET Download request.
static int	DOWNLOAD_REQUEST_ID_OFFSET
static int	DOWNLOAD_RESPONSE_RESPONSETYPE_OFFSET Download response.
static int	DOWNLOAD_RESPONSE_TYPE_DOWNLOAD_DENIED User denied firmware upload for indicated target.
static int	DOWNLOAD_RESPONSE_TYPE_ERROR The firmware encountered an error that precludes the firmware upgrade.
static int	DOWNLOAD_RESPONSE_TYPE_FILE_TOO_LARGE The size is too large to fit in the current available space on the device.
static int	DOWNLOAD_RESPONSE_TYPE_INVALID_VERSION The version information is invalid.
static int	DOWNLOAD_RESPONSE_TYPE_NOT_ALLOWED The server is not allowed to provide updates.
static int	DOWNLOAD_RESPONSE_TYPE_NOT_AUTHENTICATED The server has not been authenticated.
static int	DOWNLOAD_RESPONSE_TYPE_OK OK to send firmware binary data for indicated target.
static int	DOWNLOAD_RESPONSE_TYPE_REJECT The device is configured to reject all upload requests.
static int	DOWNLOAD_STATUS_STATUS_OFFSET Download status.
static int	ERROR_STATUS_MALFORMED_MESSAGE Malformed message.
static int	ERROR_STATUS_OFFSET
static int	ERROR_STATUS_UNKNOWN_OPCODE Unknown opcode.
static int	ERROR_STATUS_UNKNOWN_TARGET Unknown or invalid target.
static int	INFO_RESPONSE_CODESIZE_OFFSET Download info.
static int	INFO_RESPONSE_ID_OFFSET
static int	OFFSET_LENGTH
static byte	OPCODE_FIRMWARE_BINARY_BLOCK
static byte	OPCODE_FIRMWARE_BINARY_BLOCK_ACK
static byte	OPCODE_FIRMWARE_DOWNLOAD_ABORT
static byte	OPCODE_FIRMWARE_DOWNLOAD_COMPLETE
static byte	OPCODE_FIRMWARE_DOWNLOAD_COMPLETE_RESPONSE
static byte	OPCODE_FIRMWARE_DOWNLOAD_REQUEST
static byte	OPCODE_FIRMWARE_DOWNLOAD_RESPONSE
static byte	OPCODE_FIRMWARE_DOWNLOAD_STATUS
static byte	OPCODE_FIRMWARE_INFO_REQUEST
static byte	OPCODE_FIRMWARE_INFO_RESPONSE
static byte	OPCODE_FIRMWARE_TARGET_LIST Opcodes
static byte	OPCODE_INVALID_FIRMWARE_TARGET
static int	OPCODE_LENGTH Lengths
static int	OPCODE_OFFSET Offsets
static byte	OPCODE_REQUEST_TARGET_RESET
static int	RESPONSETYPE_LENGTH
static int	STATUS_LENGTH
static int	TARGET_0_CODE_SIZE
static java.lang.String	TARGET_0_LABEL Target 0.
static int	TARGET_0_VALUE
static int	TARGET_LENGTH
static int	TARGET_OFFSET
static int	VERSION_LENGTH
static int	VERSION_OFFSET

Field Detail

ABORT_DOWNLOAD_ERROR

static final int ABORT_DOWNLOAD_ERROR

Error during firmware download.

• When sent from client to server: the device encountered an unspecified error in the download and needed to abort.
• When sent from server to client: the server encountered an error in the download data or mechanism, and needed to abort the download.

See Also:

ABORT_SERVER_CLIENT, ABORT_INVALID_OFFSET, ABORT_UNEXPECTED_BINARY_BLOCK, ABORT_HARDWARE_ERROR, Constant Field Values

ABORT_HARDWARE_ERROR

static final int ABORT_HARDWARE_ERROR

Hardware error.

• When sent from client to server: Permanent hardware error.
• When sent from server to client: undefined.

See Also:

ABORT_SERVER_CLIENT, ABORT_DOWNLOAD_ERROR, ABORT_INVALID_OFFSET, ABORT_UNEXPECTED_BINARY_BLOCK, Constant Field Values

ABORT_INVALID_OFFSET

static final int ABORT_INVALID_OFFSET

Invalid offset.

• When sent from client to server: Invalid offset received in data block message.
• When sent from server to client: undefined.

See Also:

ABORT_SERVER_CLIENT, ABORT_DOWNLOAD_ERROR, ABORT_UNEXPECTED_BINARY_BLOCK, ABORT_HARDWARE_ERROR, Constant Field Values

ABORT_SERVER_CLIENT

static final int ABORT_SERVER_CLIENT

User aborts firmware download.

• When sent from client to server: user aborted firmware download.
• When sent from server to client: operator aborted firmware download.

See Also:

ABORT_DOWNLOAD_ERROR, ABORT_INVALID_OFFSET, ABORT_UNEXPECTED_BINARY_BLOCK, ABORT_HARDWARE_ERROR, Constant Field Values

ABORT_UNEXPECTED_BINARY_BLOCK

static final int ABORT_UNEXPECTED_BINARY_BLOCK

Unexpected binary block.

• When sent from client to server: Unexpected Firmware Binary Block message received.
• When sent from server to client: undefined.

See Also:

ABORT_SERVER_CLIENT, ABORT_DOWNLOAD_ERROR, ABORT_INVALID_OFFSET, ABORT_HARDWARE_ERROR, Constant Field Values

ACKNOWLEDGE_LENGTH

static final int ACKNOWLEDGE_LENGTH

See Also:

Constant Field Values

BINARY_BLOCK_ACK_FLAG_OFFSET

static final int BINARY_BLOCK_ACK_FLAG_OFFSET

Binary block.

See Also:

Constant Field Values

BINARY_BLOCK_ACK_OFFSET_OFFSET

static final int BINARY_BLOCK_ACK_OFFSET_OFFSET

Binary block ACK.

See Also:

Constant Field Values

BINARY_BLOCK_ACK_STATUS_OFFSET

static final int BINARY_BLOCK_ACK_STATUS_OFFSET

See Also:

Constant Field Values

BINARY_BLOCK_DATA_OFFSET

static final int BINARY_BLOCK_DATA_OFFSET

See Also:

Constant Field Values

BINARY_BLOCK_OFFSET_OFFSET

static final int BINARY_BLOCK_OFFSET_OFFSET

See Also:

Constant Field Values

BLOCK_OFFSET_LENGTH

static final int BLOCK_OFFSET_LENGTH

See Also:

Constant Field Values

CHECKSUM_LENGTH

static final int CHECKSUM_LENGTH

See Also:

Constant Field Values

CODESIZE_LENGTH

static final int CODESIZE_LENGTH

See Also:

Constant Field Values

DOWNLOAD_ABORT_STATUS_OFFSET

static final int DOWNLOAD_ABORT_STATUS_OFFSET

Download abort.

See Also:

Constant Field Values

DOWNLOAD_COMPLETE_CHECKSUM_OFFSET

static final int DOWNLOAD_COMPLETE_CHECKSUM_OFFSET

See Also:

Constant Field Values

DOWNLOAD_COMPLETE_CODESIZE_OFFSET

static final int DOWNLOAD_COMPLETE_CODESIZE_OFFSET

Download complete.

See Also:

Constant Field Values

DOWNLOAD_COMPLETE_RESPONSE_CHECKSUM_OFFSET

static final int DOWNLOAD_COMPLETE_RESPONSE_CHECKSUM_OFFSET

Download complete response.

See Also:

Constant Field Values

DOWNLOAD_COMPLETE_RESPONSE_STATUS_OFFSET

static final int DOWNLOAD_COMPLETE_RESPONSE_STATUS_OFFSET

See Also:

Constant Field Values

DOWNLOAD_COMPLETE_STATUS_CHECKSUM_ERROR

static final int DOWNLOAD_COMPLETE_STATUS_CHECKSUM_ERROR

Download completed successfully, but the calculated checksum did not match the checksum sent in the Download Complete message.

See Also:

DOWNLOAD_COMPLETE_STATUS_OK, DOWNLOAD_COMPLETE_STATUS_ERROR, Constant Field Values

DOWNLOAD_COMPLETE_STATUS_ERROR

static final int DOWNLOAD_COMPLETE_STATUS_ERROR

The Download did not complete successfully.

See Also:

DOWNLOAD_COMPLETE_STATUS_OK, DOWNLOAD_COMPLETE_STATUS_CHECKSUM_ERROR, Constant Field Values

DOWNLOAD_COMPLETE_STATUS_OK

static final int DOWNLOAD_COMPLETE_STATUS_OK

Download finished successfully and the calculated checksum matched the checksum sent in the Download Complete message.

See Also:

DOWNLOAD_COMPLETE_STATUS_CHECKSUM_ERROR, DOWNLOAD_COMPLETE_STATUS_ERROR, Constant Field Values

DOWNLOAD_REQUEST_CODESIZE_OFFSET

static final int DOWNLOAD_REQUEST_CODESIZE_OFFSET

Download request.

See Also:

Constant Field Values

DOWNLOAD_REQUEST_ID_OFFSET

static final int DOWNLOAD_REQUEST_ID_OFFSET

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_RESPONSETYPE_OFFSET

static final int DOWNLOAD_RESPONSE_RESPONSETYPE_OFFSET

Download response.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_DOWNLOAD_DENIED

static final int DOWNLOAD_RESPONSE_TYPE_DOWNLOAD_DENIED

User denied firmware upload for indicated target.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_ERROR

static final int DOWNLOAD_RESPONSE_TYPE_ERROR

The firmware encountered an error that precludes the firmware upgrade.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_FILE_TOO_LARGE

static final int DOWNLOAD_RESPONSE_TYPE_FILE_TOO_LARGE

The size is too large to fit in the current available space on the device.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_INVALID_VERSION

static final int DOWNLOAD_RESPONSE_TYPE_INVALID_VERSION

The version information is invalid.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_NOT_ALLOWED

static final int DOWNLOAD_RESPONSE_TYPE_NOT_ALLOWED

The server is not allowed to provide updates.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_NOT_AUTHENTICATED

static final int DOWNLOAD_RESPONSE_TYPE_NOT_AUTHENTICATED

The server has not been authenticated.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_OK

static final int DOWNLOAD_RESPONSE_TYPE_OK

OK to send firmware binary data for indicated target.

See Also:

Constant Field Values

DOWNLOAD_RESPONSE_TYPE_REJECT

static final int DOWNLOAD_RESPONSE_TYPE_REJECT

The device is configured to reject all upload requests.

See Also:

Constant Field Values

DOWNLOAD_STATUS_STATUS_OFFSET

static final int DOWNLOAD_STATUS_STATUS_OFFSET

Download status.

See Also:

Constant Field Values

ERROR_STATUS_MALFORMED_MESSAGE

static final int ERROR_STATUS_MALFORMED_MESSAGE

Malformed message.

See Also:

OPCODE_INVALID_FIRMWARE_TARGET, Constant Field Values

ERROR_STATUS_OFFSET

static final int ERROR_STATUS_OFFSET

See Also:

Constant Field Values

ERROR_STATUS_UNKNOWN_OPCODE

static final int ERROR_STATUS_UNKNOWN_OPCODE

Unknown opcode.

See Also:

OPCODE_INVALID_FIRMWARE_TARGET, Constant Field Values

ERROR_STATUS_UNKNOWN_TARGET

static final int ERROR_STATUS_UNKNOWN_TARGET

Unknown or invalid target.

See Also:

OPCODE_INVALID_FIRMWARE_TARGET, Constant Field Values

INFO_RESPONSE_CODESIZE_OFFSET

static final int INFO_RESPONSE_CODESIZE_OFFSET

Download info.

See Also:

Constant Field Values

INFO_RESPONSE_ID_OFFSET

static final int INFO_RESPONSE_ID_OFFSET

See Also:

Constant Field Values

OFFSET_LENGTH

static final int OFFSET_LENGTH

See Also:

Constant Field Values

OPCODE_FIRMWARE_BINARY_BLOCK

static final byte OPCODE_FIRMWARE_BINARY_BLOCK

See Also:

Constant Field Values

OPCODE_FIRMWARE_BINARY_BLOCK_ACK

static final byte OPCODE_FIRMWARE_BINARY_BLOCK_ACK

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_ABORT

static final byte OPCODE_FIRMWARE_DOWNLOAD_ABORT

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_COMPLETE

static final byte OPCODE_FIRMWARE_DOWNLOAD_COMPLETE

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_COMPLETE_RESPONSE

static final byte OPCODE_FIRMWARE_DOWNLOAD_COMPLETE_RESPONSE

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_REQUEST

static final byte OPCODE_FIRMWARE_DOWNLOAD_REQUEST

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_RESPONSE

static final byte OPCODE_FIRMWARE_DOWNLOAD_RESPONSE

See Also:

Constant Field Values

OPCODE_FIRMWARE_DOWNLOAD_STATUS

static final byte OPCODE_FIRMWARE_DOWNLOAD_STATUS

See Also:

Constant Field Values

OPCODE_FIRMWARE_INFO_REQUEST

static final byte OPCODE_FIRMWARE_INFO_REQUEST

See Also:

Constant Field Values

OPCODE_FIRMWARE_INFO_RESPONSE

static final byte OPCODE_FIRMWARE_INFO_RESPONSE

See Also:

Constant Field Values

OPCODE_FIRMWARE_TARGET_LIST

static final byte OPCODE_FIRMWARE_TARGET_LIST

Opcodes

See Also:

Constant Field Values

OPCODE_INVALID_FIRMWARE_TARGET

static final byte OPCODE_INVALID_FIRMWARE_TARGET

See Also:

Constant Field Values

OPCODE_LENGTH

static final int OPCODE_LENGTH

Lengths

See Also:

Constant Field Values

OPCODE_OFFSET

static final int OPCODE_OFFSET

Offsets

See Also:

Constant Field Values

OPCODE_REQUEST_TARGET_RESET

static final byte OPCODE_REQUEST_TARGET_RESET

See Also:

Constant Field Values

RESPONSETYPE_LENGTH

static final int RESPONSETYPE_LENGTH

See Also:

Constant Field Values

STATUS_LENGTH

static final int STATUS_LENGTH

See Also:

Constant Field Values

TARGET_0_CODE_SIZE

static final int TARGET_0_CODE_SIZE

See Also:

Constant Field Values

TARGET_0_LABEL

static final java.lang.String TARGET_0_LABEL

Target 0.

See Also:

Constant Field Values

TARGET_0_VALUE

static final int TARGET_0_VALUE

See Also:

Constant Field Values

TARGET_LENGTH

static final int TARGET_LENGTH

See Also:

Constant Field Values

TARGET_OFFSET

static final int TARGET_OFFSET

See Also:

Constant Field Values

VERSION_LENGTH

static final int VERSION_LENGTH

See Also:

Constant Field Values

VERSION_OFFSET

static final int VERSION_OFFSET

See Also:

Constant Field Values