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

ConnectableDeviceStateImplRepo

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

A BaseConnectableDeviceStateRepo managed by a DeviceConnectionManager

Parameters

defaultReconnectionSettings

the default ConnectionSettings.ReconnectionSettings to use when reconnecting after the device disconnects unexpectedly

connectionManager

the DeviceConnectionManager to manage the ConnectableDeviceState

coroutineContext

the CoroutineContext of this repo

Constructors

ConnectableDeviceStateImplRepo

constructor(defaultReconnectionSettings: ConnectionSettings.ReconnectionSettings, connectionManager: DeviceConnectionManager, coroutineContext: CoroutineContext)

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

initialState

val initialState: (HotStateFlowRepo<ConnectableDeviceState>) -> ConnectableDeviceState

lazyMutableSharedFlow

open override val lazyMutableSharedFlow: Lazy<MutableStateFlow<ConnectableDeviceState>>

stateFlow

open override val stateFlow: StateFlow<ConnectableDeviceState>

subscriptionCount

val subscriptionCount: StateFlow<Int>

Functions

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

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

characteristic

suspend fun Flow<ConnectableDevice?>.characteristic(serviceUUID: String, characteristicUUID: String): RemoteCharacteristic

Provides access to RemoteCharacteristic by service and characteristic string uuids. The method will suspend if characteristic is not available.

characteristicFlow

fun Flow<ConnectableDevice?>.characteristicFlow(serviceUUID: String, characteristicUUID: String): Flow<RemoteCharacteristic>

Provides access to RemoteCharacteristic's flow by service and characteristic string uuids. Only emits after services have been discovered.

characteristicOrNull

suspend fun Flow<ConnectableDevice?>.characteristicOrNull(serviceUUID: String, characteristicUUID: String): RemoteCharacteristic?

Provides access to RemoteCharacteristic by service and characteristic string uuids or null if not available.

characteristicOrNullFlow

fun Flow<ConnectableDevice?>.characteristicOrNullFlow(serviceUUID: String, characteristicUUID: String): Flow<RemoteCharacteristic?>

Provides access to RemoteCharacteristic's flow by service and characteristic string uuids. Emits null if the characteristic cannot be found.

characteristics

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

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

collect

open suspend override fun collect(collector: FlowCollector<ConnectableDeviceState>): Nothing

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

dataFlow

fun Flow<ConnectableDevice?>.dataFlow(serviceUUID: String, characteristicUUID: String): Flow<ByteArray>

Provides access to device data flow by service and characteristic string uuids. Only emits after services have been discovered.

inline fun <T> Flow<ConnectableDevice?>.dataFlow(serviceUUID: String, characteristicUUID: String, deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

Provides access to device data flow T by service and characteristic string uuids. Only emits after services have been discovered.

dataOrEmptyFlow

fun Flow<ConnectableDevice?>.dataOrEmptyFlow(serviceUUID: String, characteristicUUID: String): Flow<ByteArray>

Provides access to device data flow by service and characteristic string uuids. Emits and empty ByteArray if the service cannot be found.

dataOrNullFlow

inline fun <T> Flow<ConnectableDevice?>.dataOrNullFlow(serviceUUID: String, characteristicUUID: String, deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T?>

Provides access to device data flow T by service and characteristic string uuids. Emits null if the descriptor cannot be found.

descriptor

suspend fun Flow<ConnectableDevice?>.descriptor(serviceUUID: String, characteristicUUID: String, descriptorUUID: String): RemoteDescriptor

Provides access to RemoteDescriptor by service, characteristic and descriptor string uuids. The method will suspend if descriptor is not available.

descriptorFlow

fun Flow<ConnectableDevice?>.descriptorFlow(serviceUUID: String, characteristicUUID: String, descriptorUUID: String): Flow<RemoteDescriptor>

Provides access to RemoteDescriptor's flow by service, characteristic, and descriptor string uuids. Only emits after services have been discovered.

descriptorOrNullFlow

fun Flow<ConnectableDevice?>.descriptorOrNullFlow(serviceUUID: String, characteristicUUID: String, descriptorUUID: String): Flow<RemoteDescriptor?>

Provides access to RemoteDescriptor's flow by service, characteristic, and descriptor string uuids. Emits null if the descriptor cannot be found.

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 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 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.

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

initialValue

suspend override fun initialValue(): ConnectableDeviceState

launchTakeAndChangeState

fun launchTakeAndChangeState(context: CoroutineContext, action: suspend (ConnectableDeviceState) -> suspend () -> ConnectableDeviceState): Job

fun <K : ConnectableDeviceState> launchTakeAndChangeState(context: CoroutineContext, remainIfStateNot: KClass<K>, action: suspend (K) -> suspend () -> ConnectableDeviceState): Job

launchUseState

fun <Result> launchUseState(context: CoroutineContext, action: suspend (ConnectableDeviceState) -> Result): Job

mtu

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]

peekState

fun peekState(): ConnectableDeviceState

requestMtu

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

service

suspend fun Flow<ConnectableDevice?>.service(serviceUUID: String): RemoteService

Provides access to RemoteService by service string uuids. The method will suspend until services have been discovered.

serviceFlow

fun Flow<ConnectableDevice?>.serviceFlow(serviceUUID: String): Flow<RemoteService>

Provides access to a RemoteService by service string uuids. Only emits after services have been discovered.

serviceOrNull

suspend fun Flow<ConnectableDevice?>.serviceOrNull(serviceUUID: String): RemoteService?

Provides access to RemoteService by service and characteristic string uuids or null if not available.

serviceOrNullFlow

fun Flow<ConnectableDevice?>.serviceOrNullFlow(serviceUUID: String): Flow<RemoteService?>

Provides access to a RemoteService by service string uuids. Emits null if the service cannot be found.

services

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

takeAndChangeState

suspend fun takeAndChangeState(action: suspend (ConnectableDeviceState) -> suspend () -> ConnectableDeviceState): ConnectableDeviceState

suspend fun <K : ConnectableDeviceState> takeAndChangeState(remainIfStateNot: KClass<K>, action: suspend (K) -> suspend () -> ConnectableDeviceState): ConnectableDeviceState

unpair

suspend fun Flow<ConnectableDevice?>.unpair()

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

updateRssi

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

useState

suspend fun <Result> useState(action: suspend (ConnectableDeviceState) -> Result): Result

value

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> 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