https://github.com/transistorsoft/cordova-background-geolocation-firebase
Firebase Adapter for Cordova Background Geolocation
https://github.com/transistorsoft/cordova-background-geolocation-firebase
Last synced: 11 months ago
JSON representation
Firebase Adapter for Cordova Background Geolocation
- Host: GitHub
- URL: https://github.com/transistorsoft/cordova-background-geolocation-firebase
- Owner: transistorsoft
- License: mit
- Created: 2018-08-16T14:17:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-11-02T14:52:25.000Z (over 5 years ago)
- Last Synced: 2025-06-30T16:00:05.773Z (12 months ago)
- Language: Objective-C
- Size: 88.9 KB
- Stars: 7
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
cordova-background-geolocation-firebase · []() []()
============================================================================
[](https://www.transistorsoft.com)
-------------------------------------------------------------------------------
Firebase Proxy for [Cordova Background Geolocation](https://github.com/transistorsoft/cordova-background-geolocation-lt). The plugin will automatically post locations to your own Firebase database, overriding the `cordova-background-geolocation` plugin's SQLite / HTTP services.
----------------------------------------------------------------------------
The **[Android module](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase)** requires [purchasing a license](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase). However, it *will* work for **DEBUG** builds. It will **not** work with **RELEASE** builds [without purchasing a license](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase).
----------------------------------------------------------------------------
# Contents
- ### [Configuration Options](#large_blue_diamond-configuration-options)
- ### [Installing the Plugin](#large_blue_diamond-installing-the-plugin)
- ### [Setup Guide](#large_blue_diamond-setup-guide)
- ### [Using the plugin](#large_blue_diamond-using-the-plugin)
- ### [Example](#large_blue_diamond-example)
## :large_blue_diamond: Installing the Plugin
### From npm
```
$ cordova plugin add cordova-background-geolocation-firebase --save
```
## :large_blue_diamond: Setup Guide
You also need to download **`google-services.json`** on Android and **`GoogleService-Info.plist`** on iOS from **Firebase Console**. Place them into the cordova project root folder. Then use `` to copy those files into appropriate folders:
```xml
...
...
```
### Android
- Add the following `` to your `config.xml`
```xml
.
.
.
.
.
.
```
- Add the following plugin to your app (prefix with `ionic` if using Ionic):
```bash
$ cordova plugin add cordova-plugin-androidx-adapter
```
### iOS
This plugin imports iOS `Firebase` dependencies via **Cocoapods**. If you're unfamiliar with **Cocoapods**, [see here](https://guides.cocoapods.org/using/getting-started.html) to ensure you have it setup on your system.
After installing the plugin and adding the iOS platform, you must execute `$ pod install`:
```
$ cd platforms/ios
$ pod install
```
:warning: If you haven't update your pods in a while:
```
$ pod update
```
:warning: There's a cordova build issue I haven't yet been able to figure out: `cordova build ios` **will no longer work**:
```
$ cordova build ios
fatal error:
'RxLibrary/GRXWriteable.h' file not found
#import
^~~~~~~~~~~~~~~~~~~~~~~~~~
1 error generated.
```
As a result, you'll have to build your app using XCode from **`YourProject.xcworkspace`** (**not** `YourProject.xcodeproj`).
### Configure your license
:information_source: If you don't *have* a license yet, the plugin is fully functional in `DEBUG` builds so you can try it before [purchasing a license](https://shop.transistorsoft.com/collections/frontpage/products/background-geolocation-firebase).
1. Login to Customer Dashboard to generate an application key:
[www.transistorsoft.com/shop/customers](http://www.transistorsoft.com/shop/customers)
2. Add your license-key:
```
$ cordova plugin remove cordova-background-geolocation-firebase
$ cordova plugin add cordova-background-geolocation-firebase --variable LICENSE=YOUR_KEY_HERE
```
## :large_blue_diamond: Using the plugin ##
The plugin creates the object **`window.BackgroundGeolocationFirebase`**.
```javascript
var bgGeoFirebase = window.BackgroundGeolocationFirebase;
```
### Ionic 2+:
```javascript
let bgGeoFirebase = (window).BackgroundGeolocationFirebase;
```
## :large_blue_diamond: Example
```javascript
onDeviceReady() {
var bgGeoFirebase = window.BackgroundGeolocationFirebase;
bgGeoFirebase.configure({
locationsCollection: 'locations',
geofencesCollection: 'geofences'
});
// Now configure background-geolocation as normal. Nothing changes here.
var bgGeo = window.BackgroundGeolocation;
bgGeo.on('location', function(location) {...});
bgGeo.ready({
.
.
.
}, function(state) {
console.log('[BackgroundGeolocation] ready -', state);
});
}
```
### Ionic 2+
```javascript
import { Component } from '@angular/core';
import { NavController, Platform } from 'ionic-angular';
@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
constructor(public navCtrl: NavController, public platform: Platform) {
}
ionViewDidLoad() {
this.platform.ready().then(() => {
this.configureBackgroundGeolocation();
});
}
configureBackgroundGeolocation() {
let bgGeoFirebase = (window).BackgroundGeolocationFirebase;
bgGeoFirebase.configure({
locationsCollection: 'locations',
geofencesCollection: 'geofences'
});
let bgGeo = (window).BackgroundGeolocation;
bgGeo.on('location', (location) => {
console.log('[location] - ', location);
});
bgGeo.ready({
stopOnTerminate: false,
debug: true
}, (state) => {
if (!state.enabled) {
bgGeo.start();
}
});
}
}
```
## :large_blue_diamond: Firebase Functions
`BackgroundGeolocation` will post its default "Location Data Schema" to your Firebase app.
```json
{
"location":{},
"param1": "param 1",
"param2": "param 2"
}
```
You should implement your own [Firebase Functions](https://firebase.google.com/docs/functions/) to "*massage*" the incoming data in your collection as desired. For example:
```typescript
import * as functions from 'firebase-functions';
exports.createLocation = functions.firestore
.document('locations/{locationId}')
.onCreate((snap, context) => {
const record = snap.data();
const location = record.location;
console.log('[data] - ', record);
return snap.ref.set({
uuid: location.uuid,
timestamp: location.timestamp,
is_moving: location.is_moving,
latitude: location.coords.latitude,
longitude: location.coords.longitude,
speed: location.coords.speed,
heading: location.coords.heading,
altitude: location.coords.altitude,
event: location.event,
battery_is_charging: location.battery.is_charging,
battery_level: location.battery.level,
activity_type: location.activity.type,
activity_confidence: location.activity.confidence,
extras: location.extras
});
});
exports.createGeofence = functions.firestore
.document('geofences/{geofenceId}')
.onCreate((snap, context) => {
const record = snap.data();
const location = record.location;
console.log('[data] - ', record);
return snap.ref.set({
uuid: location.uuid,
identifier: location.geofence.identifier,
action: location.geofence.action,
timestamp: location.timestamp,
latitude: location.coords.latitude,
longitude: location.coords.longitude,
extras: location.extras,
});
});
```
## :large_blue_diamond: Configuration Options
#### `@param {String} locationsCollection [locations]`
The collection name to post `location` events to. Eg:
```javascript
BackgroundGeolocationFirebase.configure({
locationsCollection: '/locations'
});
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/locations'
});
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/routes/456/locations'
});
```
#### `@param {String} geofencesCollection [geofences]`
The collection name to post `geofence` events to. Eg:
```javascript
BackgroundGeolocationFirebase.configure({
geofencesCollection: '/geofences'
});
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/geofences'
});
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/routes/456/geofences'
});
```
#### `@param {Boolean} updateSingleDocument [false]`
If you prefer, you can instruct the plugin to update a *single document* in Firebase rather than creating a new document for *each* `location` / `geofence`. In this case, you would presumably implement a *Firebase Function* to deal with updates upon this single document and store the location in some other collection as desired. If this is your use-case, you'll also need to ensure you configure your `locationsCollection` / `geofencesCollection` accordingly with an even number of "parts", taking the form `/collection_name/document_id`, eg:
```javascript
BackgroundGeolocationFirebase.configure({
locationsCollection: '/locations/latest' // <-- 2 "parts": even
});
// or
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/routes/456/the_location' // <-- 4 "parts": even
});
// Don't use an odd number of "parts"
BackgroundGeolocationFirebase.configure({
locationsCollection: '/users/123/latest_location' // <-- 3 "parts": odd!! No!
});
```
# License
The MIT License (MIT)
Copyright (c) 2018 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.