Popularity
2.6
Growing
Activity
0.1
-
70
19
18

Description

Location tracking & geofencing the easy way. Supports background, killed app, rebooted device different update intervals.

Programming language: Kotlin
License: MIT License
Latest version: v1.2.2

Geolocator alternatives and similar packages

Based on the "Animations" category.
Alternatively, view Geolocator alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Geolocator or a related project?

Add another 'Animations' Package

README

Geofencer

Build Status Download Hits-of-Code API Gradle Version Kotlin Android Arsenal

Convience library to receive user location updates and geofence events with minimal effort.

Features:

  • supports Android-Q
  • receive updates on background
  • receive updates if app got killed
  • geofence updates (dwell, enter, exit)
  • location updates
  • configurable update intervals

[sample.gif](sample.gif)

Requirmenets

  1. Location permissions in [AndroidManifest.xml](app/src/main/AndroidManifest.xml#L8-L9)

    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    
  2. Google maps api key

    <string name="google_maps_key" templateMergeStrategy="preserve" translatable="false">YOUR_KEY</string>
    

How to use

Geofence

  1. Create [Receiver](app/src/main/java/com/sprotte/geolocator/demo/kotlin/GeofenceIntentService.kt)
class GeofenceIntentService : GeofenceIntentService() {

    override fun onGeofence(geofence: Geofence) {
        Log.v(GeoFenceIntentService::class.java.simpleName, "onGeofence $geofence")     
    }
}
  1. Add receiver to your [manifest](app/src/main/AndroidManifest.xml#L45-L47)

    <service
        android:name=".kotlin.GeoFenceIntentService"
        android:permission="android.permission.BIND_JOB_SERVICE" />
    
  2. [Start geofence tracking](app/src/main/java/com/sprotte/geolocator/demo/kotlin/MainActivity.kt#L33-L46)

val geofence = Geofence(
    id = UUID.randomUUID().toString(),
    latitude = 51.0899232,
    longitude = 5.968358,
    radius = 30.0,
    title = "Germany",
    message = "Entered Germany",
    transitionType = GEOFENCE_TRANSITION_ENTER
)

Geofencer(this).addGeofence(geofence, GeoFenceIntentService::class.java) { /* successfully added geofence */ }

Location Tracker

  1. Create [Receiver](app/src/main/java/com/sprotte/geolocator/demo/kotlin/LocationTrackerService.kt)
class LocationTrackerService : LocationTrackerUpdateIntentService() {

    override fun onLocationResult(locationResult: LocationResult) {  
        Log.v(GeoFenceIntentService::class.java.simpleName, "onLocationResult $location")
  }
}
  1. Add receiver to [manifest](app/src/main/AndroidManifest.xml#L49-L51)

    <service
        android:name=".kotlin.LocationTrackerService"
        android:permission="android.permission.BIND_JOB_SERVICE" />
    
  2. [Start tracking](app/src/main/java/com/sprotte/geolocator/demo/kotlin/MainActivity.kt#L48-L51)

LocationTracker.requestLocationUpdates(this, LocationTrackerService::class.java)
  1. Stop tracking
LocationTracker.removeLocationUpdates(requireContext())

How to use in Java

Geofence

  1. Create [Receiver](app/src/main/java/com/sprotte/geolocator/demo/java/GeofenceIntentService.java)
public class GeoFenceIntentService extends GeofenceIntentService {

    @Override
    public void onGeofence(@NotNull Geofence geofence) {

        Log.v(GeoFenceIntentService.class.getSimpleName(), "onGeofence " + geofence);           
    }
}
  1. Add receiver to your [manifest](app/src/main/AndroidManifest.xml#L63-L65)

    <service
        android:name=".java.GeoFenceIntentService"
        android:permission="android.permission.BIND_JOB_SERVICE" />
    
  2. [Start geofence tracking](app/src/main/java/com/sprotte/geolocator/demo/java/AddGeoFenceActivity.java#L48-L63)

Geofence geofence = new Geofence(
        UUID.randomUUID().toString(),
        51.0899232,
        5.968358,
        30.0,
        "Germany",
        "Entered Germany",
        GEOFENCE_TRANSITION_ENTER);
Geofencer geofencer = new Geofencer(this);
geofencer.addGeofence(geofence, GeoFenceIntentService.class,
     () -> /* successfully added geofence */ Unit.INSTANCE);             

Location Tracker

  1. Create [Receiver](app/src/main/java/com/sprotte/geolocator/demo/java/LocationTrackerService.java)
public class LocationTrackerService extends LocationTrackerUpdateIntentService {

    @Override
    public void onLocationResult(@NotNull LocationResult location) {

        Log.v(GeoFenceIntentService.class.getSimpleName(), "onLocationResult " + location);             );
    }
}
  1. Add receiver to [manifest](app/src/main/AndroidManifest.xml#L66-L68)

    <service
        android:name=".java.LocationTrackerService"
        android:permission="android.permission.BIND_JOB_SERVICE" />
    
  2. Start tracking

LocationTracker.INSTANCE.requestLocationUpdates(this, LocationTrackerService.class);
  1. Stop tracking
LocationTracker.INSTANCE.removeLocationUpdates(this);

How to install

jCenter / mavenCentral

implementation 'com.sprotte:Geolocator:latest'

or Jiptack

Step 1. Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}
Step 2. Add the dependency
dependencies {
    implementation 'com.github.exozet:Geolocator:latest'
    implementation 'com.google.android.gms:play-services-location:17.0.0'
}

Configuration

Default Location tracking update intervals can be overriden, by adding following parameter into your app/res/ - folder, e.g. [app/res/config.xml](app/src/main/res/values/config.xml#L4-L7)

    <!-- Location Tracker -->
    <integer name="location_update_interval_in_millis">0</integer>
    <integer name="location_fastest_update_interval_in_millis">0</integer>
    <integer name="location_max_wait_time_interval_in_millis">0</integer>
    <integer name="location_min_distance_for_updates_in_meters">0</integer>

    <!-- Geofencer -->
    <integer name="loitering_delay">1</integer>
    <integer name="notification_responsiveness">1</integer>
    <integer name="expiration_duration">-1</integer> // -1 == NEVER_EXPIRE

You can also set this values at runtime in some step before call method requestLocationUpdates

    int interval = 1000;
    int fastestInterval = 2000;
    int priority = LocationRequest.PRIORITY_HIGH_ACCURACY;
    int maxWaitTime = 10000;
    int smallestDisplacement = 20;

    LocationTrackerParams locationTrackerParams = new LocationTrackerParams(
            interval, fastestInterval, priority, maxWaitTime, smallestDisplacement);

    LocationTracker.INSTANCE.requestLocationUpdates(this, LocationTrackerService.class, locationTrackerParams);

LocationTrackerParams is a open class for kotlin or a not final class for java, so if you don't need to setup all params you can extend it.

Known Issues

  • does not work when in doze mode #2

Contributors

[Jan Rabe]([email protected])

[Paul Sprotte]([email protected])

AgnaldoNP