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

RemoteCharacteristic

open class RemoteCharacteristic : RemoteAttribute<DeviceAction.Read.Characteristic, DeviceAction.Write.Characteristic> , Characteristic

A Characteristic that is accessed remotely by a bluetooth client using BluetoothClient

Constructors

constructor(wrapper: RemoteCharacteristicWrapper, service: RemoteService, emitNewAction: (DeviceConnectionManager.Event.AddAction) -> Unit, logger: Logger)

Constructor

Types

Subscription

class Subscription

A subscription to a com.splendo.kaluga.bluetooth.RemoteCharacteristic. Can be created using RemoteCharacteristic.subscribe if Characteristic.properties contains CharacteristicProperty.Notifiable. Call unsubscribe to remove the subscription. This will automatically stop notification if this is the last remaining subscription to the characteristic.

SubscriptionResult

sealed class SubscriptionResult

Result from calling RemoteCharacteristic.subscribe

Properties

descriptors

open override val descriptors: List<RemoteDescriptor>

The list of RemoteDescriptor available for this characteristic

isNotifying

val isNotifying: StateFlow<Boolean>

If true this characteristic has been set to automatically provide updates to its value

properties

open override val properties: Set<CharacteristicProperty>

service

open override val service: RemoteService

uuid

open override val uuid: UUID

wrapper

val wrapper: RemoteCharacteristicWrapper

Functions

disableNotification

suspend fun disableNotification(): GattResponse.WriteResponse

Disables notification or indication for this com.splendo.kaluga.bluetooth.RemoteCharacteristic

enableNotification

suspend fun enableNotification(): GattResponse.WriteResponse

Enables notification or indication for this RemoteCharacteristic.

hasProperty

fun hasProperty(property: CharacteristicProperty): Boolean

Checks if the characteristic has a given CharacteristicProperty

read

suspend fun read(): GattResponse.ReadResponse

Requests a read of the value of the attribute from the device and suspends until the value is received.

inline suspend fun <T> read(bluetoothFormat: BluetoothFormat = BluetoothFormat): T

suspend fun <T> read(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): T

Requests a read of the a value of T of the attribute from the device and suspends until the value is received.

readOrNull

inline suspend fun <T> readOrNull(bluetoothFormat: BluetoothFormat = BluetoothFormat): T?

suspend fun <T> readOrNull(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): T?

Requests a read of the a value of T of the attribute from the device and suspends until the value is received.

startDisableNotification

fun startDisableNotification(): DeviceAction.Notification.Disable?

Starts disabling notification or indication for this com.splendo.kaluga.bluetooth.RemoteCharacteristic

startEnableNotification

fun startEnableNotification(): DeviceAction.Notification.Enable?

Starts to enable notification or indication for this RemoteCharacteristic.

startRead

fun startRead(): DeviceAction.Read.Characteristic

Creates and emits a ReadAction

startWrite

fun startWrite(newValue: ByteArray): DeviceAction.Write.Characteristic

Creates and emits a WriteAction to write a given ByteArray

inline fun <T> startWrite(bluetoothFormat: BluetoothFormat = BluetoothFormat, newValue: T): DeviceAction.Write.Characteristic

fun <T> startWrite(serializationStrategy: SerializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat, newValue: T): DeviceAction.Write.Characteristic

Creates and emits a WriteAction to write a given T

suspend fun subscribe(onUpdate: (ByteArray) -> Unit): RemoteCharacteristic.SubscriptionResult

inline suspend fun <T> subscribe(bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onUpdate: (T) -> Unit): RemoteCharacteristic.SubscriptionResult

suspend fun <T> subscribe(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat, onUpdate: (T) -> Unit): RemoteCharacteristic.SubscriptionResult

Attempts to subscribe to the characteristic.

value

fun RemoteCharacteristic.value(): Flow<ByteArray>

Gets a (Flow of) the ByteArray value from a RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

inline fun <T> RemoteCharacteristic.value(bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

fun <T> RemoteCharacteristic.value(deserializationStrategy: DeserializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat): Flow<T>

Gets a (Flow of) T value from a RemoteCharacteristic This method will automatically subscribe/unsubscribe to the RemoteCharacteristic when the Flow is collected

write

suspend fun write(newValue: ByteArray): GattResponse.WriteResponse

Attempts to write a ByteArray to the attribute on the device and suspends until the write completes.

inline suspend fun <T> write(bluetoothFormat: BluetoothFormat = BluetoothFormat, newValue: T): GattResponse.WriteResponse

suspend fun <T> write(serializationStrategy: SerializationStrategy<T>, bluetoothFormat: BluetoothFormat = BluetoothFormat, newValue: T): GattResponse.WriteResponse

Attempts to write a value of T to the attribute on the device and suspends until the write completes.