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

McuMgrOsResponse

open class McuMgrOsResponse : McuMgrResponse, DefaultManager.Response

Inheritors

McuMgrReadDateTimeResponse

McuMgrBootloaderInfoResponse

McuMgrEchoResponse

McuMgrAppInfoResponse

McuMgrTaskStatResponse

McuMgrMpStatResponse

McuMgrParamsResponse

Constructors

McuMgrOsResponse

constructor()

Properties

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 rc: Int

The raw return code found in most McuMgr response payloads.

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.