mcumgr-core/no.nordicsemi.android.mcumgr/McuMgrTransport

McuMgrTransport

An McuMgrTransport is tasked with sending requests to, and receiving responses from a device. Transport implementations should conform to one of the McuMgrSchemes. Furthermore, the McuManager does not maintain the state of the transporter, and so the transport must set-up and tear-down connections on its own accord.

Types

ConnectionCallback

interface ConnectionCallback

Receives callbacks from an explicit call to connect.

ConnectionObserver

interface ConnectionObserver

Receives connection state changes independent of explicit calls to connect or release.

ModeChangeCallback

interface ModeChangeCallback

Receives callbacks from an explicit call to changeMode.

Functions

addObserver

abstract fun addObserver(@NotNull observer: @NotNull McuMgrTransport.ConnectionObserver)

Adds the connection observer.

changeMode

abstract fun changeMode(@NotNull name: @NotNull String, @Nullable callback: @Nullable McuMgrTransport.ModeChangeCallback): Boolean

Changes the transport mode.

connect

abstract fun connect(@Nullable callback: @Nullable McuMgrTransport.ConnectionCallback)

Connect the transporter to the remote device.

getScheme

@NotNull

abstract fun getScheme(): @NotNull McuMgrScheme

Gets the scheme for this transport (see McuMgrScheme).

release

abstract fun release()

Releases the transport connection.

removeObserver

abstract fun removeObserver(@NotNull observer: @NotNull McuMgrTransport.ConnectionObserver)

Removes previously registered observer.

send

@NotNull

abstract fun <T : McuMgrResponse?> send(payload: @NotNull Array<Byte>, timeout: Long, @NotNull responseType: @NotNull Class<T>): @NotNull T

Send a synchronous Mcu Manager request.

abstract fun <T : McuMgrResponse?> send(payload: @NotNull Array<Byte>, timeout: Long, @NotNull responseType: @NotNull Class<T>, @NotNull callback: @NotNull McuMgrCallback<T>)

Send an asynchronous Mcu Manager request.