mock/no.nordicsemi.android.kotlin.ble.mock/MockEngine

MockEngine

An object responsible for connecting client with mocked servers. Each server can be started by setting MockServerDevice parameter. If so then instead of calling BLE API it will be communicating with client using MockEngine. All communication will happen locally, but API the server and client side will be using is the same as for BLE calls.

Generally this is a proxy object. It catches requests emitted by GattClientAPI and emits them as an ServerGattEvent on a server side. The server responds to those events using GattServerAPI which are mapped here to ClientGattEvent and send back to client.

Using this solution may be helpful for testing BLE communication before getting real BLE device or for local junit tests.

Functions

abortReliableWrite

fun abortReliableWrite(serverDevice: MockServerDevice, clientDevice: ClientDevice)

advertiseServer

fun advertiseServer(device: MockServerDevice, config: BleAdvertisingConfig)

beginReliableWrite

fun beginReliableWrite(serverDevice: MockServerDevice, clientDevice: ClientDevice): Boolean

cancelConnection

fun cancelConnection(serverDevice: MockServerDevice, clientDevice: ClientDevice)

clearServiceCache

fun clearServiceCache(serverDevice: MockServerDevice, clientDevice: ClientDevice)

fun close(serverDevice: MockServerDevice, clientDevice: ClientDevice)

connect

fun connect(device: ClientDevice): Boolean

connectToServer

fun connectToServer(serverDevice: MockServerDevice, clientDevice: MockClientDevice, client: GattClientAPI, options: BleGattConnectOptions)

disableCharacteristicNotification

fun disableCharacteristicNotification(clientDevice: ClientDevice, device: MockServerDevice, characteristic: IBluetoothGattCharacteristic): Boolean

discoverServices

fun discoverServices(clientDevice: ClientDevice, device: MockServerDevice): Boolean

enableCharacteristicNotification

fun enableCharacteristicNotification(clientDevice: ClientDevice, device: MockServerDevice, characteristic: IBluetoothGattCharacteristic): Boolean

executeReliableWrite

fun executeReliableWrite(serverDevice: MockServerDevice, clientDevice: ClientDevice): Boolean

notifyCharacteristicChanged

fun notifyCharacteristicChanged(device: ClientDevice, characteristic: IBluetoothGattCharacteristic, confirm: Boolean, value: DataByteArray)

readCharacteristic

fun readCharacteristic(device: MockServerDevice, clientDevice: ClientDevice, characteristic: IBluetoothGattCharacteristic): Boolean

readDescriptor

fun readDescriptor(device: MockServerDevice, clientDevice: ClientDevice, descriptor: IBluetoothGattDescriptor): Boolean

readPhy

fun readPhy(device: ClientDevice)

fun readPhy(clientDevice: ClientDevice, device: MockServerDevice)

readRemoteRssi

fun readRemoteRssi(clientDevice: ClientDevice, device: MockServerDevice): Boolean

registerServer

fun registerServer(server: GattServerAPI, device: MockServerDevice, services: List<IBluetoothGattService>)

requestConnectionPriority

fun requestConnectionPriority(clientDevice: ClientDevice, priority: BleGattConnectionPriority): Boolean

requestMtu

fun requestMtu(clientDevice: ClientDevice, serverDevice: MockServerDevice, mtu: Int): Boolean

requestPhy

fun requestPhy(device: ClientDevice, txPhy: BleGattPhy, rxPhy: BleGattPhy, phyOption: PhyOption)

sendResponse

fun sendResponse(device: ClientDevice, requestId: Int, status: Int, offset: Int, value: DataByteArray?)

setPreferredPhy

fun setPreferredPhy(clientDevice: ClientDevice, serverDevice: MockServerDevice, txPhy: BleGattPhy, rxPhy: BleGattPhy, phyOption: PhyOption)

stopAdvertising

fun stopAdvertising(device: MockServerDevice)

unregisterServer

fun unregisterServer(device: MockServerDevice)

writeCharacteristic

fun writeCharacteristic(serverDevice: ServerDevice, clientDevice: ClientDevice, characteristic: IBluetoothGattCharacteristic, value: DataByteArray, writeType: BleWriteType): Boolean

writeDescriptor

fun writeDescriptor(device: MockServerDevice, clientDevice: ClientDevice, descriptor: IBluetoothGattDescriptor, value: DataByteArray): Boolean