Merge pull request #41 from BlinkID/release/v3.8.1

Release/v3.8.1

BlinkIDDemo/BlinkIDDemo/src/main/java/com/microblink/blinkid/MenuActivity.java

@@ -312,9 +312,9 @@ private void buildElements() {
 
         // barcode list entries
 
-        // to include aztec element, valid license key for the aztec recognizer is required,
+        // valid license key for the aztec recognizer is required,
         // please set it in the buildAztecElement() method
-//        elements.add( buildAztecElement() );
+        elements.add(buildAztecElement());
         elements.add(buildPDF417Element());
         elements.add(buildBardecoderElement());
         elements.add(buildSimNumberElement());
@@ -334,6 +334,8 @@ private void buildElements() {
     private ListElement buildMrtdElement() {
         // prepare settings for Machine Readable Travel Document (MRTD) recognizer
         MRTDRecognizerSettings mrtd = new MRTDRecognizerSettings();
+        // allow results with incorrect check digits, only for demo
+        mrtd.setAllowUnverifiedResults(true);
 
         // build a scan intent by adding intent extras common to all other recognizers
         // when scanning ID documents, we will use ScanCard activity which has more suitable UI for scanning ID documents
@@ -560,7 +562,8 @@ private ListElement buildSimNumberElement() {
     private ListElement buildAztecElement() {
         // please contact us to obtain valid license key for the aztec recognizer
         // https://microblink.com/en/contact-us
-        AztecRecognizerSettings aztec = new AztecRecognizerSettings("<license_key>");
+        // this license key has expired, because of that you will get '*' characters in result
+        AztecRecognizerSettings aztec = new AztecRecognizerSettings("jp7X3DD+IG1iNzljvwkwVL7L364g9NCzTUq4lGC/vdc=");
 
         // build a scan intent by adding intent extras common to all other recognizers
         // when scanning barcodes, we will use Pdf417ScanActivity which has more suitable UI for scanning barcodes

BlinkIDDemo/build.gradle

@@ -19,7 +19,7 @@ allprojects {
 // versions of libraries that all modules require
 
 project.ext {
-    blinkIdVersion = '3.8.0'
+    blinkIdVersion = '3.8.1'
     compileSdkVersion = 25
     targetSdkVersion = 25
     buildToolsVersion = '25.0.2'

README.md

@@ -166,7 +166,7 @@ After that, you just need to add _BlinkID_ as a dependency to your application (
 
 ```
 dependencies {
-    compile('com.microblink:blinkid:3.8.0@aar') {
+    compile('com.microblink:blinkid:3.8.1@aar') {
     	transitive = true
     }
 }
@@ -178,7 +178,7 @@ Current version of Android Studio will not automatically import javadoc from mav
 
 1. In Android Studio project sidebar, ensure [project view is enabled](https://developer.android.com/sdk/installing/studio-androidview.html)
 2. Expand `External Libraries` entry (usually this is the last entry in project view)
-3. Locate `blinkid-3.8.0` entry, right click on it and select `Library Properties...`
+3. Locate `blinkid-3.8.1` entry, right click on it and select `Library Properties...`
 4. A `Library Properties` pop-up window will appear
 5. Click the second `+` button in bottom left corner of the window (the one that contains `+` with little globe)
 6. Window for definining documentation URL will appear
@@ -203,7 +203,7 @@ Open your `pom.xml` file and add these directives as appropriate:
 	<dependency>
 		  <groupId>com.microblink</groupId>
 		  <artifactId>blinkid</artifactId>
-		  <version>3.8.0</version>
+		  <version>3.8.1</version>
 		  <type>aar</type>
   	</dependency>
 </dependencies>

Release notes.md

@@ -1,5 +1,12 @@
 # Release notes
 
+## 3.8.1
+- improved `CombinedRecognizers`:
+    - better handling of names containing dashes and extra long names
+- improved `TopUpParser`:
+    - added option to return USSD code without prefix
+- by default `MRTDRecognizer` does not return results with incorrect check digits
+
 ## 3.8.0
 - introduced ability to create minimum-size AAR
 	- a separate static library distribution now exists which contains a script that you can configure with features you need and it creates a AAR file which only contains features you need - this includes minimum-size native binary and only required assets. The rest (resources and java classes) can be thrown-away by ProGuard.

builtFromCommit.txt

@@ -1 +1 @@
-Built from commit 70a8633360d15ab42670fc2afa961a1af7287c49
+Built from commit a4ba0a122a4856f995826163f95e46d94afc485a

docs/com/microblink/activity/package-tree.html

@@ -138,8 +138,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.microblink.activity.<a href="../../../com/microblink/activity/BaseVerificationFlowActivity.ActivityState.html" title="enum in com.microblink.activity"><span class="typeNameLink">BaseVerificationFlowActivity.ActivityState</span></a></li>
 <li type="circle">com.microblink.activity.<a href="../../../com/microblink/activity/ShowOcrResultMode.html" title="enum in com.microblink.activity"><span class="typeNameLink">ShowOcrResultMode</span></a> (implements android.os.Parcelable)</li>
+<li type="circle">com.microblink.activity.<a href="../../../com/microblink/activity/BaseVerificationFlowActivity.ActivityState.html" title="enum in com.microblink.activity"><span class="typeNameLink">BaseVerificationFlowActivity.ActivityState</span></a></li>
 </ul>
 </li>
 </ul>

docs/com/microblink/detectors/document/package-tree.html

@@ -103,9 +103,9 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.microblink.detectors.document.<a href="../../../../com/microblink/detectors/document/ScanningMode.html" title="enum in com.microblink.detectors.document"><span class="typeNameLink">ScanningMode</span></a></li>
-<li type="circle">com.microblink.detectors.document.<a href="../../../../com/microblink/detectors/document/DocumentDetectorResult.ScreenOrientation.html" title="enum in com.microblink.detectors.document"><span class="typeNameLink">DocumentDetectorResult.ScreenOrientation</span></a></li>
 <li type="circle">com.microblink.detectors.document.<a href="../../../../com/microblink/detectors/document/DocumentSpecificationPreset.html" title="enum in com.microblink.detectors.document"><span class="typeNameLink">DocumentSpecificationPreset</span></a></li>
+<li type="circle">com.microblink.detectors.document.<a href="../../../../com/microblink/detectors/document/DocumentDetectorResult.ScreenOrientation.html" title="enum in com.microblink.detectors.document"><span class="typeNameLink">DocumentDetectorResult.ScreenOrientation</span></a></li>
+<li type="circle">com.microblink.detectors.document.<a href="../../../../com/microblink/detectors/document/ScanningMode.html" title="enum in com.microblink.detectors.document"><span class="typeNameLink">ScanningMode</span></a></li>
 </ul>
 </li>
 </ul>

docs/com/microblink/image/package-tree.html

@@ -99,8 +99,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageType.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageType</span></a></li>
 <li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageFormat.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageFormat</span></a></li>
+<li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageType.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageType</span></a></li>
 </ul>
 </li>
 </ul>

docs/com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html

@@ -17,7 +17,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -237,57 +237,79 @@ <h3>Method Summary</h3>
 </td>
 </tr>
 <tr id="i2" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#getReturnCodeWithoutPrefix--">getReturnCodeWithoutPrefix</a></span>()</code>
+<div class="block">Returns <code>true</code> if scanned code will be returned without *digits* prefix and trailing #,
+ <code>false</code> otherwise.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#getUSSDCodeLength--">getUSSDCodeLength</a></span>()</code>
 <div class="block">Returns ussd code length i.e.</div>
 </td>
 </tr>
-<tr id="i3" class="rowColor">
+<tr id="i4" class="altColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeGetAllowNoPrefix-long-">nativeGetAllowNoPrefix</a></span>(long&nbsp;nativePtr)</code>&nbsp;</td>
 </tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeGetPrefixString-long-">nativeGetPrefixString</a></span>(long&nbsp;nativePtr)</code>&nbsp;</td>
 </tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeGetReturnCodeWithoutPrefix-long-">nativeGetReturnCodeWithoutPrefix</a></span>(long&nbsp;nativePtr)</code>&nbsp;</td>
+</tr>
+<tr id="i7" class="rowColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeGetUSSDCodeLength-long-">nativeGetUSSDCodeLength</a></span>(long&nbsp;nativePtr)</code>&nbsp;</td>
 </tr>
-<tr id="i6" class="altColor">
+<tr id="i8" class="altColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeSetAllowNoPrefix-long-boolean-">nativeSetAllowNoPrefix</a></span>(long&nbsp;nativePtr,
                       boolean&nbsp;allowNoPrefix)</code>&nbsp;</td>
 </tr>
-<tr id="i7" class="rowColor">
+<tr id="i9" class="rowColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeSetPrefixString-long-java.lang.String-">nativeSetPrefixString</a></span>(long&nbsp;nativePtr,
                      java.lang.String&nbsp;prefixString)</code>&nbsp;</td>
 </tr>
-<tr id="i8" class="altColor">
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeSetReturnCodeWithoutPrefix-long-boolean-">nativeSetReturnCodeWithoutPrefix</a></span>(long&nbsp;nativePtr,
+                                boolean&nbsp;returnCodeWithoutPrefix)</code>&nbsp;</td>
+</tr>
+<tr id="i11" class="rowColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#nativeSetUSSDCodeLength-long-int-">nativeSetUSSDCodeLength</a></span>(long&nbsp;nativePtr,
                        int&nbsp;ussdCodeLength)</code>&nbsp;</td>
 </tr>
-<tr id="i9" class="rowColor">
+<tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#setAllowNoPrefix-boolean-">setAllowNoPrefix</a></span>(boolean&nbsp;allowNoPrefix)</code>
 <div class="block">Sets if ussd codes without prefix is allowed</div>
 </td>
 </tr>
-<tr id="i10" class="altColor">
+<tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#setPrefixString-java.lang.String-">setPrefixString</a></span>(java.lang.String&nbsp;prefixString)</code>
 <div class="block">Sets prefix string for which extraction will be performed</div>
 </td>
 </tr>
-<tr id="i11" class="rowColor">
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#setReturnCodeWithoutPrefix-boolean-">setReturnCodeWithoutPrefix</a></span>(boolean&nbsp;returnCodeWithoutPrefix)</code>
+<div class="block">Sets whether *digits* prefix and # at the end of scanned ussd code will be returned</div>
+</td>
+</tr>
+<tr id="i15" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#setUSSDCodeLength-int-">setUSSDCodeLength</a></span>(int&nbsp;ussdCodeLength)</code>
 <div class="block">Sets ussd code length i.e.</div>
 </td>
 </tr>
-<tr id="i12" class="altColor">
+<tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/microblink/recognizers/blinkocr/parser/topup/TopUpParserSettings.html#writeToParcel-android.os.Parcel-int-">writeToParcel</a></span>(android.os.Parcel&nbsp;dest,
              int&nbsp;flags)</code>&nbsp;</td>
@@ -524,6 +546,56 @@ <h4>nativeGetAllowNoPrefix</h4>
 <pre>public static&nbsp;boolean&nbsp;nativeGetAllowNoPrefix(long&nbsp;nativePtr)</pre>
 </li>
 </ul>
+<a name="setReturnCodeWithoutPrefix-boolean-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setReturnCodeWithoutPrefix</h4>
+<pre>public&nbsp;void&nbsp;setReturnCodeWithoutPrefix(boolean&nbsp;returnCodeWithoutPrefix)</pre>
+<div class="block">Sets whether *digits* prefix and # at the end of scanned ussd code will be returned</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>returnCodeWithoutPrefix</code> - whether *digits* prefix and # at the end of scanned ussd
+                                 code will be returned</dd>
+</dl>
+</li>
+</ul>
+<a name="nativeSetReturnCodeWithoutPrefix-long-boolean-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nativeSetReturnCodeWithoutPrefix</h4>
+<pre>public static&nbsp;void&nbsp;nativeSetReturnCodeWithoutPrefix(long&nbsp;nativePtr,
+                                                    boolean&nbsp;returnCodeWithoutPrefix)</pre>
+</li>
+</ul>
+<a name="getReturnCodeWithoutPrefix--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getReturnCodeWithoutPrefix</h4>
+<pre>public&nbsp;boolean&nbsp;getReturnCodeWithoutPrefix()</pre>
+<div class="block">Returns <code>true</code> if scanned code will be returned without *digits* prefix and trailing #,
+ <code>false</code> otherwise.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if scanned code will be returned without *digits* prefix and trailing #,
+ <code>false</code> otherwise.</dd>
+</dl>
+</li>
+</ul>
+<a name="nativeGetReturnCodeWithoutPrefix-long-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nativeGetReturnCodeWithoutPrefix</h4>
+<pre>public static&nbsp;boolean&nbsp;nativeGetReturnCodeWithoutPrefix(long&nbsp;nativePtr)</pre>
+</li>
+</ul>
 <a name="writeToParcel-android.os.Parcel-int-">
 <!--   -->
 </a>

docs/com/microblink/view/package-tree.html

@@ -125,8 +125,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
 <li type="circle">com.microblink.view.<a href="../../../com/microblink/view/CameraAspectMode.html" title="enum in com.microblink.view"><span class="typeNameLink">CameraAspectMode</span></a> (implements android.os.Parcelable)</li>
-<li type="circle">com.microblink.view.<a href="../../../com/microblink/view/NotSupportedReason.html" title="enum in com.microblink.view"><span class="typeNameLink">NotSupportedReason</span></a></li>
 <li type="circle">com.microblink.view.<a href="../../../com/microblink/view/BaseCameraView.CameraViewState.html" title="enum in com.microblink.view"><span class="typeNameLink">BaseCameraView.CameraViewState</span></a></li>
+<li type="circle">com.microblink.view.<a href="../../../com/microblink/view/NotSupportedReason.html" title="enum in com.microblink.view"><span class="typeNameLink">NotSupportedReason</span></a></li>
 </ul>
 </li>
 </ul>