The most sophisticated background location-tracking & geofencing module with battery-conscious motion-detection intelligence for iOS and Android.
The plugin's Philosophy of Operation is to use motion-detection APIs (using accelerometer, gyroscope and magnetometer) to detect when the device is moving and stationary.
-
When the device is detected to be moving, the plugin will automatically start recording a location according to the configured
distanceFilter(meters). -
When the device is detected be stationary, the plugin will automatically turn off location-services to conserve energy.
Also available for Cordova, NativeScript and pure native apps.
The Android module requires purchasing a license. However, it will work for DEBUG builds. It will not work with RELEASE builds without purchasing a license.
(2017) This plugin is supported full-time and field-tested daily since 2013.
- API Documentation
- Installing the Plugin
- Setup Guides
- Android SDK Setup
- Using the plugin
- Example
- Debugging
- Demo Application
- Testing Server
$ npm install react-native-background-geolocation --save
If building from your local machine (as you should be), ensure you have the following items installed or updated in Android SDK Manager
import BackgroundGeolocation from "react-native-background-geolocation";There are three main steps to using BackgroundGeolocation
- Wire up event-listeners
#configurethe plugin#startthe plugin
import BackgroundGeolocation from "react-native-background-geolocation";
export default class App extends Component {
componentWillMount() {
////
// 1. Wire up event-listeners
//
// This handler fires whenever bgGeo receives a location update.
BackgroundGeolocation.on('location', this.onLocation, this.onError);
// This handler fires when movement states changes (stationary->moving; moving->stationary)
BackgroundGeolocation.on('motionchange', this.onMotionChange);
// This event fires when a change in motion activity is detected
BackgroundGeolocation.on('activitychange', this.onActivityChange);
// This event fires when the user toggles location-services authorization
BackgroundGeolocation.on('providerchange', this.onProviderChange);
////
// 2. #configure the plugin (just once for life-time of app)
//
BackgroundGeolocation.configure({
// Geolocation Config
desiredAccuracy: 0,
distanceFilter: 10,
// Activity Recognition
stopTimeout: 1,
// Application config
debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
stopOnTerminate: false, // <-- Allow the background-service to continue tracking when user closes the app.
startOnBoot: true, // <-- Auto start tracking when device is powered-up.
// HTTP / SQLite config
url: 'http://yourserver.com/locations',
batchSync: false, // <-- [Default: false] Set true to sync locations to server in a single HTTP request.
autoSync: true, // <-- [Default: true] Set true to sync each location to server as it arrives.
headers: { // <-- Optional HTTP headers
"X-FOO": "bar"
},
params: { // <-- Optional HTTP params
"auth_token": "maybe_your_server_authenticates_via_token_YES?"
}
}, (state) => {
console.log("- BackgroundGeolocation is configured and ready: ", state.enabled);
if (!state.enabled) {
////
// 3. Start tracking!
//
BackgroundGeolocation.start(function() {
console.log("- Start success");
});
}
});
}
// You must remove listeners when your component unmounts
componentWillUnmount() {
// Remove BackgroundGeolocation listeners
BackgroundGeolocation.un('location', this.onLocation);
BackgroundGeolocation.un('motionchange', this.onMotionChange);
BackgroundGeolocation.un('activitychange', this.onActivityChange);
BackgroundGeolocation.un('providerchange', this.onProviderChange);
// Or just remove them all-at-once
BackgroundGeolocation.removeListeners();
}
onLocation(location) {
console.log('- [event] location: ', location);
}
onError(error) {
console.warn('- [event] location error ', error);
}
onActivityChange(activity) {
console.log('- [event] activitychange: ', activity); // eg: 'on_foot', 'still', 'in_vehicle'
}
onProviderChange(provider) {
console.log('- [event] providerchange: ', provider);
}
onMotionChange(location) {
console.log('- [event] motionchange: ', location.isMoving, location);
}
}A fully-featured Demo App is available in its own public repo. After first cloning that repo, follow the installation instructions in the README there. This demo-app includes a settings-screen allowing you to quickly experiment with all the different settings available for each platform.
A simple Node-based web-application with SQLite database is available for field-testing and performance analysis. If you're familiar with Node, you can have this server up-and-running in about one minute.
The MIT License (MIT)
Copyright (c) 2015 Chris Scott, Transistor Software
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.