From f153474dd584f1ddc4d35fbf0b4b0337a225458b Mon Sep 17 00:00:00 2001 From: AustinHaigh Date: Sun, 12 May 2019 09:02:55 -1000 Subject: [PATCH] docs: add documentation for ARMA filter --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 1840e33..1ee1112 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,9 @@ * Region Monitoring (or geo fencing), works in all app states. * Advertising device as an iBeacon +#### Features exclusive to Android + * ARMA filter for distance calculations + ### Installation ``` @@ -348,6 +351,12 @@ cordova.plugins.locationManager.startMonitoringForRegion(beaconRegion) ``` +##### Enable ARMA filter for distance calculations (Android only) + +The underlying library uses the moving average to calculate distance by default, but an ARMA filter can be enabled which will weigh more recent measurements higher than older measurements. It can be enabled by adding the following preference to your `config.xml` file: + +`````` + ## Contributions > Contributions are welcome at all times, please make sure that the tests are running without errors