mcumgr-core/no.nordicsemi.android.mcumgr.response.dflt/McuMgrBootloaderInfoResponse

McuMgrBootloaderInfoResponse

open class McuMgrBootloaderInfoResponse : McuMgrOsResponse

Constructors

McuMgrBootloaderInfoResponse

constructor()

Properties

open var activeB0Slot: Int

The id of the active B0 slot.

open var bootloader: String

groupReturnCode

open var groupReturnCode: HasReturnCode.GroupReturnCode

Since version 2 of the SMP protocol, a more detailed return code is returned in the response.

open var mode: Int

Text response including requested parameters.

MODE_DIRECT_XIP

val MODE_DIRECT_XIP: Int = 4

MCUboot is in DirectXIP without revert mode.

MODE_DIRECT_XIP_WITH_REVERT

val MODE_DIRECT_XIP_WITH_REVERT: Int = 5

MCUboot is in DirectXIP with revert mode.

MODE_FIRMWARE_LOADER

val MODE_FIRMWARE_LOADER: Int = 7

MCUboot is in Firmware Loader mode.

MODE_OVERWRITE_ONLY

val MODE_OVERWRITE_ONLY: Int = 2

MCUboot is in overwrite (upgrade-only) mode.

MODE_RAM_LOADER

val MODE_RAM_LOADER: Int = 6

MCUboot is in RAM loader mode.

MODE_SINGLE_APP

val MODE_SINGLE_APP: Int = 0

MCUboot is in single application mode.

MODE_SWAP_SCRATCH

val MODE_SWAP_SCRATCH: Int = 1

MCUboot is in swap using scratch partition mode.

MODE_SWAP_WITHOUT_SCRATCH

val MODE_SWAP_WITHOUT_SCRATCH: Int = 3

MCUboot is in swap without scratch mode.

val MODE_UNKNOWN: Int = -1

Unknown mode of MCUboot.

open var noDowngrade: Boolean

The "no-downgrade" is a flag, indicating that mode has downgrade prevention enabled; downgrade prevention means that if uploaded image has lower version than running, it will not be taken for execution by MCUboot.

open var rc: Int

The raw return code found in most McuMgr response payloads.

val UNKNOWN_SLOT: Int = -1

The active slot number is unknown.

Functions

buildCoapResponse

@NotNull

open fun <T : McuMgrResponse?> buildCoapResponse(@NotNull scheme: @NotNull McuMgrScheme, bytes: @NotNull Array<Byte>, header: @NotNull Array<Byte>, payload: @NotNull Array<Byte>, codeClass: Int, codeDetail: Int, type: Class<T>): @NotNull T

Build a CoAP McuMgrResponse.

@NotNull

open fun <T : McuMgrResponse?> buildResponse(@NotNull scheme: @NotNull McuMgrScheme, bytes: @NotNull Array<Byte>, @NotNull type: @NotNull Class<T>): @NotNull T

Build a McuMgrResponse.

open fun getBytes(): Array<Byte>

Get the response bytes.

open fun getCoapCode(): Int

If this response is from a CoAP transport scheme, get the CoAP response code.

getExpectedLength

open fun getExpectedLength(@NotNull scheme: @NotNull McuMgrScheme, bytes: @NotNull Array<Byte>): Int

This method parses the given bytes and reads the LENGTH field from the header.

getGroupReturnCode

open fun getGroupReturnCode(): HasReturnCode.GroupReturnCode

Return the Group return code as Group - Return Code pair.

@Nullable

open fun getHeader(): @Nullable McuMgrHeader

Get the McuMgrHeader for this response.

getOsReturnCode

@Nullable

open fun getOsReturnCode(): @Nullable DefaultManager.ReturnCode

open fun getPayload(): @Nullable Array<Byte>

Get the response payload bytes.

open fun getReturnCode(): McuMgrErrorCode

Get the return code as an enum.

getReturnCodeValue

open fun getReturnCodeValue(): Int

Return the Mcu Manager return code as an int.

open fun getScheme(): McuMgrScheme

Get the scheme used to initialize this response object.

open fun isSuccess(): Boolean

Returns true if the response payload contains a return code of 0 or no return code.

@NotNull

open fun toString(): @NotNull String

Return the string representation of the response payload.