mcumgr-core/no.nordicsemi.android.mcumgr.response.suit/McuMgrManifestStateResponse

McuMgrManifestStateResponse

open class McuMgrManifestStateResponse : McuMgrResponse

Constructors

McuMgrManifestStateResponse

constructor()

Types

DigestAlgorithm

enum DigestAlgorithm

DowngradePreventionPolicy

enum DowngradePreventionPolicy

IndependentUpdateabilityPolicy

enum IndependentUpdateabilityPolicy

SignatureVerification

enum SignatureVerification

SignatureVerificationPolicy

enum SignatureVerificationPolicy

Properties

open var classId: Array<Byte>

Use getClassId to get the class ID as UUID.

open var digest: Array<Byte>

digestAlgorithm

open var digestAlgorithm: McuMgrManifestStateResponse.DigestAlgorithm

downgradePreventionPolicy

open var downgradePreventionPolicy: McuMgrManifestStateResponse.DowngradePreventionPolicy

groupReturnCode

open var groupReturnCode: HasReturnCode.GroupReturnCode

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

independentUpdateabilityPolicy

open var independentUpdateabilityPolicy: McuMgrManifestStateResponse.IndependentUpdateabilityPolicy

open var rc: Int

The raw return code found in most McuMgr response payloads.

open var role: Int

The manifest role.

semanticVersion

open var semanticVersion: Array<Int>

Use getVersion to get the human-readable version.

open var sequenceNumber: Int

open var signatureCheck: McuMgrManifestStateResponse.SignatureVerification

signatureVerificationPolicy

open var signatureVerificationPolicy: McuMgrManifestStateResponse.SignatureVerificationPolicy

open var vendorId: Array<Byte>

Use getVendorId to get the vendor ID as UUID.

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 getClassId(): UUID

Returns the Manifest class ID.

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.

getKnownClassName

@Nullable

open fun getKnownClassName(): @Nullable String

Returns the name associated with the class ID.

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 getVendorId(): UUID

Returns the Manifest vendor ID.

@Nullable

open fun getVersion(): @Nullable String

Returns human-readable version of the semantic version in format: <major>.<minor>.<patch>[-<type>][.<release_number>], e.g.

open fun isSuccess(): Boolean

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

open fun isVendorNordic(): Boolean

Returns whether the manifest is owned by Nordic Semiconductor.

@NotNull

open fun toString(): @NotNull String

Return the string representation of the response payload.