Merge pull request #34 from Esri/sample/Display-device-location-with-NMEA-data-sources

Display device location with nmea data sources

Author: shubham7109

display-device-location-with-nmea-data-sources/.gitignore

@@ -0,0 +1 @@
+/build

display-device-location-with-nmea-data-sources/README.md

@@ -0,0 +1,38 @@
+# Display device location with NMEA data sources
+
+This sample demonstrates how to parse NMEA sentences and use the results to show device location on the map.
+
+![Image of display device location with nmea data sources](display-device-location-with-nmea-data-sources.png)
+
+## Use case
+
+NMEA sentences can be retrieved from GPS receivers and parsed into a series of coordinates with additional information. Devices without a built-in GPS receiver can retrieve NMEA sentences by using a separate GPS dongle, commonly connected via bluetooth or through a serial port.
+
+The NMEA location data source allows for detailed interrogation of the information coming from the GPS receiver. For example, allowing you to report the number of satellites in view.
+
+## How to use the sample
+
+Click floating button "Play" to parse the provided NMEA sentences into a location data source, and display the location position and related satellite information. Click "Stop" to stop displaying the location information. The sample will automatically re-center the location data source as it moves across the map.
+
+## How it works
+
+1. Load NMEA sentences from a local file.
+2. Parse the NMEA sentence strings, and push data into `NmeaLocationDataSource`.
+3. Set the `NmeaLocationDataSource` to the `LocationDisplay`'s data source.
+4. Start the location display to begin receiving location and satellite updates.
+
+## Relevant API
+
+* LocationDisplay
+* NmeaLocationDataSource
+* NmeaSatelliteInfo
+
+## About the data
+
+This sample reads lines from a local file to simulate the feed of data into the `NmeaLocationDataSource`. This simulated data source provides NMEA data periodically, and allows the sample to be used on devices without a GPS dongle that produces NMEA data.
+
+The route taken in this sample features a [one minute driving trip around Redlands, CA](https://arcgis.com/home/item.html?id=d5bad9f4fee9483791e405880fb466da).
+
+## Tags
+
+GPS, history, navigation, NMEA, real-time, trace

display-device-location-with-nmea-data-sources/README.metadata.json

@@ -0,0 +1,32 @@
+{
+    "category": "Maps and Scenes",
+    "description": "This sample demonstrates how to parse NMEA sentences and use the results to show device location on the map.",
+    "formal_name": "DisplayDeviceLocationWithNmeaDataSources",
+    "ignore": false,
+    "images": [
+        "display-device-location-with-nmea-data-sources.png"
+    ],
+    "keywords": [
+        "GPS",
+        "NMEA",
+        "history",
+        "navigation",
+        "real-time",
+        "trace",
+        "LocationDisplay",
+        "NmeaLocationDataSource",
+        "NmeaSatelliteInfo"
+    ],
+    "language": "kotlin",
+    "redirect_from": "",
+    "relevant_apis": [
+        "LocationDisplay",
+        "NmeaLocationDataSource",
+        "NmeaSatelliteInfo"
+    ],
+    "snippets": [
+        "src/main/java/com/esri/arcgismaps/sample/displaydevicelocationwithnmeadatasources/MainActivity.kt",
+        "src/main/java/com/esri/arcgismaps/sample/displaydevicelocationwithnmeadatasources/DownloadActivity.kt"
+    ],
+    "title": "Display device location with NMEA data sources"
+}

display-device-location-with-nmea-data-sources/build.gradle

@@ -0,0 +1,34 @@
+apply plugin: 'com.android.application'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    defaultConfig {
+        applicationId "com.esri.arcgismaps.sample.displaydevicelocationwithnmeadatasources"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode rootProject.ext.versionCode
+        versionName rootProject.ext.versionName
+        buildConfigField("String", "API_KEY", API_KEY)
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    buildFeatures {
+        dataBinding true
+    }
+}
+
+dependencies {
+    // lib dependencies from rootProject build.gradle
+    implementation "androidx.constraintlayout:constraintlayout:$constraintLayoutVersion"
+    implementation "com.google.android.material:material:$materialVersion"
+    implementation 'androidx.appcompat:appcompat:1.5.1'
+    implementation project(path: ':samples-lib')
+}

display-device-location-with-nmea-data-sources/display-device-location-with-nmea-data-sources.png

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

display-device-location-with-nmea-data-sources/proguard-rules.pro

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.esri.arcgismaps.sample.displaydevicelocationwithnmeadatasources">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+        <activity
+            android:name=".DownloadActivity"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+
+            <meta-data
+                android:name="android.app.lib_name"
+                android:value="" />
+        </activity>
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:label="@string/app_name">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

display-device-location-with-nmea-data-sources/src/main/AndroidManifest.xml

@@ -0,0 +1,24 @@
+package com.esri.arcgismaps.sample.displaydevicelocationwithnmeadatasources
+
+import android.content.Intent
+import androidx.appcompat.app.AppCompatActivity
+import android.os.Bundle
+import android.view.View
+import com.esri.arcgismaps.sample.sampleslib.DownloaderActivity
+
+class DownloadActivity : DownloaderActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        downloadAndStartSample(
+            Intent(this, MainActivity::class.java),
+            // get the app name of the sample
+            getString(R.string.app_name),
+            listOf(
+                // ArcGIS Portal item containing the Redlands.nmea
+                // which features a vehicle driving around southern Redlands, CA.
+                "https://www.arcgis.com/home/item.html?id=d5bad9f4fee9483791e405880fb466da"
+            )
+
+        )
+    }
+}