Home Contents | # os.installFile | OS | Core4 Lua Commands

## SYNOPSIS

os.installFile(filename [, callback])

## DESCRIPTION

Performs a firmware update from inside the running system. The parameter filename must point to a firmware file. Firmware files commonly have the file ending .c4f. The file can be at any storage location, like an USB-Stick or a memory card.

The optional argument callback can be set to a lua function. The callback function is called during the install with progress information. The function should be defined as function(percent, info) ... end. The argument percent will receive the percentage done, while info has some short text description of what is happening currently.

While the firmware update runs, the Lua program is otherwise stopped. If the watchdog timer is in use, special care needs to be taken to keep the watchdog from resetting the system. This can be nicely done from the progress callback.

If no progress callback is given, the default is to put a small info window onto the middle of the graphics display, if one is attached.

## RETURN VALUE

On success, returns true. On error, three values are returned: nil, a string describing the error and the installer error code.