mcumgr-core/no.nordicsemi.android.mcumgr.managers/ShellManager

ShellManager

open class ShellManager : McuManager

Constructors

ShellManager

constructor(@NotNull transporter: @NotNull McuMgrTransport)

Construct a shell manager instance.

Types

Response

interface Response : HasReturnCode

ReturnCode

enum ReturnCode : McuMgrGroupReturnCode

Functions

buildPacket

open fun buildPacket(@NotNull scheme: @NotNull McuMgrScheme, op: Int, flags: Int, groupId: Int, sequenceNum: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>): @NotNull Array<Byte>

Build a Mcu Manager packet based on the transport scheme.

dateToString

@NotNull

open fun dateToString(@Nullable date: @Nullable Date, @Nullable timeZone: @Nullable TimeZone): @NotNull String

Format a Date and a TimeZone into a String which McuManager will accept.

exec

@NotNull

open fun exec(@NotNull cmd: @NotNull String, @Nullable argv: Array<@Nullable String>): @NotNull McuMgrExecResponse

@NotNull

open fun exec(@NotNull cmd: @NotNull String, @Nullable argv: Array<@Nullable String>, timeout: Long): @NotNull McuMgrExecResponse

The command allows to execute command line in a similar way to typing it into a shell, but both a request and a response are transported with use of SMP (synchronous).

open fun exec(@NotNull cmd: @NotNull String, @Nullable argv: Array<@Nullable String>, @NotNull callback: @NotNull McuMgrCallback<McuMgrExecResponse>)

open fun exec(@NotNull cmd: @NotNull String, @Nullable argv: Array<@Nullable String>, timeout: Long, @NotNull callback: @NotNull McuMgrCallback<McuMgrExecResponse>)

The command allows to execute command line in a similar way to typing it into a shell, but both a request and a response are transported with use of SMP (asynchronous).

getGroupId

open fun getGroupId(): Int

Get the group ID for this manager.

getMtu

open fun getMtu(): Int

Returns the upload MTU.

getScheme

@NotNull

open fun getScheme(): @NotNull McuMgrScheme

Get the transporter's scheme.

getTransporter

@NotNull

open fun getTransporter(): @NotNull McuMgrTransport

Get the transporter.

send

@NotNull

open fun <T : McuMgrResponse?> ~~send~~(data: @NotNull Array<Byte>, @NotNull respType: @NotNull Class<T>): @NotNull T

@NotNull

open fun <T : McuMgrResponse?> send(data: @NotNull Array<Byte>, timeout: Long, @NotNull respType: @NotNull Class<T>): @NotNull T

Send data synchronously using the transporter.

open fun <T : McuMgrResponse?> ~~send~~(data: @NotNull Array<Byte>, @NotNull respType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

open fun <T : McuMgrResponse?> send(data: @NotNull Array<Byte>, timeout: Long, @NotNull respType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

Send data asynchronously using the transporter.

@NotNull

open fun <T : McuMgrResponse?> ~~send~~(op: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, @NotNull respType: @NotNull Class<T>): @NotNull T

@NotNull

open fun <T : McuMgrResponse?> send(op: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, timeout: Long, @NotNull respType: @NotNull Class<T>): @NotNull T

@NotNull

open fun <T : McuMgrResponse?> ~~send~~(op: Int, flags: Int, sequenceNum: Int, commandId: Int, @NotNull respType: @NotNull Class<T>, @Nullable payloadMap: @Nullable Map<String, Any>): @NotNull T

@NotNull

open fun <T : McuMgrResponse?> send(op: Int, flags: Int, sequenceNum: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, timeout: Long, @NotNull respType: @NotNull Class<T>): @NotNull T

Send synchronous Mcu Manager command.

open fun <T : McuMgrResponse?> ~~send~~(op: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, @NotNull respType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

open fun <T : McuMgrResponse?> send(op: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, timeout: Long, @NotNull respType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

open fun <T : McuMgrResponse?> ~~send~~(op: Int, flags: Int, sequenceNum: Int, commandId: Int, @Nullable payloadMap: @Nullable Map<String, Any>, @NotNull respType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

Send an asynchronous Mcu Manager command.

setUploadMtu

open fun setUploadMtu(mtu: Int): Boolean

Sets the upload MTU.

stringToDate

@Nullable

open fun stringToDate(@Nullable dateString: @Nullable String): @Nullable Date

Parse a date string returned by a McuMgr response.