Cross-platform background geolocation for Cordova / PhoneGap with battery-saving "circular region monitoring" and "stop detection".
Follows the Cordova Plugin spec, so that it works with Plugman.
This plugin leverages Cordova/PhoneGap's require/define functionality used for plugins.
The plugin creates the object window.plugins.backgroundGeoLocation with the methods
configure(success, fail, option),
start(success, fail)
stop(success, fail).
cordova plugin add https://github.com/christocracy/cordova-plugin-background-geolocation.git
A full example could be:
//
//
// after deviceready
//
//
// Your app must execute AT LEAST ONE call for the current position via standard Cordova geolocation,
// in order to prompt the user for Location permission.
window.navigator.geolocation.getCurrentPosition(function(location) {
console.log('Location from Phonegap');
});
var bgGeo = window.plugins.backgroundGeoLocation;
/**
* This would be your own callback for Ajax-requests after POSTing background geolocation to your server.
*/
var yourAjaxCallback = function(response) {
////
// 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.
//
//
bgGeo.finish();
};
/**
* This callback will be executed every time a geolocation is recorded in the background.
*/
var callbackFn = function(location) {
console.log('[js] BackgroundGeoLocation callback: ' + location.latitude + ',' + location.longitude);
// Do your HTTP request here to POST location to your server.
//
//
yourAjaxCallback.call(this);
};
var failureFn = function(error) {
console.log('BackgroundGeoLocation error');
}
// BackgroundGeoLocation is highly configurable.
bgGeo.configure(callbackFn, failureFn, {
url: 'http://only.for.android.com/update_location.json', // <-- Android ONLY: your server url to send locations to
params: {
auth_token: 'user_secret_auth_token', // <-- Android ONLY: HTTP POST params sent to your server when persisting locations.
foo: 'bar' // <-- Android ONLY: HTTP POST params sent to your server when persisting locations.
},
headers: { // <-- Android ONLY: Optional HTTP headers sent to your configured #url when persisting locations
"X-Foo": "BAR"
},
desiredAccuracy: 10,
stationaryRadius: 20,
distanceFilter: 30,
notificationTitle: 'Background tracking', // <-- android only, customize the title of the notification
notificationText: 'ENABLED', // <-- android only, customize the text of the notification
activityType: 'AutomotiveNavigation',
debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
stopOnTerminate: false // <-- enable this to clear background location settings when the app terminates
});
// Turn ON the background-geolocation system. The user will be tracked whenever they suspend the app.
bgGeo.start();
// If you wish to turn OFF background-tracking, call the #stop method.
// bgGeo.stop()
NOTE: The plugin includes org.apache.cordova.geolocation as a dependency. You must enable Cordova's GeoLocation in the foreground and have the user accept Location services by executing #watchPosition or #getCurrentPosition.
The plugin has features allowing you to control the behaviour of background-tracking, striking a balance between accuracy and battery-usage. In stationary-mode, the plugin attempts to descrease its power usage and accuracy by setting up a circular stationary-region of configurable #stationaryRadius. iOS has a nice system Significant Changes API, which allows the os to suspend your app until a cell-tower change is detected (typically 2-3 city-block change) Android uses LocationManager#addProximityAlert. Windows Phone does not have such a API.
When the plugin detects your user has moved beyond his stationary-region, it engages the native platform's geolocation system for aggressive monitoring according to the configured #desiredAccuracy, #distanceFilter and #locationTimeout. The plugin attempts to intelligently scale #distanceFilter based upon the current reported speed. Each time #distanceFilter is determined to have changed by 5m/s, it recalculates it by squaring the speed rounded-to-nearest-five and adding #distanceFilter (I arbitrarily came up with that formula. Better ideas?).
(round(speed, 5))^2 + distanceFilter
The plugin works with iOS and Android, however both platforms differ significantly in their interaction with server.
On iOS and WP8 the plugin will execute your configured callbackFn. You may manually POST the received GeoLocation to your server using standard XHR. iOS and WP8 ignore the @config params url, params and headers.
Android WILL NOT execute your configured callbackFn. The plugin manages sync-ing GeoLocations to your server automatically, using the configured url, params and headers. Since the Android plugin must run as an autonomous Background Service, disconnected from your the main Android Activity (your foreground application), the background-geolocation plugin will continue to run, even if the foreground Activity is killed due to memory constraints. This is why the Android plugin cannot execute the Javascript callbackFn, since your app is not guaranteed to keep running -- syncing locations to the server must be handled by the plugin.
Keep in mind that it is not possible to use start() during the pause event of Cordova/PhoneGap. WP8 suspend your app immediately and our start() will not be executed. So make sure you fire start() before the app is closed/minimized.
Use the following config-parameters with the #configure method:
#####@param {Integer} desiredAccuracy [0, 10, 100, 1000] in meters
The lower the number, the more power devoted to GeoLocation resulting in higher accuracy readings. 1000 results in lowest power drain and least accurate readings. @see Apple docs
#####@param {Integer} stationaryRadius (meters)
When stopped, the minimum distance the device must move beyond the stationary location for aggressive background-tracking to engage. Note, since the plugin uses iOS 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 staionary-region exit is detected. In WP8 the frequency of position polling (while in stationary mode) is slowed down to once every three minutes.
#####@param {Boolean} debug
When enabled, the plugin will emit sounds for life-cycle events of background-geolocation! NOTE iOS: In addition, you must manually enable the Audio and Airplay background mode in Background Capabilities to hear these debugging sounds.
| ios | android | WP8 | |
|---|---|---|---|
| Exit stationary region | Calendar event notification sound | dialtone beep-beep-beep | triple short high tone |
| GeoLocation recorded | SMS sent sound | tt short beep | single long high tone |
| Aggressive geolocation engaged | SIRI listening sound | ||
| Passive geolocation engaged | SIRI stop listening sound | ||
| Acquiring stationary location sound | "tick,tick,tick" sound | double long low tone | |
| Stationary location acquired sound | "bloom" sound | long tt beep | double short high tone |
#####@param {Integer} distanceFilter
The minimum distance (measured in meters) a device must move horizontally before an update event is generated. @see Apple docs. However, #distanceFilter is elastically auto-calculated by the plugin: When speed increases, #distanceFilter increases; when speed decreases, so does distanceFilter.
distanceFilter is calculated as the square of speed-rounded-to-nearest-5 and adding configured #distanceFilter.
(round(speed, 5))^2 + distanceFilter
For example, at biking speed of 7.7 m/s with a configured distanceFilter of 30m:
=> round(7.7, 5)^2 + 30
=> (10)^2 + 30
=> 100 + 30
=> 130
A gps location will be recorded each time the device moves 130m.
At highway speed of 30 m/s with distanceFilter: 30,
=> round(30, 5)^2 + 30
=> (30)^2 + 30
=> 900 + 30
=> 930
A gps location will be recorded every 930m
Note the following real example of background-geolocation on highway 101 towards San Francisco as the driver slows down as he runs into slower traffic (geolocations become compressed as distanceFilter decreases)
Compare now background-geolocation in the scope of a city. In this image, the left-hand track is from a cab-ride, while the right-hand track is walking speed.
#####@param {Boolean} stopOnTerminate
Enable this in order to force a stop() when the application terminated (e.g. on iOS, double-tap home button, swipe away the app). This does not work in WP8.
#####@param {String} url
The url which the Android plugin will persist background geolocation to
#####@param {Object} params
Optional HTTP params POSTed to your server when persisting locations (eg: auth_token)
#####@param {Object} headers
Optional HTTP headers POSTed to your server when persisting locations
#####@param {String} notificationText/Title
On Android devices it is required to have a notification in the drawer because it's a "foreground service". This gives it high priority, decreasing probability of OS killing it. To customize the title and text of the notification, set these options.
#####@param {Integer} locationTimeout
The minimum time interval between location updates for Android and WP8, in seconds. See Android docs and the MS doc for more information.
#####@param {String} activityType [AutomotiveNavigation, OtherNavigation, Fitness, Other]
Presumably, this affects ios GPS algorithm. See Apple docs for more information
#####{String} desiredAccuracy
In Windows Phone, the underlying GeoLocator you can choose to use 'DesiredAccuracy' or 'DesiredAccuracyInMeters'. Since this plugins default configuration accepts meters, the default desiredAccuracy is mapped to the Windows Phone DesiredAccuracyInMeters leaving the DesiredAccuracy enum empty. For more info see the MS docs for more information.
The MIT License
Copyright (c) 2013 Chris Scott and Brian Samson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 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 IN THE SOFTWARE.