mcumgr-core/no.nordicsemi.android.mcumgr.dfu.mcuboot.model/ImageSet

ImageSet

Represents a set of images to be sent to the device using teh Image group (manager).

The Image manager can be used to update devices with MCUboot and SUIT bootloaders. For SUIT bootloaders a dedicated SUIT manager should be used, but some devices support both or only Image manager (e.g. for recovery).

Constructors

ImageSet

constructor()

Creates an empty image set.

constructor(@NotNull targets: @NotNull List<TargetImage>)

Creates an image set with given targets.

Properties

cacheImages

@Nullable

@get:Nullable

open val cacheImages: @Nullable List<CacheImage>

Cache images are used to update devices supporting SUIT manifest.

images

@NotNull

@get:NotNull

val images: @NotNull List<TargetImage>

List of target images to be sent to the device.

Functions

add

@NotNull

open fun add(image: Pair<Integer, Array<Byte>>): @NotNull ImageSet

@NotNull

open fun add(image: Array<Byte>): @NotNull ImageSet

@NotNull

open fun add(images: List<Pair<Integer, Array<Byte>>>): @NotNull ImageSet

@NotNull

open fun add(binary: TargetImage): @NotNull ImageSet

@NotNull

open fun add(cacheImage: CacheImage): @NotNull ImageSet

removeImagesWithImageIndex

@NotNull

open fun removeImagesWithImageIndex(imageIndex: Int): @NotNull ImageSet

set

@NotNull

open fun set(cacheImages: List<CacheImage>): @NotNull ImageSet