Merge pull request #30 from peterdeka/master

Added setRssiFilter for android in order to be able to configure the rssi filter type and options.

Author: MacKentoch

README.md

@@ -171,6 +171,7 @@ DeviceEventEmitter.addListener('beaconsDidRange', (data) => {
 | **setForegroundScanPeriod(period: number): void**                                                 | Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons (in foreground). For more info [take a look at the official docs](https://altbeacon.github.io/android-beacon-library/javadoc/index.html)                                                                                                                                                                                                                                                                                                                                                     |
 | **setBackgroundScanPeriod(period: number): void**                                                 | Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons (in background). For more info [take a look at the official docs](https://altbeacon.github.io/android-beacon-library/javadoc/index.html)                                                                                                                                                                                                                                                                                                                                                     |
 | **setBackgroundBetweenScanPeriod(period: number): void**                                          | Sets the duration in milliseconds spent not scanning between each Bluetooth LE scan cycle when no ranging/monitoring clients are in the foreground. For more info [take a look at the official docs](https://altbeacon.github.io/android-beacon-library/javadoc/index.html)                                                                                                                                                                                                                                                                                                        |
+| **setRssiFilter(filterType: int, avgModifier: number): void**                                     | Sets the RSSI averaging method. The parameter `filterType` must be one of the exported constants `ARMA_RSSI_FILTER` or `RUNNING_AVG_RSSI_FILTER`. The `avgModifier` param changes the rate of the averaging function For the ARMA filter it's in the range 0.1-1.0, for the running average it's the filter window in milliseconds. For more info [take a look at the docs](https://altbeacon.github.io/android-beacon-library/distance_vs_time.html) |
 | **setHardwareEqualityEnforced(e: boolean): void**                                                 | Configures whether the bluetoothAddress (mac address) must be the same for two Beacons to be configured equal. This setting applies to all beacon instances in the same process. Defaults to false for backward compatibility. Useful when all the beacons you are working with have the same UUID, major and minor (they are only uniquely identifiable by their mac address), otherwise the module will detect all the beacons as if they were only one. For more info [take a look at the official docs](https://altbeacon.github.io/android-beacon-library/javadoc/index.html) |
 | **getRangedRegions(): promise**                                                                   | Returns a promise that resolves in an array with the regions being ranged.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | **getMonitoredRegions(): promise**                                                                | Returns a promise that resolves in an array with the regions being monitored.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

android/src/main/java/com/mackentoch/beaconsandroid/BeaconsAndroidModule.java

@@ -27,13 +27,17 @@
 import org.altbeacon.beacon.MonitorNotifier;
 import org.altbeacon.beacon.RangeNotifier;
 import org.altbeacon.beacon.Region;
+import org.altbeacon.beacon.service.ArmaRssiFilter;
+import org.altbeacon.beacon.service.RunningAverageRssiFilter;
 
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 
 public class BeaconsAndroidModule extends ReactContextBaseJavaModule implements BeaconConsumer {
     private static final String LOG_TAG = "BeaconsAndroidModule";
+    private static final int RUNNING_AVG_RSSI_FILTER = 0;
+    private static final int ARMA_RSSI_FILTER = 1;
     private ReactApplicationContext mReactContext;
     private Context mApplicationContext;
     private BeaconManager mBeaconManager;
@@ -62,6 +66,8 @@ public Map<String, Object> getConstants() {
         constants.put("NOT_SUPPORTED_BLE", BeaconTransmitter.NOT_SUPPORTED_BLE);
         constants.put("NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS", BeaconTransmitter.NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS);
         constants.put("NOT_SUPPORTED_CANNOT_GET_ADVERTISER", BeaconTransmitter.NOT_SUPPORTED_CANNOT_GET_ADVERTISER);
+        constants.put("RUNNING_AVG_RSSI_FILTER",RUNNING_AVG_RSSI_FILTER);
+        constants.put("ARMA_RSSI_FILTER",ARMA_RSSI_FILTER);
         return constants;
     }
 
@@ -100,6 +106,27 @@ public void setForegroundBetweenScanPeriod(int period) {
         mBeaconManager.setForegroundBetweenScanPeriod((long) period);
     }
 
+    @ReactMethod
+    public void setRssiFilter(int filterType, double avgModifier) {
+        String logMsg = "Could not set the rssi filter.";
+        if (filterType==RUNNING_AVG_RSSI_FILTER){
+          logMsg="Setting filter RUNNING_AVG";
+          BeaconManager.setRssiFilterImplClass(RunningAverageRssiFilter.class);
+          if (avgModifier>0){
+            RunningAverageRssiFilter.setSampleExpirationMilliseconds((long) avgModifier);
+            logMsg+=" with custom avg modifier";
+          }
+        } else if (filterType==ARMA_RSSI_FILTER){
+          logMsg="Setting filter ARMA";
+          BeaconManager.setRssiFilterImplClass(ArmaRssiFilter.class);
+          if (avgModifier>0){
+            ArmaRssiFilter.setDEFAULT_ARMA_SPEED(avgModifier);
+            logMsg+=" with custom avg modifier";
+          }
+        }
+        Log.d(LOG_TAG, logMsg);
+    }
+
     @ReactMethod
     public void checkTransmissionSupported(Callback callback) {
         int result = BeaconTransmitter.checkTransmissionSupported(mReactContext);

lib/module.android.js

@@ -22,6 +22,9 @@ const tramissionSupport: Array<string> = [
   'NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS'
 ];
 
+const ARMA_RSSI_FILTER = beaconsAndroid.ARMA_RSSI_FILTER;
+const RUNNING_AVG_RSSI_FILTER = beaconsAndroid.RUNNING_AVG_RSSI_FILTER;
+
 function setHardwareEqualityEnforced(e: boolean): void {
   beaconsAndroid.setHardwareEqualityEnforced(e);
 }
@@ -94,6 +97,10 @@ function setForegroundScanPeriod(period: number): void {
   beaconsAndroid.setForegroundScanPeriod(period);
 }
 
+function setRssiFilter(filterType: number, avgModifier: number): void {
+  beaconsAndroid.setRssiFilter(filterType, avgModifier);
+}
+
 function getRangedRegions(): Promise<any> {
   return new Promise((resolve, reject) => {
     beaconsAndroid.getRangedRegions(resolve);
@@ -169,7 +176,7 @@ function startRangingBeaconsInRegion(regionId: string, beaconsUUID?: string): Pr
  * stops monittorings for a region
  *
  * @param {BeaconRegion} region region (see BeaconRegion type)
- * @returns {Promise<any>}          promise resolves to void or error    
+ * @returns {Promise<any>}          promise resolves to void or error
  */
 function stopMonitoringForRegion(region: BeaconRegion): Promise<any> {
   return new Promise(
@@ -213,11 +220,14 @@ export default {
   setBackgroundScanPeriod,
   setBackgroundBetweenScanPeriod,
   setForegroundScanPeriod,
+  setRssiFilter,
   checkTransmissionSupported,
   getRangedRegions,
   getMonitoredRegions,
   startMonitoringForRegion,
   startRangingBeaconsInRegion,
   stopMonitoringForRegion,
-  stopRangingBeaconsInRegion
+  stopRangingBeaconsInRegion,
+  ARMA_RSSI_FILTER,
+  RUNNING_AVG_RSSI_FILTER
 };