com.kontakt.sdk.android.ble.configuration

Class ForceScanConfiguration

java.lang.Object

com.kontakt.sdk.android.ble.configuration.ForceScanConfiguration

public class ForceScanConfiguration
extends java.lang.Object

According to the bug no 65863 reported at Android Open Source Project some Android devices perform single scan for each BLE device found. We served this bug by indtroducing configuration which will adjust the performance of the SDK to device that it will be working on. During this mode a Bluetooth Adapter (android.bluetooth.BluetoothAdapter) performs scan restart periodically. There are 2 predefined constants:

• DISABLED - indicates that ForceScanConfiguration should not be enabled because Android device detects BLE devices after single launch
• DEFAULT - provides default ForceScanConfiguration with Active Scan Period equal to 1 s (BLE scan is enabled) and Passive Scan Period 1 s (BLE scan is disabled).

Please note that parameters specified in DEFAULT predefined constant are the lowest possible. Any attempt of setting configuration with lower parameters will be validated with IllegalArgumentException. It is advisable to make SDK-based application configurable per Android device e.g. by allowing changing ForceScanConfiguration parameters in preferences. Ignoring it may cause poor performance of features provided for the SDK.

See Also:

Android Open Source Project - bug no 65863

Field Summary

Fields

Modifier and Type	Field and Description
static ForceScanConfiguration	DISABLED Applying this predefined constant causes scan forcing to be disabled.
static ForceScanConfiguration	MINIMAL Predefined default Force Scan Configuration.

Constructor Summary

Constructors

Constructor and Description
ForceScanConfiguration(long forceScanActivePeriod, long forceScanPassivePeriod) Instantiates a new Force Scan Configuration.

Method Summary

Modifier and Type	Method and Description
long	getForceScanActivePeriod() Provides force scan active period (in milliseconds).
long	getForceScanPassivePeriod() Provides force scan passive period (in milliseconds).

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED

public static final ForceScanConfiguration DISABLED

Applying this predefined constant causes scan forcing to be disabled.

MINIMAL

public static final ForceScanConfiguration MINIMAL

Predefined default Force Scan Configuration. The default Force Scan Configuration contains parameters with following values:

• forceScanActivePeriod is set to 1s. During this period device will be scanning BLE devices. Please note that you cannot specify active period shorter than default one.
• forceScanPassivePeirod is set to 1s. During this period device will not be scanning BLE devices. Please not that you cannot specify passive period shorter than default one.

Constructor Detail

ForceScanConfiguration

public ForceScanConfiguration(long forceScanActivePeriod,
                              long forceScanPassivePeriod)

Instantiates a new Force Scan Configuration.

Parameters:

forceScanActivePeriod - the force scan active period [ms]

forceScanPassivePeriod - the force scan passive period [ms]

Method Detail

getForceScanActivePeriod

public long getForceScanActivePeriod()

Provides force scan active period (in milliseconds).

Returns:

the force scan active period

getForceScanPassivePeriod

public long getForceScanPassivePeriod()

Provides force scan passive period (in milliseconds).

Returns:

the force scan passive period