io-anyline-adcubum

Stand 11.03.19

Adcubum Anyline SDK Cordova Plugin

Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices.

Versionierung

Das Projekt ist semantisch versioniert.

Auf Grundlage einer Versionsnummer von MAJOR.MINOR.PATCH werden die einzelnen Elemente folgendermassen erhöht:

• MAJOR wird erhöht, wenn API-inkompatible Änderungen veröffentlicht werden,
• MINOR wird erhöht, wenn neue Funktionalitäten, welche kompatibel zur bisherigen API sind, veröffentlicht werden, und
• PATCH wird erhöht, wenn die Änderungen ausschliesslich API-kompatible Bugfixes umfassen.

Weitere Informationen siehe http://semver.org/lang/de/ Version anpassen oder Release erstellen siehe https://stash.adcubum.com/projects/BLD/repos/bld-release-plugin/browse

Change log

Grundlage des Changelogs siehe http://keepachangelog.com/de/0.3.0/

[Unreleased]

Added

Changed

Removed

Fixed

[1.0.0] - 2017-09-07

Fixed - Styling der Navigationsbar über die Cordova Params möglich.

[0.1.0] -

• multipage document Scan flow implemented
• manual shutter + (semi) manual crop View
• overview-view to edit / rotate / delete
• top-bar for navigation and page-counter
• scanning only supported in portrait mode

Known Issues

Android Known Issues:

• manual crop view overlay calculation offset
• sometimes after manual shutter scan, flow stuck in processing image

iOS Localization

• Localization string files needs to be added to the generated cordova project. Already localized strings available in the ios plugin folder.

Depending on the current setup, it may be worthwhile to use a localization plugin to manage both iOS and Android strings in one place (JSON)

Available Documentation

• Anyline Document: Welcome to the Anyline Cordova Developer Guide

Requirements

Android

• Android device with SDK >= 15
• decent camera functionality (recommended: 720p and adequate auto focus)

iOS

• minimum iOS 8.2
• minimum iPhone4s

Quick Start - Setup

This is just a simple setup guide to integrate the anylinesdk-plugin in an existing Cordova project.
For more information about Cordova, how to use plugins, etc. see https://cordova.apache.org/.

1. Add the anylinesdk-plugin to your existing cordova project

cordova plugin add io-anyline-cordova

Or use plugman. E.g. for android:

plugman install --platform android --project platforms/android --plugin io-anyline-cordova

If you'd like to clone the repository you will have to use git-lfs. Use the following commands to install git-lfs.

brew install git-lfs
git lfs install

If you prefer downloading a package, use the provided zip package on the releases page. Be aware that the github download zip button does not work for projects with git-lfs.

2. Plugin Usage

cordova.exec(onResult, onError, "AnylineSDK", scanMode, config);

• onResult: a function that is called on a scan result
• onError: a function that is called on error or when the user canceled the scanning
• AnylineSDK: add this string to make sure the anyline-sdk plugin is called
• scanMode: "MRZ", "BARCODE", "ANYLINE_OCR", "ELECTRIC_METER", "GAS_METER" (more Energy modes can be found here)
• config: an array
  • config[0]: the license key
  • config[1]: the view config
  • config[2]: the ocr config (only uses with mode ANYLINE_OCR)

Example for config from MRZ:

[
    "YOUR_LICENSE_KEY",
    {
        "captureResolution": "1080p",
        "cutout": {
            "style": "rect",
            "maxWidthPercent": "90%",
            "maxHeightPercent": "90%",
            "alignment": "top_half",
            "strokeWidth": 2,
            "cornerRadius": 4,
            "strokeColor": "FFFFFF",
            "outerColor": "000000",
            "outerAlpha": 0.3
        },
        "flash": {
            "mode": "manual",
            "alignment": "bottom_right"
        },
        "beepOnResult": true,
        "vibrateOnResult": true,
        "blinkAnimationOnResult": true,
        "cancelOnResult": true
    }
]

3. Run your cordova project: Enjoy scanning and have fun :)

Checkout our online documentation for more details.

License

See LICENSE file.