Skip to content

Latest commit

 

History

History
224 lines (159 loc) · 9.52 KB

README.md

File metadata and controls

224 lines (159 loc) · 9.52 KB
Raw

PhoneGap-Geofencing

Geofencing And Significant Location Change Monitoring Plugin For PhoneGap. iOS Support Only For Now!!!

This Phonegap Plugin has been developed by Dov Goldberg of Ogonium. Feel free to use the code in any projects according the the license at the bottom of this readme.

I am happy to offer my consulting services if needed and can be contacted at: [email protected]

DESCRIPTION

  • This plugin provides a simple way to use iOS and Android Region Monitoring in PhoneGap applications.
  • Significant location changes API is exposed.
  • Simple JS interface is exposed to allow the adding and removing of regions to monitor.
  • Included ability to receive realtime region notifications when regions are entered and exited.

WHAT IS GEOFENCING

Geofencing is a way to monitor geographic regions. In iOS it allows an app to be informed when a specified geographic region is entered or exited.

SETUP

Using this plugin requires Cordova iOS.

  1. Make sure your Xcode project has been updated for Cordova

  2. Drag and drop the DGGeofencing.h and DGGeofencing.m files from the DGGeofencing folder in Finder to your Plugins folder in XCode.

  3. Add the .js files to your www folder on disk, and add reference(s) to the .js files using <script> tags in your html file(s)

    <script type="text/javascript" src="/js/plugins/DGGeofencing.js"></script>

  4. Add new entry with name DGGeofencing and value DGGeofencing to Plugins in config.xml

INCLUDED FUNTIONS

DGGeofencing.js contains the following functions:

  1. initCallbackForRegionMonitoring - Initializes the PhoneGap Plugin callback.
  2. startMonitoringRegion - Starts monitoring a region.
  3. stopMonitoringRegion - Clears an existing region from being monitored.
  4. getWatchedRegionIds - Returns a list of currently monitored region identifiers.
  5. startMonitoringSignificantLocationChanges - Starts monitoring significant location changes.
  6. stopMonitoringSignificantLocationChanges - Stops monitoring significant location changes.

PLUGIN CODE EXAMPLE

To add a new region to be monitored use the DGGeofencing startMonitoringRegion function. The parameters are:

  1. fid - String - This is a unique identifier.
  2. latitude - String - latitude of the region.
  3. longitude - String - latitude of the region.
  4. radius - Integer - Specifies the radius in meters of the region.

Example:

var params = [location.id, location.location.lat, location.location.lng, "10", "3"];
DGGeofencing.startMonitoringRegion(params, function(result) {}, function(error) {
	alert("failed to add region");
});

To remove an existing region use the DGGeofencing removeRegion function. The parameters are:

  1. fid - String - This is a unique identifier.
  2. latitude - String - latitude of the region.
  3. longitude - String - latitude of the region.

Example:

var params = [item.fid, item.latitude, item.longitude];
DGGeofencing.stopMonitoringRegion(params, 
function(result) {

	// not used.

}, function(error) {
	// not used
});

To retrieve the list of identifiers of currently monitored regions use the DGGeofencing getWatchedRegionIds function. No parameters.

The result object contains an array of strings in regionids

Example:

DGGeofencing.getWatchedRegionIds(
	function(result) { 
		alert("success: " + result.regionids); 				   
	},
	function(error) {  
		alert("error");   
	}
);

To start monitoring signifaction location changes use the DGGeofencing startMonitoringSignificantLocationChanges function. No parameters.

Example:

DGGeofencing.startMonitoringSignificantLocationChanges(
	function(result) { 
		console.log("Location Monitor Success: " + result);				   
	},
	function(error) {  
		console.log("failed to monitor location changes");   
	}
);

To start monitoring signifaction location changes use the DGGeofencing startMonitoringSignificantLocationChanges function. No parameters.

Example:

DGGeofencing.stopMonitoringSignificantLocationChanges(
	function(result) { 
		console.log("Stop Location Monitor Success: " + result);				   
	},
	function(error) {  
		console.log("failed to stop monitor location changes");   
	}
);

HOW TO SETUP REGION AND LOCATION NOTIFICATIONS

Of course adding and removing monitored regions would be useless without the ability to receive real time notifications when region boundries are crossed. This setup will allow the JavaScript to receive updates both when the app is running and not running.

Follow these steps to setup region notifications when the app is running:

  1. Drag and drop the DGGeofencingHelper.h and DGGeofencingHelper.m files from the DGGeofencing folder in Finder to your Plugins folder in XCode.

  2. Add the following code to the viewDidLoad function in the MainViewController.m file after [super viewDidLoad];

    [[DGGeofencingHelper sharedGeofencingHelper] setWebView:self.webView];

  3. Make sure to import DGGeofencingHelper.h in the MainViewController.m file.

  4. In your JavaScript add the following code in the same place where you process the documentReady event.

    document.addEventListener("region-update", function(event) {
 	var fid = event.regionupdate.fid;
 	var status = event.regionupdate.status;
 });

  5. For location changes add the following code in your JavaScript code in the same place where you process the documentReady event.

    document.addEventListener('location-update', function(event) {
 	var new_timestamp = event.locationupdate.new_timestamp;
 	var new_speed = event.locationupdate.new_speed;
 	var new_course = event.locationupdate.new_course;
 	var new_verticalAccuracy = event.locationupdate.new_verticalAccuracy;
 	var new_horizontalAccuracy = event.locationupdate.new_horizontalAccuracy;
 	var new_altitude = event.locationupdate.new_altitude;
 	var new_latitude = event.locationupdate.new_latitude;
 	var new_longitude = event.locationupdate.new_longitude;
 		
 	var old_timestamp = event.locationupdate.old_timestamp;
 	var old_speed = event.locationupdate.old_speed;
 	var old_course = event.locationupdate.old_course;
 	var old_verticalAccuracy = event.locationupdate.old_verticalAccuracy;
 	var old_horizontalAccuracy = event.locationupdate.old_horizontalAccuracy;
 	var old_altitude = event.locationupdate.old_altitude;
 	var old_latitude = event.locationupdate.old_latitude;
 	var old_longitude = event.locationupdate.old_longitude;
 		
 	console.log("Location Update Event: " + event);	
 });

When the app is not running, even in the background, region notifications are saved as they come in. In order to retrieve these pending region notifications follow these instructions.

  1. Add the following code in the app delegate - (BOOL) application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions
if ([[launchOptions allKeys] containsObject:UIApplicationLaunchOptionsLocationKey]) {
    [[DGGeofencingHelper sharedGeofencingHelper] setDidLaunchForRegionUpdate:YES];
} else {
    [[DGGeofencingHelper sharedGeofencingHelper] setDidLaunchForRegionUpdate:NO];
}

  1. In the JavaScript you will need to use the following code to retrieve these notifications.

        DGGeofencing.getPendingRegionUpdates(
 		function(result) { 
 			var updates = result.pendingupdates;
 			$(updates).each(function(index, update){
 				var fid = update.fid;
 				var status = update.status;
 				var timestamp = update.timestamp;
 				console.log("fid: " + fid + " status: " + status + " timestamp: " + timestamp);
 			});   
       	},
       	function(error) {   
 	  		alert("failed");
       	}
 	);

USAGE SAMPLE CODE

Feel free to take a look at a project I have made that uses the above plugin. You can find this project in my github repository Phonegap-Geofencing.

QUESTIONS AND COMMENTS

All questions and comments are welcome. Please do so on my GitHub Page.

The latest version of the DGGeofencing plugin can always be found here.

If you would like to have me consult on a project you can always reach me at [email protected].

THANKS

A big thank you to @edewit for authoring the Android DGGeofencing PhoneGap Plugin.

LICENSE

The MIT License

Copyright (c) 2012 Dov Goldberg EMAIL: [email protected]
WEBSITE: http://www.ogonium.com

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.