Wherro [Not Maintained Anymore]

A module that helps in syncing locations

• Getting Started
• Features
• Configure
• FAQ
• Contributing

Wherro simplifies the location syncing to the server.

Apps using Wherro will run 2 services responsible for Location Syncing

Getting Started 👣

Wherro is distributed through Bintray. To use it you need to add the following Gradle dependency to your build.gradle file of your android app module (NOT the root file).

repositories {
    maven { url "https://jitpack.io" }
}

dependencies {
  implementation 'com.shuttl:locationsyncservice:0.15'
}

To start using Wherro, just put in LocationConfigs through LocationsHelper.initLocationsModule method:

LocationsHelper.initLocationsModule(app = application, locationConfigs = LocationConfigs())

Following need to be added in the app's AndroidManifest root

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />

Add this to your app's AndroidManifest application

<service android:name="com.shuttl.location_pings.service.LocationPingService" />
<service android:name="com.shuttl.location_pings.service.LocationSaveService" />

That's it! 🎉 Wherro will now start 2 services corresponding to Location Saving and Location Syncing simultaneously and show 1 notification for the same

Features 🧰

Don't forget to check the changelog to have a look at all the changes in the latest version of Wherro.

• Compatible with OkHTTP 4 | Retrofit
• API >= 16 compatible
• Easy to integrate (just a 2 gradle implementation line)
• Highly Configurable

Configure 🎨

LocationConfigs(val minTimeInterval: Int = 10000, // min Time Interval for Location Fetching
  val minDistanceInterval: Int = 100, // min Distance Interval for Location Fetching
  val minSyncInterval: Int = 10000, // min Time Interval for Location Syncing
  val xApiKey: String? = "", // xApiKey Auth Key for the URL to function, if you have one
  val syncUrl: String? = "" // PUTs the location parameters on this URL
  )

Request Body JSON in the PUT network call, along with xApiKey as Authorization

[
	{
	   "lat": 23,
	   "long": 23,
	   "accuracy": 20,
	   "provider": "gps",
	   "timestamp": "1202"
	},
	{
	   "lat": 26.0012,
	   "long": 23.0012,
	   "accuracy": 20.00,
	   "provider": "gps",
	   "timestamp": "1203"
	}
]

FAQ ❓

• Why is it not working for me? - dependency issue maybe, create an issue if it doesn't work
• Why is Notification not showing up for me? - some phones have an issue with running services, create an issue if you find such issues
• Can I modify JSON Request/Params? - in works, will be updated soon

Contributing 🤝

We're looking for contributors! Don't be shy. 😁 Feel free to open issues/pull requests to help me improve this project.