Merge pull request #10 from StudyProject-NLI/docs-setup

doc update + barcode scanner

Author: Maximilian Häming

.gitignore

@@ -31,3 +31,5 @@ google-services.json
 *.hprof
 
 site
+.gradle
+build/

README.md

@@ -20,21 +20,10 @@ This is the code repository for the Android app developed in the studyproject Se
 		commit id: "Prepare for codebase transfer"
 ```
 
-# Documentation
-
-## Running locally
-- Install Python
-- `pip install -r docs/requirements.txt`
-
-Run the documentation server via 
-```bash
-$ mkdocs serve
-```
-
 
 # Building the app locally
 Requirements:
-- At least Java 8 JDK installed
+- At least Java 17 JDK installed
 - Create a `local.properties` file at the root of this repository with the following content
 
 ```bash
@@ -56,3 +45,15 @@ The resulting installable application can be found under
 `app/build/outputs/apk/debug/app-debug.apk`
 
 which you can copy and install on your device.
+
+# Documentation
+
+## Running locally
+- Install Python
+- `pip install -r docs/requirements.txt`
+
+Run the documentation server via 
+```bash
+$ mkdocs serve
+```
+

app/build.gradle

@@ -3,7 +3,6 @@ plugins {
     id 'org.jetbrains.kotlin.android'
     id 'kotlin-parcelize'
     id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
-
 }
 
 android {
@@ -15,7 +14,7 @@ android {
         minSdk 24
         targetSdk 33
         versionCode 1
-        versionName '0.0.1'
+        versionName '0.0.3'
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -49,36 +48,44 @@ dependencies {
 
     implementation 'androidx.core:core-ktx:1.12.0'
     implementation 'androidx.appcompat:appcompat:1.6.1'
-    implementation 'com.google.android.material:material:1.5.0-alpha04'
+    implementation 'com.google.android.material:material:1.11.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
-    implementation 'androidx.navigation:navigation-fragment-ktx:2.5.3'
-    implementation 'androidx.navigation:navigation-ui-ktx:2.5.3'
+    implementation 'androidx.navigation:navigation-fragment-ktx:2.7.7'
+    implementation 'androidx.navigation:navigation-ui-ktx:2.7.7'
     implementation 'androidx.lifecycle:lifecycle-process:2.7.0'
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'androidx.test.ext:junit:1.1.5'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 
     // Set up the location feature dependency
-    implementation 'com.google.android.gms:play-services-location:21.0.1'
+    implementation 'com.google.android.gms:play-services-location:21.1.0'
 
     // GSON dependency
-    implementation 'com.google.code.gson:gson:2.8.5'
+    implementation 'com.google.code.gson:gson:2.10'
 
     // Places API
-    implementation 'com.google.android.libraries.places:places:3.2.0'
+    implementation 'com.google.android.libraries.places:places:3.3.0'
+
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.1")
+
+    // Camera + Tensorflow
+    implementation("androidx.camera:camera-core:1.3.1")
+    implementation("androidx.camera:camera-camera2:1.3.1")
+    implementation("androidx.camera:camera-lifecycle:1.3.1")
+    implementation("androidx.camera:camera-video:1.3.1")
+
+    implementation("androidx.camera:camera-view:1.3.1")
+    implementation("androidx.camera:camera-extensions:1.3.1")
 
-    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9")
+    implementation("org.tensorflow:tensorflow-lite-task-vision:0.4.0")
+    implementation("org.tensorflow:tensorflow-lite-gpu-delegate-plugin:0.4.0")
+    implementation("org.tensorflow:tensorflow-lite-gpu:2.9.0")
 
+    // Camera UI
+    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.7.0")
     //mlkit
     implementation 'com.google.mlkit:barcode-scanning:17.2.0'
 
     //it.jsoup
     implementation "org.jsoup:jsoup:1.14.3"
-
-    //camera
-    implementation ("androidx.camera:camera-camera2:1.3.1")
-    implementation("androidx.camera:camera-core:1.3.1")
-    implementation("androidx.camera:camera-lifecycle:1.3.1")
-    implementation("androidx.camera:camera-view:1.3.1")
-
-}
+}

app/src/main/AndroidManifest.xml

@@ -6,10 +6,11 @@
 
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
-
-    <uses-permission-sdk-23 android:name="android.permission.CAMERA" />
     <uses-permission android:name="android.permission.VIBRATE" />
-
+    <uses-feature
+        android:name="android.hardware.camera"
+        android:required="false" />
+    <uses-permission android:name="android.permission.CAMERA" />
     <application
         android:allowBackup="true"
         android:dataExtractionRules="@xml/data_extraction_rules"
@@ -46,9 +47,11 @@
             android:name=".activities.PlaceDetailsActivity" />
         <activity
             android:name=".activities.SettingsActivity"/>
+        <activity
+            android:name=".activities.ClassificationActivity"/>
         <service
             android:name=".viewmodels.ConstantScanning"
             android:exported="false" />
     </application>
 
-</manifest>
+</manifest>

app/src/main/assets/mobilenetv1.tflite

@@ -0,0 +1,38 @@
+package com.nlinterface.activities
+
+import android.content.pm.PackageManager
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import androidx.core.content.ContextCompat
+import android.Manifest
+import android.content.ContentValues.TAG
+import android.util.Log
+import androidx.camera.core.AspectRatio
+import androidx.camera.core.CameraSelector
+import androidx.camera.core.ImageAnalysis
+import androidx.camera.core.Preview
+import androidx.camera.lifecycle.ProcessCameraProvider
+import androidx.core.app.ActivityCompat
+import com.nlinterface.databinding.ActivityClassificationBinding
+import com.nlinterface.databinding.FragmentCameraBinding
+import com.nlinterface.utility.ObjectDetectorHelper
+
+class ClassificationActivity: AppCompatActivity() {
+
+    private lateinit var viewBinding: ActivityClassificationBinding
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        if(!hasCameraPermission()) {
+            ActivityCompat.requestPermissions(
+                this, arrayOf(Manifest.permission.CAMERA), 0
+            )
+        }
+
+        viewBinding = ActivityClassificationBinding.inflate(layoutInflater)
+        setContentView(viewBinding.root)
+    }
+
+    private fun hasCameraPermission() = ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA) == PackageManager.PERMISSION_GRANTED
+
+
+}

app/src/main/java/com/nlinterface/activities/ClassificationActivity.kt

@@ -65,14 +65,6 @@ class MainActivity : AppCompatActivity() {
         configureUI()
         configureTTS()
         configureSTT()
-
-        verifyCameraPermissions()
-        if (checkCallingOrSelfPermission(
-                Manifest.permission.CAMERA
-            ) == PackageManager.PERMISSION_GRANTED) {
-                val serviceIntent = Intent(this, ConstantScanning()::class.java)
-                startService(serviceIntent)
-            }
     }
 
     /**
@@ -94,6 +86,17 @@ class MainActivity : AppCompatActivity() {
 
         // process theme settings
         GlobalParameters.instance!!.updateTheme()
+
+        val serviceIntent = Intent(this, ConstantScanning()::class.java)
+        if (GlobalParameters.instance!!.barcodeServiceMode == GlobalParameters.BarcodeServiceMode.ON) {
+            verifyCameraPermissions()
+            if (checkCallingOrSelfPermission( Manifest.permission.CAMERA ) == PackageManager.PERMISSION_GRANTED) {
+                startService(serviceIntent)
+        }
+        } else {
+            stopService(serviceIntent)
+            Log.println(Log.INFO, "Scanner", "Stopping the Barcode Scanning Service")
+        }
     }
 
     /**
@@ -220,6 +223,12 @@ class MainActivity : AppCompatActivity() {
             navToActivity(this, ActivityType.PLACEDETAILS)
         }
 
+        // set up button to navigate to ClassificationActivity
+        val classificationButton: Button = findViewById<View>(R.id.classification_bt) as Button
+        classificationButton.setOnClickListener { _ -> 
+            navToActivity(this, ActivityType.CLASSIFICATION)
+        }
+        
         // set up button to navigate to SettingsActivity
         val settingsActivityButton: Button = findViewById<View>(R.id.settings_bt) as Button
         settingsActivityButton.setOnClickListener { _ ->

app/src/main/java/com/nlinterface/activities/MainActivity.kt

@@ -14,6 +14,7 @@ import com.nlinterface.utility.ActivityType
 import com.nlinterface.utility.GlobalParameters
 import com.nlinterface.utility.GlobalParameters.ThemeChoice
 import com.nlinterface.utility.GlobalParameters.KeepScreenOn
+import com.nlinterface.utility.GlobalParameters.BarcodeServiceMode
 import com.nlinterface.utility.STTInputType
 import com.nlinterface.utility.navToActivity
 import com.nlinterface.utility.setViewRelativeSize
@@ -53,6 +54,9 @@ class SettingsActivity : AppCompatActivity() {
     private lateinit var themeOptions: MutableList<String>
     private lateinit var themeButton: Button
 
+    private lateinit var barcodeServiceOptions: MutableList<String>
+    private lateinit var barcodeServiceButton : Button
+
     private lateinit var voiceActivationButton: ImageButton
 
     private lateinit var lastCommand: String
@@ -83,6 +87,11 @@ class SettingsActivity : AppCompatActivity() {
             themeOptions.add(option)
         }
 
+        barcodeServiceOptions = mutableListOf()
+        resources.getStringArray(R.array.barcode_mode_options).forEach { option ->
+            barcodeServiceOptions.add(option)
+        }
+
         configureUI()
         configureTTS()
         configureSTT()
@@ -107,6 +116,9 @@ class SettingsActivity : AppCompatActivity() {
         keepScreenOnButton.setOnClickListener { onKeepScreenOnButtonClick() }
         keepScreenOnButton.text = keepScreenOnOptions[globalParameters.keepScreenOn.ordinal]
 
+        barcodeServiceButton = findViewById(R.id.settings_barcode_mode)
+        barcodeServiceButton.setOnClickListener { onBarcodeServiceButtonClick() }
+        barcodeServiceButton.text = barcodeServiceOptions[globalParameters.barcodeServiceMode.ordinal]
     }
 
     /**
@@ -145,6 +157,19 @@ class SettingsActivity : AppCompatActivity() {
         viewModel.say(resources.getString(R.string.new_screen_setting, keepScreenOnButton.text))
     }
 
+    private fun onBarcodeServiceButtonClick() {
+        if (globalParameters.barcodeServiceMode.ordinal == BarcodeServiceMode.values().size - 1) {
+            globalParameters.barcodeServiceMode = BarcodeServiceMode.values()[0]
+        } else {
+            globalParameters.barcodeServiceMode = BarcodeServiceMode.values()[globalParameters.barcodeServiceMode.ordinal + 1]
+        }
+
+        barcodeServiceButton.text = barcodeServiceOptions[globalParameters.barcodeServiceMode.ordinal]
+
+        // TODO: Add voice commands for Barcode Service
+    }
+
+
     /**
      * If the activity is paused, save the current preferences to SharedPreferences.
      */