core/no.nordicsemi.android.kotlin.ble.core.scanner

Package-level declarations

Types

AdvertisingDataTypeWithData

data class AdvertisingDataTypeWithData(val type: BleType, val advertisingData: DataByteArray, val mask: DataByteArray)

Set filter on advertising data with specific advertising data type.

BleGattPrimaryPhy

@RequiresApi(value = 26)

enum BleGattPrimaryPhy : Enum<BleGattPrimaryPhy>

Returns the primary Physical Layer on which this advertisment was received.

BleNumOfMatches

@RequiresApi(value = 23)

enum BleNumOfMatches : Enum<BleNumOfMatches>

Sets the number of matches for Bluetooth LE scan filters hardware match.

BleScanDataStatus

@RequiresApi(value = 26)

enum BleScanDataStatus : Enum<BleScanDataStatus>

The data status.

BleScanFilter

data class BleScanFilter(val type: BleType? = null, val typeWithData: AdvertisingDataTypeWithData? = null, val deviceAddress: String? = null, val deviceName: String? = null, val manufacturerData: FilteredManufacturerData? = null, val serviceData: FilteredServiceData? = null, val serviceSolicitationUuid: FilteredServiceSolicitationUuid? = null, val serviceUuid: FilteredServiceUuid? = null)

BLE scanner filter. It is used to filter BleScanResult obtained from BleScanner.

BleScanMode

enum BleScanMode : Enum<BleScanMode>

Enum class representing available scan modes for BLE scanning.

BleScannerCallbackType

enum BleScannerCallbackType : Enum<BleScannerCallbackType>

Defines callback type for Bluetooth LE scan.

BleScannerMatchMode

@RequiresApi(value = 23)

enum BleScannerMatchMode : Enum<BleScannerMatchMode>

Set match mode (BleScannerMatchMode) for Bluetooth LE scan filters hardware match.

BleScannerPhy

@RequiresApi(value = 26)

enum BleScannerPhy : Enum<BleScannerPhy>

Set the Physical Layer to use during this scan.

BleScannerSettings

data class BleScannerSettings(val scanMode: BleScanMode = BleScanMode.SCAN_MODE_LOW_POWER, val reportDelay: Long = 0, val includeStoredBondedDevices: Boolean = true, val callbackType: BleScannerCallbackType = BleScannerCallbackType.CALLBACK_TYPE_ALL_MATCHES, val numOfMatches: BleNumOfMatches? = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { BleNumOfMatches.MATCH_NUM_MAX_ADVERTISEMENT } else { null }, val matchMode: BleScannerMatchMode? = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { BleScannerMatchMode.MATCH_MODE_AGGRESSIVE } else { null }, val legacy: Boolean = false, val phy: BleScannerPhy? = null)

Data class that offers configuration parameters for a scanner.

BleScanRecord

data class BleScanRecord(val advertiseFlag: Int, val serviceUuids: List<ParcelUuid>?, val serviceData: Map<ParcelUuid, DataByteArray>, val serviceSolicitationUuids: List<ParcelUuid>, val deviceName: String?, val txPowerLevel: Int?, val bytes: DataByteArray? = null, val manufacturerSpecificData: SparseArray<DataByteArray>) : Parcelable

Represents a scan record from Bluetooth LE scan.

BleScanResult

data class BleScanResult(val device: ServerDevice, val data: BleScanResultData? = null)

Class containing a scan result grouped with an advertising device.

BleScanResultData

data class BleScanResultData(val rssi: Int, val timestampNanos: Long, val scanRecord: BleScanRecord?, val advertisingSid: Int? = null, val primaryPhy: BleGattPrimaryPhy? = null, val secondaryPhy: BleGattPhy? = null, val txPower: Int? = null, val periodicAdvertisingInterval: Int? = null, val isLegacy: Boolean? = null, val isConnectable: Boolean? = null, val dataStatus: BleScanDataStatus? = null) : Parcelable

ScanResult for Bluetooth LE scan.

BleScanResults

data class BleScanResults(val device: ServerDevice, val scanResult: List<BleScanResultData> = emptyList()) : Parcelable

Class containing all scan results grouped with an advertising device.

FilteredManufacturerData

data class FilteredManufacturerData(val id: Int, val data: DataByteArray, val mask: DataByteArray? = null)

A helper class which groups manufacturer id and it's data.

FilteredServiceData

data class FilteredServiceData(val uuid: ParcelUuid, val data: DataByteArray, val mask: DataByteArray? = null)

A helper class which groups service id, it's data and mask. Used as a scanning filter.

FilteredServiceSolicitationUuid

data class FilteredServiceSolicitationUuid(val uuid: ParcelUuid, val mask: ParcelUuid? = null)

Set filter on partial service Solicitation uuid.

FilteredServiceUuid

data class FilteredServiceUuid(val uuid: ParcelUuid, val mask: ParcelUuid? = null)

Filter on service uuid.