ditto/live.ditto.transports.ble

Package-level declarations

Types

AddService

data class AddService(val service: BluetoothGattService) : BleServerOperation

BleClientOperation

sealed class BleClientOperation

Abstract sealed class representing a type of BLE operation

BleServerOperation

sealed class BleServerOperation

Abstract sealed class representing a type of BLE operation

CharacteristicRead

data class CharacteristicRead(val device: BluetoothDevice, val characteristicUuid: UUID) : BleClientOperation

Read the value of a characteristic represented by characteristicUuid

CharacteristicWrite

data class CharacteristicWrite(val device: BluetoothDevice, val characteristicUuid: UUID, val writeType: Int, val payload: ByteArray) : BleClientOperation

Write payload as the value of a characteristic represented by characteristicUuid

CommandQueue

class CommandQueue<T>(handler: Handler, callbacks: CommandQueueCallback<T>, operationTimeout: Long) : ConcurrentLinkedQueue<T>

CommandQueueCallback

abstract class CommandQueueCallback<T>

Connect

data class Connect(val device: BluetoothDevice, val context: Context) : BleClientOperation

Connect to device and perform service discovery

ConnectL2CapSocket

data class ConnectL2CapSocket(val device: BluetoothDevice, val psm: Int) : BleClientOperation

DescriptorRead

data class DescriptorRead(val device: BluetoothDevice, val descriptorUuid: UUID) : BleClientOperation

Read the value of a descriptor represented by descriptorUuid

DescriptorWrite

data class DescriptorWrite(val device: BluetoothDevice, val descriptorUuid: UUID, val payload: ByteArray) : BleClientOperation

Write payload as the value of a descriptor represented by descriptorUuid

DisableNotifications

data class DisableNotifications(val device: BluetoothDevice, val characteristicUuid: UUID) : BleClientOperation

Disable notifications/indications on a characteristic represented by characteristicUuid

Disconnect

data class Disconnect(val device: BluetoothDevice) : BleClientOperation

Disconnect from device and release all connection resources

DisconnectPeripheral

data class DisconnectPeripheral(val device: BluetoothDevice) : BleServerOperation

Disconnect from device and release all connection resources

DittoBluetoothManager

class DittoBluetoothManager(val context: Context, dittoHandleWrapper: DittoHandle, val config: DittoBluetoothLeConfig)

Owns the BluetoothPlatform and references to the Rust-based BLE Client and Server transports. Previously these were long-lived instances but sometimes the Android BLE stack gums up and stops reporting events properly until the app is restarted. The nuclear solution of dropping and recreating the BluetoothPlatform resolves this situation. At the expense of background support, this manager class will track disabled/enabled/background/foreground events and fully stop or start the platform accordingly.

EnableNotifications

data class EnableNotifications(val device: BluetoothDevice, val characteristicUuid: UUID) : BleClientOperation

Enable notifications/indications on a characteristic represented by characteristicUuid

MtuRequest

data class MtuRequest(val device: BluetoothDevice, val mtu: Int) : BleClientOperation

Request for an MTU of mtu

NotifyCharacteristicChanged

data class NotifyCharacteristicChanged(val device: BluetoothDevice, val characteristic: BluetoothGattCharacteristic, val confirm: Boolean, val data: ByteArray) : BleServerOperation

Prefer2MPhy

data class Prefer2MPhy(val device: BluetoothDevice) : BleClientOperation

StartAdvertisingSet

data class StartAdvertisingSet(val adSetParams: AdvertisingSetParameters, val advertisingData: AdvertiseData, val scanResponse: AdvertiseData) : BleServerOperation

StartLegacyAdvertising

data class StartLegacyAdvertising(val adSettings: AdvertiseSettings, val advertisingData: AdvertiseData, val scanResponse: AdvertiseData) : BleServerOperation

Properties

CCC_DESCRIPTOR_UUID

val CCC_DESCRIPTOR_UUID: UUID

UUID of the Client Characteristic Configuration Descriptor (0x2902).

CHAR_UUID_ANNOUNCE

val CHAR_UUID_ANNOUNCE: UUID

CHAR_UUID_CONTROL_READ

val CHAR_UUID_CONTROL_READ: UUID

CHAR_UUID_CONTROL_WRITE

val CHAR_UUID_CONTROL_WRITE: UUID

CHAR_UUID_PSM

val CHAR_UUID_PSM: UUID

CHAR_UUID_READ

val CHAR_UUID_READ: UUID

CHAR_UUID_WRITE

val CHAR_UUID_WRITE: UUID

WRITE_DELAY_MS

const val WRITE_DELAY_MS: Long = 5

Functions

computeIfPresentCompat

fun <K, V> ConcurrentHashMap<K, V>.computeIfPresentCompat(key: K & Any, computation: (K, V) -> V?)

containsPermission

fun BluetoothGattDescriptor.containsPermission(permission: Int): Boolean

containsProperty

fun BluetoothGattCharacteristic.containsProperty(property: Int): Boolean

findCharacteristic

fun BluetoothGatt.findCharacteristic(uuid: UUID): BluetoothGattCharacteristic?

findDescriptor

fun BluetoothGatt.findDescriptor(uuid: UUID): BluetoothGattDescriptor?

isCccd

fun BluetoothGattDescriptor.isCccd(): Boolean

Convenience extension function that returns true if this BluetoothGattDescriptor is a Client Characteristic Configuration Descriptor.

isIndicatable

fun BluetoothGattCharacteristic.isIndicatable(): Boolean

isNotifiable

fun BluetoothGattCharacteristic.isNotifiable(): Boolean

isReadable

fun BluetoothGattCharacteristic.isReadable(): Boolean

fun BluetoothGattDescriptor.isReadable(): Boolean

isWritable

fun BluetoothGattCharacteristic.isWritable(): Boolean

fun BluetoothGattDescriptor.isWritable(): Boolean

isWritableWithoutResponse

fun BluetoothGattCharacteristic.isWritableWithoutResponse(): Boolean

notifyCharacteristicChangedCompat

fun BluetoothGattServer.notifyCharacteristicChangedCompat(device: BluetoothDevice, characteristic: BluetoothGattCharacteristic, confirm: Boolean, value: ByteArray): Int

printProperties

fun BluetoothGattDescriptor.printProperties(): String

removeIfCompat

fun <E> ConcurrentLinkedQueue<E>.removeIfCompat(filter: (E) -> Boolean)

toAddressBytes

fun String.toAddressBytes(): ByteArray

Android identifies remote devices by MAC address, whereas iOS uses a UUID. The cross-platform code uses 16-byte values to handle full-size UUIDs directly. On Android we expand a MAC address into 16 bytes.

toAddressString

fun ByteArray.toAddressString(): String

Convert a ByteArray representing a MAC address into that MAC address string.

toUuid

fun ByteArray.toUuid(): UUID

fun String.toUuid(): UUID

writeCharacteristicCompat

fun BluetoothGatt.writeCharacteristicCompat(characteristic: BluetoothGattCharacteristic, payload: ByteArray, writeType: Int): Int

writeDescriptorCompat

fun BluetoothGatt.writeDescriptorCompat(descriptor: BluetoothGattDescriptor, payload: ByteArray): Int