Repository files navigation

Cross-platform geolocation for Cordova / PhoneGap with battery-saving "circular region monitoring" and "stop detection".

Plugin can be used for geolocation when app is running in foreground or background. It is more battery and data efficient than html5 geolocation or cordova-geolocation plugin. It can be used side by side with other geolocation providers (eg. html5 navigator.geolocation).

On Android you can choose from two location location providers:

• ANDROID_DISTANCE_FILTER_PROVIDER (forked fromcordova-plugin-background-geolocation)
• ANDROID_ACTIVITY_PROVIDER

SeeWhich provider should I use? for more information about providers.

Checkout repositorycordova-plugin-background-geolocation-example.

All new issues should follow instructions inISSUE_TEMPLATE.md.Properly filled issue report will significantly reduce number of follow up questions and decrease issue resolving time.Most issues cannot be resolved without debug logs. Please try to isolate debug lines related to your issue.Instructions how to prepare debug logs can be found in sectionDebugging.If you're reporting app crash, debug logs might not contain all needed informations about the cause of the crash.In that case, also provide relevant parts of output ofadb logcat command.

This plugin is following semantic versioning as definedhttp://semver.org

As version 2.0 platform support for Windows Phone 8 was removed.Some incompatible changes were introduced:

• optionstopOnTerminate defaults to true
• optionlocationService renamed tolocationProvider
• android providers are nowANDROID_DISTANCE_FILTER_PROVIDER andANDROID_ACTIVITY_PROVIDER
• removedlocationTimeout option (useinterval in milliseconds instead)
• notificationIcon was replaced with two separate options (notificationIconSmall andnotificationIconLarge)
• js object backgroundGeoLocation is deprecated usebackgroundGeolocation instead
• iOS foreground mode witch automatic background mode switch
• iOSswitchMode allows to switch between foreground and background mode
• setPace on iOS is deprecated use switchMode instead

cordova plugin add cordova-plugin-mauron85-background-geolocation

Default iOS location permission prompt can be changed in your config.xml:

<plugin name="cordova-plugin-mauron85-background-geolocation" spec="^2.2.0">    <variable name="ALWAYS_USAGE_DESCRIPTION" value="This app requires background tracking enabled" /></plugin>

This plugin should work with Adobe® PhoneGap™ Build without any modification.To register plugin add following line into your config.xml:

<plugin name="cordova-plugin-mauron85-background-geolocation" spec="^2.2.0"/>

NOTE: If you're usinghydration, you have to download and reinstall your app with every new version of the plugin, as plugins are not updated.

You will need to ensure that you have installed the following items through the Android SDK Manager:

Please note that as of Cordova Android 6.0.0 icons are by default in mipmap/ directory not drawable/ directory, so this plugin will have a build issue on < 6.0.0 Cordova builds, you will need to update Authenticator.xml to drawable directory from mipmap directory to work on older versions.

document.addEventListener('deviceready',onDeviceReady,false);functiononDeviceReady(){/**    * This callback will be executed every time a geolocation is recorded in the background.    */varcallbackFn=function(location){console.log('[js] BackgroundGeolocation callback:  '+location.latitude+','+location.longitude);// Do your HTTP request here to POST location to your server.// jQuery.post(url, JSON.stringify(location));/*        IMPORTANT:  You must execute the finish method here to inform the native plugin that you're finished,        and the background-task may be completed.  You must do this regardless if your HTTP request is successful or not.        IF YOU DON'T, ios will CRASH YOUR APP for spending too much time in the background.        */backgroundGeolocation.finish();};varfailureFn=function(error){console.log('BackgroundGeolocation error');};// BackgroundGeolocation is highly configurable. See platform specific configuration optionsbackgroundGeolocation.configure(callbackFn,failureFn,{desiredAccuracy:10,stationaryRadius:20,distanceFilter:30,interval:60000});// Turn ON the background-geolocation system.  The user will be tracked whenever they suspend the app.backgroundGeolocation.start();// If you wish to turn OFF background-tracking, call the #stop method.// backgroundGeolocation.stop();}

Configure options:

Following options are specific to provider as defined by locationProvider option

Success callback will be called with one argument - location object, which tries to mimic w3cCoordinates interface.

Platform: iOS, Android

Start background geolocation.

Platform: iOS, Android

Stop background geolocation.

Platform: iOS, Android

One time check for status of location services. In case of error, fail callback will be executed.

Platform: Android >= 6, iOS >= 8.0

Show app settings to allow change of app location permissions.

Platform: iOS < 10.0, Android

Show system settings to allow configuration of current location sources.

Platform: iOS, Android

Method can be used to detect user changes in location services settings.If user enable or disable location services then success callback will be executed.In case or error (SettingNotFoundException) fail callback will be executed.

Platform: iOS, Android

Stop watching for location mode changes.

Platform: iOS, Android

Method will return all stored locations.This method is useful for initial rendering of user location on a map just after application launch.NOTE: Returned locations does not contain locationId.

backgroundGeolocation.getLocations(function(locations){console.log(locations);});

Platform: iOS, Android

Method will return locations, which has not been yet posted to server.NOTE: Locations does contain locationId.

Platform: iOS, Android

Delete location with locationId.

Note: Locations are not actually deleted from database to avoid gaps in locationId numbering.Instead locations are marked as deleted. Locations marked as deleted will not appear in output ofbackgroundGeolocation.getLocations.

Note: You don't need to delete all locations. Plugin manages number of locations automatically and location count never exceeds number as defined byoption.maxLocations.

Platform: iOS, Android

Delete all stored locations.

Platform: iOS

Normally plugin will handle switching betweenBACKGROUND andFOREGROUND mode itself.Calling switchMode you can override plugin behavior and force plugin to switch into other mode.

InFOREGROUND mode plugin uses iOS local manager to receive locations and behavior is affectedbyoption.desiredAccuracy andoption.distanceFilter.

InBACKGROUND mode plugin uses significant changes and region monitoring to receive locationsand usesoption.stationaryRadius only.

// switch to FOREGROUND modebackgroundGeolocation.switchMode(backgroundGeolocation.mode.FOREGROUND);// switch to BACKGROUND modebackgroundGeolocation.switchMode(backgroundGeolocation.mode.BACKGROUND);

Platform: iOS, Android

Return all logged events. Useful for plugin debugging.Parameterlimit limits number of returned entries.@seeDebugging for more information.

backgroundGeolocation.configure(callbackFn,failureFn,{desiredAccuracy:10,stationaryRadius:20,distanceFilter:30,url:'http://192.168.81.15:3000/locations',httpHeaders:{'X-FOO':'bar'},maxLocations:1000,// Android only sectionlocationProvider:backgroundGeolocation.provider.ANDROID_ACTIVITY_PROVIDER,interval:60000,fastestInterval:5000,activitiesInterval:10000,notificationTitle:'Background tracking',notificationText:'enabled',notificationIconColor:'#FEDD1E',notificationIconLarge:'mappointer_large',notificationIconSmall:'mappointer_small'});backgroundGeolocation.watchLocationMode(function(enabled){if(enabled){// location service are now enabled// call backgroundGeolocation.start// only if user already has expressed intent to start service}else{// location service are now disabled or we don't have permission// time to change UI to reflect that}},function(error){console.log('Error watching location mode. Error:'+error);});backgroundGeolocation.isLocationEnabled(function(enabled){if(enabled){backgroundGeolocation.start(function(){// service started successfully// you should adjust your app UI for example change switch element to indicate// that service is running},function(error){// Tracking has not started because of error// you should adjust your app UI for example change switch element to indicate// that service is not runningif(error.code===2){if(window.confirm('Not authorized for location updates. Would you like to open app settings?')){backgroundGeolocation.showAppSettings();}}else{window.alert('Start failed: '+error.message);}});}else{// Location services are disabledif(window.confirm('Location is disabled. Would you like to open location settings?')){backgroundGeolocation.showLocationSettings();}}});

All locations updates are recorded in local db at all times. When App is in foreground or background in addition to storing location in local db, location callback function is triggered. Number of location stored in db is limited byoption.maxLocations a never exceeds this number. Instead old locations are replaced by new ones.

Whenoption.url is defined, each location is also immediately posted to url defined byoption.url. If post is successful, the location is marked as deleted in local db. All failed to post locations will be coalesced and send in some time later in one single batch. Batch sync takes place only when number of failed to post locations reachesoption.syncThreshold.Optionally different url for batch sync can be defined byoption.syncUrl. Ifoption.syncUrl is not set thenoption.url will be used instead.

When onlyoption.syncUrl is defined. Locations are send only in single batch, when number of locations reachesoption.syncThreshold. (No individual location will be send)

Request body of posted locations is always array, even when only one location is sent.

Warning:option.maxLocations has to be larger thanoption.syncThreshold. It's recommended to be 2x larger. In other case location syncing might not work properly.

varexpress=require('express');varbodyParser=require('body-parser');varapp=express();// parse application/jsonapp.use(bodyParser.json({type :'*/*'}));// force jsonapp.post('/locations',function(request,response){console.log('Headers:\n',request.headers);console.log('Body:\n',request.body);console.log('------------------------------');response.sendStatus(200);});app.listen(3000);console.log('Server started...');

On iOS the plugin will execute your configuredcallbackFn. You may manually POST the receivedGeolocation to your server using standard XHR. The plugin uses iOS Significant Changes API, and starts triggeringcallbackFn only when a cell-tower switch is detected (i.e. the device exits stationary radius). The functionchangePace(isMoving, success, failure) is provided to force the plugin to enter "moving" or "stationary" state.

Since the plugin usesiOS significant-changes API, the plugin cannot detect the exact moment the device moves out of the stationary-radius. In normal conditions, it can take as much as 3 city-blocks to 1/2 km before stationary-region exit is detected.

On Android devices it is recommended to have a notification in the drawer (optionstartForeground:true). This gives plugin location service higher priority, decreasing probability of OS killing it. Checkwiki for explanation.

Plugin should work with custom ROMS at least ANDROID_DISTANCE_FILTER_PROVIDER. But ANDROID_ACTIVITY_PROVIDER provider depends on Google Play Services.Usually ROMs don't include Google Play Services libraries. Strange bugs may occur, like no GPS locations (only from network and passive) and other. When posting issue report, please mention that you're using custom ROM.

Note: Following section was kindly copied fromphonegap-plugin-push. Visit link for resolving issue with facebook plugin.

If you have an issue compiling the app and you're getting an error similar to this (com.android.dex.DexException: Multiple dex files define):

UNEXPECTED TOP-LEVEL EXCEPTION:com.android.dex.DexException: Multiple dex files define Landroid/support/annotation/AnimRes;at com.android.dx.merge.DexMerger.readSortableTypes(DexMerger.java:596)at com.android.dx.merge.DexMerger.getSortedTypes(DexMerger.java:554)at com.android.dx.merge.DexMerger.mergeClassDefs(DexMerger.java:535)at com.android.dx.merge.DexMerger.mergeDexes(DexMerger.java:171)at com.android.dx.merge.DexMerger.merge(DexMerger.java:189)at com.android.dx.command.dexer.Main.mergeLibraryDexBuffers(Main.java:502)at com.android.dx.command.dexer.Main.runMonoDex(Main.java:334)at com.android.dx.command.dexer.Main.run(Main.java:277)at com.android.dx.command.dexer.Main.main(Main.java:245)at com.android.dx.command.Main.main(Main.java:106)

Then at least one other plugin you have installed is using an outdated way to declare dependencies such asandroid-support orplay-services-gcm.This causes gradle to fail, and you'll need to identify which plugin is causing it and request an update to the plugin author, so that it uses the proper way to declare dependencies for cordova.Seethis for the reference on the cordova plugin specification, it'll be usefull to mention it when creating an issue or requesting that plugin to be updated.

Common plugins to suffer from this outdated dependency management are plugins related tofacebook,google+,notifications,crosswalk andgoogle maps.

Android 6.0 "Marshmallow" introduced a new permissions model where the user can turn on and off permissions as necessary. When user disallow location access permissions, error configure callback will be called with error code: 2.

NOTE: Only available for API Level >=21.

To use custom notification icons, you need to put icons intores/drawable directoryof your app. You can automate the process as part ofafter_platform_add hook configured viaconfig.xml. Checkconfig.xml andscripts/res_android.js of example app for reference.

With Adobe® PhoneGap™ Build icons must be placed intolocales/android/drawable dir at the root of your project. For more information go tohow-to-add-native-image-with-phonegap-build.

Plugin will not work in XDK emulator ('Unimplemented API Emulation: BackgroundGeolocation.start' in emulator). But will work on real device.

Plugin logs all activity into database. Logs are retained for 7 days.You can attach your device to the computer and print logs to console.

• For iOS open Safari and select from menuDevelop ➜Your Device name
• For Android launch Chromeabout:inspect

Copy paste following snippet into your browser console:

functionpadLeft(nr,n,str){returnArray(n-String(nr).length+1).join(str||'0')+nr;}functionprintLogs(logEntries,logFormatter,COLORS,MAX_LINES){MAX_LINES=MAX_LINES||100;// maximum lines to print per batchvarbatch=Math.ceil(logEntries.length/MAX_LINES);varlogLines=Array(MAX_LINES);//preallocate memory prevents GCvarlogLinesColor=Array(MAX_LINES*2);for(vari=0;i<batch;i++){varit=0;varlogEntriesPart=logEntries.slice((i*MAX_LINES),(i+1)*MAX_LINES);for(varj=0;j<logEntriesPart.length;j++){varlogEntry=logEntriesPart[j];logLines[j]=logFormatter(logEntry);logLinesColor[it++]=('background:white;color:black');logLinesColor[it++]=(COLORS[logEntry.level]);}if(logEntriesPart.length<MAX_LINES){console.log.apply(console,[logLines.slice(0,logEntriesPart.length).join('\n')].concat(logLinesColor.slice(0,logEntriesPart.length*2)));}else{console.log.apply(console,[logLines.join('\n')].concat(logLinesColor));}}}functionprintAndroidLogs(logEntries){varCOLORS=Object();COLORS['ERROR']='background:white;color:red';COLORS['WARN']='background:black;color:yellow';COLORS['INFO']='background:white;color:blue';COLORS['TRACE']='background:white;color:black';COLORS['DEBUG']='background:white;color:black';varlogFormatter=function(logEntry){vard=newDate(logEntry.timestamp);vardateStr=[d.getFullYear(),padLeft(d.getMonth()+1,2),padLeft(d.getDate(),2)].join('/');vartimeStr=[padLeft(d.getHours(),2),padLeft(d.getMinutes(),2),padLeft(d.getSeconds(),2)].join(':');return['%c[',dateStr,' ',timeStr,'] %c',logEntry.logger,':',logEntry.message].join('');}returnprintLogs(logEntries,logFormatter,COLORS);}functionprintIosLogs(logEntries){varCOLORS=Array();COLORS[1]='background:white;color:red';COLORS[2]='background:black;color:yellow';COLORS[4]='background:white;color:blue';COLORS[8]='background:white;color:black';COLORS[16]='background:white;color:black';varlogFormatter=function(logEntry){vard=newDate(logEntry.timestamp*1000);vardateStr=[d.getFullYear(),padLeft(d.getMonth()+1,2),padLeft(d.getDate(),2)].join('/');vartimeStr=[padLeft(d.getHours(),2),padLeft(d.getMinutes(),2),padLeft(d.getSeconds(),2)].join(':');return['%c[',dateStr,' ',timeStr,'] %c',logEntry.logger,':',logEntry.message].join('');}returnprintLogs(logEntries,logFormatter,COLORS);}

Print Android logs:

backgroundGeolocation.getLogEntries(100, printAndroidLogs);

Print iOS logs:

backgroundGeolocation.getLogEntries(100, printIosLogs);

NOTE: For iOS in addition, you must manually enable theAudio and Airplay background mode inBackground Capabilities to hear these debugging sounds.

There is nice cordova plugincordova-plugin-geofence, which does exactly that. Let's keep this plugin lightweight as much as possible.

SeeCHANGES.md

Apache License

Copyright (c) 2013 Christopher Scott, Transistor Software

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.