com.reelyactive.blesdk.support.ble

Class BluetoothLeScannerCompat

java.lang.Object

com.reelyactive.blesdk.support.ble.BluetoothLeScannerCompat

public abstract class BluetoothLeScannerCompat
extends java.lang.Object

Represents the public entry into the Bluetooth LE compatibility scanner that efficiently captures advertising packets broadcast from Bluetooth LE devices.

API declarations in this class are the same as the new LE scanning API that is being introduced in Android "L" platform. Declarations contained here will eventually be replaced by the platform versions. Refer to the "L" release API design for further information.

The API implemented here is for compatibility when used on Build.VERSION_CODES.JELLY_BEAN_MR2 and later.

See Also:

Bluetooth Adopted Specifications, Core Specification Supplement (CSS) v4

Field Summary

Fields

Modifier and Type	Field and Description
protected long	scanLostOverrideMillis

Constructor Summary

Constructors

Constructor and Description
BluetoothLeScannerCompat()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract android.app.PendingIntent	getAlarmIntent()
protected abstract android.app.AlarmManager	getAlarmManager()
protected abstract Clock	getClock()
protected abstract int	getMaxPriorityScanMode()
protected abstract boolean	hasClients()
protected abstract void	onNewScanCycle()
void	setCustomScanTiming(int scanMillis, int idleMillis, long serialScanDurationMillis) Sets the Bluetooth LE scan cycle overriding values set on individual scans from ScanSettings.
void	setScanLostOverride(long lostOverrideMillis) Sets the delay after which a device will be marked as lost if it hasn't been sighted within the given time.
protected void	setScanMode(int scanMode) Sets parameters for the various scan modes
abstract boolean	startScan(java.util.List<ScanFilter> filters, ScanSettings settings, ScanCallback callback) Starts a scan for Bluetooth LE devices, looking for device advertisements that match the given filters.
void	startScan(ScanCallback callback) Start Bluetooth LE scan with default parameters and no filters.
abstract void	stopScan(ScanCallback callback) Stops an ongoing Bluetooth LE device scan.
protected void	updateRepeatingAlarm() Update the repeating alarm wake-up based on the period defined for the scanner If there are no clients, or a batch scan running, it will cancel the alarm.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scanLostOverrideMillis

protected long scanLostOverrideMillis

Constructor Detail

BluetoothLeScannerCompat

public BluetoothLeScannerCompat()

Method Detail

startScan

public void startScan(ScanCallback callback)

Start Bluetooth LE scan with default parameters and no filters. The scan results will be delivered through callback.

Requires Manifest.permission.BLUETOOTH_ADMIN permission.

Parameters:

callback - Callback used to deliver scan results.

Throws:

java.lang.IllegalArgumentException - If callback is null.

startScan

public abstract boolean startScan(java.util.List<ScanFilter> filters,
                ScanSettings settings,
                ScanCallback callback)

Starts a scan for Bluetooth LE devices, looking for device advertisements that match the given filters. Attempts to start scans more than once with the same com.reelyactive.blesdk.support.ble.ScanCallback instance will fail and return false.

Due to the resource limitations in BLE chipset, an app cannot add more than N(real number TBD) filters.

Once the controller storage reaches its limitation on scan filters, the framework will try to merge the existing scan filters and set the merged filters to chipset. The framework will need to keep a copy of the original scan filters to make sure each app gets only its desired results.

The callback will be invoked when LE scan finds a matching BLE advertising packet. A BLE advertising record is considered matching the filters if it matches any of the BluetoothLeScanFilter in the list.

Results of the scan are reported using the onResult(List) callback.

Requires BLUETOOTH_ADMIN permission.

Returns:

true if the scan starts successfully, false otherwise.

stopScan

public abstract void stopScan(ScanCallback callback)

Stops an ongoing Bluetooth LE device scan.

Requires BLUETOOTH_ADMIN permission.

Parameters:

callback -

setCustomScanTiming

public void setCustomScanTiming(int scanMillis,
                       int idleMillis,
                       long serialScanDurationMillis)

Sets the Bluetooth LE scan cycle overriding values set on individual scans from ScanSettings.

This is an extension of the "L" Platform API.

Parameters:

scanMillis - duration in milliseconds for the scan to be active, or -1 to remove, 0 to pause. Ignored by hardware and truncated batch scanners.

idleMillis - duration in milliseconds for the scan to be idle. Ignored by hardware and truncated batch scanners.

serialScanDurationMillis - duration in milliseconds of the on-demand serial scan launched opportunistically by the truncated batch mode scanner. Ignored by non-truncated scanners.

setScanLostOverride

public void setScanLostOverride(long lostOverrideMillis)

Sets the delay after which a device will be marked as lost if it hasn't been sighted within the given time. Set to a negative value to allow default behaviour.

updateRepeatingAlarm

protected void updateRepeatingAlarm()

Update the repeating alarm wake-up based on the period defined for the scanner If there are no clients, or a batch scan running, it will cancel the alarm.

setScanMode

protected void setScanMode(int scanMode)

Sets parameters for the various scan modes

Parameters:

scanMode - the ScanMode in BluetoothLeScanner Settings

getClock

protected abstract Clock getClock()

getMaxPriorityScanMode

protected abstract int getMaxPriorityScanMode()

hasClients

protected abstract boolean hasClients()

getAlarmManager

protected abstract android.app.AlarmManager getAlarmManager()

getAlarmIntent

protected abstract android.app.PendingIntent getAlarmIntent()

onNewScanCycle

protected abstract void onNewScanCycle()