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

PeripheralSpec

class PeripheralSpec<ID>

A specification of a peripheral that can be simulated.

Use PeripheralSpec.simulatePeripheral to create a new peripheral specification.

Types

Builder

class Builder<ID>

The builder for the PeripheralSpec.

Companion

object Companion

Properties

val advertisement: List<MockAdvertisementConfig>?

List of advertisement configurations.

connectionInterval

val connectionInterval: Duration?

The connection interval when connected.

eventHandler

val eventHandler: PeripheralSpecEventHandler?

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

identifier

var identifier: ID

The peripheral identifier.

isBonded

var isBonded: Boolean

Whether the peripheral is bonded.

isConnected

var isConnected: Boolean

Whether the peripheral is connected.

isKnown

var isKnown: Boolean

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.

maxMtu

val maxMtu: Int?

The maximum supported MTU size.

name

val name: String?

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

proximity

var proximity: Proximity

The proximity of the peripheral.

services

val services: List<ServiceDefinition>?

The services available after service discovery.

supportedPhy

val supportedPhy: Set<Phy>

The set of supported PHYs.

type

val type: PeripheralType

The peripheral type.

Functions

simulateCaching

fun simulateCaching()

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

simulateConnection

fun simulateConnection()

Simulates the situation when another application on the device connects to the device.

simulateDisconnection

fun simulateDisconnection(reason: DisconnectionReason)

Simulates peripheral disconnection from the device.

simulateMacChange

fun simulateMacChange(newIdentifier: ID)

simulateProximityChange

fun simulateProximityChange(proximity: Proximity)

Simulates a change in the proximity of the peripheral.

simulateReset

fun simulateReset()