data class CharacteristicProperties(val broadcast: Boolean? = null, val read: Boolean? = null, val writeWithoutResponse: Boolean? = null, val write: Boolean? = null, val notify: Boolean? = null, val indicate: Boolean? = null, val authenticatedSignedWrites: Boolean? = null, val extendedProperties: Boolean? = null)

Describes the properties of a characteristic. This follows Bluetooth Core Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.

CharacteristicWriteType

@Serializable

enum CharacteristicWriteType : Enum<BluetoothEmulation.CharacteristicWriteType>

Indicates the various types of characteristic write.

DescriptorOperationReceivedParameter

@Serializable

data class DescriptorOperationReceivedParameter(val descriptorId: String, val type: BluetoothEmulation.DescriptorOperationType, val data: String? = null)

DescriptorOperationType

@Serializable

enum DescriptorOperationType : Enum<BluetoothEmulation.DescriptorOperationType>

Indicates the various types of descriptor operation.

EnableParameter

@Serializable

data class EnableParameter(val state: BluetoothEmulation.CentralState, val leSupported: Boolean)

GattOperationReceivedParameter

@Serializable

data class GattOperationReceivedParameter(val address: String, val type: BluetoothEmulation.GATTOperationType)

Event for when a GATT operation of |type| to the peripheral with |address| happened.

GATTOperationType

@Serializable

enum GATTOperationType : Enum<BluetoothEmulation.GATTOperationType>

Indicates the various types of GATT event.

ManufacturerData

@Serializable

data class ManufacturerData(val key: Int, val data: String)

Stores the manufacturer data

RemoveCharacteristicParameter

@Serializable

data class RemoveCharacteristicParameter(val characteristicId: String)

RemoveDescriptorParameter

@Serializable

data class RemoveDescriptorParameter(val descriptorId: String)

RemoveServiceParameter

@Serializable

data class RemoveServiceParameter(val serviceId: String)

ScanEntry

@Serializable

data class ScanEntry(val deviceAddress: String, val rssi: Int, val scanRecord: BluetoothEmulation.ScanRecord)

Stores the advertisement packet information that is sent by a Bluetooth device.

ScanRecord

@Serializable

data class ScanRecord(val name: String? = null, val uuids: List<String>? = null, val appearance: Int? = null, val txPower: Int? = null, val manufacturerData: List<BluetoothEmulation.ManufacturerData>? = null)

Stores the byte data of the advertisement packet sent by a Bluetooth device.

SetSimulatedCentralStateParameter

@Serializable

data class SetSimulatedCentralStateParameter(val state: BluetoothEmulation.CentralState)

SimulateAdvertisementParameter

@Serializable

data class SimulateAdvertisementParameter(val entry: BluetoothEmulation.ScanEntry)

SimulateCharacteristicOperationResponseParameter

@Serializable

data class SimulateCharacteristicOperationResponseParameter(val characteristicId: String, val type: BluetoothEmulation.CharacteristicOperationType, val code: Int, val data: String? = null)

SimulateDescriptorOperationResponseParameter

@Serializable

data class SimulateDescriptorOperationResponseParameter(val descriptorId: String, val type: BluetoothEmulation.DescriptorOperationType, val code: Int, val data: String? = null)

SimulateGATTDisconnectionParameter

@Serializable

data class SimulateGATTDisconnectionParameter(val address: String)

SimulateGATTOperationResponseParameter

@Serializable

data class SimulateGATTOperationResponseParameter(val address: String, val type: BluetoothEmulation.GATTOperationType, val code: Int)

SimulatePreconnectedPeripheralParameter

@Serializable

data class SimulatePreconnectedPeripheralParameter(val address: String, val name: String, val manufacturerData: List<BluetoothEmulation.ManufacturerData>, val knownServiceUuids: List<String>)

Properties

characteristicOperationReceived

val characteristicOperationReceived: Flow<BluetoothEmulation.CharacteristicOperationReceivedParameter>

descriptorOperationReceived

val descriptorOperationReceived: Flow<BluetoothEmulation.DescriptorOperationReceivedParameter>

gattOperationReceived

val gattOperationReceived: Flow<BluetoothEmulation.GattOperationReceivedParameter>

Event for when a GATT operation of |type| to the peripheral with |address| happened.

Functions

addCharacteristic

suspend fun addCharacteristic(args: BluetoothEmulation.AddCharacteristicParameter, mode: CommandMode = CommandMode.DEFAULT): BluetoothEmulation.AddCharacteristicReturn

suspend fun addCharacteristic(serviceId: String, characteristicUuid: String, properties: BluetoothEmulation.CharacteristicProperties): BluetoothEmulation.AddCharacteristicReturn

addDescriptor

suspend fun addDescriptor(args: BluetoothEmulation.AddDescriptorParameter, mode: CommandMode = CommandMode.DEFAULT): BluetoothEmulation.AddDescriptorReturn

suspend fun addDescriptor(characteristicId: String, descriptorUuid: String): BluetoothEmulation.AddDescriptorReturn

Adds a descriptor with |descriptorUuid| to the characteristic respresented by |characteristicId|.

addService

suspend fun addService(args: BluetoothEmulation.AddServiceParameter, mode: CommandMode = CommandMode.DEFAULT): BluetoothEmulation.AddServiceReturn

suspend fun addService(address: String, serviceUuid: String): BluetoothEmulation.AddServiceReturn

Adds a service with |serviceUuid| to the peripheral with |address|.

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disable the BluetoothEmulation domain.

enable

suspend fun enable(state: BluetoothEmulation.CentralState, leSupported: Boolean)

suspend fun enable(args: BluetoothEmulation.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

Enable the BluetoothEmulation domain.

removeCharacteristic

suspend fun removeCharacteristic(characteristicId: String)

suspend fun removeCharacteristic(args: BluetoothEmulation.RemoveCharacteristicParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes the characteristic respresented by |characteristicId| from the simulated central.

removeDescriptor

suspend fun removeDescriptor(descriptorId: String)

suspend fun removeDescriptor(args: BluetoothEmulation.RemoveDescriptorParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes the descriptor with |descriptorId| from the simulated central.

removeService

suspend fun removeService(serviceId: String)

suspend fun removeService(args: BluetoothEmulation.RemoveServiceParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes the service respresented by |serviceId| from the simulated central.

setSimulatedCentralState

suspend fun setSimulatedCentralState(state: BluetoothEmulation.CentralState)

suspend fun setSimulatedCentralState(args: BluetoothEmulation.SetSimulatedCentralStateParameter, mode: CommandMode = CommandMode.DEFAULT)

Set the state of the simulated central.

simulateAdvertisement

suspend fun simulateAdvertisement(entry: BluetoothEmulation.ScanEntry)

suspend fun simulateAdvertisement(args: BluetoothEmulation.SimulateAdvertisementParameter, mode: CommandMode = CommandMode.DEFAULT)

Simulates an advertisement packet described in |entry| being received by the central.

simulateCharacteristicOperationResponse

suspend fun simulateCharacteristicOperationResponse(args: BluetoothEmulation.SimulateCharacteristicOperationResponseParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun simulateCharacteristicOperationResponse(characteristicId: String, type: BluetoothEmulation.CharacteristicOperationType, code: Int, data: String? = null)

simulateDescriptorOperationResponse

suspend fun simulateDescriptorOperationResponse(args: BluetoothEmulation.SimulateDescriptorOperationResponseParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun simulateDescriptorOperationResponse(descriptorId: String, type: BluetoothEmulation.DescriptorOperationType, code: Int, data: String? = null)

simulateGATTDisconnection

suspend fun simulateGATTDisconnection(address: String)

suspend fun simulateGATTDisconnection(args: BluetoothEmulation.SimulateGATTDisconnectionParameter, mode: CommandMode = CommandMode.DEFAULT)

Simulates a GATT disconnection from the peripheral with |address|.

simulateGATTOperationResponse

suspend fun simulateGATTOperationResponse(args: BluetoothEmulation.SimulateGATTOperationResponseParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun simulateGATTOperationResponse(address: String, type: BluetoothEmulation.GATTOperationType, code: Int)

simulatePreconnectedPeripheral

suspend fun simulatePreconnectedPeripheral(args: BluetoothEmulation.SimulatePreconnectedPeripheralParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun simulatePreconnectedPeripheral(address: String, name: String, manufacturerData: List<BluetoothEmulation.ManufacturerData>, knownServiceUuids: List<String>)