client-core-mock/no.nordicsemi.kotlin.ble.client.mock/PeripheralSpec

PeripheralSpec

class PeripheralSpec<ID : Any> : MockPeripheral

A specification of a peripheral that can be simulated.

Use PeripheralSpec.simulatePeripheral to create a new peripheral specification.

Parameters

identifier

The peripheral identifier.

addressType

The address type of the peripheral.

initialProximity

The initial proximity of the peripheral.

activePhy

The PHYs (TX and RX) used by the connection the peripheral is initially connected with, or null if the peripheral is not initially connected.

isKnown

Whether the peripheral has been scanned before and its address type is cached. It is not possible to connect to an unknown device without scanning.

isBonded

Whether the phone has the bond information of the peripheral.

peripheralHasBond

Whether the peripheral has the bond information of the phone.

advertisingSets

List of advertisement configurations.

eventHandler

The event handler that will be called for every event emulating a real peripheral.

services

The services available after service discovery.

cachedServices

The services cached on the client side.

isServiceCacheValid

Whether the cached services are valid.

Types

Builder

class Builder<ID : Any>

The builder for the PeripheralSpec.

Companion

object Companion

Properties

addressType

var addressType: AddressType

The address type of the peripheral.

appearance

val appearance: Int?

The appearance of the peripheral, exposed with Appearance characteristic. See Bluetooth Assigned Numbers: link, 2.6 Appearance Values.

bondState

val bondState: StateFlow<MockBondState>

The bond state of the peripheral, as seen by the phone.

connectionParameters

var connectionParameters: ConnectionParameters.Specified?

Current connection parameters.

encryptionState

val encryptionState: StateFlow<MockEncryptionState?>

The encryption of the link with the phone.

events

val events: SharedFlow<GattEvent>

A flow of GATT events emitted by the peripheral.

identifier

var identifier: ID

The peripheral identifier.

isBonded

open override val isBonded: Boolean

Whether the phone has the bond information of the peripheral.

isConnected

open override val isConnected: Boolean

Whether the peripheral is connected.

isKnown

var isKnown: Boolean

Whether the peripheral has been scanned before and its address type is cached.

llMtu

var llMtu: Int?

Current Link Layer MTU.

maxAttMtu

val maxAttMtu: Int?

The maximum supported ATT MTU (ATT layer Maximum Transfer Unit).

maxLlMtu

val maxLlMtu: Int?

The maximum Link Layer MTU (Maximum Transfer Unit used on Link Layer using Data Length Extension (DLE)).

mtu

var mtu: Int?

Current ATT MTU.

name

val name: String?

The name of the peripheral, exposed with Device Name characteristic.

peripheralHasBond

@Volatile

open override var peripheralHasBond: Boolean

Whether the peripheral has the bond information of the phone.

phy

var phy: PhyInUse?

The PHYs currently used by the connection: TX is the PHY used by the central to transmit, and RX is the PHY used to receive. They may differ.

preferredConnectionInterval

val preferredConnectionInterval: IntRange?

The preferred connection interval range.

preferredSlaveLatency

val preferredSlaveLatency: Int?

The preferred slave latency.

preferredSupervisionTimeout

val preferredSupervisionTimeout: Int?

The preferred supervision timeout.

proximity

var proximity: Proximity

The proximity of the peripheral.

supportedPhy

val supportedPhy: Set<Phy>

The set of supported PHYs.

type

val type: PeripheralType

The peripheral type.

Functions

simulateBondRemoval

fun simulateBondRemoval()

Simulates the central removing the bond information associated with the peripheral.

simulateBondRequest

open override fun simulateBondRequest()

Simulates bonding of the phone and the peripheral.

simulateCaching

fun simulateCaching()

Simulates the situation when the device is scanned and advertisement data is received.

simulateConnection

fun simulateConnection(phy: PrimaryPhy = PrimaryPhy.PHY_LE_1M, mtu: Int = maxAttMtu ?: ATT_MTU_DEFAULT)

Simulates the situation when another application on the device tries to connect to the device.

simulateConnectionParametersRequest

open override fun simulateConnectionParametersRequest(parameters: ConnectionParameters.Specified, delay: Int = 6)

Simulates a connection parameters update request from the peripheral.

simulateDisconnection

open override fun simulateDisconnection()

Simulates a situation when the peripheral is gracefully disconnecting from the device.

simulateMacChange

fun simulateMacChange(newIdentifier: ID, addressType: AddressType)

Simulates a change of the peripheral identifier (Device Address).

simulateMtuRequest

open override fun simulateMtuRequest(mtu: Int)

Simulates an MTU request from the peripheral.

simulatePeripheralBondLoss

open override fun simulatePeripheralBondLoss()

Simulates the peripheral forgetting the bond information, for example after a factory reset.

simulateProximityChange

fun simulateProximityChange(proximity: Proximity)

Simulates a change in the proximity of the peripheral.

simulateReset

open override fun simulateReset()

Simulates peripheral reset.

simulateServiceChange

open override fun simulateServiceChange(newServices: MockServerScope.() -> Unit)

Simulates a change in the services offered by the peripheral.

simulateValueUpdate

open override fun simulateValueUpdate(handle: Int, value: ByteArray)

Simulates a characteristic value update on the peripheral.