bluetooth/test-client/com.splendo.kaluga.bluetooth.test

Package-level declarations

Types

class AndroidMockCharacteristicWrapper(val uuid: UUID = UUID.randomUUID(), descriptorUUIDs: List<UUID> = emptyList(), val service: RemoteServiceWrapper, val properties: Set<CharacteristicProperty> = emptySet()) : MockCharacteristicWrapper

AndroidMockDescriptorWrapper

class AndroidMockDescriptorWrapper(val uuid: UUID = UUID.randomUUID(), val characteristic: RemoteCharacteristicWrapper) : MockDescriptorWrapper

AppleMockCharacteristicWrapper

class AppleMockCharacteristicWrapper(val uuid: CBUUID = CBUUID(), val properties: Set<CharacteristicProperty> = emptySet(), val service: RemoteServiceWrapper = MockServiceWrapper(), descriptorUUIDs: List<CBUUID> = emptyList()) : MockCharacteristicWrapper

AppleMockDescriptorWrapper

class AppleMockDescriptorWrapper(val uuid: CBUUID = CBUUID(), val characteristic: RemoteCharacteristicWrapper = AppleMockCharacteristicWrapper()) : MockDescriptorWrapper

CharacteristicList

typealias CharacteristicList = ArrayList<ServiceWrapperBuilder.Characteristic>

ConnectedMockClient

class ConnectedMockClient

A mock Bluetooth device that has been connected and had its services discovered, ready to route reads and writes.

ContainsMockValue

interface ContainsMockValue

DescriptorList

typealias DescriptorList = ArrayList<ServiceWrapperBuilder.Descriptor>

IOSMockCharacteristicWrapper

class IOSMockCharacteristicWrapper(val uuid: CBUUID = CBUUID(), val properties: Set<CharacteristicProperty> = emptySet(), val service: RemoteServiceWrapper = MockServiceWrapper(), descriptorUUIDs: List<CBUUID> = emptyList()) : MockCharacteristicWrapper

IOSMockDescriptorWrapper

class IOSMockDescriptorWrapper(val uuid: CBUUID = CBUUID(), val characteristic: RemoteCharacteristicWrapper = IOSMockCharacteristicWrapper()) : MockDescriptorWrapper

MockBluetoothClient

class MockBluetoothClient(val discoveredDevicesFlow: MutableStateFlow<List<ConnectableDevice>> = MutableStateFlow(emptyList()), val filteredDevicesFlow: MutableStateFlow<Map<Filter, List<ConnectableDevice>>> = MutableStateFlow(emptyMap()), val pairedDevicesFlow: MutableStateFlow<Map<Set<UUID>, List<ConnectableDevice>>> = MutableStateFlow(emptyMap()), val isEnabled: MutableStateFlow<Boolean> = MutableStateFlow(true), setupMocks: Boolean = true) : BluetoothClient

MockBluetoothClientBuilder

class MockBluetoothClientBuilder(setupMocks: Boolean = true) : BaseBluetoothClientBuilder

A mock implementation of BaseBluetoothClientBuilder that creates MockBluetoothClients.

MockBluetoothGattWrapper

class MockBluetoothGattWrapper(setupMocks: Boolean = true) : BluetoothGattWrapper

MockBuilderDsl

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS])

@DslMarker

annotation class MockBuilderDsl

MockCBPeripheralWrapper

data class MockCBPeripheralWrapper(val name: String? = null, val identifier: NSUUID = NSUUID()) : DeviceWrapper

MockCharacteristic

class MockCharacteristic(characteristic: RemoteCharacteristicWrapper, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit) : RemoteCharacteristic

Mock implementation of RemoteCharacteristic

MockCharacteristicWrapper

interface MockCharacteristicWrapper : RemoteCharacteristicWrapper, ContainsMockValue

MockDescriptor

class MockDescriptor(descriptorWrapper: RemoteDescriptorWrapper, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit) : RemoteDescriptor

Mock implementation of RemoteDescriptor

MockDescriptorWrapper

interface MockDescriptorWrapper : RemoteDescriptorWrapper, ContainsMockValue

MockDeviceBuilder

class MockDeviceBuilder(context: CoroutineContext)

MockDeviceInfoBuilder

class MockDeviceInfoBuilder

MockDeviceWrapper

class MockDeviceWrapper(val name: String?, val identifier: Identifier, val bondState: DeviceWrapper.BondState, setupMocks: Boolean = true) : DeviceWrapper

MockRemoteServiceWrapper

class MockRemoteServiceWrapper(val uuid: UUID = UUID.randomUUID(), initialCharacteristics: List<ServiceWrapperBuilder.Characteristic> = emptyList()) : RemoteServiceWrapper

MockServiceWrapper

class MockServiceWrapper(val uuid: UUID = UUID(), val type: Service.Type = Service.Type.PRIMARY, val characteristics: List<RemoteCharacteristicWrapper> = emptyList(), val includedServices: List<RemoteServiceWrapper> = emptyList()) : RemoteServiceWrapper

ServiceUUIDsList

typealias ServiceUUIDsList = ArrayList<UUID>

ServiceWrapperBuilder

class ServiceWrapperBuilder

WebMockCharacteristicWrapper

class WebMockCharacteristicWrapper(val uuid: UUID = randomUUID(), val properties: Set<CharacteristicProperty> = emptySet(), val service: RemoteServiceWrapper = WebMockServiceWrapper(), descriptorUUIDs: List<UUID> = emptyList()) : MockCharacteristicWrapper

WebMockDescriptorWrapper

class WebMockDescriptorWrapper(val uuid: UUID = randomUUID(), val characteristic: RemoteCharacteristicWrapper = WebMockCharacteristicWrapper()) : MockDescriptorWrapper

WebMockServiceWrapper

class WebMockServiceWrapper(val uuid: UUID = randomUUID(), initialCharacteristics: List<ServiceWrapperBuilder.Characteristic> = emptyList()) : RemoteServiceWrapper

Functions

build

actual fun ServiceWrapperBuilder.build(): RemoteServiceWrapper

expect fun ServiceWrapperBuilder.build(): RemoteServiceWrapper

actual fun ServiceWrapperBuilder.build(): RemoteServiceWrapper

buildMockDevice

fun buildMockDevice(context: CoroutineContext, builder: MockDeviceBuilder.() -> Unit): MockDevice

Build MockDevice, see MockDeviceBuilder

characteristic

fun CharacteristicList.characteristic(builder: ServiceWrapperBuilder.Characteristic.Builder.() -> Unit): Boolean

connectedMockClient

suspend fun CoroutineScope.connectedMockClient(builder: ServiceWrapperBuilder.() -> Unit): ConnectedMockClient

Connects a mock Bluetooth device exposing the service described by builder, discovers its services, and returns a ConnectedMockClient that keeps the device connected so reads and writes route end-to-end.

createDeviceWrapper

actual fun createDeviceWrapper(deviceName: String?, identifier: Identifier): DeviceWrapper

expect fun createDeviceWrapper(deviceName: String? = null, identifier: Identifier = randomIdentifier()): DeviceWrapper

actual fun createDeviceWrapper(deviceName: String?, identifier: Identifier): DeviceWrapper

createMockDevice

fun createMockDevice(wrapper: DeviceWrapper, coroutineScope: CoroutineScope, connectionSettings: ConnectionSettings = ConnectionSettings( reconnectionSettings = ConnectionSettings.ReconnectionSettings.Never, ), connectionManagerBuilder: MockDeviceConnectionManager.Builder = MockDeviceConnectionManager.Builder(), createDeviceStateFlow: (DeviceConnectionManager, CoroutineContext) -> ConnectableDeviceStateFlowRepo = { manager, coroutineContext -> ConnectableDeviceStateImplRepo(connectionSettings.reconnectionSettings, manager, coroutineContext) }, builder: MockDeviceInfoBuilder.() -> Unit): ConnectableDeviceImpl

fun createMockDevice(identifier: Identifier, connectionSettings: ConnectionSettings = ConnectionSettings( reconnectionSettings = ConnectionSettings.ReconnectionSettings.Never, ), connectionManagerBuilder: (ConnectionSettings) -> DeviceConnectionManager, builder: MockDeviceInfoBuilder.() -> Unit, createDeviceStateFlow: (DeviceConnectionManager, CoroutineContext) -> ConnectableDeviceStateFlowRepo = { manager, coroutineContext -> ConnectableDeviceStateImplRepo(connectionSettings.reconnectionSettings, manager, coroutineContext) }, coroutineScope: CoroutineScope): ConnectableDeviceImpl

createServiceWrapper

fun createServiceWrapper(builder: ServiceWrapperBuilder.() -> Unit): RemoteServiceWrapper

descriptor

fun DescriptorList.descriptor(uuid: UUID): Boolean

randomIdentifier

actual fun randomIdentifier(): Identifier

expect fun randomIdentifier(): Identifier

actual fun randomIdentifier(): Identifier

uuid

fun ServiceUUIDsList.uuid(uuidString: String): Boolean