bluetooth/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<Device?>.advertisement(): Flow<BaseAdvertisementData>

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

characteristics

fun Flow<Service?>.characteristics(): Flow<List<Characteristic>>

Gets a (Flow of) the list Characteristic associated with the Service in a Flow

collect

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

connect

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

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

descriptors

fun Flow<Characteristic?>.descriptors(): Flow<List<Descriptor>>

Gets a (Flow of) the list Descriptor associated with the Characteristic in a Flow

disconnect

suspend fun Flow<Device?>.disconnect()

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

distance

fun Flow<Device?>.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 Device. To get a more stable result, this method will average the distance over the last averageOver results.

get

@JvmName(name = "getAttribute")

operator fun <AttributeType : Attribute<ReadAction, WriteAction>, ReadAction : DeviceAction.Read, WriteAction : DeviceAction.Write> Flow<List<AttributeType>>.get(uuid: UUID): Flow<AttributeType?>

Gets a (Flow of) AttributeType of a given UUID from a Flow of a list of AttributeType

@JvmName(name = "getService")

operator fun Flow<List<Service>>.get(uuid: UUID): Flow<Service?>

Gets a (Flow of) Service of a given UUID from a Flow of a list of Service

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

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

info

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

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

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<Device?>.mtu(): Flow<MTU?>

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

pair

suspend fun Flow<Device?>.pair()

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

peekState

fun peekState(): ConnectableDeviceState

requestMtu

suspend fun Flow<Device?>.requestMtu(mtu: MTU): Boolean

Attempts to request a MTU size for the Device from a Flow of Device When this method completes, the devices should have had ConnectableDeviceState.Connected.requestMtu called

rssi

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

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

services

fun Flow<Device?>.services(): Flow<List<Service>>

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

state

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

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

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<Device?>.unpair()

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

updateRssi

suspend fun Flow<Device?>.updateRssi()

Attempts to request an update to the RSSI of the Device from a Flow of Device 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 <AttributeType : Attribute<ReadAction, WriteAction>, ReadAction : DeviceAction.Read, WriteAction : DeviceAction.Write> Flow<AttributeType?>.value(): Flow<ByteArray?>

Gets a (Flow of) the ByteArray value from a Flow of an AttributeType