bluetooth/com.splendo.kaluga.bluetooth/Attribute

Attribute

abstract class Attribute<ReadAction : DeviceAction.Read, WriteAction : DeviceAction.Write>(initialValue: ByteArray? = null, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit, parentLogTag: String, logger: Logger) : Flow<ByteArray?>

A bluetooth attribute conforming to the Attribute Protocol in Bluetooth Low Energy

Parameters

ReadAction

the DeviceAction.Read associated with the attribute

WriteAction

the DeviceAction.Write associated with the attribute

initialValue

the initial ByteArray value of the attribute

emitNewAction

method to call when a new DeviceConnectionManager.Event.AddAction event should take place

parentLogTag

the log tag used to modify the log tag of this attribute

logger

the Logger to use for logging.

Inheritors

Characteristic

Descriptor

Constructors

Attribute

constructor(initialValue: ByteArray? = null, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit, parentLogTag: String, logger: Logger)

Properties

uuid

abstract val uuid: UUID

The UUID of the attribute

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<ByteArray?>): 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

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]

readValue

fun readValue(): ReadAction

Creates and emits a ReadAction

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

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

updateValue

open fun updateValue()

Notifies the attribute that a new value may be available

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

writeValue

fun writeValue(newValue: ByteArray): WriteAction

Creates and emits a WriteAction to write a given ByteArray