environment-android-mock/no.nordicsemi.kotlin.ble.environment.android.mock/MockAndroidEnvironment

MockAndroidEnvironment

sealed class MockAndroidEnvironment : AndroidEnvironment, MockEnvironment

A mock environment that can be used to test the behavior of the Central Manager.

Inheritors

Types

Api21

class Api21(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, isMultipleAdvertisementSupported: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER, issueOnlyOneActiveScan: Boolean = false) : MockAndroidEnvironment

A mock environment for Android 5.0 (Lollipop).

Api23

class Api23(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, isMultipleAdvertisementSupported: Boolean = true, isLocationPermissionGranted: Boolean = true, isLocationEnabled: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER, issueOnlyOneActiveScan: Boolean = false, issueIncorrectL2capTxMtu: Boolean = false) : MockAndroidEnvironment

A mock environment for Android 6.0 (Marshmallow).

Api26

class Api26(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, isMultipleAdvertisementSupported: Boolean = true, isLeExtendedAdvertisingSupported: Boolean = true, isLePeriodicAdvertisingSupported: Boolean = isLeExtendedAdvertisingSupported, leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int = if (isLeExtendedAdvertisingSupported) 1650 else 31, isLe2MPhySupported: Boolean = true, isLeCodedPhySupported: Boolean = true, isScanningOnLeCodedPhySupported: Boolean = isLeCodedPhySupported, isLocationPermissionGranted: Boolean = true, isLocationEnabled: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER, issueOnlyOneActiveScan: Boolean = false, issueIncorrectL2capTxMtu: Boolean = false) : MockAndroidEnvironment

A mock environment for Android 8.0 (Oreo).

Api31

class Api31(deviceName: String = DEFAULT_NAME, isBluetoothSupported: Boolean = true, isBluetoothEnabled: Boolean = true, isMultipleAdvertisementSupported: Boolean = true, isLeExtendedAdvertisingSupported: Boolean = true, isLePeriodicAdvertisingSupported: Boolean = isLeExtendedAdvertisingSupported, leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int = if (isLeExtendedAdvertisingSupported) 1650 else 31, isLe2MPhySupported: Boolean = true, isLeCodedPhySupported: Boolean = true, isScanningOnLeCodedPhySupported: Boolean = isLeCodedPhySupported, isBluetoothScanPermissionGranted: Boolean = true, isBluetoothConnectPermissionGranted: Boolean = true, isBluetoothAdvertisePermissionGranted: Boolean = true, isNeverForLocationFlagSet: Boolean = true, isLocationPermissionGranted: Boolean = true, isLocationEnabled: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER, issueOnlyOneActiveScan: Boolean = false, issueIncorrectL2capTxMtu: Boolean = false) : MockAndroidEnvironment

A mock environment for Android 12 (S).

Nexus4

class Nexus4(deviceName: String = "Nexus 4", isBluetoothEnabled: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockAndroidEnvironment

A mock environment for the Nexus 4.

SamsungA8

class SamsungA8(deviceName: String = "Samsung A8", isBluetoothEnabled: Boolean = true, isBluetoothScanPermissionGranted: Boolean = true, isBluetoothConnectPermissionGranted: Boolean = true, isBluetoothAdvertisePermissionGranted: Boolean = true, isNeverForLocationFlagSet: Boolean = true, isLocationPermissionGranted: Boolean = true, isLocationEnabled: Boolean = true, advertiser: MockAdvertiser = DEFAULT_MOCK_ADVERTISER, scanner: MockScanner = DEFAULT_MOCK_SCANNER) : MockAndroidEnvironment

A mock environment for the Samsung A8 with Android 14.

Properties

advertiser

val advertiser: MockAdvertiser

A callback that will be called when the app requests to advertise. The callback should return the TX power level used for mock advertising.

androidSdkVersion

open override val androidSdkVersion: Int

bluetoothState

open override val bluetoothState: StateFlow<Manager.State>

deviceName

open override var deviceName: String

deviceNameOrNull

open val deviceNameOrNull: String?

isBluetoothAdvertisePermissionGranted

open override var isBluetoothAdvertisePermissionGranted: Boolean

Whether the BLUETOOTH_ADVERTISE permission is granted. The permission can be set to true to emulate it being granted in runtime.

isBluetoothConnectPermissionGranted

open override var isBluetoothConnectPermissionGranted: Boolean

Whether the BLUETOOTH_CONNECT permission is granted. The permission can be set to true to emulate it being granted in runtime.

isBluetoothEnabled

open override val isBluetoothEnabled: Boolean

isBluetoothScanPermissionGranted

open override var isBluetoothScanPermissionGranted: Boolean

Whether the BLUETOOTH_SCAN permission is granted. The permission can be set to true to emulate it being granted in runtime.

isBluetoothSupported

open override val isBluetoothSupported: Boolean

isLe2MPhySupported

open override val isLe2MPhySupported: Boolean

isLeCodedPhySupported

open override val isLeCodedPhySupported: Boolean

isLeExtendedAdvertisingSupported

open override val isLeExtendedAdvertisingSupported: Boolean

isLePeriodicAdvertisingSupported

open override val isLePeriodicAdvertisingSupported: Boolean

isLocationEnabled

open val isLocationEnabled: Boolean

isLocationPermissionGranted

open override var isLocationPermissionGranted: Boolean

Whether the fine location permission is granted. The permission can be set to true to emulate it being granted in runtime.

isLocationRequiredForScanning

open override val isLocationRequiredForScanning: Boolean

isMultipleAdvertisementSupported

open override val isMultipleAdvertisementSupported: Boolean

isScanningOnLeCodedPhySupported

val isScanningOnLeCodedPhySupported: Boolean

Whether the device can scan for Bluetooth LE devices advertising on LE Coded PHY as Primary PHY.

issueIncorrectL2capTxMtu

val issueIncorrectL2capTxMtu: Boolean

Some Android devices claim they can only transmit 27-byte long packets on L2CAP in the LLCP Data Length Update procedure, while later trying to send 251 bytes. This causes the peripheral to terminate the connection. This flag simulates this issue. It was encountered e.g. on Samsung A8 and Samsung A8 Tab.

issueOnlyOneActiveScan

val issueOnlyOneActiveScan: Boolean

Some early Android devices were sending only one Scan Request message for a single device per scan. Non-connectable devices were reported continuously, but connectable devices were reported only once. The client had to stop and start scanning again to receive further advertisements. This flag simulates this issue. It was encountered e.g. on Nexus 4.

leMaximumAdvertisingDataLength

open override val leMaximumAdvertisingDataLength: @Range(from = 31, to = 1650) Int

locationState

open override val locationState: StateFlow<Boolean>

reportsConnectionParameters

open override var reportsConnectionParameters: Boolean

requiresBluetoothRuntimePermissions

open val requiresBluetoothRuntimePermissions: Boolean

scanner

val scanner: MockScanner

A callback that will be called when the mock central manager requests to scan for devices. It returns whether the scan was successful, secretly failed, or returned an error.

supportsRuntimePermissions

open val supportsRuntimePermissions: Boolean

Functions

open override fun close()

enableBluetooth

open override fun enableBluetooth()

simulateLocationState

fun simulateLocationState(newState: Boolean)

Simulates turning on/off location service on the mock device.

simulatePowerOff

fun simulatePowerOff()

Simulates turning off Bluetooth adapter on the mock device.

simulatePowerOn

fun simulatePowerOn()

Simulates turning on Bluetooth adapter on the mock device.