mcumgr-ble/no.nordicsemi.android.mcumgr.ble/McuMgrBleTransport

McuMgrBleTransport

open class McuMgrBleTransport : BleManager, McuMgrTransport

The McuMgrBleTransport is an implementation for the BLE transport scheme. This class extends BleManager, which handles the BLE state machine and owns the BluetoothGatt object that executes BLE actions.

Starting from version 1.1 it is possible to extend the functionality to support additional services. For that extend the following methods:

Constructors

McuMgrBleTransport

constructor(@NonNull context: Context, @NonNull device: BluetoothDevice)

Construct a McuMgrBleTransport object.

constructor(@NonNull context: Context, @NonNull device: BluetoothDevice, @NonNull handler: Handler)

Construct a McuMgrBleTransport object with a handler to run the BleManager and asynchronous callbacks.

constructor(@NonNull context: Context, @NonNull device: BluetoothDevice, @NonNull handler: Handler, @NonNull uuidConfig: UuidConfig)

Construct a McuMgrBleTransport object with a handler to run the BleManager and asynchronous callbacks.

Properties

bondingObserver

open var bondingObserver: BondingObserver

connectionObserver

open var connectionObserver: ConnectionObserver

PAIRING_VARIANT_CONSENT

val PAIRING_VARIANT_CONSENT: Int = 3

PAIRING_VARIANT_DISPLAY_PASSKEY

val PAIRING_VARIANT_DISPLAY_PASSKEY: Int = 4

PAIRING_VARIANT_DISPLAY_PIN

val PAIRING_VARIANT_DISPLAY_PIN: Int = 5

PAIRING_VARIANT_OOB_CONSENT

val PAIRING_VARIANT_OOB_CONSENT: Int = 6

PAIRING_VARIANT_PASSKEY

val PAIRING_VARIANT_PASSKEY: Int = 1

PAIRING_VARIANT_PASSKEY_CONFIRMATION

val PAIRING_VARIANT_PASSKEY_CONFIRMATION: Int = 2

PAIRING_VARIANT_PIN

val PAIRING_VARIANT_PIN: Int = 0

SMP_SERVICE_UUID

val ~~SMP_SERVICE_UUID~~: UUID

The SMP service UUID.

Functions

addObserver

open fun addObserver(@NonNull observer: McuMgrTransport.ConnectionObserver)

attachClientConnection

open fun attachClientConnection(client: BluetoothDevice)

changeMode

open fun changeMode(@NonNull name: String, @Nullable callback: McuMgrTransport.ModeChangeCallback): Boolean

open fun close()

connect

fun connect(device: BluetoothDevice): ConnectRequest

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

disconnect

fun disconnect(): DisconnectRequest

getBatteryValue

fun getBatteryValue(): Int

getBluetoothDevice

@NonNull

open fun getBluetoothDevice(): BluetoothDevice

Returns the device set in the constructor.

getConnectionState

fun getConnectionState(): Int

getMaxPacketLength

fun getMaxPacketLength(): Int

Returns the maximum length of a SMP packet that can be transmitted over by the transport.

getMinLogPriority

open fun getMinLogPriority(): Int

getScheme

@NonNull

open fun getScheme(): McuMgrScheme

isConnected

fun isConnected(): Boolean

isReady

fun isReady(): Boolean

log

open fun log(priority: Int, @NonNull message: String)

release

open fun release()

removeObserver

open fun removeObserver(@NonNull observer: McuMgrTransport.ConnectionObserver)

requestConnPriority

open fun requestConnPriority(priority: Int)

Requests the given connection priority.

send

@NonNull

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

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

setDeviceSidePacketMergingSupported

open fun ~~setDeviceSidePacketMergingSupported~~(maxLength: Int)

Sets the maximum packet length for the transport.

setGattCallbacks

open fun setGattCallbacks(callbacks: BleManagerCallbacks)

setInitialMtu

open fun setInitialMtu(@IntRange(from = 23, to = 517) mtu: Int)

Sets the initial MTU size to be requested upon connection.

setLoggingEnabled

open fun setLoggingEnabled(enabled: Boolean)

Allows to enable low-level logging.

setMaxPacketLength

fun setMaxPacketLength(maxLength: Int)

In order to send packets longer than MTU size, this library supports automatic segmentation of packets into at-most-MTU size chunks.

useServer

fun useServer(server: BleServerManager)