https://github.com/transistorsoft/background-geolocation-firebase
Firebase proxy for Background Geolocation SDK (pure native version)
https://github.com/transistorsoft/background-geolocation-firebase
Last synced: 8 months ago
JSON representation
Firebase proxy for Background Geolocation SDK (pure native version)
- Host: GitHub
- URL: https://github.com/transistorsoft/background-geolocation-firebase
- Owner: transistorsoft
- License: mit
- Created: 2019-08-23T12:53:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-23T20:21:23.000Z (almost 7 years ago)
- Last Synced: 2025-10-02T15:40:58.928Z (8 months ago)
- Language: Objective-C
- Size: 104 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
background-geolocation-firebase
============================================================================
[](https://www.transistorsoft.com)
-------------------------------------------------------------------------------
Firebase Proxy for [BackgroundGeolocation Native SDK](https://github.com/transistorsoft/background-geolocation-lt). The plugin will automatically post locations to your own Firebase database, overriding the `background-geolocation` SDK'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).
----------------------------------------------------------------------------
## :large_blue_diamond: Installing the Plugin
You will have to install the plugin by manually downloading [a Release](https://github.com/transistorsoft/background-geolocation-firebase/releases) from this repository. The plugin is not currently submitted to a package manager (eg: jCenter)
Create a folder in the root of your application project, eg: `/Libraries` and place the extracted **`background-geolocation-firebase`** folder into it:
eg: :open_file_folder: **`Libraries/background-geolocation-firebase`**
## :large_blue_diamond: Setup Guides
- ### iOS
- [Cocoapods Setup](docs/INSTALL-IOS.md)
- ### Android
- [Manual Setup](docs/INSTALL-ANDROID.md)
## :large_blue_diamond: Configure your license
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 to `android/app/src/main/AndroidManifest.xml`:
```diff
+
.
.
.
```
## :large_blue_diamond: Using the plugin ##
### iOS
```Obj-c
#import "ViewController.h"
@import TSLocationManager;
#import "BackgroundGeolocationFirebase.h"
@interface ViewController ()
@end
@implementation ViewController
- (void)viewDidLoad {
TSLocationManager *bgGeo = [TSLocationManager sharedInstance];
TSConfig *config = [TSConfig sharedInstance];
// Get a reference to BackgroundGeolocationFirebase adapter
BackgroundGeolocationFirebase *firebaseAdapter = [BackgroundGeolocationFirebase sharedInstance];
// Configure firebase adapter as desired.
firebaseAdapter.locationsCollection = @"locations"; // <-- "locations" is default
firebaseAdapter.geofencesCollection = @"geofences"; // <-- "geofences" is default
firebaseAdapter.updateSingleDocument = NO; // <-- NO is default
// Register the Firebase adapter with BackgroundGeolocation
[config registerPlugin:firebaseAdapter.name];
// Continue implementing BackgroundGeolocation as normal
[config updateWithBlock:^(TSConfigBuilder *builder) {
builder.debug = YES;
builder.logLevel = tsLogLevelVerbose;
}];
[bgGeo ready];
[bgGeo start];
[super viewDidLoad];
}
@end
```
### Android
```java
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
////
// Get a reference to TSFirebaseProxy
//
TSFirebaseProxy firebaseProxy = TSFirebaseProxy.getInstance(getApplicationContext());
// Configure the TSFirebaseProxy
firebaseProxy.setLocationsCollection("locations"); // <-- "locations" is default
firebaseProxy.setGeofencesCollection("geofences"); // <-- "geofences" is default
firebaseProxy.setUpdateSingleDocument(false); // <-- false is default.
// Register the TSFirebaseProxy
firebaseProxy.register(getApplicationContext());
// Continue implementing BackgroundGeolocation as normal
final BackgroundGeolocation bgGeo = BackgroundGeolocation.getInstance(getApplicationContext(), getIntent());
final TSConfig config = TSConfig.getInstance(getApplicationContext());
// Configure the SDK:
config.updateWithBuilder()
// Configure Debugging
.setDebug(true)
// Configure Geolocation
.setDesiredAccuracy(LocationRequest.PRIORITY_HIGH_ACCURACY)
.setDistanceFilter(50f)
.commit();
// Finally, signal #ready to the plugin.
bgGeo.ready(new TSCallback() {
@Override public void onSuccess() {
TSLog.logger.debug("[ready] success");
if (!config.getEnabled()) {
bgGeo.start();
}
}
@Override public void onFailure(String error) {
TSLog.logger.debug("[ready] FAILURE: " + error);
}
});
}
}
```
## :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:
Eg:
- `"/locations"`
- `"/users/123/locations"`
- `"/users/123/routes/456/locations"`
#### `@param {String} geofencesCollection [geofences]`
The collection name to post `geofence` events to. Eg:
Eg:
- `"/geofences"`
- `"/users/123/geofences"`
- `"/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:
Eg:
- `"/locations/latest" // <-- 2 "parts": even`
- `"/users/123/routes/456/the_location" // <-- 4 "parts": even`
:warning: Do **not** use an *odd* number of "parts"
- `"/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.