Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/transistorsoft/capacitor-background-geolocation-firebase
Firebase adapter for Capacitor Background Geolocation
https://github.com/transistorsoft/capacitor-background-geolocation-firebase
Last synced: 24 days ago
JSON representation
Firebase adapter for Capacitor Background Geolocation
- Host: GitHub
- URL: https://github.com/transistorsoft/capacitor-background-geolocation-firebase
- Owner: transistorsoft
- Created: 2021-07-19T15:50:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T16:03:43.000Z (about 1 month ago)
- Last Synced: 2024-11-13T19:44:04.675Z (29 days ago)
- Language: TypeScript
- Size: 1.07 MB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-capacitor - Background Geolocation Firebase - Firebase adapter for Capacitor Background Geolocation. ([Transistor Software plugins](https://www.transistorsoft.com//))
README
# capacitor-background-geolocation-firebase
[](https://www.transistorsoft.com)
By [**Transistor Software**](http://transistorsoft.com), creators of [**Capacitor Background Geolocation**](http://www.transistorsoft.com/shop/products/capacitor-background-geolocation)
------------------------------------------------------------------------------
Firebase Proxy for [Capacitor Background Geolocation](https://github.com/transistorsoft/capacitor-background-geolocation). The plugin will automatically post locations to your own Firebase database, overriding the `capacitor-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).
----------------------------------------------------------------------------
## :large_blue_diamond: Installing the Plugin
### From npm
```
$ npm install @transistorsoft/capacitor-background-geolocation-firebase --save
```
### From yarn
```bash
$ yarn add @transistorsoft/capacitor-background-geolocation-firebase
```
### Latest from Github
```
$ npm install git+https://[email protected]:transistorsoft/capacitor-background-geolocation-firebase.git --save
```
## :large_blue_diamond: Setup Guides
## iOS
- [Required Setup](help/INSTALL-IOS.md)
## Android
- [Required Setup](help/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 ##
```javascript
import {BackgroundGeolocationFirebase} from "capacitor-background-geolocation-firebase";
```
## :large_blue_diamond: Example
```javascript
import { Component } from '@angular/core';
import BackgroundGeolocation from '@transistorsoft/capacitor-background-geolocation';
import {BackgroundGeolocationFirebase} from '@transistorsoft/capacitor-background-geolocation-firebase';
@Component({
selector: 'app-home',
templateUrl: 'home.page.html',
styleUrls: ['home.page.scss'],
})
export class HomePage {
constructor() {}
// Initialize in ngAfterContentInit
// [WARNING] DO NOT use ionViewWillEnter, as that method won't run when app is launched in background.
ngAfterContentInit() {
this.initBackgroundGeolocation();
}
async initBackgroundGeolocation() {
////
// 1. configure BackgroundGeolocationFirebase
//
BackgroundGeolocationFirebase.configure({
locationsCollection: "locations",
geofencesCollection: "geofences"
});
////
// 2. Configure BackgroundGeolocation as usual.
//
BackgroundGeolocation.ready({
...
}.then((state) => {
console.log("- BackgroundGeolocation is configured and ready");
});
}
}
```
## :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({
geofencesCollection: '/users/123/geofences'
});
BackgroundGeolocationFirebase.configure({
geofencesCollection: '/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) 2021 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.