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

GattConnectionStateAction

sealed class GattConnectionStateAction

Describes the action the BLE platform should take after receiving an android.bluetooth.BluetoothGattCallback.onConnectionStateChange event.

GattDisconnectAction

sealed class GattDisconnectAction

Describes how to tear down a GATT when the platform or Rust core requests a disconnect.

GattState

object GattState

HexFormat

@ExperimentalStdlibApi

class HexFormat

Represents hexadecimal format options.

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

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.

BLE_STATUS_WRITE_BUSY

const val BLE_STATUS_WRITE_BUSY: Int = 201

Added in API Level 33, equivalent to BluetoothStatusCodes.ERROR_GATT_WRITE_REQUEST_BUSY https://developer.android.com/reference/android/bluetooth/BluetoothStatusCodes#ERROR_GATT_WRITE_REQUEST_BUSY

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.

CHAR_UUID_PSM

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.

CHAR_UUID_READ

val CHAR_UUID_READ: UUID

Characteristic for reading mesh data.

CHAR_UUID_WRITE

val CHAR_UUID_WRITE: UUID

Characteristic for writing mesh data.

GATT_SUCCESS

const val GATT_SUCCESS: Int = 0

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.

findDescriptor

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

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

HexFormat

@ExperimentalStdlibApi

inline fun HexFormat(builderAction: HexFormat.Builder.() -> Unit): HexFormat

Builds a new HexFormat by configuring its format options using the specified builderAction, and returns the resulting format.

hexToByte

@ExperimentalStdlibApi

fun String.hexToByte(format: HexFormat = HexFormat.Default): Byte

Parses a Byte value from this string using the specified format.

hexToByteArray

@ExperimentalStdlibApi

fun String.hexToByteArray(format: HexFormat = HexFormat.Default): ByteArray

Parses bytes from this string using the specified HexFormat.

hexToInt

@ExperimentalStdlibApi

fun String.hexToInt(format: HexFormat = HexFormat.Default): Int

Parses an Int value from this string using the specified format.

hexToLong

@ExperimentalStdlibApi

fun String.hexToLong(format: HexFormat = HexFormat.Default): Long

Parses a Long value from this string using the specified format.

hexToShort

@ExperimentalStdlibApi

fun String.hexToShort(format: HexFormat = HexFormat.Default): Short

Parses a Short value from this string using the specified format.

isCccd

fun BluetoothGattDescriptor.isCccd(): Boolean

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

isDeadSystemException

fun Throwable.isDeadSystemException(): Boolean

Checks if the given Throwable is a DeadSystemRuntimeException or DeadObjectException, which indicates that the Bluetooth system service has died unexpectedly.

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