Updated docs for v2.12.0

BlinkID · Sep 12, 2017 · bf13ac3 · bf13ac3
1 parent fde8875
commit bf13ac3
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,37 @@
+## 2.12.0
+
+- Updates and additions
+    - Added Australian Driver Licence Recognizer `PPAustraliaDLFrontRecognizerResult` and `PPAustraliaDLFrontRecognizerSettings` for state Victoria
+    - Added Swiss ID Back Recognizer `PPSwissIDBackRecognizerResult` and `PPSwissIDBackRecognizerSettings`
+    - Added Swiss ID Front Recognizer `PPSwissIDFrontRecognizerResult` and `PPSwissIDFrontRecognizerSettings`
+    - Added reading of mirrored QR codes
+    - Added `PPMrzFilter` protocol and delegate `mrzFilter` on `PPMrtdRecognizerSettings`
+        - Determines whether document should be processed or it is filtered out, based on its MRZ (Machine Readable Zone)
+    - Introduced `GlareDetector` which is by default used in all recognizers whose settings implement `GlareDetectorOptions`:
+        - When glare is detected, OCR will not be performed on the affected document position to prevent errors in the extracted data
+        - If the glare detector is used and obtaining of glare metadata is enabled in `MetadataSettings`
+        - Glare detector can be disabled by using `detectGlare` property on the recognizer settings
+    - Added `PPQuadDetectorResultWithSize` which inherits existing `PPQuadDetectorResult`
+        - It's subclasses are `PPDocumentDetectorResult` and `PPMrtdDetectorResult`
+        - Returns information about physical size (height) in inches of the detected location when physical size is known
+
+- Minor API changes
+    - `PPBlinkOcrRecognizerResult` and `PPBlinkOcrRecognizerSettings` are now deprecated. Use `PPDetectorRecognizerResult` and `PPDetectorRecognizerSettings` for templating or `PPBlinkInputRecognizerResult` and `PPBlinkInputRecognizerSettings` for segment scan
+    - removed option to scan 1D Code39 and Code128 barcodes on US Driver's licenses that contain those barcodes alongside PDF417 barcode
+
+- Bugfixes:
+    - Fixed crash which sometimes happened while scanning MRTD documents
+    - Fixed returning valid data for MRZ based recognizers when not all fields outside MRZ have been scanned
+    - Fixed crash in QR code which happened periodically in all recognizers
+    - Fixed autorotation of overlay view controller 
+    - Fixed scanning return result type of `PPDetectorRecognizerSettings` when initialized with `PPMrtdDetectorSettings` - returning `PPMrtdDetectorResult`
+
+- Improvements in ID scanning performance:
+    - Date parsing improvements
+    - Better extraction of fields on back side of the Croatian ID card
+    - Improved reading of issuing authority on Croatian ID back side
+    - Improved USDLRecognizer - added support for new USDL standard
+
 ## 2.11.0
 
 - Updates and additions

diff --git a/PPBlinkID.podspec b/PPBlinkID.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name        = "PPBlinkID"
-  s.version     = "2.11.0"
+  s.version     = "2.12.0"
   s.summary     = "A delightful component for barcode scanning"
   s.homepage    = "http://microblink.com"
 
@@ -32,7 +32,7 @@ Pod::Spec.new do |s|
 
   s.source      = { 
         :git => 'https://github.com/BlinkID/blinkid-ios.git', 
-        :tag => 'v2.11.0'
+        :tag => 'v2.12.0'
   }
 
   s.platform     = :ios

diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ pod try PPBlinkID
 platform :ios, '8.0'
 
 target 'TargetName' do
-  pod 'PPBlinkID', '~> 2.11.0'
+  pod 'PPBlinkID', '~> 2.12.0'
 end
 ```
 

diff --git a/Release notes.md b/Release notes.md
@@ -1,3 +1,37 @@
+## 2.12.0
+
+- Updates and additions
+    - Added Australian Driver Licence Recognizer `PPAustraliaDLFrontRecognizerResult` and `PPAustraliaDLFrontRecognizerSettings` for state Victoria
+    - Added Swiss ID Back Recognizer `PPSwissIDBackRecognizerResult` and `PPSwissIDBackRecognizerSettings`
+    - Added Swiss ID Front Recognizer `PPSwissIDFrontRecognizerResult` and `PPSwissIDFrontRecognizerSettings`
+    - Added reading of mirrored QR codes
+    - Added `PPMrzFilter` protocol and delegate `mrzFilter` on `PPMrtdRecognizerSettings`
+        - Determines whether document should be processed or it is filtered out, based on its MRZ (Machine Readable Zone)
+    - Introduced `GlareDetector` which is by default used in all recognizers whose settings implement `GlareDetectorOptions`:
+        - When glare is detected, OCR will not be performed on the affected document position to prevent errors in the extracted data
+        - If the glare detector is used and obtaining of glare metadata is enabled in `MetadataSettings`
+        - Glare detector can be disabled by using `detectGlare` property on the recognizer settings
+    - Added `PPQuadDetectorResultWithSize` which inherits existing `PPQuadDetectorResult`
+        - It's subclasses are `PPDocumentDetectorResult` and `PPMrtdDetectorResult`
+        - Returns information about physical size (height) in inches of the detected location when physical size is known
+
+- Minor API changes
+    - `PPBlinkOcrRecognizerResult` and `PPBlinkOcrRecognizerSettings` are now deprecated. Use `PPDetectorRecognizerResult` and `PPDetectorRecognizerSettings` for templating or `PPBlinkInputRecognizerResult` and `PPBlinkInputRecognizerSettings` for segment scan
+    - removed option to scan 1D Code39 and Code128 barcodes on US Driver's licenses that contain those barcodes alongside PDF417 barcode
+
+- Bugfixes:
+    - Fixed crash which sometimes happened while scanning MRTD documents
+    - Fixed returning valid data for MRZ based recognizers when not all fields outside MRZ have been scanned
+    - Fixed crash in QR code which happened periodically in all recognizers
+    - Fixed autorotation of overlay view controller 
+    - Fixed scanning return result type of `PPDetectorRecognizerSettings` when initialized with `PPMrtdDetectorSettings` - returning `PPMrtdDetectorResult`
+
+- Improvements in ID scanning performance:
+    - Date parsing improvements
+    - Better extraction of fields on back side of the Croatian ID card
+    - Improved reading of issuing authority on Croatian ID back side
+    - Improved USDLRecognizer - added support for new USDL standard
+
 ## 2.11.0
 
 - Updates and additions

diff --git a/Transition guide.md b/Transition guide.md
@@ -1,4 +1,10 @@
+## 2.12.0
+
+- There is no more option in `PPUsdlRecognizerSettings` to scan 1D barcodes. Previously this setting did nothing - it's OK to just delete the setter call if you use it.
+- `PPBlinkOcrRecognizerResult` and `PPBlinkOcrRecognizerSettings` are now deprecated. Use `PPDetectorRecognizerResult` and `PPDetectorRecognizerSettings` for templating or `PPBlinkInputRecognizerResult` and `PPBlinkInputRecognizerSettings` for segment scan
+
 ## 2.11.0
+
 - No changes
 
 ## 2.10.0

diff --git a/buildCommit.txt b/buildCommit.txt
@@ -1 +1 @@
-Built from core repository commit 80e408cde3e5adb929c8a0cf8679b9bc98187285
+Built from core repository commit a6124b0e2d364418632d9ff5f448904aa3b23d92
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Built from core repository commit 80e408cde3e5adb929c8a0cf8679b9bc98187285
		Built from core repository commit a6124b0e2d364418632d9ff5f448904aa3b23d92