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

start

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

Start the upgrade.

The specified image file will be sent to the target using the given transport, then depending on the mode, verified using "test" command or confirmed using "confirm" command. If successful, the reset command will be sent. The device should boot with the new firmware. The manager will try to connect to the SMP server on the new firmware and confirm the new images if they were not confirmed before, or they didn't confirm automatically.

This method should be used for SUIT files.

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

Starts an upgrade with given image set. The targets define the image index and slot to which the binary should be sent.

This method can be used for multi-core devices (each core is identified by imageIndex) with and without Direct XIP feature.

Direct XIP is a feature added in NCS 2.5 allowing to boot a device from a non-primary slot. For such devices the correct image has to be sent (compiled for that specific slot), depending on the slot number with the active image. This feature removes the need for a swap after an update, as the newly uploaded image is already in the correct slot.

Since

1.8

Parameters

images

set of images. For direct XIP this set should contain images compiled for both slots. The correct image will be chosen automatically.

settings

settings applied to the upgrade process.