kable-core/com.juul.kable/WebBluetoothPeripheral

WebBluetoothPeripheral

interface WebBluetoothPeripheral : Peripheral

Properties

Platform specific identifier for the remote peripheral. On some platforms, this can be used to "restore" a previously known peripheral for reconnection.

name

abstract val name: String?

The peripheral name, as provided by the underlying bluetooth system. This value is system dependent and is not necessarily the Generic Access Profile (GAP) device name.

scope

abstract val scope: CoroutineScope

CoroutineScope tied to the lifecycle of this Peripheral (is cancelled upon Peripheral being disposed via close).

services

abstract val services: StateFlow<List<DiscoveredService>?>

The list of services (GATT profile) which have been discovered on the remote peripheral.

state

abstract val state: StateFlow<State>

Provides a conflated Flow of the Peripheral's State.

Functions

abstract fun close()

connect

abstract suspend fun connect(): CoroutineScope

Initiates a connection, suspending until connected, or failure occurs. Multiple concurrent invocations will all suspend until connected (or failure occurs). If already connected, then returns immediately.

disconnect

abstract suspend fun disconnect()

Disconnects the active connection, or cancels an in-flight connection attempt, suspending until Peripheral has settled on a disconnected state.

maximumWriteValueLengthForType

abstract suspend fun maximumWriteValueLengthForType(writeType: WriteType): Int

Return the current ATT MTU size, minus the size of the ATT headers (3 bytes).

observe

abstract fun observe(characteristic: Characteristic, onSubscription: OnSubscriptionAction = {}): Flow<ByteArray>

Observes changes to the specified Characteristic.

observeDataView

abstract fun observeDataView(characteristic: Characteristic, onSubscription: OnSubscriptionAction = {}): Flow<DataView>

read

abstract suspend fun read(characteristic: Characteristic): ByteArray

Reads data from characteristic.

abstract suspend fun read(descriptor: Descriptor): ByteArray

Reads data from descriptor.

readAsDataView

abstract suspend fun readAsDataView(characteristic: Characteristic): DataView

abstract suspend fun readAsDataView(descriptor: Descriptor): DataView

rssi

abstract suspend fun rssi(): Int

On JavaScript, requires Chrome 79+ with the chrome://flags/#enable-experimental-web-platform-features flag enabled.

write

abstract suspend fun write(descriptor: Descriptor, data: ByteArray)

Writes data to descriptor.

abstract suspend fun write(characteristic: Characteristic, data: ByteArray, writeType: WriteType = WithoutResponse)

Writes data to characteristic.