Accessor to a Web Bluetooth BluetoothRemoteGATTCharacteristic. A structural snapshot built during service discovery; the actual read/write/notify go through the connection manager + per-target interop.

RemoteDescriptor

open class RemoteDescriptor(val wrapper: RemoteDescriptorWrapper, val characteristic: RemoteCharacteristic, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit, logger: Logger) : RemoteAttribute<DeviceAction.Read.Descriptor, DeviceAction.Write.Descriptor> , Descriptor

A Descriptor that is accessed remotely by a bluetooth client using BluetoothClient

RemoteDescriptorWrapper

actual interface RemoteDescriptorWrapper

Accessor to a BluetoothGattDescriptor

actual interface RemoteDescriptorWrapper

Accessor to a CBDescriptor

expect interface RemoteDescriptorWrapper

Accessor to the platform level Bluetooth Descriptor

actual interface RemoteDescriptorWrapper

Accessor to a CBDescriptor

actual interface RemoteDescriptorWrapper

Accessor to a Web Bluetooth BluetoothRemoteGATTDescriptor. A structural snapshot built during service discovery.

RemoteService

class RemoteService : Service

A Service that is accessed remotely by a bluetooth client using BluetoothClient

RemoteServiceWrapper

actual interface RemoteServiceWrapper

Accessor to a BluetoothGattService

actual interface RemoteServiceWrapper

Accessor to a CBService

expect interface RemoteServiceWrapper

Accessor to the platform level Bluetooth service

actual interface RemoteServiceWrapper

Accessor to a CBService

actual interface RemoteServiceWrapper

Accessor to a Web Bluetooth BluetoothRemoteGATTService. A structural snapshot built during the (async) service discovery in the connection manager.

Properties

defaultBluetoothClientDispatcher

val defaultBluetoothClientDispatcher: CloseableCoroutineDispatcher

Functions

fun Flow<ConnectableDevice?>.advertisement(): Flow<BaseAdvertisementData>

Gets the (Flow of) BaseAdvertisementData from a Flow of ConnectableDevice

characteristics

fun Flow<RemoteService?>.characteristics(): Flow<List<RemoteCharacteristic>>

Gets a (Flow of) the list RemoteCharacteristic associated with the RemoteService in a Flow

connect

suspend fun Flow<ConnectableDevice?>.connect(reconnectionSettings: ConnectionSettings.ReconnectionSettings? = null): Boolean

Attempts to connect to the ConnectableDevice from a Flow of ConnectableDevice When this method completes, the devices should be in a ConnectableDeviceState.Connected state

descriptors

fun Flow<RemoteCharacteristic?>.descriptors(): Flow<List<RemoteDescriptor>>

Gets a (Flow of) the list RemoteDescriptor associated with the RemoteCharacteristic in a Flow

disconnect

suspend fun Flow<ConnectableDevice?>.disconnect()

Attempts to disconnect to the ConnectableDevice from a Flow of ConnectableDevice When this method completes, the devices should be in a ConnectableDeviceState.Disconnected state

discoveredServices

fun ConnectableDevice.discoveredServices(): Flow<List<RemoteService>>

Gets a (Flow of) the list of Service associated with the ConnectableDevice This will automatically discover services if the device is in a ConnectableDeviceState.Connected.NoServices state. This differs from services in that the resulting flow will only emit once services are discovered.

fun Flow<ConnectableDevice?>.discoveredServices(): Flow<List<RemoteService>>

Gets a (Flow of) the list of Service associated with the ConnectableDevice in a Flow This will automatically discover services if the device is in a ConnectableDeviceState.Connected.NoServices state. This differs from services in that the resulting flow will only emit once services are discovered.

distance

fun ConnectableDevice.distance(environmentalFactor: Double = 2.0, averageOver: Int = 5): Flow<Double>

Gets the (Flow of) the distance in meters between the scanner and a ConnectableDevice. To get a more stable result, this method will average the distance over the last averageOver results.

fun Flow<ConnectableDevice?>.distance(environmentalFactor: Double = 2.0, averageOver: Int = 5): Flow<Double>

Gets the (Flow of) the distance in meters between the scanner and a Flow of ConnectableDevice. To get a more stable result, this method will average the distance over the last averageOver results.

filterDiscovering

fun ConnectableDevice.filterDiscovering(): Flow<ConnectableDeviceState.Connected.DiscoveredServices?>

Gets a (Flow of) ConnectableDeviceState.Connected.DiscoveredServices from a ConnectableDevice This will automatically start discovering services if the device is in a ConnectableDeviceState.Connected.NoServices state.

get

operator fun Flow<List<ConnectableDevice>>.get(identifier: Identifier): Flow<ConnectableDevice?>

Gets a (Flow of) ConnectableDevice with a given Identifier from a Flow of a list of ConnectableDevice.

includedServices

fun Flow<RemoteService?>.includedServices(): Flow<List<RemoteService>>

Gets a (Flow of) the list RemoteService that are included with the RemoteService in a Flow

info

fun Flow<ConnectableDevice?>.info(): Flow<DeviceInfo>

Gets the (Flow of) DeviceInfo from a Flow of ConnectableDevice

mtu

fun ConnectableDevice.mtu(): Flow<Int?>

Gets the (Flow of) the MTU from a ConnectableDevice

fun Flow<ConnectableDevice?>.mtu(): Flow<Int?>

Gets the (Flow of) the MTU from a Flow of ConnectableDevice

pair

suspend fun Flow<ConnectableDevice?>.pair()

Pairs a (Flow of) ConnectableDevice by waiting for it to become connected and calling [ConnectableDeviceState.Connected.pair]

requestMtu

suspend fun ConnectableDevice.requestMtu(mtu: MTU): DeviceAction.RequestMtu

Attempts to request a MTU size for the ConnectableDevice from a ConnectableDevice

suspend fun Flow<ConnectableDevice?>.requestMtu(mtu: MTU): GattResponse.MTUResponse

Attempts to request a MTU size for the ConnectableDevice from a Flow of ConnectableDevice

rssi

fun Flow<ConnectableDevice?>.rssi(): Flow<RSSI>

Gets the (Flow of) the RSSI value from a Flow of ConnectableDevice

services

fun ConnectableDevice.services(): Flow<List<RemoteService>>

Gets a (Flow of) the list of Service associated with the ConnectableDevice This will automatically discover services if the device is in a ConnectableDeviceState.Connected.NoServices state.

fun Flow<ConnectableDevice?>.services(): Flow<List<RemoteService>>

Gets a (Flow of) the list of Service associated with the ConnectableDevice in a Flow This will automatically discover services if the device is in a ConnectableDeviceState.Connected.NoServices state.

state

fun Flow<ConnectableDevice?>.state(): Flow<DeviceState>

Gets a (Flow of) DeviceState from a Flow or ConnectableDevice

unpair

suspend fun Flow<ConnectableDevice?>.unpair()

Pairs a (Flow of) ConnectableDevice by calling [ConnectableDeviceState.unpair] on the first ConnectableDeviceState

updateRssi

suspend fun ConnectableDevice.updateRssi()

Attempts to request an update to the RSSI of the ConnectableDevice from a ConnectableDevice When this method completes, the devices should have had ConnectableDeviceState.Connected.readRssi called

suspend fun Flow<ConnectableDevice?>.updateRssi()

Attempts to request an update to the RSSI of the ConnectableDevice from a Flow of ConnectableDevice When this method completes, the devices should have had ConnectableDeviceState.Connected.readRssi called

value

fun RemoteCharacteristic.value(): Flow<ByteArray>

Gets a (Flow of) the ByteArray value from a RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

fun Flow<RemoteCharacteristic?>.value(): Flow<ByteArray>

Gets a (Flow of) the ByteArray value from a Flow of an RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

inline fun <T> RemoteCharacteristic.value(bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

fun <T> RemoteCharacteristic.value(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

Gets a (Flow of) T value from a RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

inline fun <T> Flow<RemoteCharacteristic?>.value(bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

fun <T> Flow<RemoteCharacteristic?>.value(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

Gets a (Flow of) T value from a Flow of an RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

valueOrEmpty

fun Flow<RemoteCharacteristic?>.valueOrEmpty(): Flow<ByteArray>

Gets a (Flow of) the ByteArray value from a Flow of an RemoteCharacteristic or an empty ByteArray if data is unavailable This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

valueOrNull

inline fun <T> Flow<RemoteCharacteristic?>.valueOrNull(bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T?>

Gets a (Flow of) T value from a Flow of an RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

fun <T> Flow<RemoteCharacteristic?>.valueOrNull(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T?>

Gets a (Flow of) T value from a Flow of an RemoteCharacteristic or null if data is unavailable This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected