Skip to content

Transition guide

Jump to bottom
Dino Gustin edited this page Jun 6, 2018 · 33 revisions

Transition to 5.15.0

  • No changes

Transition to 5.14.1

  • No changes

Transition to 5.14.0

  • No changes

Transition to 5.13.0

  • Renamed PPMyKadRecognizerSettings and PPMyKadRecognizerResult to PPMyKadFrontRecognizerSettings and PPMyKadFrontRecognizerResult

Transition to 5.12.1

  • No changes

Transition to 5.12.0

  • Removed imageDPI property on PPTemplatingRecognizerSettings

Transition to 5.11.0

  • PPDocumentDetectorResult does not contain information about screen orientation any more

Transition to 5.10.2

  • No changes

Transition to 5.10.1

  • 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.

Transition to 5.10.0

  • PPBlinkOcrRecognizerResult and PPBlinkOcrRecognizerSettings are now deprecated. Use PPDetectorRecognizerResult and PPDetectorRecognizerSettings for templating or PPBlinkInputRecognizerResult and PPBlinkInputRecognizerSettings for segment scan
  • PPSerbianPdf417RecognizerResult and PPSerbianPdf417RecognizerSettings are renamed to PPSerbianBarcodeRecognizerResult and PPSerbianBarcodeRecognizerSettings

Transition to 5.9.4

  • extractAddress property in PPSlovakIDBackRecognizerSettings is now removed since previously wasn't use

Transition to 5.9.3

  • PPAztecRecognizerResult and PPAztecRecognizerSettings are now deprecated. Use PPBarcodeRecognizerResult and PPBarcodeRecognizerSettings
  • PPBarDecoderRecognizerResult and PPBarDecoderRecognizerSettings are now deprecated. Use PPBarcodeRecognizerResult and PPBarcodeRecognizerSettings
  • PPZXingRecognizerResult and PPZXingRecognizerSettings are now deprecated. Use PPBarcodeRecognizerResult and PPBarcodeRecognizerSettings

Transition to 5.9.2

  • No changes

Transition to 5.9.1

  • No changes

Transition to 5.9.0

  • Since Microblink.framework is a dynamic framework, you also need to add it to embedded binaries section in General settings of your target.

  • Library size was reduced by removing all unnecessary components. One of the components removed was internal libz library. You now need to add libz.tbd into "Linked frameworks and binaries" setting.

  • Microblink.framework is a dynamic framework which contains slices for all architectures - device and simulator. If you intend to extract .ipa file for ad hoc distribution, you'll need to preprocess the framework to remove simulator architectures.

Ideal solution is to add a build phase after embed frameworks build phase, which strips unused slices from embedded frameworks.

Build step is based on the one provided here: http://ikennd.ac/blog/2015/02/stripping-unwanted-architectures-from-dynamic-libraries-in-xcode/

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"

# This script loops through the frameworks embedded in the application and
# removes unused architectures.
find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"

EXTRACTED_ARCHS=()

for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done

echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"

echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"

done
  • Deprecated PPHelpDisplayMode. It still works, but ideally, you should replace it with a custom logic for presenting help inside the application using the SDK.
  • Simplified PPOcrLayout class (removed properties which were not used). If you used it previously, simply remove that code because it does not provide any value.
  • If you're using PPGermanIDMrzRecognizer, it's functionality is now split into two recognizers:
    • one for back side of the new ID (PPGermanIDBackRecognizer)
    • one for front side of the old ID (PPGermanOldIDRecognizer)

Transition to 5.8.0

  • No changes

Transition to 5.7.2

  • No changes

Transition to 5.7.1

  • If you used payerAddress and recipientAddress properties in PPSloQrCodeRecognizerResult, those properties are now split into payerStreet, payerPlace, recipientStreet and recipientPlace.
  • If you used accountNumber property in PPSkSlipRecognizerResult, this property can now be replaced by iban property

Transition to 5.7.0

  • If you're using PPSingaporeIdRecognizer, you should now decide which side of the ID you want to use, and use either PPSingaporeIDBackRecognizer, or PPSingaporeIDFrontRecognizer
  • PPMobileCouponsOcrParserFactory changed name to PPTopUpOcrParserFactory

Transition to 5.6.0

  • No changes

Transition to 5.5.0

  • No changes

Transition to 5.4.1

  • No changes

Transition to 5.4.0

  • PPMrtdRecognizerResult now returns NSDate in methods dateOfBirth and dateOfExpiry. Previously NSString was returned and user had to parse the string to get the date. If you want old behaviour, use methods rawDateOfBirth and rawDateOfExpiry which will return strings in same format as in previous versions.
  • this also applies for all recognizer results that inherit PPMrtdRecognizerResult
  • although PPDateOcrParser now returns PPDateResult object (which contains both NSDate and original NSString from which date was parsed), when obtaining parser result via parserResultForName: or parserResultForName:parserGroup: methods, you will be provided with string just like in previous versions. If you want NSDate, you should use methods specificParsedResultForName: or specificParsedResultForName:parserGroup: and cast NSObject they return into NSDate.
  • all recognizer results (classes that derive PPRecognizerResult) now have annotated nullability for their getters. Some of them used to assume non-null, while still returning nil sometimes. This has now been corrected and all getters are _Nullable

Transition to 5.3.0

  • No changes

Transition to 5.2.0

  • No changes

Transition to 5.1.0

  • No changes

Transition to 5.0.3

  • No changes

Transition to 5.0.2

  • No changes

Transition to 5.0.1

  • No changes

Transition to 5.0.0

  • PPCameraCoordinator now assumes the role of PPCoordinator. If you do not use your own camera management or Direct API you can rename all instances of PPCoordinator to PPCameraCoordinator
  • PPCoordinator method cameraViewControllerWithDelegate: has been removed. To create PPScanningViewControllers you can now use [PPViewControllerFactory cameraViewControllerWithDelegate: coordinator: error:]
  • Direct API is now located in PPCoordinator. To process image use 'processImage:' method and be sure to set 'PPCoordinatorDelegate' when creating 'PPCoordinator' to recieve scanning results and events. You can se processing image roi and processing orientation on 'PPImage' object.
  • Methods of 'PPOverlayContainerViewController' protocol should now be called after camera view has appeared.
  • Removed PPOcrEngineOptions property from PPRegexOcrParserFactory and PPRawOcrParserFactory. Replaced property with setter method.

Transition to 4.6.4

  • No changes

Transition to 4.6.2

  • Renamed PPOcrRecognizerSettings and PPOcrRecognizerResult to PPBlinkOcrRecognizerSettings and PPBlinkOcrRecognizerResult respectively

  • Changed interface of some Detector API methods

  • PPDocumentDecodingInfoEntry renamed to PPDecodingInfo

  • Removed PPDocumentDecodingInfo. All occurances need to be replaced with NSArray<PPDecodingInfo>

Transition to 4.6.1

  • If you implement custom camera UI and handle cameraViewController:didFindLocation:withStatus, this method was changed to cameraViewController:didFinishDetectionWithResult:. PPDetectorResult object now contains all information previosusly passed to this method. Simply update the code to use the new method signature. Verify the exact type of the passed detectorResult object, cast it to this class, and use provided getters to obtain all information.

Transition to 4.6.0

  • PPOverlayViewController changed the way Overlay Subviews are added to the view hierarchy. Instead of calling addOverlaySubview: (which automatically added a view to view hierarachy), you now need to call registerOverlaySubview: (which registers subview for scanning events), and manually add subview to view hierarchy using addSubview: method. This change gives you more flexibility for adding views and managing autolayout and autoresizing masks. So, replace all calls to (assuming self is a PPOverlayViewController instance)
[self addOverlaySubview:subview];

with

[self registerOverlaySubview:subview];
[self.view addSubview:subview];
  • Localization Macros MB_LOCALIZED and MB_LOCALIZED_FORMAT can now be overriden in your app to provide completely custom localization mechanisms.

Transition to 4.5.1

  • No changes

Transition to 4.5.0

  • Remove MicroBlinkResources.bundle and add MicroBlink.bundle.

  • If you use PPMetadataSettings objects,

    • successfulScanFrame property replace with successfulFrame
    • currentVideoFrame property replace with currentFrame

Transition to 4.4.0

  • Remove the old .embeddedframework package completely from your project

  • Add new .framework and .bundle package to your project. Verify that Framework search path really contains a path to the .framework folder.

  • If necessary, add all required system frameworks and libraries:

    • libc++.tbd
    • libiconv.tbd
    • AVFoundation.framework
    • AudioToolbox.framework
    • CoreMedia.framework
    • AssetsLibrary.framework
    • Accelerate.framework

  • If you previously used built-in onboarding (help) screens, since they are moved outside the SDK, you need to re-add it to your project. You can do that by overriding the method :

- (void)scanningViewControllerWillPresentHelp:(UIViewController<PPScanningViewController> *)scanningViewController

In the implementation, presenting the Onboarding screens. Default implementation which is provided in the Sample app for your country / use case. We recommend you use provided help screens - just drag & drop the classes, storyboard and xcassets files in your project.

Transition to 4.3.0

  • You can now use bitcode = YES in your build settings.

Transition to 4.2.0

  • PhotoPayHelpViewController.nib resource was renamed to PhotoPayHelpViewController.xib. This allows it to be open with new Xcode versions (Xcode 7)

Transition to 4.1.0

  • rotatedImage property of PPImageMetadata no longer exists. Use image property instead, it correctly handles rotation.

  • The ability to use native iOS orientation handling features is now added. PPScanningViewController now has properties autorotate and supportedOrientations. ScanningViewController uses these properties in the implementation of standard iOS rotation handling methods: shouldAutorotate and supportedInterfaceOrientations.

If you use autorotation with the new features, make sure you disable autorotation of the overlay using settings.uiSettings.autorotateOverlay = NO

Transition to 4.0.3

  • No changes

Transition to 4.0.2

  • No changes

Transition to 4.0.1

  • This version uses a new license key format. If you had a license key generated prior to v4.0.1, contact us so we can regenerate the license key for you.

  • PPCoordinator class now exposes fewer public methods and properties.

  • PPScanningViewController's methods resumeScanning and resumeScanningWithoutStateReset merged into one resumeScanningAndResetState:. - All calls to resumeScanning replace with resumeScanningAndResetState:YES. - All calls to resumeScanningWithoutStateReset replace with resumeScanningAndResetState:NO

  • Classes representing scanning results were renamed. Renaming was performed to match naming convention of PPRecognizerSettings hierarcy: now each PPRecognizerSettings class has it's matching PPRecognizerResult. Replace all existing references to old class names with the new ones:

    • PPBaseResult was renamed to PPRecognizerResult.

    • PPOcrScanResult was renamed to PPOcrRecognizerResult, this is the result of a recognizer whose settings are given with PPOcrRecognizerSettings.

    • PPCroResult renamed to PPCroRecognizerResult. This is a common superclass to PPCroSlipRecognizerResult, PPCroPdf417RecognizerResult and PPCroQrRecognizerResult.

    • PPCroSlipResult renamed to PPCroSlipRecognizerResult, this is the result of a recognizer whose settings are given with PPCroSlipRecognizerSettings.

    • PPCroBarcodeResult renamed to PPCroPdf417RecognizerResult, this is the result of a recognizer whose settings are given with PPCroPdf417RecognizerSettings.

    • Introduced PPCroQrRecognizerResult, this is the result of a recognizer whose settings are given with PPCroQrRecognizerSettings.

  • PPOcrResult (class representing a result of the OCR process, with individual characters, lines and blocks), was renamed to PPOcrLayout. Name change was introduced to further distinguish the class from PPRecognizerResult classes.

  • Remove all references to updateScanningRegion method since it's now being called automatically in setScanningRegion setter.

Transition to 4.0.0

  • Framework was renamed to MicroBlink.embeddedframework. Remove the existing .embeddedframwork package from your project, and drag&drop MicroBlink.embeddedframework in the project explored of your Xcode project.

  • If necessary, after the update, modify your framework search path so that it points to the MicroBlink.embeddedframework folder.

  • Main header of the framework was renamed to <MicroBlink/Microblink.h>. Change all references to previous header with the new one.

  • method [PPCoordinator isPhotoPaySupported] was renamed to [PPCoordinator isScanningSupported]. Change all occurances of the method name.

  • Remove all references to updateScanningRegion method since it's now being called automatically in setScanningRegion setter.

  • Retrieving results has changed. Consult guides in Docs/ especially those with prefix 01.

PhotoPay SDK

Clone this wiki locally