@azatek/background-geolocation 1.0.0 → 7.0.1

package/README.md

@@ -35,10 +35,31 @@ const watcherId = await BackgroundGeolocation.addWatcher({
 
 ## Accuracy Modes
 
-- **LocationAccuracy.HIGH (100)**: GPS only - High battery usage, best accuracy
-- **LocationAccuracy.BALANCED (102)**: GPS + Network - Medium battery, good accuracy
-- **LocationAccuracy.LOW (104)**: Network only - Low battery, approximate location
-- **LocationAccuracy.PASSIVE (105)**: Minimal battery, uses other apps' location requests
+| Mode | Value | Description | Accuracy Level |
+|------|-------|-------------|----------------|
+| **HIGH** | 100 | Best accuracy, high battery usage | Android: PRIORITY_HIGH_ACCURACY<br>iOS: kCLLocationAccuracyBest |
+| **BALANCED** | 102 | Good accuracy (default) | Android: PRIORITY_BALANCED_POWER_ACCURACY<br>iOS: kCLLocationAccuracyNearestTenMeters |
+| **LOW** | 104 | Approximate location | Android: PRIORITY_LOW_POWER<br>iOS: kCLLocationAccuracyHundredMeters |
+| **PASSIVE** | 105 | Minimal battery | Android: PRIORITY_PASSIVE<br>iOS: kCLLocationAccuracyThreeKilometers |
+
+### Platform Behavior
+
+**Both platforms now behave identically:**
+- Location updates are triggered **only by distance changes**, not time intervals
+- `distanceFilter: 50` → Updates only when device moves 50+ meters
+- `distanceFilter: 0` → Updates on any movement (controlled by accuracy setting)
+
+**Important:**
+- ⚠️ With `distanceFilter > 0`, you will **NOT** receive updates when stationary
+- ✅ This matches iOS behavior and saves battery
+- 💡 Set `distanceFilter: 0` if you need updates even when stationary
+
+**Android-specific:**
+- Uses `FusedLocationProviderClient` with very large time interval to effectively disable time-based updates
+
+**iOS-specific:**
+- Uses `CLLocationManager.distanceFilter` natively
+- HIGH mode automatically switches to `kCLLocationAccuracyBestForNavigation` when device is charging
 
 ## Original Usage
 

package/android/src/main/java/com/equimaps/capacitor_background_geolocation/BackgroundGeolocation.java

@@ -42,7 +42,8 @@ import androidx.localbroadcastmanager.content.LocalBroadcastManager;
                 @Permission(
                         strings = {
                                 Manifest.permission.ACCESS_COARSE_LOCATION,
-                                Manifest.permission.ACCESS_FINE_LOCATION
+                                Manifest.permission.ACCESS_FINE_LOCATION,
+                                Manifest.permission.FOREGROUND_SERVICE_LOCATION
                         },
                         alias = "location"
                 )
@@ -70,23 +71,12 @@ public class BackgroundGeolocation extends Plugin {
         } catch (SecurityException ignore) {}
     }
 
-    @PluginMethod(returnType = PluginMethod.RETURN_CALLBACK)
-    public void addWatcher(final PluginCall call) {
-        if (service == null) {
-            call.reject("Service not running.");
+    private void startWatcher(PluginCall call) {
+        if (!isLocationEnabled(getContext())) {
+            call.reject("Location services disabled.", "NOT_AUTHORIZED");
             return;
         }
-        call.setKeepAlive(true);
 
-        if (getPermissionState("location") != PermissionState.GRANTED) {
-            if (call.getBoolean("requestPermissions", true)) {
-                requestPermissionForAlias("location", call, "locationPermissionsCallback");
-            } else {
-                call.reject("Permission denied.", "NOT_AUTHORIZED");
-            }
-        } else if (!isLocationEnabled(getContext())) {
-            call.reject("Location services disabled.", "NOT_AUTHORIZED");
-        }
         if (call.getBoolean("stale", false)) {
             fetchLastLocation(call);
         }
@@ -164,6 +154,26 @@ public class BackgroundGeolocation extends Plugin {
 		);
     }
 
+    @PluginMethod(returnType = PluginMethod.RETURN_CALLBACK)
+    public void addWatcher(final PluginCall call) {
+        if (service == null) {
+            call.reject("Service not running.");
+            return;
+        }
+        call.setKeepAlive(true);
+
+        if (getPermissionState("location") != PermissionState.GRANTED) {
+            if (call.getBoolean("requestPermissions", true)) {
+                requestPermissionForAlias("location", call, "locationPermissionsCallback");
+            } else {
+                call.reject("Permission denied.", "NOT_AUTHORIZED");
+            }
+            return;
+        }
+
+        startWatcher(call);
+    }
+
     @PermissionCallback
     private void locationPermissionsCallback(PluginCall call) {
 
@@ -171,15 +181,13 @@ public class BackgroundGeolocation extends Plugin {
             call.reject("User denied location permission", "NOT_AUTHORIZED");
             return;
         }
-        if (call.getBoolean("stale", false)) {
-            fetchLastLocation(call);
-        }
+
         if (service != null) {
             service.onPermissionsGranted();
-            // The handleOnResume method will now be called, and we don't need it to call
-            // service.onPermissionsGranted again so we reset this flag.
             stoppedWithoutPermissions = false;
         }
+
+        startWatcher(call);
     }
 
     @PluginMethod()

package/android/src/main/java/com/equimaps/capacitor_background_geolocation/BackgroundGeolocationService.java

@@ -16,6 +16,7 @@ import com.google.android.gms.location.LocationCallback;
 import com.google.android.gms.location.LocationRequest;
 import com.google.android.gms.location.LocationResult;
 import com.google.android.gms.location.LocationServices;
+import com.google.android.gms.location.Priority;
 
 import java.util.HashSet;
 
@@ -84,35 +85,32 @@ public class BackgroundGeolocationService extends Service {
 			
 			// Map accuracy enum to Android Priority
 			int priority;
-			long interval;
-			
+
 			switch (accuracy) {
 				case 100: // HIGH
 					priority = Priority.PRIORITY_HIGH_ACCURACY;
-					interval = 5000; // 5 seconds
 					break;
 				case 102: // BALANCED (Default)
 					priority = Priority.PRIORITY_BALANCED_POWER_ACCURACY;
-					interval = 10000; // 10 seconds
 					break;
 				case 104: // LOW
 					priority = Priority.PRIORITY_LOW_POWER;
-					interval = 30000; // 30 seconds
 					break;
 				case 105: // PASSIVE
 					priority = Priority.PRIORITY_PASSIVE;
-					interval = 60000; // 60 seconds
 					break;
 				default:
 					priority = Priority.PRIORITY_BALANCED_POWER_ACCURACY;
-					interval = 10000;
 			}
-			
-			// Use modern LocationRequest.Builder API
+
+			// Match iOS behavior: Only update based on distance, not time intervals
+			// When distanceFilter is 0, use a minimal interval to get updates
+			// When distanceFilter > 0, use a very large interval so only distance triggers updates
+			long interval = (distanceFilter > 0) ? Long.MAX_VALUE : 1000;
+
 			LocationRequest locationRequest = new LocationRequest.Builder(priority, interval)
 					.setMinUpdateDistanceMeters(distanceFilter)
 					.setWaitForAccurateLocation(false)
-					.setMaxUpdateDelayMillis(interval)
 					.build();
 
             LocationCallback callback = new LocationCallback(){
@@ -129,7 +127,7 @@ public class BackgroundGeolocationService extends Service {
                 @Override
                 public void onLocationAvailability(LocationAvailability availability) {
                     if (!availability.isLocationAvailable()) {
-                        Logger.debug("Location not available");
+                        Logger.warn("Location not available - check if GPS is enabled");
                     }
                 }
             };
@@ -151,7 +149,9 @@ public class BackgroundGeolocationService extends Service {
                         watcher.locationCallback,
                         null
                 );
-            } catch (SecurityException ignore) {}
+            } catch (SecurityException e) {
+                Logger.error("SecurityException when requesting location updates", e);
+            }
 
             // Promote the service to the foreground if necessary.
             // Ideally we would only call 'startForeground' if the service is not already

package/index.js

@@ -0,0 +1,6 @@
+export const LocationAccuracy = {
+    HIGH: 100,
+    BALANCED: 102,
+    LOW: 104,
+    PASSIVE: 105
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@azatek/background-geolocation",
-    "version": "1.0.0",
+    "version": "7.0.1",
     "description": "Capacitor plugin for background geolocation tracking with configurable GPS accuracy modes (HIGH/BALANCED/LOW/PASSIVE) for battery optimization. Fork of @capacitor-community/background-geolocation with enhanced accuracy control.",
     "keywords": [
         "capacitor",
@@ -21,8 +21,18 @@
     },
     "author": "AzaTek",
     "license": "MIT",
+    "main": "index.js",
+    "module": "index.js",
     "types": "definitions.d.ts",
+    "exports": {
+        ".": {
+            "types": "./definitions.d.ts",
+            "import": "./index.js",
+            "require": "./index.js"
+        }
+    },
     "files": [
+        "index.js",
         "CapacitorCommunityBackgroundGeolocation.podspec",
         "Package.swift",
         "android/build.gradle",