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

Package-level declarations

Common types and interfaces for Bluetooth Low Energy clients.

Types

AdvertisingData

interface AdvertisingData

Advertising Data represents the data found in the Advertisement Packet and Scan Response combined.

AnyRemoteService

sealed interface AnyRemoteService : AnyService<RemoteCharacteristic>

A GATT service on a remote connected peripheral device.

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.

MonitoringEvent

sealed class MonitoringEvent>(val peripheral: P)

An event indicating that the scanning device entered region of the monitored peripheral.

Peripheral

abstract class Peripheral<ID : Any, EX : Peripheral.Executor<ID>>(scope: CoroutineScope, impl: EX) : Peer<ID>

Class representing a Bluetooth LE peripheral.

PeripheralEnteredRange

class PeripheralEnteredRange>(peripheral: P) : MonitoringEvent

An event indicating that the scanning device entered region of the monitored peripheral.

PeripheralLeftRange

class PeripheralLeftRange>(peripheral: P) : MonitoringEvent

An event indicating that the scanning device left region of the monitored peripheral and no advertising packets were received.

Profile

sealed class Profile(requiredServiceUuids: List<Uuid>, optionalServiceUuids: List<Uuid> = emptyList(), val name: String? = null)

A class representing a Bluetooth LE profile.

ProfileServices

sealed class ProfileServices<out T>

The outcome of resolving a profile's services on a peripheral, passed to the block parameter of Peripheral.profile.

ProximityChanged

class ProximityChanged>(peripheral: P, val previousProximity: ProximityChanged.Proximity, val proximity: ProximityChanged.Proximity) : RangeEvent

An event indicating that the proximity of the peripheral has changed.

RangeEvent

sealed class RangeEvent>(val peripheral: P)

An event indicating ranging events for the peripheral.

RemoteCharacteristic

interface RemoteCharacteristic : Characteristic<RemoteDescriptor>

A GATT characteristic of a service on a remote connected peripheral device.

RemoteDescriptor

interface RemoteDescriptor : Descriptor

A GATT descriptor of a characteristic on a remote connected peripheral device.

RemoteIncludedService

interface RemoteIncludedService : IncludedService<RemoteCharacteristic> , AnyRemoteService

A GATT service that is included in another service on a remote connected peripheral device.

RemoteService

abstract class RemoteService : PrimaryService<RemoteCharacteristic> , AnyRemoteService

A GATT service on a remote connected peripheral device.

RemoteServices

sealed class RemoteServices

State of the service discovery process.

ScanResult

interface ScanResult, AD : AdvertisingData>

A Scan Result represents a single advertisement found during the scan.

Functions

distinctByPeripheral

fun <ID : Any, P : Peripheral<ID, *>, SR : ScanResult<P, *>> Flow<SR>.distinctByPeripheral(): Flow<SR>

A flow which emits only one (first found) Scan Result from each discovered peripheral.