ditto/live.ditto.transports.ble

Package-level declarations

Types

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

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

CommandQueueCallback

abstract class CommandQueueCallback<T>

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

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

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 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

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

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

BLE_STATUS_ERR_UNKNOWN

const val BLE_STATUS_ERR_UNKNOWN: Int = 2147483647

Added in API Level 31, equivalent to BluetoothStatusCodes.ERROR_UNKNOWN or Integer.MAX_VALUE.

BLE_STATUS_SUCCESS

const val BLE_STATUS_SUCCESS: Int = 0

Added in API Level 31, equivalent to BluetoothStatusCodes.SUCCESS.

CCC_DESCRIPTOR_UUID

val CCC_DESCRIPTOR_UUID: UUID

UUID of the Client Characteristic Configuration Descriptor (CCCD, 0x2902). This is used to enable notifications or indications in BLE.

CHAR_UUID_ANNOUNCE

val CHAR_UUID_ANNOUNCE: UUID

Characteristic for writing an announce string. This is used by the central to notify the peripheral that the connection is ready.

CHAR_UUID_CONTROL_READ

val CHAR_UUID_CONTROL_READ: UUID

Characteristic for reading control data.

CHAR_UUID_CONTROL_WRITE

val CHAR_UUID_CONTROL_WRITE: UUID

Characteristic for writing control data.

val CHAR_UUID_PSM: UUID

Characteristic for reading L2CAP PSM. This is needed by the central to connect to the L2CAP socket that the peripheral is listening on.

val CHAR_UUID_READ: UUID

Characteristic for reading mesh data.

CHAR_UUID_WRITE

val CHAR_UUID_WRITE: UUID

Characteristic for writing mesh data.

MAC_ADDRESS_FORMAT

val MAC_ADDRESS_FORMAT: HexFormat

Functions

computeIfPresentCompat

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

Wraps ConcurrentHashMap.computeIfPresent in an SDK version agnostic API.

containsPermission

fun BluetoothGattDescriptor.containsPermission(permission: Int): Boolean

Check if a BluetoothGattDescriptor has a property bit flag.

containsProperty

fun BluetoothGattCharacteristic.containsProperty(property: Int): Boolean

Check if a BluetoothGattCharacteristic has a property bit flag.

findCharacteristic

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

Returns the first BluetoothGattCharacteristic with the given UUID, if any.

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

Returns the first BluetoothGattDescriptor with the given UUID, if any.

fun BluetoothGattDescriptor.isCccd(): Boolean

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

fun BluetoothGattCharacteristic.isIndicatable(): Boolean

fun BluetoothGattCharacteristic.isNotifiable(): Boolean

fun BluetoothGattCharacteristic.isReadable(): Boolean

fun BluetoothGattDescriptor.isReadable(): Boolean

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

Wraps BluetoothGattServer.notifyCharacteristicChanged in an SDK version agnostic API.

printProperties

fun BluetoothGattDescriptor.printProperties(): String

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

Wraps ConcurrentLinkedQueue.removeIfCompat in an SDK version agnostic API.

fun String.toAddressBytes(): ByteArray

Convert a MAC address String into a UUID byte array.

toAddressString

fun ByteArray.toAddressString(): String

Convert a ByteArray representing a MAC address into a String.

fun ByteArray.toUuid(): UUID

Convert a ByteArray representing a UUID into a UUID.

fun String.toUuid(): UUID

Convenience function for converting a String into a UUID.

writeCharacteristicCompat

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

Wraps BluetoothGatt.writeCharacteristic in an SDK version agnostic API.

writeDescriptorCompat

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

Wraps BluetoothGatt.writeDescriptor in an SDK version agnostic API.