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

descriptors

abstract val descriptors: List<RemoteDescriptor>

instanceId

abstract val instanceId: Int

isNotifying

abstract val isNotifying: Boolean

Returns whether the characteristic is notifying or indicating.

owner

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

properties

abstract val properties: List<CharacteristicProperty>

service

abstract override val service: AnyRemoteService

uuid

abstract val uuid: Uuid

Functions

read

abstract suspend fun read(): ByteArray

Reads the value of the characteristic.

setNotifying

abstract suspend fun setNotifying(enabled: Boolean)

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

abstract suspend fun subscribe(): Flow<ByteArray>

Subscribes for notifications or indications of the characteristic.

waitForValueChange

abstract suspend fun waitForValueChange(): ByteArray

Waits for the value of the characteristic to change.

write

abstract suspend fun write(data: ByteArray, writeType: WriteType)

Writes the value of the characteristic.