The friendly Bluetooth name of the remote device. The local adapter will automatically retrieve remote names when performing a device scan, and will cache them. This method just returns the name for this device from the cache

state

val state: StateFlow<ConnectionState>

The connection state of the peripheral, as StateFlow. The flow emits a new value whenever the state of the peripheral changes.

Functions

awaitDisconnection

@IgnorableReturnValue

suspend fun awaitDisconnection(): ConnectionState.Disconnected.Reason?

Suspends until the peripheral is disconnected.

disconnect

suspend fun disconnect()

Disconnects the client from the peripheral.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

maximumWriteValueLength

abstract fun maximumWriteValueLength(type: WriteType): Int

The maximum amount of data, in bytes, that can be sent to a characteristic in a single write operation.

profile

suspend fun profile(serviceUuid: Uuid, required: Boolean = true, block: suspend CoroutineScope.(RemoteService) -> Unit)

fun profile(serviceUuid: Uuid, required: Boolean = true, scope: CoroutineScope, block: suspend CoroutineScope.(RemoteService) -> Unit)

Registers a profile implementation that runs when the specified GATT service is discovered.

suspend fun profile(requiredServiceUuids: List<Uuid>, optionalServiceUuids: List<Uuid> = emptyList(), required: Boolean = true, block: suspend CoroutineScope.(List<RemoteService>) -> Unit)

fun profile(requiredServiceUuids: List<Uuid>, optionalServiceUuids: List<Uuid> = emptyList(), required: Boolean = true, scope: CoroutineScope, block: suspend CoroutineScope.(List<RemoteService>) -> Unit)

Registers a profile implementation that runs when the specified GATT services are discovered.

readRssi

suspend fun readRssi(): Int

Reads the received signal strength indicator (RSSI) of the peripheral.

services

fun services(uuids: List<Uuid> = emptyList()): StateFlow<RemoteServices>

Returns a flow emitting RemoteServices events.

toString

open override fun toString(): String