client-core/no.nordicsemi.kotlin.ble.client/RemoteCharacteristic

RemoteCharacteristic

interface RemoteCharacteristic : Characteristic<RemoteDescriptor>

A GATT characteristic of a service on a remote connected peripheral device.

The API allows to access the value of the characteristic.

Depending on the properties of the characteristic, it may be possible to read, write, subscribe for value changes, etc.

Properties

abstract val descriptors: List<RemoteDescriptor>

abstract val instanceId: Int

abstract val isNotifying: Boolean

Returns whether the characteristic is notifying or indicating.

open override val owner: Peripheral<*, *>?

abstract val properties: Set<CharacteristicProperty>

abstract override val service: AnyRemoteService

abstract val uuid: Uuid

Functions

open fun isReadable(): Boolean

open fun isSubscribable(): Boolean

open fun isWritable(): Boolean

abstract suspend fun read(): ByteArray

Reads the value of the characteristic.

abstract suspend fun setNotifying(enabled: Boolean)

Enables notifications or indications, depending on the characteristic's properties.

abstract fun subscribe(onSubscription: suspend RemoteCharacteristic.() -> Unit = {}): Flow<ByteArray>

Subscribes for notifications or indications of the characteristic.

waitForValueChange

abstract suspend fun waitForValueChange(rawDataFilter: (ByteArray) -> Boolean = { true }, merge: suspend (accumulator: ByteArray, received: ByteArray, index: Int) -> MergeResult = { _, rec, _ -> MergeResult.Completed(rec) }, filter: (ByteArray) -> Boolean = { true }, trigger: suspend RemoteCharacteristic.() -> Unit = {}): ByteArray

Waits for the value of the characteristic to change.

abstract suspend fun write(data: ByteArray, writeType: WriteType = properties.defaultWriteType ?: WriteType.WITH_RESPONSE)

Writes the value of the characteristic.