BluetoothLEAdvertisementWatcherTrigger.SignalStrengthFilter Property

Definition

Namespace:

Windows.ApplicationModel.Background

Gets or sets the configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

public:
 property BluetoothSignalStrengthFilter ^ SignalStrengthFilter { BluetoothSignalStrengthFilter ^ get(); void set(BluetoothSignalStrengthFilter ^ value); };

BluetoothSignalStrengthFilter SignalStrengthFilter();

void SignalStrengthFilter(BluetoothSignalStrengthFilter value);

public BluetoothSignalStrengthFilter SignalStrengthFilter { get; set; }

var bluetoothSignalStrengthFilter = bluetoothLEAdvertisementWatcherTrigger.signalStrengthFilter;
bluetoothLEAdvertisementWatcherTrigger.signalStrengthFilter = bluetoothSignalStrengthFilter;

Public Property SignalStrengthFilter As BluetoothSignalStrengthFilter

Property Value

BluetoothSignalStrengthFilter

The configuration of Bluetooth LE advertisement filtering that uses signal strength-based filtering.

Remarks

The SignalStrengthFilter has additional limitations on its properties when used by the BluetoothLEAdvertisementWatcherTrigger class. The trigger will fail to register if it contains parameters outside of the valid range. If the properties are left as NULL, a default value is selected.

The additional restrictions and default values are as follows:

• InRangeThresholdInDBm: The maximum value for RSSI for Bluetooth LE is +20. The minimum value for RSSI for Bluetooth LE is -127 (default when NULL is -127).
• OutOfRangeThresholdInDBm: The maximum value for RSSI for Bluetooth LE is +20. The maximim value for RSSI for Bluetooth LE is -127 (default when NULL is -127).
• OutOfRangeTimeout: Equal or greater than 1 second and less than or equal to 60 seconds (default when NULL is 60 seconds).
• SamplingInterval: Equal or greater than 1 second. Any sampling interval greater or equal to 25.5 seconds will disable sampling entirely. In that special case, the filtering is trigger-based. For more information about the behavior of the RSSI filtering, refer to BluetoothSignalStrengthFilter.

Additional restrictions are in place such that a filter with OutOfRangeThresholdInDBm higher than InRangeThresholdInDBm will be rejected for example. Some of these limits are obtainable programmatically through the MinSamplingInterval, MaxSamplingInterval, MinOutOfRangeTimeout and MaxOutOfRangeTimeout properties.