-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from StudyProject-NLI/Bene
Barcode Scanner MVP
- Loading branch information
Showing
7 changed files
with
275 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,4 @@ | ||
| # Gradle files | ||
| .gradle/ | ||
| build/ | ||
|
|
||
| # Local configuration file (sdk path, etc) | ||
| local.properties | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
218 changes: 218 additions & 0 deletions
218
app/src/main/java/com/nlinterface/viewmodels/BarcodeProductinfoViewModel.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| package com.nlinterface.viewmodels | ||
|
|
||
|
|
||
| import android.app.Service | ||
| import android.content.Context | ||
| import androidx.camera.core.CameraSelector | ||
| import androidx.camera.core.ExperimentalGetImage | ||
| import androidx.camera.core.ImageAnalysis | ||
| import androidx.camera.core.ImageProxy | ||
| import androidx.camera.lifecycle.ProcessCameraProvider | ||
| import com.google.mlkit.vision.barcode.BarcodeScannerOptions | ||
| import com.google.mlkit.vision.barcode.BarcodeScanning | ||
| import com.google.mlkit.vision.barcode.common.Barcode | ||
| import com.google.mlkit.vision.common.InputImage | ||
| import androidx.core.content.ContextCompat | ||
| import android.content.Intent | ||
| import android.os.IBinder | ||
| import android.os.Vibrator | ||
| import android.util.Log | ||
| import androidx.lifecycle.ProcessLifecycleOwner | ||
| import org.jsoup.Jsoup | ||
| import org.jsoup.nodes.Document | ||
|
|
||
| /** | ||
| * Classes and functions managing a background Service, + | ||
| * which is constantly checking for barcodes | ||
| * | ||
| * TODO: Add voice command allowing to stop TTS | ||
| */ | ||
|
|
||
| /** | ||
| * The Scanner is used to create a BarcodeScanner object, | ||
| * analyze the imageProxy and check for barcodes, | ||
| * and defines how to handle them. | ||
| * | ||
| * @param viewModel: viewModel allows the use of the say function | ||
| */ | ||
| class Scanner( | ||
| private val viewModel: MainViewModel, | ||
| private val vibrator: Vibrator | ||
| ) : ImageAnalysis.Analyzer { | ||
|
|
||
| /** | ||
| * BarcodeScanner object: Currently only scans EAN 13 barcodes | ||
| */ | ||
| private val options = BarcodeScannerOptions.Builder() | ||
| .setBarcodeFormats( | ||
| Barcode.FORMAT_EAN_13 | ||
| ) | ||
| .build() | ||
| private val barcodeScanner = BarcodeScanning.getClient(options) | ||
|
|
||
| /** | ||
| * Analysis of the ImageProxy. Converts the camera output into analyzable format. | ||
| * Applies the function handleBarcodeResult to the first barcode scanned. | ||
| * This is embedded into a Thread to avoid to much calculations on the Main thread. | ||
| * | ||
| * @param image: uses the camera image without passing an argument directly | ||
| * | ||
| */ | ||
| @ExperimentalGetImage | ||
| override fun analyze(image: ImageProxy) { | ||
| val mediaImage = image.image | ||
| if (mediaImage != null) { | ||
| val scannerInput = | ||
| InputImage.fromMediaImage(mediaImage, image.imageInfo.rotationDegrees) | ||
| barcodeScanner.process(scannerInput) | ||
| .addOnSuccessListener { barcodes -> | ||
| for (barcode in barcodes) { | ||
| Log.println(Log.INFO, "Scanner", "Barcode " + barcode.rawValue + " was detected") | ||
| val urlAddOn = barcode.rawValue ?: "default" | ||
| Thread { | ||
| handleBarcodeResult(urlAddOn) | ||
| }.start() | ||
| break | ||
| } | ||
| } | ||
| .addOnFailureListener { exception -> | ||
| exception.printStackTrace() | ||
| } | ||
| .addOnCompleteListener { image.close() } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Function to handle the Barcode Result. | ||
| * Initiates a vibration to give feedback to the user, that a barcode was scanned | ||
| * It creates an object BrowserSearch to use its function searchUrl | ||
| * | ||
| * @param urlAddOn: the Barcode as a String to use for web-search | ||
| */ | ||
| private fun handleBarcodeResult(urlAddOn: String) { | ||
| vibrator.vibrate(200) | ||
| val eanSearch = BrowserSearch() | ||
| Log.println(Log.INFO, "Scraping", "Waiting for Scraping result") | ||
| eanSearch.searchUrl(viewModel, urlAddOn) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The BrowserSearch class embeds the web-search. | ||
| * | ||
| */ | ||
| class BrowserSearch{ | ||
|
|
||
| /** | ||
| * The function to do the web-search and scraping. | ||
| * Url: https://de.openfoodfacts.org/produkt/$barcode | ||
| * searches the website with regards to the Barcodes value | ||
| * Then scrapes the document for the specified elements and TTS the extracted text. | ||
| * | ||
| * @param viewModel: viewModel allows the use of the say function | ||
| * @param barcode: the barcode as String to add on to the Url | ||
| */ | ||
| fun searchUrl (viewModel:MainViewModel, barcode: String) { | ||
| try { | ||
| val searchUrl = "https://de.openfoodfacts.org/produkt/$barcode" | ||
| val document: Document = Jsoup.connect(searchUrl).get() | ||
| val name = document.select("h1.title-3").first()?.text() | ||
| val ingredients = | ||
| document.getElementById("panel_ingredients_content")?.text() | ||
| val allInfo = name.toString() + ingredients.toString() | ||
| viewModel.say(allInfo) | ||
| } catch (e: Exception) { | ||
| e.printStackTrace() | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * The Scanning process handles the camera and initiates the imageAnalysis. | ||
| * | ||
| */ | ||
|
|
||
| class ScanningProcess{ | ||
|
|
||
| /** | ||
| * Function starting the scanning process. | ||
| * Selects the camera to be used, initializes an ImageAnalysis object, | ||
| * from which to use the scanner method. | ||
| * Also binds the camera to a Lifecycle | ||
| * | ||
| * @param viewModel: passed on to allow using the say function | ||
| * @param context: context for the cameraProvider and the imageAnalyzes | ||
| * | ||
| * TODO: Change selector to other camera | ||
| */ | ||
| fun activateScanning(viewModel: MainViewModel, vibrator: Vibrator, context: Context) { | ||
|
|
||
| val selector = CameraSelector.Builder() | ||
| .requireLensFacing(CameraSelector.LENS_FACING_BACK) | ||
| .build() | ||
| val imageAnalysis = ImageAnalysis.Builder() | ||
| .setBackpressureStrategy(ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST) | ||
| .build() | ||
| imageAnalysis.setAnalyzer( | ||
| ContextCompat.getMainExecutor(context), | ||
| Scanner(viewModel, vibrator) | ||
| ) | ||
| val cameraProvider = ProcessCameraProvider.getInstance(context).get() | ||
| try { | ||
| cameraProvider.bindToLifecycle( | ||
| ProcessLifecycleOwner.get(), | ||
| selector, | ||
| imageAnalysis | ||
| ) | ||
| Log.println(Log.INFO, "Camera", "Camera binding successful") | ||
|
|
||
| } catch (e: Exception) { | ||
| e.printStackTrace().toString() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * ConstantScanning is a Service, | ||
| * meaning it is allowed to run in the background parallel to the other activity. | ||
| * Also it runs without an UI, which is wanted in the case of the Scanner | ||
| */ | ||
|
|
||
| class ConstantScanning: Service() { | ||
|
|
||
| /** | ||
| * This method is required by the Service architecture, | ||
| * but not needed because the scanning should be done constantly. | ||
| * Therefore it just return null | ||
| */ | ||
| override fun onBind(intent: Intent?): IBinder? { | ||
| return null | ||
| } | ||
|
|
||
| /** | ||
| * Function that manages the Service, once initialized. | ||
| * It creates a viewModel object to be passed on, so the say method can be used later on. | ||
| * It also creates a Vibrator and Scanner object and starts the Scanning process. | ||
| * Returns Start-Sticky to ensure it will try to start again, | ||
| * if it is destroyed for whatever reason | ||
| * | ||
| * @param intent | ||
| * @param flags | ||
| * @param startId | ||
| */ | ||
|
|
||
| override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int { | ||
|
|
||
|
|
||
|
|
||
| val application = application | ||
| val viewModel = MainViewModel(application) | ||
| viewModel.initTTS() | ||
| val vibrator = getSystemService(Context.VIBRATOR_SERVICE) as Vibrator | ||
| val scanner = ScanningProcess() | ||
| scanner.activateScanning(viewModel, vibrator, this) | ||
| Log.println(Log.INFO, "Scanner","Barcode Scanning Service is Active") | ||
|
|
||
| return START_STICKY | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| #Thu May 25 17:04:02 CEST 2023 | ||
| distributionBase=GRADLE_USER_HOME | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip | ||
| distributionPath=wrapper/dists | ||
| zipStorePath=wrapper/dists | ||
| zipStoreBase=GRADLE_USER_HOME |