scanner-ble/no.nordicsemi.android.common.scanner.data

Package-level declarations

Data models for customizing the scanner.

This package provides the data models used by the scanner, along with a set of predefined Filters and SortingOptions. These allow for custom filtering logic based on device names, proximity (RSSI), or service UUIDs, and sorting based on name or signal strength.

Types

CustomFilter

class CustomFilter(@StringRes title: Int, @DrawableRes icon: Int = R.drawable.baseline_check_24, isInitiallySelected: Boolean = false, predicate: (selected: Boolean, result: ScanResult, highestRssi: Int) -> Boolean) : Filter

Custom filter.

CustomSorting

class CustomSorting(@StringRes title: Int, comparator: Comparator<ScannedPeripheral>) : SortingOption

Sort results using a custom comparator.

Filter

sealed class Filter

OnlyNearby

class OnlyNearby(rssiThreshold: Int = -50, @StringRes title: Int = R.string.filter_only_nearby, isInitiallySelected: Boolean = false) : Filter

Filter nearby devices based on RSSI value.

OnlyWithNames

class OnlyWithNames(@StringRes title: Int = R.string.filter_only_with_names, isInitiallySelected: Boolean = false) : Filter

Filter that allows scan results with no empty names.

ScannedPeripheral

data class ScannedPeripheral(val peripheral: Peripheral, var latestScanResult: ScanResult, var highestRssi: Int)

A record containing information about a scanned peripheral.

SortByName

class SortByName(@StringRes title: Int = R.string.sort_by_alphabetical) : SortingOption

Sort results alphabetically by device name.

SortByRssi

class SortByRssi(@StringRes title: Int = R.string.sort_by_rssi) : SortingOption

Sort results by highest RSSI value.

SortingDisabled

data object SortingDisabled : SortingOption

Sort results by first found order.

SortingOption

sealed class SortingOption

WithServiceUuid

class WithServiceUuid(uuid: Uuid, @DrawableRes icon: Int = R.drawable.baseline_check_24, @StringRes title: Int = R.string.filter_with_service_uuid, isInitiallySelected: Boolean = false) : Filter

Filter devices based on a Service UUID.