SpinUpdate.h File Reference

Macros
#define	SPINUPDATE_API   SPINUPDATE_IMPORT_EXPORT

Functions
SPINUPDATE_API int	UpdateFirmwareConsole (unsigned int numArgs, char **argList)
	Updates the firmware for the device.
SPINUPDATE_API int	UpdateFirmwareGUI (std::string args)
SPINUPDATE_API int	UpdateFirmware (std::vector< std::string > args)
SPINUPDATE_API void	SetMessageCallback (UpdatorMessageCallback messageCallbackFunction)
SPINUPDATE_API void	SetProgressCallback (UpdatorProgressCallback progressCallbackFunction)
SPINUPDATE_API const char *	GetErrorMessage ()

Variables
SPINUPDATE_API typedef int(*	UpdatorMessageCallback )(const char *message)
SPINUPDATE_API typedef int(*	UpdatorProgressCallback )(const char *action, unsigned int address, int globalPercent, int currPercent)

Macro Definition Documentation

SPINUPDATE_API

#define SPINUPDATE_API   SPINUPDATE_IMPORT_EXPORT

Function Documentation

GetErrorMessage()

SPINUPDATE_API const char * GetErrorMessage

(

)

SetMessageCallback()

SPINUPDATE_API void SetMessageCallback

(

UpdatorMessageCallback

messageCallbackFunction

)

SetProgressCallback()

SPINUPDATE_API void SetProgressCallback

(

UpdatorProgressCallback

progressCallbackFunction

)

UpdateFirmware()

SPINUPDATE_API int UpdateFirmware

(

std::vector< std::string >

args

)

UpdateFirmwareConsole()

SPINUPDATE_API int UpdateFirmwareConsole	(	unsigned int	numArgs,
		char **	argList
	)

Updates the firmware for the device.

Parameters

numArgs	Number of strings pointed to by argv
argList	Pointer to list of string options for the firmware update

Returns

0 for success, otherwise non zero for failures.

Typical usage for updating is as follows: -R{serial number} [-{options} ..] {firmware zim file} -R{serial number} -UU -B {firmware zim file}

Option definitions: -B = Reboots the camera after the update has completed. If this argument is not provided, a manual power cycle will be required. -A = Updates individual portions of the firmware in flash. The code section of camera at location 0xFF08000 will be updated. ./sample_app -AFF080000 camera.zim -U = Downgrade the firmware. Multiple U's can be used to overwrite the ROM header. -F = Force program and EEprom reload. -R = Enter a regular expression for camera serial match. For example: ./sample_app -R.* camera.zim Results in matching any camera serial -P = Checks the progress of the updater. -epromsave = Save the content of the EEprom to a file.

UpdateFirmwareGUI()

SPINUPDATE_API int UpdateFirmwareGUI

(

std::string

args

)

Variable Documentation

UpdatorMessageCallback

SPINUPDATE_API typedef int(* UpdatorMessageCallback) (const char *message)

(

const char *

message

)

UpdatorProgressCallback

SPINUPDATE_API typedef int( * UpdatorProgressCallback) (const char *action, unsigned int address, int globalPercent, int currPercent)	(	const char *	action,
		unsigned int	address,
		int	globalPercent,
		int	currPercent
	)