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

CentralManager

interface CentralManager : CentralManager<String, Peripheral, Peripheral.Executor, ConjunctionFilterScope, ScanResult>

Android-specific interface of the Central Manager.

This interface extends CentralManager and adds support for bonded devices, connecting and scanning using Android-specific options, and getting peripherals by their MAC addresses.

Types

ConnectionOptions

sealed class ConnectionOptions

Android-specific connection options.

Factory

object Factory

ScanOptions

data class ScanOptions(val mode: ScanMode = ScanMode.LOW_LATENCY, val passive: Boolean = false, val legacyOnly: Boolean = false, val phy: PrimaryPhy? = null)

Android-specific scan options.

Properties

logger

abstract var logger: Log.Sink<Layer>?

state

abstract val state: StateFlow<Manager.State>

Functions

abstract override fun close()

connect

open suspend override fun connect(peripheral: Peripheral)

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

abstract suspend fun connect(peripheral: Peripheral, options: CentralManager.ConnectionOptions)

Establishes Bluetooth LE connection to the peripheral.

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)

getBondedPeripherals

abstract fun getBondedPeripherals(): List<Peripheral>

Returns a list of peripherals for which the system has bond information.

getPeripheralById

open fun getPeripheralById(id: String): Peripheral?

getPeripheralsById

abstract fun getPeripheralsById(ids: List<String>): List<Peripheral>

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, filter: ConjunctionFilterScope.() -> Unit): Flow<MonitoringEvent<Peripheral>>

range

abstract fun range(peripheral: Peripheral, timeout: Duration): Flow<RangeEvent<Peripheral>>

Relay

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

scan

open override fun scan(timeout: Duration, filter: ConjunctionFilterScope.() -> Unit): Flow<ScanResult>

Scans for Bluetooth LE devices using default scan options.

abstract fun scan(timeout: Duration = Duration.INFINITE, options: CentralManager.ScanOptions, filter: ConjunctionFilterScope.() -> Unit = {}): Flow<ScanResult>

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)