client-core/no.nordicsemi.kotlin.ble.client/CentralManager

CentralManager

interface CentralManager<ID : Any, P : Peripheral<ID, EX>, EX : Peripheral.Executor<ID>, F : CentralManager.ScanFilterScope, SR : ScanResult<*, *>> : Manager

A central manager is responsible for scanning, monitoring and connecting to Bluetooth LE devices.

Type Parameters

The type of the peripheral identifier.

The type of the peripheral.

The type of the scan filter scope.

Scan result type.

Types

ScanFilterScope

interface ScanFilterScope

A base interface for scan filter scope.

Properties

logger

abstract var logger: Log.Sink<Layer>?

state

abstract val state: StateFlow<Manager.State>

Functions

abstract override fun close()

Closes the manager and releases its resources.

connect

abstract suspend fun connect(peripheral: P)

Establishes Bluetooth LE connection to the peripheral using default connection options.

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)

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)

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)

getPeripheralById

open fun getPeripheralById(id: ID): P?

A peripheral that the central manager is able to match to the provided identifier.

getPeripheralsById

abstract fun getPeripheralsById(ids: List<ID>): List<P>

A list of peripherals that the central manager is able to match to the provided identifiers.

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 fun <C : Log.Category> Log.Sink<C>.log(category: C, level: Log.Level, throwable: Throwable)

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

monitor

abstract fun monitor(timeout: Duration = Duration.INFINITE, filter: F.() -> Unit): Flow<MonitoringEvent<P>>

Starts monitoring for Bluetooth LE devices.

range

abstract fun range(peripheral: P, timeout: Duration = Duration.INFINITE): Flow<RangeEvent<P>>

Starts ranging for Bluetooth LE devices.

Relay

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

scan

abstract fun scan(timeout: Duration = Duration.INFINITE, filter: F.() -> Unit = {}): Flow<SR>

Scans for Bluetooth LE devices.

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)

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)