v0.7.5

- Scanner closes on action timeout.
- Targeting sdk 35
- Overall code optimized
- Some deprecated codes removed
- Improved UI
- Enabled MaterialYou theming for material variant.
- Overlay permission will be asked during action setup

Author: abhishekabhi789

README.md

@@ -5,40 +5,46 @@
 </picture><br>
 <h1 align="center">GCS for Tasker</h1>
 <a href="https://developer.android.com/tools/releases/platforms#5.0">
-<img alt="API 21+" src="https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=for-the-badge&color=FF0800" title="Android 5.0 Lollipop"></a>
-<a href="https://github.com/abhishekabhi789/GCS_for_Tasker/releases">
-<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/abhishekabhi789/GCS_for_Tasker/total?style=for-the-badge&color=00C853" title="Total download count"></a>
+<img alt="API 21+" src="https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=for-the-badge&color=FF0000" title="Android 5.0 Lollipop"></a>
 <a href="https://github.com/abhishekabhi789/GCS_for_Tasker/releases/latest">
 <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/abhishekabhi789/GCS_for_Tasker?include_prereleases&style=for-the-badge&color=0091EA" title="latest release version"></a>
-<a href="https://taskernet.com/shares/?user=AS35m8mVC%2FNlWH31JCTnGHpKVeZk1osEp8V1pFxCq1Ls28Un1RXCw9ZNWWvmpxOebt4WIYFeiZhZKHc%3D&id=Project%3AGCS4T+Example+Project">
-<img alt="demo project download" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ftaskernet.com%2F_ah%2Fapi%2Fdatashare%2Fv1%2Fshares%2FAS35m8mVC%252FNlWH31JCTnGHpKVeZk1osEp8V1pFxCq1Ls28Un1RXCw9ZNWWvmpxOebt4WIYFeiZhZKHc%253D%2FProject%253AGCS4T%2520Example%2520Project%3Fa%3D0&query=%24.info.stats.downloads&prefix=Downloads%3A%20&style=for-the-badge&label=Taskernet&labelColor=yellow&color=grey" title="import the demo project from taskernet" ></a>
-
-</div>GCS for Tasker is an Android application that can act as both a Tasker event plugin and action
-plugin. This app uses the Google Code Scanner API to scan and extract information from QR codes.<br>
+<a href="https://github.com/abhishekabhi789/GCS_for_Tasker/releases">
+<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/abhishekabhi789/GCS_for_Tasker/total?style=for-the-badge&color=00C853" title="Total download count"></a>
+<br>
+<br>
+A code scanning plugin for <a href="https://joaoapps.com/tasker/">Tasker</a> that uses the <a href="https://developers.google.com/ml-kit/vision/barcode-scanning/code-scanner">Google Code Scanner</a> API.
+</div>
 
 ## :gear: Requirements
 
-This is a [Tasker Plugin](https://tasker.joaoapps.com/plugins-intro.html), and it requires
-the [Tasker](https://joaoapps.com/tasker/) Android app to function. To use this app, you must have
-an Android device with an API level
-of [21](https://developer.android.com/tools/releases/platforms#5.0 "Android 5.0 Lollipop") or
-higher, as the Code Scanner API works on devices with
-this API level or above. Furthermore, it is necessary to have the Google Play Services installed on
-the device.
+- This is a [Tasker Plugin](https://tasker.joaoapps.com/plugins-intro.html), and it requires the [Tasker](https://joaoapps.com/tasker/) Android app to function.
+
+- This app works on Android 5.0(Lollipop) and higher devices as the Code Scanner API works on devices with this API level or above.
 
-## :bulb: Features
+- The app works only on devices having updated Google Play Services installed.
 
-With the GCS for Tasker app, you can easily integrate QR code scanning into your Tasker projects.
-This app supports both scanning events and actions. This app doesn't ask for camera permissions, nor
-does it store or share any data except with Tasker.
+## :shield: Permissions
+
+- #### Manage overlay permission (Draw-over-other-apps permission)
+  From Android 10 - Q (API 29) android system restricted launching activities from background([more info here](https://developer.android.com/guide/components/activities/background-starts)).
+  App will be exempted from this restriction if it has the manage overlay permission.
+
+- #### Post Notification
+  On some low memory devices, the android system kills the app when it goes to background while scanner UI is visible.
+  Therefore, once scanning is done, the app may not be running to receive the result.
+  Running a service may keep the app in memory, and it requires a notification to be posted.
+  This permission is not requested at run time because not every device needs it. If you encounter this issue, try granting it.
+
+- ### Starting from background
+  App has to be white listed from any restriction that can prevent starting the scanner from background, like `Open new windows while
+  running in the background` in MiUi.
 
 ## :dna: Variants
 
-There are two variants available for this project based on the theme used in event configuration
-activity. Classic themed app is smaller in size and material themed app is around 4 times bigger.
-Both are having same package name and are signed with same key, you can switch them anytime. It's
-recommended to clear the app data after such switching to release storage space consumed by previous
-variant.
+There are two variants available for this project based on the theme used in plugin configuration activity.
+The classic variant is smaller in size, and material variant is twice as bigger.
+Both variants share the same package name and are signed with the same key, so you can switch between them anytime.
+It is recommended to clear the app data after switching to free up storage space consumed by the previous variant.
 
 <details><summary>
 
@@ -52,26 +58,26 @@ Install this plugin app and Tasker.
 - For events, select the "Event" option, then choose "Plugin" and select "GCS for Tasker" from the
   list. From there, you can configure the event based on your preferences.
 
-    * Value filter: The event will trigger only when the raw value of the scanned code matches the
-      value filter. This field supports both simple and regex matching. Adjust the switch next to
-      this field to choose simple matching or regex matching.
-    * Type filter: The event will trigger only when the qr code type matches any of the type filter.
+    * **Value filter**: The event will trigger only when the raw value of the scanned code matches the
+      value filter. This field supports both simple and regex matching. Use the switch next to
+      this field to choose matching method.
+    * **Type filter**: The event will trigger only when the qr code type matches any of the type filter.
       Refer [Barcode.BarcodeValueType](https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/common/Barcode.BarcodeValueType)
       for more about code types.
-    * Format filter: The event will trigger only when the code format matches any of the format
+    * **Format filter**: The event will trigger only when the code format matches any of the format
       filter.
       Refer [Barcode.BarcodeFormat](https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/common/Barcode.BarcodeFormat)
       for more about code formats.
 
   The event will trigger only if all specified filters are satisfied.
 
-- For actions, select "Plugin" from the "Select action category" list, and then choose "GCS for
+- For actions, select "Plugin" from the action list, and then choose "GCS for
   Tasker". Then on the configuration activity you can configure below settings.
-    * Format filter: The code scanner will only detect codes having the chosen format.
-    * Enable auto zoom: The scanner will try to automatically zoom the camera towards the code.
-    * Allow manual input: The scanner allows manual input of code value.
+ 
+    * **Format filter**: The code scanner will only detect codes having the chosen format.
+    * **Enable auto zoom**: The scanner will try to automatically zoom the camera towards the code.
+    * **Allow manual input**: The scanner allows manual input of code value.
 
-All the code types and code formats can be copied from event and action configuration.
 
 #### In GCS for Tasker
 
@@ -83,34 +89,11 @@ After completing the Tasker setup, try to perform a scan.
     * This download is a background task and is handled by the Google Play Service. You won't be
       notified when the task is completed.
 
-Here's an example project. Import it
-from [TaskerNet](https://taskernet.com/shares/?user=AS35m8mVC%2FNlWH31JCTnGHpKVeZk1osEp8V1pFxCq1Ls28Un1RXCw9ZNWWvmpxOebt4WIYFeiZhZKHc%3D&id=Project%3AGCS4T+Example+Project)
-</details>
-<details><summary>
-
-## :question: FAQ
-
-</summary>
-
-#### Can this be used on a device that does not have Google Play Services?
-
-> No, the app uses the unbundled Google code scanner API provided by Google Play Services on the
-> device.
-
-#### Does the app require an internet connection to function?
-
-> This app does not require an internet connection since the scanner library is capable of working
-> offline. However, Google Play Services requires an internet connection to download QR scanner
-> libraries if they are not already present on your device.
-
-#### Does clearing app data delete any setup or data?
-
-> For API 25+(Android 7.1+) devices, the shortcut configuration will be cleared when cleaning app
-> data. No scanner related functionalities affected with clearing app data. All configuration data is
-> stored in Tasker and the scanner library is in google play services. Also, if you want to save the
-> scan results, you have to set up a Tasker task to do so.
+Here's a demo project. Import it from [TaskerNet](https://taskernet.com/shares/?user=AS35m8mVC%2FNlWH31JCTnGHpKVeZk1osEp8V1pFxCq1Ls28Un1RXCw9ZNWWvmpxOebt4WIYFeiZhZKHc%3D&id=Project%3AGCS4T+Example+Project)
 
+The app also initializes a shortcut during the first scan. From this app shortcut, you'll be able to choose a Tasker task related to the scanner for quick access, such as `GCS4T: View History` in the demo project.
 </details>
+
 <details><summary>
 
 ## :wrench: Troubleshoot
@@ -120,30 +103,21 @@ from [TaskerNet](https://taskernet.com/shares/?user=AS35m8mVC%2FNlWH31JCTnGHpKVe
 #### Scanner module not downloading.
 
 >- Ensure internet connection.
->- Ensure battery saver is turned off.
+>- Make sure the battery saver is turned off.
 >- Update play service if available.
->- Reboot device.
+>- Reboot the device.
 >
 > If problem persists try
->- clearing the data of Google Play Services (Attention!: Use caution when deleting)
->- Upgrade or downgrade Google Play Services.
+>- clearing the data of Google Play Services (:warning: Use caution when deleting)
+>- Try upgrading or downgrading Google Play Services.
 
-#### Code Scanned but no response from Tasker.
+#### Scanner Action not launching
 
->- Try a different code to make sure the tasker setup is correct.
->- Check Tasker run log.
->- Try both event and action.
->- Create a new event/action without any filter rules and flash the output.
-
-#### Scanner UI doesn't dismiss after action timeout.
-
-> The library does not provide a method to programmatically close or set a timeout for the scanner.
-> You can consider using Tasker/AutoInput to click the close button or the back button after the
-> action fails due to timeout.
+>- Remove any restriction such as battery saver, background start, draw-over-other-apps, notification and try again.
+>- If the issue persists, report it here.
 
 #### Error: Failed to scan code.
 
-> If the scanner throws 'Failed to scan code' error, try clearing the app data
-> of [Google Play Service](https://play.google.com/store/apps/details?id=com.google.android.gms&hl=en&gl=US).
-> It's a Google Code Scanner module related issue
-</details>
+> If the scanner returns 'Failed to scan code' error, try clearing the app data of Google Play Service.
+> It's a Google Code Scanner module related issue.
+</details>

app/build.gradle

@@ -5,22 +5,22 @@ plugins {
 
 android {
     namespace 'com.abhi.gcsfortasker'
-    compileSdk 34
+    compileSdk 35
 
     defaultConfig {
         applicationId "com.abhi.gcsfortasker"
         minSdk 21
-        targetSdk 33
-        versionCode 74
-        versionName "0.7.4"
+        targetSdk 35
+        versionCode 75
+        versionName "0.7.5"
     }
 
     buildTypes {
-         debug {
-             minifyEnabled true
-             shrinkResources true
-             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
-         }
+        debug {
+            minifyEnabled false
+            shrinkResources false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
         release {
             minifyEnabled true
             shrinkResources true
@@ -51,11 +51,9 @@ android {
     }
     sourceSets {
         classic {
-            java.srcDirs 'src/classic/java'
             res.srcDirs 'src/classic/res'
         }
         material {
-            java.srcDirs 'src/material/java'
             res.srcDirs 'src/material/res'
         }
     }
@@ -70,20 +68,19 @@ android {
 }
 
 dependencies {
-    //code scanner - unbundled
+    implementation 'androidx.appcompat:appcompat:1.7.0'
+    //code scanner
     implementation 'com.google.android.gms:play-services-code-scanner:16.1.0'
     //tasker plugin
     implementation 'com.joaomgcd:taskerpluginlibrary:0.4.10'
     //coroutine
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3'
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
     //splashscreen
     implementation "androidx.core:core-splashscreen:1.0.1"
     //for testing
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.1'
     //material theming
-    materialImplementation 'com.google.android.material:material:1.11.0'
-    materialImplementation 'androidx.constraintlayout:constraintlayout:2.1.4'
-
-}
+    materialImplementation 'com.google.android.material:material:1.12.0'
+    materialImplementation 'androidx.constraintlayout:constraintlayout:2.2.0'
+}

app/proguard-rules.pro

@@ -23,6 +23,5 @@
 -dontobfuscate
 #-keep class com.abhi.gcsfortasker.** { *; }
 #-keep class com.joaomgcd.taskerpluginlibrary.** { *; }
-#Barcode is accessed via reflection. see utils.kt
+# Barcode is accessed via reflection on BarcodeFieldUtils
 -keep class com.google.mlkit.vision.barcode.common.Barcode { *; }
-

app/src/classic/java/com/abhi/gcsfortasker/ClassicUtils.kt

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<shape xmlns:android="http://schemas.android.com/apk/res/android"
+    android:shape="oval">
+    <solid android:color="@color/yellow" />
+</shape>

app/src/classic/res/drawable/round_bg.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<shape xmlns:android="http://schemas.android.com/apk/res/android">
+    <corners android:radius="@dimen/boxCornerRadius" />
+    <solid android:color="@color/textFieldBackground" />
+</shape>