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.

ConnectionParametersChanged

data class ConnectionParametersChanged(val newParameters: ConnectionParameters) : GattEvent

Event indicating that the connection parameters have changed.

ConnectionStateChanged

data class ConnectionStateChanged(val newState: ConnectionState) : GattEvent

Event indicating that the connection state has changed.

GattEvent

sealed class GattEvent

A base class for all GATT events.

ImplSpecificEvent

open class ImplSpecificEvent : GattEvent

Event type used by implementations.

MonitoringEvent

sealed class MonitoringEvent>

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

MtuChanged

data class MtuChanged(val mtu: Int) : GattEvent

Event indicating that the (Maximum Transfer Unit) MTU has changed.

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.

PhyChanged

data class PhyChanged(val phy: PhyInUse) : GattEvent

Event indicating that the PHY used for the connection has changed.

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>

An event indicating ranging events for the peripheral.

ReliableWriteCompleted

data class ReliableWriteCompleted(val status: OperationStatus) : GattEvent

Event indicating that the Reliable Write procedure have been completed (executed or aborted).

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.

RssiRead

data class RssiRead(val rssi: Int) : GattEvent

Event indicating that the RSSI value has been read.

ScanResult

interface ScanResult, AD : AdvertisingData>

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

ServicesChanged

data object ServicesChanged : GattEvent

Event indicating that the services have changed.

ServicesDiscovered

data class ServicesDiscovered(val services: List<RemoteService>) : GattEvent

Event indicating that the services have changed.

Functions

distinctByPeripheral

fun <ID, 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.