File SpinUpdate.h¶

FileList > include > SpinUpdate.h

#include <string>
#include <vector>

Public Attributes¶

Type	Name
SPINUPDATE_API typedef int(*	UpdatorMessageCallback
SPINUPDATE_API typedef int(*	UpdatorProgressCallback

Public Functions¶

Type	Name
SPINUPDATE_API const char *	GetErrorMessage ()
SPINUPDATE_API void	SetMessageCallback (UpdatorMessageCallback messageCallbackFunction)
SPINUPDATE_API void	SetProgressCallback (UpdatorProgressCallback progressCallbackFunction)
SPINUPDATE_API int	UpdateFirmware (std::vector< std::string > args)
SPINUPDATE_API int	UpdateFirmwareConsole (unsigned int numArgs, char ** argList)
SPINUPDATE_API int	UpdateFirmwareGUI (std::string args)

Macros¶

Type	Name
define	SPINUPDATE_API `SPINUPDATE\_IMPORT\_EXPORT`

Public Attributes Documentation¶

variable UpdatorMessageCallback¶

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

variable UpdatorProgressCallback¶

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

Public Functions Documentation¶

function GetErrorMessage¶

SPINUPDATE_API const char * GetErrorMessage ()

function SetMessageCallback¶

SPINUPDATE_API void SetMessageCallback (
    UpdatorMessageCallback messageCallbackFunction
)

function SetProgressCallback¶

SPINUPDATE_API void SetProgressCallback (
    UpdatorProgressCallback progressCallbackFunction
)

function UpdateFirmware¶

SPINUPDATE_API int UpdateFirmware (
    std::vector< std::string > args
)

function 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.

function UpdateFirmwareGUI¶

SPINUPDATE_API int UpdateFirmwareGUI (
    std::string args
)

Macro Definition Documentation¶

define SPINUPDATE_API¶

#define SPINUPDATE_API `SPINUPDATE_IMPORT_EXPORT`

The documentation for this class was generated from the following file C:/workspace/include/SpinUpdate.h