<UgiFirmwareUpdateDelegate> Protocol Reference

Overview

A UgiFirmwareUpdateDelegate object is passed to the firmwareUpdate method of the Ugi singleton.

All of the protocol methods are optional, the delegate only implements the methods it needs.

Instance Methods

(void) - firmwareUpdateProgress:withAmountTotal:canCancel:
 Firmware update progress. More...
 
(void) - firmwareUpdateCompleted:updateTime:
 Firmware update complete. More...
 

Types

enum  UgiFirmwareUpdateReturnValues {
  UGI_FIRMWARE_UPDATE_SUCCESS = 0, UGI_FIRMWARE_UPDATE_NO_FILE = 100, UGI_FIRMWARE_UPDATE_BAD_FILE = 101, UGI_FIRMWARE_UPDATE_INCOMPATIBLE_HARDWARE = 102,
  UGI_FIRMWARE_UPDATE_INCOMPATIBLE_VERSION = 103, UGI_FIRMWARE_UPDATE_CRC_MISMATCH = 3, UGI_FIRMWARE_UPDATE_PROTOCOL_FAILURE = 104, UGI_FIRMWARE_UPDATE_CANT_RECONNECT = 105,
  UGI_FIRMWARE_UPDATE_CANCELLED = 106, UGI_FIRMWARE_UPDATE_BATTERY_TOO_LOW = 107
}
 Values returned from firmwareUpdate and sent with firmwareUpdateCompleted. More...
 

Instance Method Documentation

- (void) firmwareUpdateProgress: (int)  amountDone
withAmountTotal: (int)  amountTotal
canCancel: (BOOL)  canCancel 
optional

Firmware update progress.

Parameters
amountDoneamount of the update completed
amountTotalamount in the complete update
canCancelYES if the update can be cancelled at this point
- (void) firmwareUpdateCompleted: (UgiFirmwareUpdateReturnValues result
updateTime: (int)  seconds 

Firmware update complete.

Parameters
resultResult of the update
secondsTime the update took in seconds

Enumeration Documentation

Values returned from firmwareUpdate and sent with firmwareUpdateCompleted.

Enumerator
UGI_FIRMWARE_UPDATE_SUCCESS 

Update successful.

UGI_FIRMWARE_UPDATE_NO_FILE 

No update file loaded.

UGI_FIRMWARE_UPDATE_BAD_FILE 

The update file is corrupted.

UGI_FIRMWARE_UPDATE_INCOMPATIBLE_HARDWARE 

The update is not compatible with the reader.

UGI_FIRMWARE_UPDATE_INCOMPATIBLE_VERSION 

The update is incompatible with the existing firmware.

UGI_FIRMWARE_UPDATE_CRC_MISMATCH 

CRC mismatch in the file.

UGI_FIRMWARE_UPDATE_PROTOCOL_FAILURE 

Failure communicating with the Grokker.

UGI_FIRMWARE_UPDATE_CANT_RECONNECT 

Can't reconnect to the Grokker.

UGI_FIRMWARE_UPDATE_CANCELLED 

Update was cancelled.

UGI_FIRMWARE_UPDATE_BATTERY_TOO_LOW 

Battery is too low to update the firmware.