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 current state of the peripheral as a state flow.

Functions

awaitDisconnection

@IgnorableReturnValue

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

Suspends until the peripheral is disconnected.

currentMtu

protected open fun currentMtu(): Int

Returns the current ATT MTU.

open fun <C : Log.Category> Log.Sink<C>.d(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.d(category: C, throwable: Throwable?, message: () -> String)

debug

open fun <C : Log.Category> Log.Sink<C>.debug(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.debug(category: C, throwable: Throwable?, message: () -> String)

disconnect

suspend fun disconnect()

Disconnects the client from the peripheral.

open fun <C : Log.Category> Log.Sink<C>.e(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.e(category: C, throwable: Throwable?, message: () -> String)

equals

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

error

open fun <C : Log.Category> Log.Sink<C>.error(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.error(category: C, throwable: Throwable?, message: () -> String)

hashCode

open override fun hashCode(): Int

open fun <C : Log.Category> Log.Sink<C>.i(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.i(category: C, throwable: Throwable?, message: () -> String)

info

open fun <C : Log.Category> Log.Sink<C>.info(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.info(category: C, throwable: Throwable?, message: () -> String)

log

open override fun <C : Log.Category> Log.Sink<C>.log(category: C, level: Log.Level, throwable: Throwable)

open override fun <C : Log.Category> Log.Sink<C>.log(category: C, level: Log.Level, throwable: Throwable?, message: () -> String)

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(profile: Profile, required: Boolean = true)

fun profile(scope: CoroutineScope, profile: Profile, required: Boolean = true)

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

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

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

suspend fun profile(serviceUuid: Uuid, required: Boolean = true, name: String? = null, block: suspend CoroutineScope.(ProfileServices<RemoteService>) -> Unit)

fun profile(scope: CoroutineScope, serviceUuid: Uuid, required: Boolean = true, name: String? = null, block: suspend CoroutineScope.(ProfileServices<RemoteService>) -> Unit)

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

readRssi

suspend fun readRssi(): Int

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

Relay

open override fun <C : Log.Category> Relay(sink: () -> Log.Sink<C>?): Log.Sink<C>

runCatchingOnConnection

protected suspend fun runCatchingOnConnection(block: suspend () -> Unit): Boolean

Executes the given block when the peripheral is connected.

services

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

Returns a flow emitting RemoteServices events.

open fun <C : Log.Category> Log.Sink<C>.t(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.t(category: C, throwable: Throwable?, message: () -> String)

toString

open override fun toString(): String

trace

open fun <C : Log.Category> Log.Sink<C>.trace(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.trace(category: C, throwable: Throwable?, message: () -> String)

open fun <C : Log.Category> Log.Sink<C>.v(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.v(category: C, throwable: Throwable?, message: () -> String)

verbose

open fun <C : Log.Category> Log.Sink<C>.verbose(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.verbose(category: C, throwable: Throwable?, message: () -> String)

open fun <C : Log.Category> Log.Sink<C>.w(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.w(category: C, throwable: Throwable?, message: () -> String)

warn

open fun <C : Log.Category> Log.Sink<C>.warn(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.warn(category: C, throwable: Throwable?, message: () -> String)