├── Source ├── settings.gradle ├── sample │ ├── lint.xml │ ├── src │ │ └── main │ │ │ ├── res │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ └── styles.xml │ │ │ ├── drawable-hdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── drawable-mdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── drawable-xhdpi │ │ │ │ └── ic_launcher.png │ │ │ ├── values-v11 │ │ │ │ └── styles.xml │ │ │ ├── values-v14 │ │ │ │ └── styles.xml │ │ │ └── layout │ │ │ │ └── activity_main.xml │ │ │ ├── AndroidManifest.xml │ │ │ └── java │ │ │ └── im │ │ │ └── delight │ │ │ └── android │ │ │ └── example │ │ │ └── location │ │ │ └── MainActivity.java │ └── build.gradle ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties ├── .editorconfig ├── library │ ├── src │ │ └── main │ │ │ ├── AndroidManifest.xml │ │ │ └── java │ │ │ └── im │ │ │ └── delight │ │ │ └── android │ │ │ └── location │ │ │ └── SimpleLocation.java │ └── build.gradle ├── build.gradle ├── .gitignore ├── gradlew.bat └── gradlew ├── NOTICE ├── .editorconfig ├── README.md └── LICENSE /Source/settings.gradle: -------------------------------------------------------------------------------- 1 | include ':library' 2 | include ':sample' 3 | -------------------------------------------------------------------------------- /Source/sample/lint.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /Source/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/delight-im/Android-SimpleLocation/HEAD/Source/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /Source/sample/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Android-SimpleLocation-Test 4 | 5 | 6 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Android-SimpleLocation 2 | Copyright (c) delight.im 3 | 4 | This product includes software developed by 5 | delight.im (http://www.delight.im/). 6 | -------------------------------------------------------------------------------- /Source/sample/src/main/res/drawable-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/delight-im/Android-SimpleLocation/HEAD/Source/sample/src/main/res/drawable-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /Source/sample/src/main/res/drawable-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/delight-im/Android-SimpleLocation/HEAD/Source/sample/src/main/res/drawable-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /Source/sample/src/main/res/drawable-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/delight-im/Android-SimpleLocation/HEAD/Source/sample/src/main/res/drawable-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | indent_style = tab 7 | trim_trailing_whitespace = true 8 | end_of_line = lf 9 | insert_final_newline = true 10 | 11 | [*.md] 12 | indent_style = space 13 | indent_size = 4 14 | -------------------------------------------------------------------------------- /Source/.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | indent_style = tab 7 | trim_trailing_whitespace = true 8 | end_of_line = lf 9 | insert_final_newline = true 10 | 11 | [*.md] 12 | indent_style = space 13 | indent_size = 4 14 | -------------------------------------------------------------------------------- /Source/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Wed Oct 21 11:34:03 PDT 2015 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.8-all.zip 7 | -------------------------------------------------------------------------------- /Source/library/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 4 | 7 | 8 | -------------------------------------------------------------------------------- /Source/sample/src/main/res/values-v11/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /Source/build.gradle: -------------------------------------------------------------------------------- 1 | // Top-level build file where you can add configuration options common to all sub-projects/modules. 2 | buildscript { 3 | repositories { 4 | jcenter() 5 | } 6 | dependencies { 7 | classpath 'com.android.tools.build:gradle:1.5.0' 8 | classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3' 9 | } 10 | } 11 | 12 | allprojects { 13 | repositories { 14 | jcenter() 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /Source/sample/src/main/res/values-v14/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /Source/sample/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 14 | 15 | -------------------------------------------------------------------------------- /Source/sample/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | android { 3 | compileSdkVersion 19 4 | buildToolsVersion "23.0.1" 5 | 6 | defaultConfig { 7 | applicationId "im.delight.android.example.location" 8 | minSdkVersion 8 9 | targetSdkVersion 19 10 | } 11 | 12 | buildTypes { 13 | release { 14 | minifyEnabled false 15 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt' 16 | } 17 | } 18 | } 19 | 20 | dependencies { 21 | compile project(':library') 22 | } 23 | -------------------------------------------------------------------------------- /Source/.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.ap_ 4 | 5 | # Files for the Dalvik VM 6 | *.dex 7 | 8 | # Java class files 9 | *.class 10 | 11 | # Generated files 12 | bin/ 13 | gen/ 14 | 15 | # Gradle files 16 | .gradle/ 17 | build/ 18 | 19 | # Local configuration file (sdk path, etc) 20 | local.properties 21 | 22 | # Proguard folder generated by Eclipse 23 | proguard/ 24 | 25 | # Log Files 26 | *.log 27 | 28 | # Android Studio Navigation editor temp files 29 | .navigation/ 30 | 31 | # Android Studio captures folder 32 | captures/ 33 | 34 | # Custom 35 | .idea/ 36 | *.iml 37 | -------------------------------------------------------------------------------- /Source/sample/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | 14 | 15 | 16 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /Source/library/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.library' 2 | apply plugin: 'com.github.dcendents.android-maven' 3 | 4 | android { 5 | compileSdkVersion 19 6 | buildToolsVersion "23.0.1" 7 | 8 | defaultConfig { 9 | minSdkVersion 8 10 | targetSdkVersion 19 11 | } 12 | 13 | buildTypes { 14 | release { 15 | minifyEnabled false 16 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt' 17 | } 18 | } 19 | } 20 | 21 | task sourcesJar(type: Jar) { 22 | from android.sourceSets.main.java.srcDirs 23 | classifier = 'sources' 24 | } 25 | 26 | task javadoc(type: Javadoc) { 27 | failOnError false 28 | source = android.sourceSets.main.java.sourceFiles 29 | classpath += project.files(android.getBootClasspath().join(File.pathSeparator)) 30 | } 31 | 32 | task javadocJar(type: Jar, dependsOn: javadoc) { 33 | classifier = 'javadoc' 34 | from javadoc.destinationDir 35 | } 36 | 37 | artifacts { 38 | archives sourcesJar 39 | archives javadocJar 40 | } 41 | -------------------------------------------------------------------------------- /Source/sample/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 6 | 9 | 10 | 11 | 16 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /Source/sample/src/main/java/im/delight/android/example/location/MainActivity.java: -------------------------------------------------------------------------------- 1 | package im.delight.android.example.location; 2 | 3 | import android.os.Bundle; 4 | import android.app.Activity; 5 | import android.view.View; 6 | import android.widget.Toast; 7 | 8 | import im.delight.android.location.SimpleLocation; 9 | 10 | public class MainActivity extends Activity { 11 | 12 | private SimpleLocation mLocation; 13 | 14 | @Override 15 | protected void onCreate(final Bundle savedInstanceState) { 16 | super.onCreate(savedInstanceState); 17 | setContentView(R.layout.activity_main); 18 | 19 | // construct a new instance 20 | mLocation = new SimpleLocation(this); 21 | 22 | // reduce the precision to 5,000m for privacy reasons 23 | mLocation.setBlurRadius(5000); 24 | 25 | // if we can't access the location yet 26 | if (!mLocation.hasLocationEnabled()) { 27 | // ask the user to enable location access 28 | SimpleLocation.openSettings(this); 29 | } 30 | 31 | findViewById(R.id.textView).setOnClickListener(new View.OnClickListener() { 32 | 33 | @Override 34 | public void onClick(View v) { 35 | final double latitude = mLocation.getLatitude(); 36 | final double longitude = mLocation.getLongitude(); 37 | final long timestampInMilliseconds = mLocation.getTimestampInMilliseconds(); 38 | final long elapsedTimeInNanoseconds = mLocation.getElapsedTimeInNanoseconds(); 39 | 40 | Toast.makeText(MainActivity.this, "Latitude: "+latitude, Toast.LENGTH_SHORT).show(); 41 | Toast.makeText(MainActivity.this, "Longitude: "+longitude, Toast.LENGTH_SHORT).show(); 42 | Toast.makeText(MainActivity.this, "Timestamp in milliseconds: "+timestampInMilliseconds, Toast.LENGTH_SHORT).show(); 43 | Toast.makeText(MainActivity.this, "Elapsed time in nanoseconds: "+elapsedTimeInNanoseconds, Toast.LENGTH_SHORT).show(); 44 | } 45 | 46 | }); 47 | } 48 | 49 | @Override 50 | protected void onResume() { 51 | super.onResume(); 52 | 53 | // make the device update its location 54 | mLocation.beginUpdates(); 55 | } 56 | 57 | @Override 58 | protected void onPause() { 59 | // stop location updates (saves battery) 60 | mLocation.endUpdates(); 61 | 62 | super.onPause(); 63 | } 64 | 65 | } 66 | -------------------------------------------------------------------------------- /Source/gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /Source/gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Android-SimpleLocation 2 | 3 | Utility class for easy access to the device location on Android 4 | 5 | ## Requirements 6 | 7 | * Android 2.2+ 8 | 9 | ## Installation 10 | 11 | * Add this library to your project 12 | * Declare the Gradle repository in your root `build.gradle` 13 | 14 | ```gradle 15 | allprojects { 16 | repositories { 17 | maven { url "https://jitpack.io" } 18 | } 19 | } 20 | ``` 21 | 22 | * Declare the Gradle dependency in your app module's `build.gradle` 23 | 24 | ```gradle 25 | dependencies { 26 | compile 'com.github.delight-im:Android-SimpleLocation:v1.1.0' 27 | } 28 | ``` 29 | 30 | ## Usage 31 | 32 | ### Decide for the required granularity 33 | 34 | * If you want to get the device's location with fine granularity (between 2m and 100m precision), GPS will be required. This consumes more battery but is most precise. 35 | * If you want to get the device's location with coarse granularity only (precise to several hundred meters), the location will be retrieved from the network (Wi-Fi and cell towers). This saves battery but is less precise. 36 | 37 | ### Add the required permissions 38 | 39 | For fine location (GPS location), add the following permission in your `AndroidManifest.xml`: 40 | 41 | ```xml 42 | 43 | ``` 44 | 45 | For coarse location (network location), add the following permission in your `AndroidManifest.xml`: 46 | 47 | ```xml 48 | 49 | ``` 50 | 51 | ### Retrieve the location from the device 52 | 53 | ```java 54 | public class MyActivity extends Activity { 55 | 56 | private SimpleLocation location; 57 | 58 | @Override 59 | protected void onCreate(Bundle savedInstanceState) { 60 | super.onCreate(savedInstanceState); 61 | 62 | // ... 63 | 64 | // construct a new instance of SimpleLocation 65 | location = new SimpleLocation(this); 66 | 67 | // if we can't access the location yet 68 | if (!location.hasLocationEnabled()) { 69 | // ask the user to enable location access 70 | SimpleLocation.openSettings(this); 71 | } 72 | 73 | findViewById(R.id.someView).setOnClickListener(new View.OnClickListener() { 74 | 75 | @Override 76 | public void onClick(View v) { 77 | final double latitude = location.getLatitude(); 78 | final double longitude = location.getLongitude(); 79 | 80 | // TODO 81 | } 82 | 83 | }); 84 | } 85 | 86 | @Override 87 | protected void onResume() { 88 | super.onResume(); 89 | 90 | // make the device update its location 91 | location.beginUpdates(); 92 | 93 | // ... 94 | } 95 | 96 | @Override 97 | protected void onPause() { 98 | // stop location updates (saves battery) 99 | location.endUpdates(); 100 | 101 | // ... 102 | 103 | super.onPause(); 104 | } 105 | 106 | } 107 | ``` 108 | 109 | ### Getting notified about location updates 110 | 111 | ```java 112 | location.setListener(new SimpleLocation.Listener() { 113 | 114 | public void onPositionChanged() { 115 | // new location data has been received and can be accessed 116 | } 117 | 118 | }); 119 | ``` 120 | 121 | ### Extended constructor options 122 | 123 | ```java 124 | Context context = this; 125 | boolean requireFineGranularity = false; 126 | new SimpleLocation(context, requireFineGranularity); 127 | 128 | // or 129 | 130 | Context context = this; 131 | boolean requireFineGranularity = false; 132 | boolean passiveMode = false; 133 | new SimpleLocation(context, requireFineGranularity, passiveMode); 134 | 135 | // or 136 | 137 | Context context = this; 138 | boolean requireFineGranularity = false; 139 | boolean passiveMode = false; 140 | long updateIntervalInMilliseconds = 10 * 60 * 1000; 141 | new SimpleLocation(context, requireFineGranularity, passiveMode, updateIntervalInMilliseconds); 142 | 143 | // or 144 | 145 | Context context = this; 146 | boolean requireFineGranularity = false; 147 | boolean passiveMode = false; 148 | long updateIntervalInMilliseconds = 10 * 60 * 1000; 149 | boolean requireNewLocation = false; 150 | new SimpleLocation(context, requireFineGranularity, passiveMode, updateIntervalInMilliseconds, requireNewLocation); 151 | ``` 152 | 153 | ### Retrieving available data 154 | 155 | ```java 156 | SimpleLocation.Point position = location.getPosition(); 157 | // double latitude = position.latitude; 158 | // and 159 | // double longitude = position.longitude; 160 | 161 | // or 162 | 163 | double latitude = location.getLatitude(); 164 | // and 165 | double longitude = location.getLongitude(); 166 | 167 | // or 168 | 169 | long timestampInMilliseconds = location.getTimestampInMilliseconds(); 170 | 171 | // or 172 | 173 | long elapsedTimeInNanoseconds = location.getElapsedTimeInNanoseconds(); 174 | 175 | // or 176 | 177 | float speed = location.getSpeed(); 178 | 179 | // or 180 | 181 | double altitude = location.getAltitude(); 182 | ``` 183 | 184 | ### Calculating the distance between two locations 185 | 186 | ```java 187 | double startLatitude = 59.95; 188 | double startLongitude = 30.3; 189 | double endLatitude = 44.84; 190 | double endLongitude = -0.58; 191 | location.calculateDistance(startLatitude, startLongitude, endLatitude, endLongitude); 192 | 193 | // or 194 | 195 | Point startPoint = new SimpleLocation.Point(59.95, 30.3); 196 | Point endPoint = new SimpleLocation.Point(44.84, -0.58); 197 | location.calculateDistance(startPoint, endPoint); 198 | ``` 199 | 200 | ### Blurring the location (for privacy reasons) 201 | 202 | ```java 203 | // reduce the precision to 10,000m (for privacy reasons) 204 | int blurRadiusInMeters = 10000; 205 | location.setBlurRadius(blurRadiusInMeters); 206 | ``` 207 | 208 | ## License 209 | 210 | ``` 211 | Copyright (c) delight.im 212 | 213 | Licensed under the Apache License, Version 2.0 (the "License"); 214 | you may not use this file except in compliance with the License. 215 | You may obtain a copy of the License at 216 | 217 | http://www.apache.org/licenses/LICENSE-2.0 218 | 219 | Unless required by applicable law or agreed to in writing, software 220 | distributed under the License is distributed on an "AS IS" BASIS, 221 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 222 | See the License for the specific language governing permissions and 223 | limitations under the License. 224 | ``` 225 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Source/library/src/main/java/im/delight/android/location/SimpleLocation.java: -------------------------------------------------------------------------------- 1 | package im.delight.android.location; 2 | 3 | /* 4 | * Copyright (c) delight.im 5 | * 6 | * Licensed under the Apache License, Version 2.0 (the "License"); 7 | * you may not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, software 13 | * distributed under the License is distributed on an "AS IS" BASIS, 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | * See the License for the specific language governing permissions and 16 | * limitations under the License. 17 | */ 18 | 19 | import android.os.Build; 20 | import android.os.Parcel; 21 | import android.os.Parcelable; 22 | import java.util.Random; 23 | import android.os.SystemClock; 24 | import android.provider.Settings; 25 | import android.content.Intent; 26 | import android.os.Bundle; 27 | import android.location.LocationListener; 28 | import android.location.Location; 29 | import android.content.Context; 30 | import android.location.LocationManager; 31 | 32 | /** Utility class for easy access to the device location on Android */ 33 | public class SimpleLocation { 34 | 35 | /** Wrapper for two coordinates (latitude and longitude) */ 36 | public static class Point implements Parcelable { 37 | 38 | /** The latitude of the point */ 39 | public final double latitude; 40 | /** The longitude of the point */ 41 | public final double longitude; 42 | 43 | /** 44 | * Constructs a new point from the given coordinates 45 | * 46 | * @param lat the latitude 47 | * @param lon the longitude 48 | */ 49 | public Point(double lat, double lon) { 50 | latitude = lat; 51 | longitude = lon; 52 | } 53 | 54 | @Override 55 | public String toString() { 56 | return "("+latitude+", "+longitude+")"; 57 | } 58 | 59 | public static final Parcelable.Creator CREATOR = new Parcelable.Creator() { 60 | 61 | @Override 62 | public Point createFromParcel(Parcel in) { 63 | return new Point(in); 64 | } 65 | 66 | @Override 67 | public Point[] newArray(int size) { 68 | return new Point[size]; 69 | } 70 | 71 | }; 72 | 73 | @Override 74 | public int describeContents() { 75 | return 0; 76 | } 77 | 78 | @Override 79 | public void writeToParcel(Parcel out, int flags) { 80 | out.writeDouble(latitude); 81 | out.writeDouble(longitude); 82 | } 83 | 84 | private Point(Parcel in) { 85 | latitude = in.readDouble(); 86 | longitude = in.readDouble(); 87 | } 88 | 89 | } 90 | 91 | /** Callback that can be implemented in order to listen for events */ 92 | public static interface Listener { 93 | 94 | /** Called whenever the device's position changes so that you can call {@link SimpleLocation#getPosition()} */ 95 | public void onPositionChanged(); 96 | 97 | } 98 | 99 | /** The internal name of the provider for the coarse location */ 100 | private static final String PROVIDER_COARSE = LocationManager.NETWORK_PROVIDER; 101 | /** The internal name of the provider for the fine location */ 102 | private static final String PROVIDER_FINE = LocationManager.GPS_PROVIDER; 103 | /** The internal name of the provider for the fine location in passive mode */ 104 | private static final String PROVIDER_FINE_PASSIVE = LocationManager.PASSIVE_PROVIDER; 105 | /** The default interval to receive new location updates after (in milliseconds) */ 106 | private static final long INTERVAL_DEFAULT = 10 * 60 * 1000; 107 | /** The factor for conversion from kilometers to meters */ 108 | private static final float KILOMETER_TO_METER = 1000.0f; 109 | /** The factor for conversion from latitude to kilometers */ 110 | private static final float LATITUDE_TO_KILOMETER = 111.133f; 111 | /** The factor for conversion from longitude to kilometers at zero degree in latitude */ 112 | private static final float LONGITUDE_TO_KILOMETER_AT_ZERO_LATITUDE = 111.320f; 113 | /** The PRNG that is used for location blurring */ 114 | private static final Random mRandom = new Random(); 115 | private static final double SQUARE_ROOT_TWO = Math.sqrt(2); 116 | /** The last location that was internally cached when creating new instances in the same process */ 117 | private static Location mCachedPosition; 118 | /** The LocationManager instance used to query the device location */ 119 | private final LocationManager mLocationManager; 120 | /** Whether a fine location should be required or coarse location can be used */ 121 | private final boolean mRequireFine; 122 | /** Whether passive mode shall be used or not */ 123 | private final boolean mPassive; 124 | /** The internal after which new location updates are requested (in milliseconds) where longer intervals save battery */ 125 | private final long mInterval; 126 | /** Whether to require a new location (`true`) or accept old (last known) locations as well (`false`) */ 127 | private final boolean mRequireNewLocation; 128 | /** The blur radius (in meters) that will be used to blur the location for privacy reasons */ 129 | private int mBlurRadius; 130 | /** The LocationListener instance used internally to listen for location updates */ 131 | private LocationListener mLocationListener; 132 | /** The current location with latitude, longitude, speed and altitude */ 133 | private Location mPosition; 134 | private Listener mListener; 135 | 136 | /** 137 | * Constructs a new instance with default granularity, mode and interval 138 | * 139 | * @param context the Context reference to get the system service from 140 | */ 141 | public SimpleLocation(final Context context) { 142 | this(context, false); 143 | } 144 | 145 | /** 146 | * Constructs a new instance with default mode and interval 147 | * 148 | * @param context the Context reference to get the system service from 149 | * @param requireFine whether to require fine location or use coarse location 150 | */ 151 | public SimpleLocation(final Context context, final boolean requireFine) { 152 | this(context, requireFine, false); 153 | } 154 | 155 | /** 156 | * Constructs a new instance with default interval 157 | * 158 | * @param context the Context reference to get the system service from 159 | * @param requireFine whether to require fine location or use coarse location 160 | * @param passive whether to use passive mode (to save battery) or active mode 161 | */ 162 | public SimpleLocation(final Context context, final boolean requireFine, final boolean passive) { 163 | this(context, requireFine, passive, INTERVAL_DEFAULT); 164 | } 165 | 166 | /** 167 | * Constructs a new instance 168 | * 169 | * @param context the Context reference to get the system service from 170 | * @param requireFine whether to require fine location or use coarse location 171 | * @param passive whether to use passive mode (to save battery) or active mode 172 | * @param interval the interval to request new location updates after (in milliseconds) where longer intervals save battery 173 | */ 174 | public SimpleLocation(final Context context, final boolean requireFine, final boolean passive, final long interval) { 175 | this(context, requireFine, passive, interval, false); 176 | } 177 | 178 | /** 179 | * Constructs a new instance 180 | * 181 | * @param context the Context reference to get the system service from 182 | * @param requireFine whether to require fine location or use coarse location 183 | * @param passive whether to use passive mode (to save battery) or active mode 184 | * @param interval the interval to request new location updates after (in milliseconds) where longer intervals save battery 185 | * @param requireNewLocation whether to require a new location (`true`) or accept old (last known) locations as well (`false`) 186 | */ 187 | public SimpleLocation(final Context context, final boolean requireFine, final boolean passive, final long interval, final boolean requireNewLocation) { 188 | mLocationManager = (LocationManager) context.getApplicationContext().getSystemService(Context.LOCATION_SERVICE); 189 | mRequireFine = requireFine; 190 | mPassive = passive; 191 | mInterval = interval; 192 | mRequireNewLocation = requireNewLocation; 193 | 194 | if (!mRequireNewLocation) { 195 | mPosition = getCachedPosition(); 196 | cachePosition(); 197 | } 198 | } 199 | 200 | /** 201 | * Attaches or detaches a listener that informs about certain events 202 | * 203 | * @param listener the `SimpleLocation.Listener` instance to attach or `null` to detach 204 | */ 205 | public void setListener(final Listener listener) { 206 | mListener = listener; 207 | } 208 | 209 | /** 210 | * Whether the device has location access enabled in the settings 211 | * 212 | * @return whether location access is enabled or not 213 | */ 214 | public boolean hasLocationEnabled() { 215 | return hasLocationEnabled(getProviderName()); 216 | } 217 | 218 | private boolean hasLocationEnabled(final String providerName) { 219 | try { 220 | return mLocationManager.isProviderEnabled(providerName); 221 | } 222 | catch (Exception e) { 223 | return false; 224 | } 225 | } 226 | 227 | /** Starts updating the location and requesting new updates after the defined interval */ 228 | public void beginUpdates() { 229 | if (mLocationListener != null) { 230 | endUpdates(); 231 | } 232 | 233 | if (!mRequireNewLocation) { 234 | mPosition = getCachedPosition(); 235 | } 236 | 237 | mLocationListener = createLocationListener(); 238 | mLocationManager.requestLocationUpdates(getProviderName(), mInterval, 0, mLocationListener); 239 | } 240 | 241 | /** Stops the location updates when they aren't needed anymore so that battery can be saved */ 242 | public void endUpdates() { 243 | if (mLocationListener != null) { 244 | mLocationManager.removeUpdates(mLocationListener); 245 | mLocationListener = null; 246 | } 247 | } 248 | 249 | /** 250 | * Blurs the specified location with the defined blur radius or returns an unchanged location if no blur radius is set 251 | * 252 | * @param originalLocation the original location received from the device 253 | * @return the blurred location 254 | */ 255 | private Location blurWithRadius(final Location originalLocation) { 256 | if (mBlurRadius <= 0) { 257 | return originalLocation; 258 | } 259 | else { 260 | Location newLocation = new Location(originalLocation); 261 | 262 | double blurMeterLong = calculateRandomOffset(mBlurRadius) / SQUARE_ROOT_TWO; 263 | double blurMeterLat = calculateRandomOffset(mBlurRadius) / SQUARE_ROOT_TWO; 264 | 265 | newLocation.setLongitude(newLocation.getLongitude() + meterToLongitude(blurMeterLong, newLocation.getLatitude())); 266 | newLocation.setLatitude(newLocation.getLatitude() + meterToLatitude(blurMeterLat)); 267 | 268 | return newLocation; 269 | } 270 | } 271 | 272 | /** 273 | * For any radius `n`, calculate a random offset in the range `[-n, n]` 274 | * 275 | * @param radius the radius 276 | * @return the random offset 277 | */ 278 | private static int calculateRandomOffset(final int radius) { 279 | return mRandom.nextInt((radius + 1) * 2) - radius; 280 | } 281 | 282 | /** 283 | * Returns the current position as a Point instance 284 | * 285 | * @return the current location (if any) or `null` 286 | */ 287 | public Point getPosition() { 288 | if (mPosition == null) { 289 | return null; 290 | } 291 | else { 292 | Location position = blurWithRadius(mPosition); 293 | return new Point(position.getLatitude(), position.getLongitude()); 294 | } 295 | } 296 | 297 | /** 298 | * Returns the latitude of the current location 299 | * 300 | * @return the current latitude (if any) or `0` 301 | */ 302 | public double getLatitude() { 303 | if (mPosition == null) { 304 | return 0.0f; 305 | } 306 | else { 307 | Location position = blurWithRadius(mPosition); 308 | return position.getLatitude(); 309 | } 310 | } 311 | 312 | /** 313 | * Returns the longitude of the current location 314 | * 315 | * @return the current longitude (if any) or `0` 316 | */ 317 | public double getLongitude() { 318 | if (mPosition == null) { 319 | return 0.0f; 320 | } 321 | else { 322 | Location position = blurWithRadius(mPosition); 323 | return position.getLongitude(); 324 | } 325 | } 326 | 327 | /** 328 | * Returns the timestamp of the current location as a number of milliseconds since January 1, 1970 (UTC) 329 | * 330 | * @return the timestamp (if any) or `0` 331 | */ 332 | public long getTimestampInMilliseconds() { 333 | if (mPosition == null) { 334 | return 0L; 335 | } 336 | else { 337 | return mPosition.getTime(); 338 | } 339 | } 340 | 341 | /** 342 | * Returns the elapsed time since system boot of the current location in nanoseconds 343 | * 344 | * @return the elapsed time (if any) or `0` 345 | */ 346 | public long getElapsedTimeInNanoseconds() { 347 | if (mPosition == null) { 348 | return 0L; 349 | } 350 | else { 351 | if (Build.VERSION.SDK_INT >= 17) { 352 | return mPosition.getElapsedRealtimeNanos(); 353 | } 354 | else { 355 | return (SystemClock.elapsedRealtime() + getTimestampInMilliseconds() - System.currentTimeMillis()) * 1000000; 356 | } 357 | } 358 | } 359 | 360 | /** 361 | * Returns the current speed 362 | * 363 | * @return the current speed (if detected) or `0` 364 | */ 365 | public float getSpeed() { 366 | if (mPosition == null) { 367 | return 0.0f; 368 | } 369 | else { 370 | return mPosition.getSpeed(); 371 | } 372 | } 373 | 374 | /** 375 | * Returns the current altitude 376 | * 377 | * @return the current altitude (if detected) or `0` 378 | */ 379 | public double getAltitude() { 380 | if (mPosition == null) { 381 | return 0.0f; 382 | } 383 | else { 384 | return mPosition.getAltitude(); 385 | } 386 | } 387 | 388 | /** 389 | * Sets the blur radius (in meters) to use for privacy reasons 390 | * 391 | * @param blurRadius the blur radius (in meters) 392 | */ 393 | public void setBlurRadius(final int blurRadius) { 394 | mBlurRadius = blurRadius; 395 | } 396 | 397 | /** 398 | * Creates a new LocationListener instance used internally to listen for location updates 399 | * 400 | * @return the new LocationListener instance 401 | */ 402 | private LocationListener createLocationListener() { 403 | return new LocationListener() { 404 | 405 | @Override 406 | public void onLocationChanged(Location location) { 407 | mPosition = location; 408 | cachePosition(); 409 | 410 | if (mListener != null) { 411 | mListener.onPositionChanged(); 412 | } 413 | } 414 | 415 | @Override 416 | public void onStatusChanged(String provider, int status, Bundle extras) { } 417 | 418 | @Override 419 | public void onProviderEnabled(String provider) { } 420 | 421 | @Override 422 | public void onProviderDisabled(String provider) { } 423 | 424 | }; 425 | } 426 | 427 | /** 428 | * Returns the name of the location provider that matches the specified settings 429 | * 430 | * @return the provider's name 431 | */ 432 | private String getProviderName() { 433 | return getProviderName(mRequireFine); 434 | } 435 | 436 | /** 437 | * Returns the name of the location provider that matches the specified settings and depends on the given granularity 438 | * 439 | * @param requireFine whether to require fine location or use coarse location 440 | * @return the provider's name 441 | */ 442 | private String getProviderName(final boolean requireFine) { 443 | // if fine location (GPS) is required 444 | if (requireFine) { 445 | // we just have to decide between active and passive mode 446 | 447 | if (mPassive) { 448 | return PROVIDER_FINE_PASSIVE; 449 | } 450 | else { 451 | return PROVIDER_FINE; 452 | } 453 | } 454 | // if both fine location (GPS) and coarse location (network) are acceptable 455 | else { 456 | // if we can use coarse location (network) 457 | if (hasLocationEnabled(PROVIDER_COARSE)) { 458 | // if we wanted passive mode 459 | if (mPassive) { 460 | // throw an exception because this is not possible 461 | throw new RuntimeException("There is no passive provider for the coarse location"); 462 | } 463 | // if we wanted active mode 464 | else { 465 | // use coarse location (network) 466 | return PROVIDER_COARSE; 467 | } 468 | } 469 | // if coarse location (network) is not available 470 | else { 471 | // if we can use fine location (GPS) 472 | if (hasLocationEnabled(PROVIDER_FINE) || hasLocationEnabled(PROVIDER_FINE_PASSIVE)) { 473 | // we have to use fine location (GPS) because coarse location (network) was not available 474 | return getProviderName(true); 475 | } 476 | // no location is available so return the provider with the minimum permission level 477 | else { 478 | return PROVIDER_COARSE; 479 | } 480 | } 481 | } 482 | } 483 | 484 | /** 485 | * Returns the last position from the cache 486 | * 487 | * @return the cached position 488 | */ 489 | private Location getCachedPosition() { 490 | if (mCachedPosition != null) { 491 | return mCachedPosition; 492 | } 493 | else { 494 | try { 495 | return mLocationManager.getLastKnownLocation(getProviderName()); 496 | } 497 | catch (Exception e) { 498 | return null; 499 | } 500 | } 501 | } 502 | 503 | /** Caches the current position */ 504 | private void cachePosition() { 505 | if (mPosition != null) { 506 | mCachedPosition = mPosition; 507 | } 508 | } 509 | 510 | /** 511 | * Opens the device's settings screen where location access can be enabled 512 | * 513 | * @param context the Context reference to start the Intent from 514 | */ 515 | public static void openSettings(final Context context) { 516 | context.startActivity(new Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS)); 517 | } 518 | 519 | /** 520 | * Converts a difference in latitude to a difference in kilometers (rough estimation) 521 | * 522 | * @param latitude the latitude (difference) 523 | * @return the kilometers (difference) 524 | */ 525 | public static double latitudeToKilometer(double latitude) { 526 | return latitude * LATITUDE_TO_KILOMETER; 527 | } 528 | 529 | /** 530 | * Converts a difference in kilometers to a difference in latitude (rough estimation) 531 | * @param kilometer the kilometers (difference) 532 | * @return the latitude (difference) 533 | */ 534 | public static double kilometerToLatitude(double kilometer) { 535 | return kilometer / latitudeToKilometer(1.0f); 536 | } 537 | 538 | /** 539 | * Converts a difference in latitude to a difference in meters (rough estimation) 540 | * 541 | * @param latitude the latitude (difference) 542 | * @return the meters (difference) 543 | */ 544 | public static double latitudeToMeter(double latitude) { 545 | return latitudeToKilometer(latitude) * KILOMETER_TO_METER; 546 | } 547 | 548 | /** 549 | * Converts a difference in meters to a difference in latitude (rough estimation) 550 | * @param meter the meters (difference) 551 | * @return the latitude (difference) 552 | */ 553 | public static double meterToLatitude(double meter) { 554 | return meter / latitudeToMeter(1.0f); 555 | } 556 | 557 | /** 558 | * Converts a difference in longitude to a difference in kilometers (rough estimation) 559 | * 560 | * @param longitude the longitude (difference) 561 | * @param latitude the latitude (absolute) 562 | * @return the kilometers (difference) 563 | */ 564 | public static double longitudeToKilometer(double longitude, double latitude) { 565 | return longitude * LONGITUDE_TO_KILOMETER_AT_ZERO_LATITUDE * Math.cos(Math.toRadians(latitude)); 566 | } 567 | 568 | /** 569 | * Converts a difference in kilometers to a difference in longitude (rough estimation) 570 | * @param kilometer the kilometers (difference) 571 | * @param latitude the latitude (absolute) 572 | * @return the longitude (difference) 573 | */ 574 | public static double kilometerToLongitude(double kilometer, double latitude) { 575 | return kilometer / longitudeToKilometer(1.0f, latitude); 576 | } 577 | 578 | /** 579 | * Converts a difference in longitude to a difference in meters (rough estimation) 580 | * 581 | * @param longitude the longitude (difference) 582 | * @param latitude the latitude (absolute) 583 | * @return the meters (difference) 584 | */ 585 | public static double longitudeToMeter(double longitude, double latitude) { 586 | return longitudeToKilometer(longitude, latitude) * KILOMETER_TO_METER; 587 | } 588 | 589 | /** 590 | * Converts a difference in meters to a difference in longitude (rough estimation) 591 | * @param meter the meters (difference) 592 | * @param latitude the latitude (absolute) 593 | * @return the longitude (difference) 594 | */ 595 | public static double meterToLongitude(double meter, double latitude) { 596 | return meter / longitudeToMeter(1.0f, latitude); 597 | } 598 | 599 | /** 600 | * Calculates the difference from the start position to the end position (in meters) 601 | * 602 | * @param start the start position 603 | * @param end the end position 604 | * @return the distance in meters 605 | */ 606 | public static double calculateDistance(Point start, Point end) { 607 | return calculateDistance(start.latitude, start.longitude, end.latitude, end.longitude); 608 | } 609 | 610 | /** 611 | * Calculates the difference from the start position to the end position (in meters) 612 | * 613 | * @param startLatitude the latitude of the start position 614 | * @param startLongitude the longitude of the start position 615 | * @param endLatitude the latitude of the end position 616 | * @param endLongitude the longitude of the end position 617 | * @return the distance in meters 618 | */ 619 | public static double calculateDistance(double startLatitude, double startLongitude, double endLatitude, double endLongitude) { 620 | float[] results = new float[3]; 621 | Location.distanceBetween(startLatitude, startLongitude, endLatitude, endLongitude, results); 622 | return results[0]; 623 | } 624 | 625 | } 626 | --------------------------------------------------------------------------------