Filtering on Service Data is not supported because it is not implemented: https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md

GattRequestRejectedException

open class GattRequestRejectedException : IllegalStateException

Thrown on Android when underlying android.bluetooth.BluetoothDevice method call returns false. This can occur under the following conditions:

GattStatusException

class GattStatusException(message: String? = null, cause: Throwable? = null, val status: Int) : IOException

Represents an Android GATT status failure.

GattWriteException

class GattWriteException : GattRequestRejectedException

Thrown when underlying BluetoothGatt write operation call fails.

Identifier

actual typealias Identifier = String

actual typealias Identifier = Uuid

expect class Identifier

actual typealias Identifier = String

InternalError

class InternalError : Error

An Error that signifies that an unexpected condition or state was encountered in the Kable internals.

IOException

typealias ~~IOException~~ = kotlinx.io.IOException

JsPeripheral

typealias ~~JsPeripheral~~ = WebBluetoothPeripheral

Kable

object Kable

KableInitializer

class KableInitializer : Initializer<Kable>

LazyCharacteristic

data class LazyCharacteristic : Characteristic

LazyDescriptor

data class LazyDescriptor(val serviceUuid: Uuid, val characteristicUuid: Uuid, val descriptorUuid: Uuid) : Descriptor

LocationManagerUnavailableException

typealias ~~LocationManagerUnavailableException~~ = UnmetRequirementException

ManufacturerData

class ManufacturerData(val code: Int, val data: ByteArray)

NotConnectedException

open class NotConnectedException(message: String? = null, cause: Throwable? = null) : IOException

NotReadyException

typealias ~~NotReadyException~~ = NotConnectedException

ObservationExceptionPeripheral

class ObservationExceptionPeripheral

ObsoleteKableApi

annotation class ObsoleteKableApi

Marks declarations that are obsolete in Kable API, which means that the design of the corresponding declarations has known flaws/drawbacks and they will be redesigned or replaced in the future.

OnDemandThreadingStrategy

object OnDemandThreadingStrategy : ThreadingStrategy

A ThreadingStrategy that creates "threads" when acquired and immediately shuts down when released.

Options

data class Options

OptionsBuilder

class OptionsBuilder

Peripheral

interface Peripheral : AutoCloseable

Represents a remote Bluetooth Low Energy peripheral. Should be disposed (via close) when no longer needed.

PeripheralBuilder

actual class PeripheralBuilder

expect class PeripheralBuilder

actual class PeripheralBuilder

Phy

enum Phy : Enum<Phy>

Preferred Physical Layer (PHY) for connections to remote LE devices.

PlatformAdvertisement

actual interface PlatformAdvertisement : Advertisement, Parcelable

actual interface PlatformAdvertisement

expect interface PlatformAdvertisement : Advertisement

actual interface PlatformAdvertisement : Advertisement

PlatformScanner

typealias PlatformScanner = Scanner<PlatformAdvertisement>

PooledThreadingStrategy

class PooledThreadingStrategy(scope: CoroutineScope = GlobalScope, evictAfter: Duration = 1.minutes) : ThreadingStrategy

A ThreadingStrategy that pools unused "threads" until evictAfter time has elapsed.

Priority

typealias ~~Priority~~ = AndroidPeripheral.Priority

Reason

actual enum ~~Reason~~ : Enum<Reason>

https://developer.apple.com/documentation/corebluetooth/cbmanagerstate

expect enum ~~Reason~~ : Enum<Reason>

actual enum ~~Reason~~ : Enum<Reason>

actual enum Reason : Enum<Reason>

Scanner

interface Scanner<out T : Advertisement>

ScannerBuilder

actual class ScannerBuilder

expect class ScannerBuilder

actual class ScannerBuilder

Service

interface Service

ServicesDiscoveredPeripheral

actual class ServicesDiscoveredPeripheral

expect class ServicesDiscoveredPeripheral

actual class ServicesDiscoveredPeripheral

State

sealed class State

Threading

sealed class Threading

ThreadingStrategy

interface ThreadingStrategy

Transport

enum Transport : Enum<Transport>

Preferred transport for GATT connections to remote dual-mode devices.

UnmetRequirementException

class UnmetRequirementException : IOException

UnmetRequirementReason

enum UnmetRequirementReason : Enum<UnmetRequirementReason>

WebBluetoothAdvertisement

typealias ~~WebBluetoothAdvertisement~~ = PlatformAdvertisement

WebBluetoothPeripheral

interface WebBluetoothPeripheral : Peripheral

WebBluetoothScanner

typealias ~~WebBluetoothScanner~~ = PlatformScanner

WriteType

enum WriteType : Enum<WriteType>

Properties

broadcast

val Characteristic.Properties.broadcast: Boolean

extendedProperties

val Characteristic.Properties.extendedProperties: Boolean

indicate

val Characteristic.Properties.indicate: Boolean

name

val Threading.name: String

notify

val Characteristic.Properties.notify: Boolean

read

val Characteristic.Properties.read: Boolean

signedWrite

val Characteristic.Properties.signedWrite: Boolean

write

val Characteristic.Properties.write: Boolean

writeWithoutResponse

val Characteristic.Properties.writeWithoutResponse: Boolean

Functions

characteristic

fun Uuid.Companion.characteristic(name: String): Uuid

Gets a characteristic Uuid from a known characteristic name.

characteristicOf

fun ~~characteristicOf~~(service: String, characteristic: String): Characteristic

fun characteristicOf(service: Uuid, characteristic: Uuid): Characteristic

descriptor

fun Uuid.Companion.descriptor(name: String): Uuid

Gets a descriptor Uuid from a known descriptor name.

descriptorOf

fun ~~descriptorOf~~(service: String, characteristic: String, descriptor: String): Descriptor

fun descriptorOf(service: Uuid, characteristic: Uuid, descriptor: Uuid): Descriptor

Options

fun Options(builder: OptionsBuilder.() -> Unit): Options

https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice

fun ~~Options~~(filters: List<Filter>? = null, filterSets: List<FilterSet>? = null, optionalServices: List<Uuid>? = null): Options

Peripheral

fun Peripheral(bluetoothDevice: BluetoothDevice, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun Peripheral(advertisement: Advertisement, builderAction: PeripheralBuilderAction): Peripheral

fun Peripheral(identifier: Identifier, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun Peripheral(advertisement: <Error class: unknown class>, builderAction: <Error class: unknown class>): <Error class: unknown class>

fun Peripheral(identifier: Identifier, builderAction: <Error class: unknown class> = {}): CoreBluetoothPeripheral

fun Peripheral(cbPeripheral: CBPeripheral, builderAction: <Error class: unknown class> = {}): CoreBluetoothPeripheral

expect fun Peripheral(advertisement: Advertisement, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun Peripheral(advertisement: Advertisement, builderAction: PeripheralBuilderAction): Peripheral

peripheral

fun CoroutineScope.~~peripheral~~(bluetoothDevice: BluetoothDevice, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun CoroutineScope.~~peripheral~~(advertisement: Advertisement, builderAction: PeripheralBuilderAction): Peripheral

fun CoroutineScope.~~peripheral~~(identifier: Identifier, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun <Error class: unknown class>.~~peripheral~~(advertisement: <Error class: unknown class>, builderAction: <Error class: unknown class>): <Error class: unknown class>

fun <Error class: unknown class>.~~peripheral~~(identifier: Identifier, builderAction: <Error class: unknown class> = {}): <Error class: unknown class>

fun <Error class: unknown class>.~~peripheral~~(cbPeripheral: CBPeripheral, builderAction: <Error class: unknown class>): CoreBluetoothPeripheral

expect fun CoroutineScope.~~peripheral~~(advertisement: Advertisement, builderAction: PeripheralBuilderAction = {}): Peripheral

actual fun CoroutineScope.~~peripheral~~(advertisement: Advertisement, builderAction: PeripheralBuilderAction): Peripheral

requestPeripheral

suspend fun requestPeripheral(options: Options, builderAction: PeripheralBuilderAction = {}): Peripheral?

Obtains a nearby Peripheral via device picker. Returns null if dialog is cancelled (e.g. user dismissed dialog by clicking outside of dialog or clicking cancel button).

Scanner

fun Scanner(builderAction: ScannerBuilder.() -> Unit = {}): PlatformScanner

service

fun Uuid.Companion.service(name: String): Uuid

Gets a service Uuid from a known service name.

shutdown

fun Threading.shutdown()

Threading

fun ThreadingStrategy.Threading(name: String): Threading

Creates Threading that can be used for Bluetooth communication. The returned Threading is returned in a started state and must be shutdown when no longer needed.

toIdentifier

actual fun String.toIdentifier(): Identifier

expect fun String.toIdentifier(): Identifier

actual fun String.toIdentifier(): Identifier