bluetooth-client/com.splendo.kaluga.bluetooth.device

Package-level declarations

Types

AdvertisementData

actual class AdvertisementData : BaseAdvertisementData

Android implementation of BaseAdvertisementData

actual class AdvertisementData : BaseAdvertisementData

iOS implementation of BaseAdvertisementData

expect class AdvertisementData : BaseAdvertisementData

Platform specific implementation of BaseAdvertisementData

actual class AdvertisementData : BaseAdvertisementData

BaseAdvertisementData for the JS family. The requestDevice picker exposes only the device name; RSSI, manufacturer/service data and tx power are not available on the web.

BaseAdvertisementData

interface BaseAdvertisementData

Data advertised by a Bluetooth Device

BaseConnectableDeviceStateRepo

abstract class BaseConnectableDeviceStateRepo(initialState: () -> ConnectableDeviceState, coroutineContext: CoroutineContext) : HotStateFlowRepo<ConnectableDeviceState>

A HotStateFlowRepo to manage the ConnectableDeviceState of a Device

BaseDeviceConnectionManager

abstract class BaseDeviceConnectionManager(deviceWrapper: DeviceWrapper, settings: ConnectionSettings, coroutineScope: CoroutineScope) : DeviceConnectionManager, CoroutineScope

A DeviceConnectionManager using a DeviceWrapper

BluetoothGattWrapper

interface BluetoothGattWrapper

A wrapper to access a BluetoothGatt

ConnectableDevice

interface ConnectableDevice : Device

A Device that can be connected to

ConnectableDeviceImpl

class ConnectableDeviceImpl(val identifier: Identifier, initialDeviceInfo: DeviceInfoImpl, connectionSettings: ConnectionSettings, connectionManagerBuilder: (ConnectionSettings) -> DeviceConnectionManager, coroutineScope: CoroutineScope, createDeviceStateFlow: (DeviceConnectionManager, CoroutineContext) -> ConnectableDeviceStateFlowRepo = { connectionManager, context -> ConnectableDeviceStateImplRepo(connectionSettings.reconnectionSettings, connectionManager, context) }) : ConnectableDevice, CoroutineScope

Implementation of ConnectableDevice

ConnectableDeviceState

sealed interface ConnectableDeviceState : DeviceState, KalugaState

A DeviceState for a ConnectableDevice that can be connected to

ConnectableDeviceStateFlowRepo

typealias ConnectableDeviceStateFlowRepo = StateRepo<ConnectableDeviceState, MutableStateFlow<ConnectableDeviceState>>

A Mutable StateRepo of ConnectableDeviceState

ConnectableDeviceStateImplRepo

class ConnectableDeviceStateImplRepo(defaultReconnectionSettings: ConnectionSettings.ReconnectionSettings, connectionManager: DeviceConnectionManager, coroutineContext: CoroutineContext) : BaseConnectableDeviceStateRepo

A BaseConnectableDeviceStateRepo managed by a DeviceConnectionManager

ConnectedDeviceBinding

sealed interface ConnectedDeviceBinding<T>

Builder for setting up binding to an object T so that it may be changed by a ConnectableDevice.

ConnectionSettings

class ConnectionSettings

Settings to apply to a Device when connecting

DefaultBluetoothGattWrapper

class DefaultBluetoothGattWrapper(gatt: BluetoothGatt) : BluetoothGattWrapper

Default implementation of BluetoothGattWrapper

DefaultCBPeripheralWrapper

class DefaultCBPeripheralWrapper(peripheral: CBPeripheral) : DeviceWrapper

Default implementation of DeviceWrapper

DefaultDeviceWrapper

class DefaultDeviceWrapper(device: BluetoothDevice) : DeviceWrapper

Default implementation of DeviceWrapper

DeviceAction

sealed class DeviceAction<Response : GattResponse>

An action a ConnectableDevice can execute on one of its com.splendo.kaluga.bluetooth.RemoteAttribute

DeviceConnectionManager

interface DeviceConnectionManager

A manager for connecting a Device

DeviceInfo

interface DeviceInfo

Properties of a Bluetooth Device

DeviceInfoImpl

data class DeviceInfoImpl(val deviceName: String?, val identifier: Identifier, val rssi: RSSI, val advertisementData: BaseAdvertisementData) : DeviceInfo

An implementation of DeviceInfo

DeviceState

sealed interface DeviceState

The state of a Device

DeviceWrapper

actual interface DeviceWrapper

Accessor to the BluetoothDevice

actual interface DeviceWrapper

Accessor to the CBPeripheral

expect interface DeviceWrapper

Accessor to the platform level Bluetooth device

actual interface DeviceWrapper

Accessor to a Web Bluetooth BluetoothDevice. The live JS device is held in the per-target registry under identifier; this wrapper only carries its identifier and name.

NotConnectableDeviceState

interface NotConnectableDeviceState : DeviceState

A DeviceState indicating the ConnectableDevice cannot be connected to

RemoteAttributeBinding

interface RemoteAttributeBinding<T>

Builder for setting up binding to an object T so that it may be changed by a RemoteAttribute.

RemoteCharacteristicBinding

sealed interface RemoteCharacteristicBinding<T> : RemoteAttributeBinding<T>

Builder for setting up binding to an object T so that it may be changed by a RemoteCharacteristic.

RemoteDescriptorBinding

interface RemoteDescriptorBinding<T> : RemoteAttributeBinding<T>

Builder for setting up binding to an object T so that it may be changed by a RemoteDescriptor.

RemoteServiceBinding

interface RemoteServiceBinding<T>

Builder for setting up binding to an object T so that it may be changed by a RemoteService.

RequiresServicesDiscoveredBinding

sealed interface RequiresServicesDiscoveredBinding<T, Transformation>

Builder for setting up binding to an object T so that it may be notified when RemoteService become available / unavailable.

WebDeviceWrapper

class WebDeviceWrapper(val identifier: Identifier, val name: String?) : DeviceWrapper

Default implementation of DeviceWrapper for the JS family.

Properties

description

val BaseAdvertisementData.description: String

Functions

bind

fun <T> T.bind(characteristic: RemoteCharacteristic, scope: CoroutineScope, binding: RemoteCharacteristicBinding.EnsuresServicesAvailable<T>.() -> Unit): StateFlow<T>

Binds an object of type T to a RemoteCharacteristic, so that it may be updated according to binding.

fun <T> T.bind(descriptor: RemoteDescriptor, scope: CoroutineScope, binding: RemoteDescriptorBinding<T>.() -> Unit): StateFlow<T>

Binds an object of type T to a RemoteDescriptor, so that it may be updated according to binding.

fun <T> T.bind(service: RemoteService, scope: CoroutineScope, binding: RemoteServiceBinding.EnsuresAvailable<T>.() -> Unit): StateFlow<T>

Binds an object of type T to a RemoteService, so that it may be updated according to binding.

fun <T> T.bind(device: ConnectableDevice, scope: CoroutineScope, binding: ConnectedDeviceBinding.RequiresServicesDiscovered<T>.() -> Unit): StateFlow<T>

Binds an object of type T to a ConnectableDevice, so that it may be updated according to binding

fun <T> T.bind(deviceState: ConnectableDeviceState.Connected.DiscoveredServices, scope: CoroutineScope, binding: ConnectedDeviceBinding.EnsuresAvailable<T>.() -> Unit): StateFlow<T>

Binds an object of type T to a ConnectableDeviceState.Connected.DiscoveredServices state, so that it may be updated according to binding. This assumes services has been discovered and as such any binding will fail if a RemoteAttribute is not available.

@JvmName(name = "bindCharacteristic")

fun <T> T.bind(characteristic: Flow<RemoteCharacteristic?>, scope: CoroutineScope, binding: RemoteCharacteristicBinding.RequiresServicesDiscovered<T>.() -> Unit): StateFlow<T>

Binds an object of type T to the Flow of a RemoteCharacteristic, so that it may be updated according to binding

@JvmName(name = "bindDescriptor")

fun <T> T.bind(descriptor: Flow<RemoteDescriptor?>, scope: CoroutineScope, binding: RemoteDescriptorBinding.RequiresServicesDiscovered<T>.() -> Unit): StateFlow<T>

Binds an object of type T to the Flow of a RemoteDescriptor, so that it may be updated according to binding

@JvmName(name = "bindService")

fun <T> T.bind(service: Flow<RemoteService?>, scope: CoroutineScope, binding: RemoteServiceBinding.RequiresServicesDiscovered<T>.() -> Unit): StateFlow<T>

Binds an object of type T to the Flow of a RemoteService, so that it may be updated according to binding

@JvmName(name = "bindDevice")

fun <T> T.bind(device: Flow<ConnectableDevice?>, scope: CoroutineScope, binding: ConnectedDeviceBinding.RequiresServicesDiscovered<T>.() -> Unit): StateFlow<T>

Binds an object of type T to the Flow of a ConnectableDevice, so that it may be updated according to binding

observe

inline fun <Notification, T> RemoteCharacteristicBinding<T>.observe(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline builder: RemoteCharacteristicBinding.ObserveBuilder.NonMutating<T, Notification>.() -> Unit)

Sets up observation of a Notification from the RemoteCharacteristic

triggerRead

@JvmName(name = "consumeUnitToTriggerRead")

fun <T> RemoteAttributeBinding.TriggerResponse<Unit, T>.triggerRead(unitBuilder: RemoteAttributeBinding.UnitReadBuilder.NonMutating<T, ByteArray>.() -> Unit)

@JvmName(name = "triggerReadFromUnit")

inline fun <Response, T> RemoteAttributeBinding.TriggerResponse<Unit, T>.triggerRead(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline unitBuilder: RemoteAttributeBinding.UnitReadBuilder.NonMutating<T, Response>.() -> Unit)

fun <Response, T> RemoteAttributeBinding.TriggerResponse<Unit, T>.triggerRead(asValue: ByteArray.() -> Response, unitBuilder: RemoteAttributeBinding.UnitReadBuilder.NonMutating<T, Response>.() -> Unit)

fun <Response, T> RemoteAttributeBinding.TriggerResponse<Unit, T>.triggerRead(deserializationStrategy: DeserializationStrategy<Response>, bluetoothFormat: BluetoothFormat = BluetoothFormat, unitBuilder: RemoteAttributeBinding.UnitReadBuilder.NonMutating<T, Response>.() -> Unit)

Responds to a Unit to cause the RemoteAttribute to be read.

inline fun <Response, Trigger, T> RemoteAttributeBinding.TriggerResponse<Trigger, T>.triggerRead(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline builder: RemoteAttributeBinding.ReadBuilder.NonMutating<T, Trigger, Response>.() -> Unit)

Responds to a Trigger to cause the RemoteAttribute to be read.

triggerWrite

fun <T> RemoteAttributeBinding.TriggerResponse<ByteArray, T>.triggerWrite(builder: RemoteAttributeBinding.WriteBuilder.NonMutating<T, ByteArray>.() -> Unit)

Responds to a ByteArray to write it to the RemoteAttribute.

inline fun <Trigger, T> RemoteAttributeBinding.TriggerResponse<Trigger, T>.triggerWrite(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline builder: RemoteAttributeBinding.WriteBuilder.NonMutating<T, Trigger>.() -> Unit)

Consumes Trigger from a Channel to write it to the RemoteAttribute.

inline fun <Trigger, Data, T> RemoteAttributeBinding.TriggerResponse<Trigger, T>.triggerWrite(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline mapper: Trigger.() -> Data, noinline builder: RemoteAttributeBinding.WriteBuilder.NonMutating<T, Trigger>.() -> Unit)

Responds to a Trigger to have Data written to the RemoteAttribute.