core-ble/org.meshtastic.core.ble/BleConnection

BleConnection

Encapsulates a BLE connection to a BleDevice.

Inheritors

Properties

abstract val connectionState: StateFlow<BleConnectionState>

A flow of BleConnectionState changes. StateFlow semantics ensure the latest state is always observable and distinct-equals deduplication avoids spurious re-emissions.

device

abstract val device: BleDevice?

The currently connected BleDevice, or null if not connected.

deviceFlow

abstract val deviceFlow: StateFlow<BleDevice?>

A flow of the current device. StateFlow semantics: replays the latest value to new collectors and conflates rapid updates.

Functions

connect

abstract suspend fun connect(device: BleDevice)

Connects to the given BleDevice.

connectAndAwait

abstract suspend fun connectAndAwait(device: BleDevice, timeout: Duration): BleConnectionState

Connects to the given BleDevice and waits for a terminal state or timeout.

disconnect

abstract suspend fun disconnect()

Disconnects from the current device.

maximumWriteValueLength

abstract fun maximumWriteValueLength(writeType: BleWriteType): Int?

Returns the maximum write value length for the given write type, or null if unknown.

profile

abstract suspend fun <T> profile(serviceUuid: Uuid, timeout: Duration = 30.seconds, setup: suspend CoroutineScope.(BleService) -> T): T

Executes setup after the requested BLE profile is available. This is shared by radio, OTA, and DFU flows, so implementations should keep profile-entry setup bounded and avoid transfer-hot-path work here when a caller can reuse an already discovered BleService.

requestBalancedConnectionPriority

open fun requestBalancedConnectionPriority(): Boolean

Requests the platform to return to balanced BLE connection priority (default ~30–50 ms interval). Call after latency-sensitive operations (initial config drain, DFU) to reduce ongoing battery draw. Default implementation returns false for platforms that don't support it.

requestHighConnectionPriority

open fun requestHighConnectionPriority(): Boolean

Asks the platform to switch to a high-throughput / low-latency BLE connection priority for the duration of the connection. Used by latency-sensitive flows like firmware updates. Returns true if the request was issued. Default implementation returns false for platforms that don't support it.