client/no.nordicsemi.android.kotlin.ble.client.main.service/ClientBleGattCharacteristic

ClientBleGattCharacteristic

A helper class which provides operations which can happen on a GATT characteristic. Its main responsibility is to provide write/read/notify features in a synchronous manner, because simultaneous calls will be ignored by Android API.

Properties

descriptors

val descriptors: List<ClientBleGattDescriptor>

instanceId

val instanceId: Int

Instance id of the characteristic.

permissions

val permissions: List<BleGattPermission>

Permissions of the characteristic.

properties

val properties: List<BleGattProperty>

Properties of the characteristic.

uuid

val uuid: UUID

UUID of the characteristic.

Functions

findDescriptor

fun findDescriptor(uuid: UUID): ClientBleGattDescriptor?

Finds a descriptor by UUID.

getNotifications

suspend fun getNotifications(bufferSize: Int = 0, bufferOverflow: BufferOverflow = BufferOverflow.DROP_OLDEST): Flow<DataByteArray>

Enables and observes notifications/indications of the characteristic. After subscriber is closed the notifications should be disabled.

read

@RequiresPermission(value = "android.permission.BLUETOOTH_CONNECT")

suspend fun read(): DataByteArray

Reads value from a characteristic and suspends for the result.

splitWrite

@RequiresPermission(value = "android.permission.BLUETOOTH_CONNECT")

suspend fun splitWrite(value: DataByteArray, writeType: BleWriteType = BleWriteType.DEFAULT)

Writes bytes to a characteristic and waits for a request to finish. If value is bigger than MTU then it splits the value and send it in consecutive messages.

write

@RequiresPermission(value = "android.permission.BLUETOOTH_CONNECT")

suspend fun write(value: DataByteArray, writeType: BleWriteType = BleWriteType.DEFAULT)

Writes bytes to a characteristic and waits for a request to finish.