bluetooth/com.splendo.kaluga.bluetooth.device

Package-level declarations

Types

AdvertisementData

actual class AdvertisementData : BaseAdvertisementData

Android implementation of BaseAdvertisementData

expect class AdvertisementData : BaseAdvertisementData

Platform specific implementation of BaseAdvertisementData

actual class AdvertisementData

iOS implementation of BaseAdvertisementData

actual class AdvertisementData : BaseAdvertisementData

JavaScript implementation of BaseAdvertisementData. Not actually implemented

actual class AdvertisementData : BaseAdvertisementData

Java implementation of BaseAdvertisementData. Not actually implemented

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

ConnectableDeviceState

interface ConnectableDeviceState : DeviceState, KalugaState

A DeviceState for a Device 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

ConnectionSettings

data class ConnectionSettings(val reconnectionSettings: ConnectionSettings.ReconnectionSettings = ReconnectionSettings.Always, val logger: Logger = RestrictedLogger(RestrictedLogLevel.None))

Settings to apply to a Device when connecting

DefaultBluetoothGattWrapper

class DefaultBluetoothGattWrapper(gatt: BluetoothGatt) : BluetoothGattWrapper

Default implementation of BluetoothGattWrapper

DefaultCBPeripheralWrapper

class DefaultCBPeripheralWrapper(peripheral: <Error class: unknown class>) : DeviceWrapper

Default implementation of DeviceWrapper

DefaultDeviceWrapper

class DefaultDeviceWrapper(device: BluetoothDevice) : DeviceWrapper

Default implementation of DeviceWrapper

interface Device

A Bluetooth device that can be connected to

sealed class DeviceAction

An action a Device can execute on one of its com.splendo.kaluga.bluetooth.Attribute

DeviceConnectionManager

interface DeviceConnectionManager

A manager for connecting a Device

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

Implementation of Device

interface DeviceInfo

Properties of a Bluetooth Device

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

An implementation of DeviceInfo

interface DeviceState

The state of a Device

actual interface DeviceWrapper

Accessor to the BluetoothDevice

expect interface DeviceWrapper

Accessor to the platform level Bluetooth device

actual interface DeviceWrapper

Accessor to the CBPeripheral

actual interface DeviceWrapper

Accessor to the JavaScript Bluetooth device. Not Actually implemented

actual interface DeviceWrapper

Accessor to the Java Bluetooth device. Not Actually implemented

actual typealias Identifier = String

Unique identifier of a Bluetooth Device

expect class Identifier

Unique identifier of a Bluetooth Device

actual typealias Identifier = <Error class: unknown class>

Unique identifier of a Bluetooth Device

actual typealias Identifier = UUID

Unique identifier of a Bluetooth Device

actual typealias Identifier = UUID

Unique identifier of a Bluetooth Device

IdentifierSerializer

open class IdentifierSerializer : KSerializer<SerializableIdentifier>

KSerializer for a SerializableIdentifier

NotConnectableDeviceState

interface NotConnectableDeviceState : DeviceState

A DeviceState indicating the Device cannot be connected to

SerializableIdentifier

@Serializable(with = IdentifierSerializer::class)

data class SerializableIdentifier(val identifier: Identifier)

A Identifier that can be serialized

Properties

val BaseAdvertisementData.description: String

val Identifier.serializable: SerializableIdentifier

Converts an Identifier into a SerializableIdentifier

expect val Identifier.stringValue: String

Gets a string representation of an Identifier

Functions

identifierFromString

actual fun identifierFromString(stringValue: String): Identifier?

Gets an Identifier from a string value

expect fun identifierFromString(stringValue: String): Identifier?

Gets an Identifier from a string value

actual fun identifierFromString(stringValue: String): Identifier?

Gets an Identifier from a string value

actual fun identifierFromString(stringValue: String): Identifier?

Gets an Identifier from a string value

actual fun identifierFromString(stringValue: String): Identifier?

Gets an Identifier from a string value

randomIdentifier

actual fun randomIdentifier(): Identifier

Gets a random Identifier

expect fun randomIdentifier(): Identifier

Gets a random Identifier

actual fun randomIdentifier(): Identifier

Gets a random Identifier

actual fun randomIdentifier(): Identifier

Gets a random Identifier

actual fun randomIdentifier(): Identifier

Gets a random Identifier