Updated projects

regulaforensics · Dec 19, 2024 · 21e630a · 21e630a
1 parent 88471be
commit 21e630a
Show file tree

Hide file tree

Showing 50 changed files with 806 additions and 384 deletions.
diff --git a/1120-Without License/README.md b/1120-Without License/README.md
@@ -1,23 +1,43 @@
-# Regula Document Reader (Android version)
-`1120` folder contains the sample project for working with the [Mobile document authenticator Regula 1120](https://regulaforensics.com/en/products/machine_verification/1120/).
+# BLE Device without Hardware License Sample Project (Android)
 
-# Content
-* [How to build the demo application](#how-to-build-the-demo-application)
+* [Overview](#overview)
+* [Installation](#installation)
 * [Documentation](#documentation)
-* [Additional information](#additional-information)
-
-## How to build the demo application
-1. Visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
-2. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
-3. Open the `1120-Without License` project in an IDE.
-4. Copy the license file to the project: `1120-Without License/app/src/main/res/raw/`.
-5. Copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `1120-Without License/app/src/main/assets/Regula/`.
-6. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
-7. Run the project.
-   Note: Android Gradle plugin requires Java 11 to run
+* [Demo Application](#demo-application)
+* [Technical Support](#technical-support)
+* [Business Enquiries](#business-enquiries)
+
+## Overview
+
+Sample project in Kotlin, demonstrating the Document Reader SDK integration with the device <a target="_blank" href="https://docs.regulaforensics.com/develop/1120/">Mobile Document Authenticator Regula 1120</a> without the hardware license inside it.
+
+In this case, to run the project, it needs to be initialized with a proper software license in the application.
+
+## Installation
+
+1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
+2. Open the `1120-Without License` project in an IDE.
+3. Add license and database files to the project:
+   - Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
+   - Copy the license file to the project: `1120-Without License/app/src/main/res/raw/`
+   - Copy the database file `db.dat` from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `1120-Without License/app/src/main/assets/Regula/`
+4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
+5. Run the project.
+
+**Note:** Android Gradle plugin requires Java 11 to run.
 
 ## Documentation
-The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
 
-## Additional information
-If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
+<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
+
+## Demo Application
+
+<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
+
+## Technical Support
+
+To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
+
+## Business Enquiries
+
+To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.
diff --git a/1120-Without License/app/build.gradle b/1120-Without License/app/build.gradle
@@ -36,9 +36,9 @@ dependencies {
     implementation 'com.google.android.material:material:1.6.1'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
 
-    implementation 'com.regula.btdevice:api:1.0.+@aar'
-    implementation 'com.regula.documentreader.core:fullauthrfid:7.4.+@aar'
-    implementation('com.regula.documentreader:api:7.4.+@aar') {
+    implementation 'com.regula.btdevice:api:1.1.+@aar'
+    implementation 'com.regula.documentreader.core:fullauthrfid:7.5.+@aar'
+    implementation('com.regula.documentreader:api:7.5.+@aar') {
         transitive = true;
     }
 }
diff --git a/1120-Without License/app/src/main/java/com/regula/ble_1120/MainActivity.kt b/1120-Without License/app/src/main/java/com/regula/ble_1120/MainActivity.kt
@@ -72,7 +72,7 @@ class MainActivity : AppCompatActivity() {
             if (result) {
                 btnConnect?.isEnabled = true
             } else {
-                Toast.makeText(this@MainActivity, "Init failed:$error", Toast.LENGTH_LONG).show()
+                Toast.makeText(this@MainActivity, "Init failed:${error?.message}", Toast.LENGTH_LONG).show()
                 return@IDocumentReaderInitCompletion
             }
         }

diff --git a/Advanced/DocumentReader-Kotlin/README.md b/Advanced/DocumentReader-Kotlin/README.md
@@ -1,36 +1,53 @@
-# Regula Document Reader (Android version)
-`Advanced` folder contains the advanced sample project with almost all available features.
+# Document Reader SDK Advanced Sample Project (Android)
 
-# Content
-* [How to build the demo application](#how-to-build-the-demo-application)
-* [Troubleshooting license issues](#troubleshooting-license-issues)
+* [Overview](#overview)
+* [Installation](#installation)
+* [Troubleshooting](#troubleshooting)
 * [Documentation](#documentation)
-* [Additional information](#additional-information)
+* [Demo Application](#demo-application)
+* [Technical Support](#technical-support)
+* [Business Enquiries](#business-enquiries)
 
-## How to build the demo application
-1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
+## Overview
+
+Sample project in Kotlin, demonstrating a variety of Document Reader SDK configuration and customization options.
+
+# Installation
+
+1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
 2. Open the `Advanced/DocumentReader-Kotlin` project in an IDE.
-3. If you use any mobile device (except 7310):
-- visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
-- copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`.
-- copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`.
-4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
+3. If you use any mobile device (except Regula 7310), add license and database files to the project:
+   - Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
+   - Copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`
+   - Copy the database file `db.dat` from the [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`
+4. Change the application ID to the one you have specified during the registration at the [Client Portal](https://client.regulaforensics.com/).
 5. Run the project.
-Note: Android Gradle plugin requires Java 11 to run
+
+**Note:** Android Gradle plugin requires Java 11 to run
+
+## Troubleshooting
+
+If you have issues with the license verification when running the application, check the following:
 
-## Troubleshooting license issues
-If you have issues with license verification when running the application, please verify that next is true:
 1. The OS, which you use, is specified in the license (Android).
 2. The application ID, which you use, is specified in the license.
 3. The license is valid (not expired).
 4. The date and time on the device, where you run the application, are valid.
 5. You use the latest release version of the Document Reader SDK.
-6. You placed the license into the project.
+6. You placed the license into the project as described in the [Installation](#installation) section.
 
 ## Documentation
-The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
 
-## Additional information
-If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
+<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
+
+## Demo Application
+
+<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
+
+## Technical Support
+
+To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
+
+## Business Enquiries
 
-To use our SDK in your own app you have to [purchase](https://pipedrivewebforms.com/form/5f1d771cbe4f844a1f78f8a06fbf94361841159) a commercial license.
+To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.
diff --git a/Advanced/DocumentReader-Kotlin/app/build.gradle b/Advanced/DocumentReader-Kotlin/app/build.gradle
@@ -37,11 +37,11 @@ dependencies {
     implementation 'androidx.navigation:navigation-ui-ktx:2.4.0'
     implementation "androidx.recyclerview:recyclerview:1.2.1"
 
-    implementation 'com.regula.btdevice:api:1.0.+@aar'
+    implementation 'com.regula.btdevice:api:1.1.+@aar'
     //noinspection GradleDynamicVersion
-    implementation 'com.regula.documentreader.core:fullrfid:7.4.+@aar'
+    implementation 'com.regula.documentreader.core:fullrfid:7.5.+@aar'
     //noinspection GradleDynamicVersion
-    implementation('com.regula.documentreader:api:7.4.+@aar') {
+    implementation('com.regula.documentreader:api:7.5.+@aar') {
         transitive = true
     }
 

diff --git a/Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/DeviceActivity.kt b/Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/DeviceActivity.kt
@@ -134,7 +134,7 @@ class DeviceActivity : AppCompatActivity() {
         IDocumentReaderInitCompletion { result: Boolean, error: DocumentReaderException? ->
             dismissDialog()
             if (!result) { //Initialization was not successful
-                Toast.makeText(this, "Init failed:$error", Toast.LENGTH_LONG).show()
+                Toast.makeText(this, "Init failed: ${error?.message}", Toast.LENGTH_LONG).show()
                 return@IDocumentReaderInitCompletion
             } else {
                 MainActivity.isInitializedByBleDevice = true

diff --git a/Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/MainActivity.kt b/Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/MainActivity.kt
@@ -178,7 +178,7 @@ class MainActivity : FragmentActivity(), Serializable {
             else
                 Toast.makeText(
                     this@MainActivity,
-                    "Init failed:$error_initializeReader",
+                    "Init failed:${error_initializeReader?.message}",
                     Toast.LENGTH_LONG
                 ).show()
         }
@@ -276,7 +276,9 @@ class MainActivity : FragmentActivity(), Serializable {
                         results_RFIDReader: DocumentReaderResults?,
                         error: DocumentReaderException?
                     ) {
-                        if (rfidAction == DocReaderAction.COMPLETE || rfidAction == DocReaderAction.CANCEL)
+                        if (rfidAction == DocReaderAction.COMPLETE
+                            || rfidAction == DocReaderAction.ERROR
+                            || rfidAction == DocReaderAction.CANCEL)
                             displayResults(results_RFIDReader!!)
                     }
                 })

diff --git a/BackendProcessing/README.md b/BackendProcessing/README.md
@@ -1,35 +1,53 @@
-# Regula Document Reader (Android version)
-The `BackendProcessing` sample project shows how configure Backend Processing in the Android app
+# Document Reader SDK Backend Processing Sample Project (Android)
 
-# Content
-* [How to build the demo application](#how-to-build-the-demo-application)
-* [Troubleshooting license issues](#troubleshooting-license-issues)
+* [Overview](#overview)
+* [Installation](#installation)
+* [Troubleshooting](#troubleshooting)
 * [Documentation](#documentation)
-* [Additional information](#additional-information)
-
-## How to build the demo application
-1. Visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
-2. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
-3. Open the `BackendProcessing` project in an IDE.
-4. Copy the license file to the project: `BackendProcessing/app/src/main/res/raw/`.
-5. Copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `BackendProcessing/app/src/main/assets/Regula/`.
-6. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
-7. Run the project.
-   Note: Android Gradle plugin requires Java 11 to run
-
-## Troubleshooting license issues
-If you have issues with license verification when running the application, please verify that next is true:
+* [Demo Application](#demo-application)
+* [Technical Support](#technical-support)
+* [Business Enquiries](#business-enquiries)
+
+## Overview
+
+Sample project in Kotlin, demonstrating how to set up and use the <a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/integration/server-side-verification/">Complete Server-Side Verification</a> feature.
+
+## Installation
+
+1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
+2. Open the `BackendProcessing` project in an IDE.
+3. Add license and database files to the project:
+   - Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
+   - Copy the license file to the project: `BackendProcessing/app/src/main/res/raw/`
+   - Copy the database file `db.dat` from the [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `BackendProcessing/app/src/main/assets/Regula/`
+4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
+5. Run the project.
+
+**Note:** Android Gradle plugin requires Java 11 to run.
+
+## Troubleshooting
+
+If you have issues with the license verification when running the application, check the following:
+
 1. The OS, which you use, is specified in the license (Android).
 2. The application ID, which you use, is specified in the license.
 3. The license is valid (not expired).
 4. The date and time on the device, where you run the application, are valid.
 5. You use the latest release version of the Document Reader SDK.
-6. You placed the license into the project.
+6. You placed the license into the project as described in the [Installation](#installation) section.
 
 ## Documentation
-The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
 
-## Additional information
-If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
+<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
+
+## Demo Application
+
+<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
+
+## Technical Support
+
+To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
+
+## Business Enquiries
 
-To use our SDK in your own app you have to [purchase](https://pipedrivewebforms.com/form/5f1d771cbe4f844a1f78f8a06fbf94361841159) a commercial license.
+To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.
diff --git a/BackendProcessing/app/build.gradle b/BackendProcessing/app/build.gradle
@@ -40,8 +40,8 @@ dependencies {
     implementation 'com.google.android.material:material:1.6.1'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
 
-    implementation 'com.regula.documentreader.core:fullrfid:7.4.+@aar'
-    implementation('com.regula.documentreader:api:7.4.+@aar') {
+    implementation 'com.regula.documentreader.core:fullrfid:7.5.+@aar'
+    implementation('com.regula.documentreader:api:7.5.+@aar') {
         transitive = true
     }
 }
diff --git a/BackendProcessing/app/src/main/java/com/regula/backend.processing/MainActivity.kt b/BackendProcessing/app/src/main/java/com/regula/backend.processing/MainActivity.kt
@@ -84,7 +84,7 @@ class MainActivity : AppCompatActivity() {
                     binding.showScannerBtn.isEnabled = false
                 }
             } else {
-                Toast.makeText(this@MainActivity, "Init failed:$error", Toast.LENGTH_LONG).show()
+                Toast.makeText(this@MainActivity, "Init failed: ${error?.message}", Toast.LENGTH_LONG).show()
                 return@IDocumentReaderInitCompletion
             }
         }
@@ -101,7 +101,7 @@ class MainActivity : AppCompatActivity() {
                     Toast.makeText(this@MainActivity, "Scanning was cancelled", Toast.LENGTH_LONG)
                         .show()
                 } else if (action == DocReaderAction.ERROR) {
-                    Toast.makeText(this@MainActivity, "Error:$error", Toast.LENGTH_LONG).show()
+                    Toast.makeText(this@MainActivity, "Error:${error?.message}", Toast.LENGTH_LONG).show()
                 }
             }
         }