mcumgr-core/no.nordicsemi.android.mcumgr.dfu.mcuboot/FirmwareUpgradeManager

FirmwareUpgradeManager

open class FirmwareUpgradeManager : FirmwareUpgradeController

Manages a McuManager firmware upgrade. Once initialized, this object can only perform a single firmware upgrade for a single device to completion. In other words, the same FirmwareUpgradeManager may start the upload, cancel the upload, and call start once again to restart the firmware upgrade. However, once the upload is completed, the same FirmwareUpgradeManager cannot not be used for subsequent firmware upgrades.

Like other MCU managers, FirmwareUpgradeManagers must be initialized with a McuMgrTransport which defines the scheme and implements the transport methods for communicating with the device. FirmwareUpgradeManagers additionally require a callback and the image data to upload.

Once initialized, a firmware upgrade is started by calling start, and can be paused, resumed, and canceled using pause, resume, and cancel.

Constructors

FirmwareUpgradeManager

constructor(@NotNull transport: @NotNull McuMgrTransport)

Construct a firmware upgrade manager.

constructor(@NotNull transport: @NotNull McuMgrTransport, @Nullable callback: @Nullable FirmwareUpgradeCallback<FirmwareUpgradeManager.State>)

Construct a firmware upgrade manager.

Types

enum Mode

open class Settings : FirmwareUpgradeSettings

enum State

Functions

open fun cancel()

Cancel the firmware upgrade.

open fun getState(): FirmwareUpgradeManager.State

Get the current State of the firmware upgrade.

@NotNull

open fun getTransporter(): @NotNull McuMgrTransport

Get the transporter.

open fun isInProgress(): Boolean

Determine whether the firmware upgrade is in progress.

open fun isPaused(): Boolean

Determine whether the firmware upgrade is paused.

open fun pause()

Pause the firmware upgrade.

open fun resume()

Resume a paused firmware upgrade.

setCallbackOnUiThread

open fun setCallbackOnUiThread(uiThreadCallbacks: Boolean)

If true, run all callbacks on the UI thread (default).

setFirmwareUpgradeCallback

open fun setFirmwareUpgradeCallback(@Nullable callback: @Nullable FirmwareUpgradeCallback<FirmwareUpgradeManager.State>)

Sets the manager callback.

open fun setMode(@NotNull mode: @NotNull FirmwareUpgradeManager.Mode)

Sets the manager mode.

open fun start(imageData: @NotNull Array<Byte>, @NotNull settings: @NotNull FirmwareUpgradeManager.Settings)

Start the upgrade.

open fun start(@NotNull images: @NotNull ImageSet, @NotNull settings: @NotNull FirmwareUpgradeManager.Settings)

Starts an upgrade with given image set.