Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AddCharacteristicRequest(val serviceId: String, val characteristicUuid: String, val properties: CharacteristicProperties)

Request object containing input parameters for the BluetoothEmulationDomain.addCharacteristic command.

Link copied to clipboard
@Serializable
data class AddCharacteristicResponse(val characteristicId: String)

Response type for the BluetoothEmulationDomain.addCharacteristic command.

Link copied to clipboard
@Serializable
data class AddDescriptorRequest(val characteristicId: String, val descriptorUuid: String)

Request object containing input parameters for the BluetoothEmulationDomain.addDescriptor command.

Link copied to clipboard
@Serializable
data class AddDescriptorResponse(val descriptorId: String)

Response type for the BluetoothEmulationDomain.addDescriptor command.

Link copied to clipboard
@Serializable
data class AddServiceRequest(val address: String, val serviceUuid: String)

Request object containing input parameters for the BluetoothEmulationDomain.addService command.

Link copied to clipboard
@Serializable
data class AddServiceResponse(val serviceId: String)

Response type for the BluetoothEmulationDomain.addService command.

Link copied to clipboard

This domain allows configuring virtual Bluetooth devices to test the web-bluetooth API.

Link copied to clipboard
@Serializable(with = CentralStateSerializer::class)
sealed interface CentralState

Indicates the various states of Central.

Link copied to clipboard
@Serializable(with = CharacteristicOperationTypeSerializer::class)
sealed interface CharacteristicOperationType

Indicates the various types of characteristic operation.

Link copied to clipboard
@Serializable
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.

Link copied to clipboard
@Serializable(with = CharacteristicWriteTypeSerializer::class)
sealed interface CharacteristicWriteType

Indicates the various types of characteristic write.

Link copied to clipboard
@Serializable(with = DescriptorOperationTypeSerializer::class)
sealed interface DescriptorOperationType

Indicates the various types of descriptor operation.

Link copied to clipboard
@Serializable
object DisableResponse

A dummy response object for the BluetoothEmulationDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class EnableRequest(val state: CentralState, val leSupported: Boolean)

Request object containing input parameters for the BluetoothEmulationDomain.enable command.

Link copied to clipboard
@Serializable
object EnableResponse

A dummy response object for the BluetoothEmulationDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable(with = GATTOperationTypeSerializer::class)
sealed interface GATTOperationType

Indicates the various types of GATT event.

Link copied to clipboard
@Serializable
data class ManufacturerData(val key: Int, val data: String)

Stores the manufacturer data

Link copied to clipboard
@Serializable
data class RemoveCharacteristicRequest(val characteristicId: String)

Request object containing input parameters for the BluetoothEmulationDomain.removeCharacteristic command.

Link copied to clipboard
@Serializable
object RemoveCharacteristicResponse

A dummy response object for the BluetoothEmulationDomain.removeCharacteristic command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class RemoveDescriptorRequest(val descriptorId: String)

Request object containing input parameters for the BluetoothEmulationDomain.removeDescriptor command.

Link copied to clipboard
@Serializable
object RemoveDescriptorResponse

A dummy response object for the BluetoothEmulationDomain.removeDescriptor command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class RemoveServiceRequest(val serviceId: String)

Request object containing input parameters for the BluetoothEmulationDomain.removeService command.

Link copied to clipboard
@Serializable
object RemoveServiceResponse

A dummy response object for the BluetoothEmulationDomain.removeService command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class ScanEntry(val deviceAddress: String, val rssi: Int, val scanRecord: ScanRecord)

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

Link copied to clipboard
@Serializable
data class ScanRecord(val name: String? = null, val uuids: List<String>? = null, val appearance: Int? = null, val txPower: Int? = null, val manufacturerData: List<ManufacturerData>? = null)

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

Link copied to clipboard
@Serializable
data class SetSimulatedCentralStateRequest(val state: CentralState)

Request object containing input parameters for the BluetoothEmulationDomain.setSimulatedCentralState command.

Link copied to clipboard

A dummy response object for the BluetoothEmulationDomain.setSimulatedCentralState command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class SimulateAdvertisementRequest(val entry: ScanEntry)

Request object containing input parameters for the BluetoothEmulationDomain.simulateAdvertisement command.

Link copied to clipboard
@Serializable
object SimulateAdvertisementResponse

A dummy response object for the BluetoothEmulationDomain.simulateAdvertisement command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

@Serializable
data class SimulateCharacteristicOperationResponseRequest(val characteristicId: String, val type: CharacteristicOperationType, val code: Int, val data: String? = null)

Request object containing input parameters for the BluetoothEmulationDomain.simulateCharacteristicOperationResponse command.

A dummy response object for the BluetoothEmulationDomain.simulateCharacteristicOperationResponse command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

@Serializable
data class SimulateDescriptorOperationResponseRequest(val descriptorId: String, val type: DescriptorOperationType, val code: Int, val data: String? = null)

Request object containing input parameters for the BluetoothEmulationDomain.simulateDescriptorOperationResponse command.

A dummy response object for the BluetoothEmulationDomain.simulateDescriptorOperationResponse command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class SimulateGATTDisconnectionRequest(val address: String)

Request object containing input parameters for the BluetoothEmulationDomain.simulateGATTDisconnection command.

Link copied to clipboard

A dummy response object for the BluetoothEmulationDomain.simulateGATTDisconnection command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class SimulateGATTOperationResponseRequest(val address: String, val type: GATTOperationType, val code: Int)

Request object containing input parameters for the BluetoothEmulationDomain.simulateGATTOperationResponse command.

Link copied to clipboard

A dummy response object for the BluetoothEmulationDomain.simulateGATTOperationResponse command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class SimulatePreconnectedPeripheralRequest(val address: String, val name: String, val manufacturerData: List<ManufacturerData>, val knownServiceUuids: List<String>)

Request object containing input parameters for the BluetoothEmulationDomain.simulatePreconnectedPeripheral command.

Link copied to clipboard

A dummy response object for the BluetoothEmulationDomain.simulatePreconnectedPeripheral command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.