kmmbeacons/com.nextome.kmmbeacons/KmmBeacons

KmmBeacons

class KmmBeacons

Constructors

Link copied to clipboard
fun KmmBeacons()

Functions

Link copied to clipboard
fun observeErrors(): CFlow<Exception>

Listen for errors during scans;

Link copied to clipboard
fun observeNonBeacons(): CFlow<List<KScanRecord>>

Observe non-Beacon BLE Devices raw data. On iOS, this always returns an empty list due to OS restrictions. Results with be delivered according times set with setScanPeriod and setBetweenScanPeriod.

Link copied to clipboard
fun observeResults(): CFlow<List<KScanResult>>

Observe the scan results. Note that results will be delivered each scanPeriod + betweenScanPeriod time. It is possible to adjust delivery time with setScanPeriod and setBetweenScanPeriod.

Link copied to clipboard
fun setAndroidRegions(regions: List<KScanRegion>)

Sets given regions for Android devices. If no region is provided, Android will return beacons with all UUIDS.

Link copied to clipboard
fun setBetweenScanPeriod(betweenScanPeriod: Long)

Sets the time between each bluetooth scan with the given betweenScanPeriod in millis.

Link copied to clipboard
fun setIosRegions(regions: List<KScanRegion>)

Sets given regions for iOS devices. iOS scanning needs regions to be defined to recognize beacons with the given uuid. If no region is provided, iOS scan will not recognize any beacons.

Link copied to clipboard
fun setRssiThreshold(value: Int)

Filter beacons (and non beacons) which have an RSSI value below value.

Link copied to clipboard
fun setScanPeriod(scanPeriod: Long)

Sets the time of each bluetooth scan with the given scanPeriod in millis.

Link copied to clipboard
fun startScan()

Starts beacon scanning.

Link copied to clipboard
fun stopScan()

Stops beacon scanning.