com.etherios.connector.core.facilities.firmware

Class FirmwareDownloadStatus

java.lang.Object

com.etherios.connector.core.facilities.firmware.FirmwareDownloadStatus

public class FirmwareDownloadStatus
extends java.lang.Object

Firmware download status class.

This indicates the status of this version of the code after a firmware update process.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO Bad target info.
static int	DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION The target reset, but could not run the code indicated by Version Number.
static int	DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION The target reset, but could not run the code indicated by Version Number.
static int	DOWNLOAD_STATUS_OK The target successfully reset and is running the code indicated by version number.

Constructor Summary

Constructors

Constructor and Description
FirmwareDownloadStatus(int target, int status, byte[] newVersion, byte[] oldVersion) Class constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getNewVersion() Returns the new version of the updated target.
byte[]	getOldVersion() Returns the previous version of the updated target.
int	getStatus() Returns the status of the firmware download.
int	getTarget() Returns the firmware target number.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO

public static final int DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO

Bad target info.

See Also:

DOWNLOAD_STATUS_OK, DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION, Constant Field Values

DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION

public static final int DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION

The target reset, but could not run the code indicated by Version Number. The target then attempted to revert to the old version, but could not do so or encountered an error. Version Number may be invalid in this case.

See Also:

DOWNLOAD_STATUS_OK, DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO, Constant Field Values

DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION

public static final int DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION

The target reset, but could not run the code indicated by Version Number. The target then reverted to the old version, and is reporting the error in the version of code indicated by Version Number.

See Also:

DOWNLOAD_STATUS_OK, DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO, Constant Field Values

DOWNLOAD_STATUS_OK

public static final int DOWNLOAD_STATUS_OK

The target successfully reset and is running the code indicated by version number.

See Also:

DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO, Constant Field Values

Constructor Detail

FirmwareDownloadStatus

public FirmwareDownloadStatus(int target,
                              int status,
                              byte[] newVersion,
                              byte[] oldVersion)

Class constructor. Instances a new object of type FirmwareDownloadStatus with the given parameters.

Depending on the status code, old or new version will be used:

• DOWNLOAD_STATUS_OK, new version of the target will be used.
• DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, old version will be used.
• DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION preferably new version will be used, but it is not needed to be specify.
• DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO none will be used.

Parameters:

target - The target number that has just been uploaded.

status - The status of the firmware download.

newVersion - The new version of the target that has just been uploaded.

oldVersion - The old version of the target that has just been uploaded.

See Also:

DOWNLOAD_STATUS_OK, DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO

Method Detail

getNewVersion

public byte[] getNewVersion()

Returns the new version of the updated target. It may be null.

Returns:

and array containing the new version of the updated target. It may be null if it was not specified.

getOldVersion

public byte[] getOldVersion()

Returns the previous version of the updated target. It may be null.

Returns:

and array containing the previous version of the updated target. It may be null if it was not specified.

getStatus

public int getStatus()

Returns the status of the firmware download.

Returns:

the status of the firmware download.

See Also:

DOWNLOAD_STATUS_OK, DOWNLOAD_STATUS_ERROR_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_NOT_EVEN_USING_OLD_VERSION, DOWNLOAD_STATUS_ERROR_BAD_TARGET_INFO

getTarget

public int getTarget()

Returns the firmware target number.

Returns:

the firmware target number.