mcumgr-core/no.nordicsemi.android.mcumgr.dfu.suit/SUITUpgradeManager

SUITUpgradeManager

open class SUITUpgradeManager : FirmwareUpgradeController

Constructors

constructor(@NotNull transport: @NotNull McuMgrTransport)

Construct a firmware upgrade manager.

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

Construct a firmware upgrade manager.

Types

OnResourceRequiredCallback

interface OnResourceRequiredCallback

ResourceCallback

interface ResourceCallback

State

enum State

Functions

cancel

open fun cancel()

Cancel the firmware upgrade.

getState

open fun getState(): SUITUpgradeManager.State

Get the current State of the firmware upgrade.

getTransporter

@NotNull

open fun getTransporter(): @NotNull McuMgrTransport

Get the transporter.

isInProgress

open fun isInProgress(): Boolean

Determine whether the firmware upgrade is in progress.

isPaused

open fun isPaused(): Boolean

Determine whether the firmware upgrade is paused.

pause

open fun pause()

Pause the firmware upgrade.

resume

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<SUITUpgradeManager.State>)

Sets the manager callback.

setResourceCallback

open fun setResourceCallback(@Nullable resourceCallback: @Nullable SUITUpgradeManager.OnResourceRequiredCallback)

Set the resource callback used to provide resources requested by the DFU target.

start

open fun start(@NotNull settings: @NotNull FirmwareUpgradeSettings, envelope: @NotNull Array<Byte>)

open fun start(@NotNull settings: @NotNull FirmwareUpgradeSettings, envelope: @NotNull Array<Byte>, @Nullable cacheImages: @Nullable CacheImageSet)

Start the upgrade.