Skip to content

Latest commit

 

History

History
465 lines (333 loc) · 17 KB

README.md

File metadata and controls

465 lines (333 loc) · 17 KB
Raw

flutter-klippa-scanner-sdk

Dart version Build Status

SDK usage

Please be aware you need to have a license to use this SDK. If you would like to use our scanner, please contact us here

Getting started

Android

Edit the file android/key.properties, if it doesn't exist yet, create it. Add the SDK credentials:

klippa.scanner.sdk.username={your-username}
klippa.scanner.sdk.password={your-password}

Replace the {your-username} and {your-password} values with the ones provided by Klippa.

iOS

Edit the file ios/Podfile, add the Klippa CocoaPod:

platform :ios, '13.0'
ENV['KLIPPA_SCANNER_SDK_USERNAME'] = '{your-username}'
ENV['KLIPPA_SCANNER_SDK_PASSWORD'] = '{your-password}'

// Edit the Runner config to add the pod:

target 'Runner' do
    // ... other instructions
    
    // Add this below flutter_install_all_ios_pods    
    if "#{ENV['KLIPPA_SCANNER_SDK_URL']}" == ""
        ENV['KLIPPA_SCANNER_SDK_URL'] = File.read(File.join(File.dirname(File.realpath(__FILE__)), '.symlinks', 'plugins', 'klippa_scanner_sdk', 'ios', 'sdk_repo')).strip
    end

    if "#{ENV['KLIPPA_SCANNER_SDK_VERSION']}" == ""
        ENV['KLIPPA_SCANNER_SDK_VERSION'] = File.read(File.join(File.dirname(File.realpath(__FILE__)), '.symlinks', 'plugins', 'klippa_scanner_sdk', 'ios', 'sdk_version')).strip
    end

    pod 'Klippa-Scanner', podspec: "#{ENV['KLIPPA_SCANNER_SDK_URL']}/#{ENV['KLIPPA_SCANNER_SDK_USERNAME']}/#{ENV['KLIPPA_SCANNER_SDK_PASSWORD']}/KlippaScanner/#{ENV['KLIPPA_SCANNER_SDK_VERSION']}.podspec"
end

Replace the {your-username} and {your-password} values with the ones provided by Klippa.

Edit the file ios/{project-name}/Info.plist and add the NSCameraUsageDescription value:

...
<key>NSCameraUsageDescription</key>
<string>Access to your camera is needed to photograph documents.</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>Access to your photo library is used to save the images of documents.</string>
...

Flutter

Add klippa_scanner_sdk as a dependency in your pubspec.yaml file.

dependencies:
  flutter:
    sdk: flutter

  klippa_scanner_sdk: ^x.y.z

  # Rest of dependencies

Usage

import 'package:klippa_scanner_sdk/klippa_scanner_sdk.dart';

var config = CameraConfig();

try {
  var result = await KlippaScannerSdk.startSession(config, '{insert-license-here');
} on PlatformException catch (e) {
  print('Failed to start session ' + e.toString());
}

The reject reason object has a code and a message, the used codes are:

The reject reason object has a code and a message, the used codes are:

  • E_ACTIVITY_DOES_NOT_EXIST (Android only)
  • E_FAILED_TO_SHOW_SESSION (Android only)
  • E_MISSING_LICENSE
  • E_CANCELED
  • E_UNKNOWN_ERROR

How to use a specific version of the SDK?

Android

Edit the file android/build.gradle, add the following:

allprojects {
  // ... other definitions
  project.ext {
      klippaScannerVersion = "{version}"
  }
}

Replace the {version} value with the version you want to use.

If you want to change the repository:

Edit the file android/key.properties, add the sdk repository URL:

klippa.scanner.sdk.url={repository-url}

Replace {repository-url with the URL that you want to use.

iOS

Edit the file ios/Podfile, add the following line below the username/password if you want to change the version:

ENV['KLIPPA_SCANNER_SDK_VERSION'] = '{version}'

replace {version} with the version you want to use.

If you want to change the repository:

Edit the file ios/Podfile add the following line below the username/password if you want to change the URL:

ENV['KLIPPA_SCANNER_SDK_URL'] = '{repository-url}'

Replace {repository-url} with the URL that you want to use.

How to change the setup of the SDK:

General

// Ability to disable/hide the shutter button (only works when a model is supplied as well).
config.shutterButton.allowShutterButton = true;
config.shutterButton.hideShutterButton = false;

// Whether the crop mode (auto edge detection) should be enabled by default.
config.defaultCrop = true;

// Define the max resolution of the output file. It’s possible to set only one of these values. We will make sure the picture fits in the given resolution. We will also keep the aspect ratio of the image. Default is max resolution of camera.
config.imageMaxWidth = 1920;
config.imageMaxHeight = 1080;

// Set the output quality (between 0-100) of the jpg encoder. Default is 100.
config.imageMaxQuality = 95;

// If you would like to use a custom model for object detection. Model + labels file should be packaged in your bundle.
config.model.fileName = "model";
config.model.modelLabels = "labelmap";

// If you want to adjust the timer options.
config.timer.allowed = true;
config.timer.enabled = true;
config.timer.duration = 1.0;

// Whether to go to the Review Screen once the image limit has been reached. (default false)
config.shouldGoToReviewScreenWhenImageLimitReached = false;
    
// Whether to hide or show the rotate button in the Review Screen. (default shown/true)
config.userCanRotateImage = false;

// Whether to hide or show the cropping button in the Review Screen. (default shown/true)
config.userCanCropManually = false;

// Whether to hide or show the color changing button in the Review Screen. (default shown/true)
config.userCanChangeColorSetting = false;

// To add extra horizontal and / or vertical padding to the cropped image.
config.cropPadding.width = 100;
config.cropPadding.height =  100;

// After capture, show a checkmark preview with this success message, instead of a preview of the image.
config.success.previewDuration = 1.0;

// The amount of seconds the preview should be visible for, should be a float.
config.previewDuration = 1.0;

// To limit the amount of images that can be taken.
config.imageLimit = 10;

// Whether the camera automatically saves the images to the camera roll (iOS) / gallery (Android). Default true.
config.storeImagesToCameraRol = true;

// Whether to allow users to select media from their device (Shows a media button bottom left on the scanner screen).
config.userCanPickMediaFromStorage = true;

// Whether the next button in the bottom right of the scanner screen goes to the review screen instead of finishing the session.
config.shouldGoToReviewScreenOnFinishPressed = true;

// Whether the user must confirm the taken photo before the SDK continues.
config.userShouldAcceptResultToContinue = false;

// What the default color conversion will be (grayscale, original, enhanced).
config.defaultColor = DefaultColor.original;

// Enable Single Document Mode
config.cameraModeSingle = new CameraMode();
// Localize the name of Single Document Mode
config.cameraModeSingle?.name = "Single Document Mode";
// Localize the instructions of Single Document Mode
config.cameraModeSingle?.message = "Used for a single document";

// Enable Multi Document Mode
config.cameraModeMulti = new CameraMode();
// Localize the name of Multi Document Mode
config.cameraModeMulti?.name = "Multi Document Mode";
// Localize the instructions of Multi Document Mode
config.cameraModeMulti?.message = "Used for a multiple documents";

// Enable Segmented Document Mode
config.cameraModeSegmented = new CameraMode();
// Localize the name of Segmented Document Mode
config.cameraModeSegmented?.name = "Segmented Document Mode";
// Localize the instructions of Segmented Document Mode
config.cameraModeSegmented?.message = "Used for a single document segmented into multiple photos";

// When multiple camera modes are enabled select which should show first by index.
config.startingIndex = 0;

Android only

// Where to put the image results.
config.storagePath = "/sdcard/scanner";

// The filename to use for the output images, supports replacement tokens %dateTime% and %randomUUID%.
config.outputFileName = "KlippaScannerExample-%dateTime%-%randomUUID%";

// The threshold sensitive the motion detection is. (lower value is higher sensitivity, default 50).
config.imageMovingSensitivityAndroid = 50;

iOS only

// The text inside of the color selection alert dialog button named original.
config.imageColorOriginalText = "original";

// The text inside of the color selection alert dialog button named grayscale.
config.imageColorGrayscaleText = "grayscale";

// The text inside of the color selection alert dialog button named enhanced.
config.imageColorEnhancedText = "enhanced";

// Whether the camera has a view finder overlay (a helper grid so the user knows where the document should be), should be a Boolean.
config.isViewFinderEnabled = true;

// The threshold sensitive the motion detection is. (lower value is higher sensitivity, default 200).
config.imageMovingSensitivityiOS = 200;

// The lower threshold before the warning message informs the environment is too dark (default 0).
config.brightnessLowerThreshold = 0;

// The upper threshold before the warning message informs the environment is too bright (default 6).
config.brightnessUpperThreshold = 6;

How to change the colors of the SDK?

Android

Add or edit the file android/app/src/res/values/colors.xml, add the following:

<resources>
  <color name="klippa_scanner_sdk_color_accent">#ffffff</color>
  <color name="klippa_scanner_sdk_color_button_with_icon_background">#444444</color>
  <color name="klippa_scanner_sdk_color_button_with_icon_foreground">#ffffff</color>
  <color name="klippa_scanner_sdk_color_icon_disabled">#444</color>
  <color name="klippa_scanner_sdk_color_icon_enabled">#ffffff</color>
  <color name="klippa_scanner_sdk_color_primary">#000000</color>
  <color name="klippa_scanner_sdk_color_secondary">#2dc36a</color>
  <color name="klippa_scanner_sdk_color_warning_background">#BF000000</color>
  <color name="klippa_scanner_sdk_color_warning_text">#ffffff</color>
</resources>

iOS

Use the following properties in the config:

  config.accentColor = Color.fromARGB(255, 255, 255, 255);
  config.buttonWithIconBackgroundColor = Color.fromARGB(255, 68, 68, 68);
  config.buttonWithIconForegroundColor = Color.fromARGB(255, 255, 255, 255);
  config.iconDisabledColor = Color.fromARGB(255, 255, 0, 191);
  config.iconEnabledColor = Color.fromARGB(255, 0, 59, 255);
  config.primaryColor = Color.fromARGB(255, 0, 0, 0);
  config.secondaryColor = Color.fromARGB(255, 255, 0, 191);
  config.warningBackgroundColor = Color.fromARGB(255, 252, 252, 252);
  config.warningTextColor = Color.fromARGB(255, 0, 0, 0);
  config.overlayColorAlpha = 0.75; // manually set the alpha of the overlay bounding box.

How to change the strings of the SDK?

Android

Add or edit the file android/app/src/res/values/strings.xml, add the following:

<resources>
  <string name="klippa_action_crop">Crop</string>
  <string name="klippa_action_delete">Delete</string>
  <string name="klippa_action_expand">Expand</string>
  <string name="klippa_action_filter">Filter</string>
  <string name="klippa_action_rotate">Rotate</string>
  <string name="klippa_action_save">Save</string>
  <string name="klippa_auto_capture">Auto-Capture</string>
  <string name="klippa_cancel_button_text">Cancel</string>
  <string name="klippa_cancel_confirmation">When you close the taken scans will be deleted. Are you sure you want to cancel without saving?</string>
  <string name="klippa_cancel_delete_images">Cancel Scanner</string>
  <string name="klippa_continue_button_text">Continue</string>
  <string name="klippa_delete_button_text">Delete</string>
  <string name="klippa_image_color_enhanced">Enhanced</string>
  <string name="klippa_image_color_grayscale">Grayscale</string>
  <string name="klippa_image_color_original">Original</string>
  <string name="klippa_image_limit_reached">You have reached the image limit</string>
  <string name="klippa_image_moving_message">Moving too much</string>
  <string name="klippa_images">Images</string>
  <string name="klippa_manual_capture">Manual</string>
  <string name="klippa_orientation_warning_message">Hold your phone in portrait mode</string>
  <string name="klippa_retake_button_text">Retake</string>
  <string name="klippa_success_message">Success</string>
  <string name="klippa_zoom_message">Move closer to the document</string>
</resources>

iOS

Use the following properties in the config:

// The warning message when someone should move closer to a document, should be a string.
config.moveCloserMessage = "Move closer to the document";

// The warning message when the camera preview has to much motion to be able to automatically take a photo.
config.imageMovingMessage = "Too much movement";

// The warning message when the camera turned out of portrait mode.
config.orientationWarningMessage = "Hold your phone in portrait mode";

// The message to display when the image was successfully taken.
config.success.message = "Success!";

// The message to display when the limit has been reached.
config.imageLimitReachedMessage = "You have reached the image limit";

// The message to display when the cancel button has tapped.
config.cancelConfirmationMessage = "Delete photos and exit scanner?";

// The text of the delete image button.
config.deleteButtonText = "Delete Photo";

// The text of the retake image button.
config.retakeButtonText = "Retake Photo";

// The text of the cancel event button.
config.cancelButtonText = "Cancel";

// The text of the button shown as one of the delete confirmation alert dialog options.
config.cancelAndDeleteImagesButtonText = "Delete photos and exit";

// The warning message when the camera result is too bright.
config.imageTooBrightMessage = "The image is too bright";

// The warning message when the camera result is too dark.
config.imageTooDarkMessage = "The image is too dark";

// The message displayed at the top of segmented document mode.
config.segmentedModeImageCountMessage = "Images"

// The text shown in the review screen to edit the bounding box.
config.cropEditButtonText = "Crop"

// The text shown in the review screen to change the filter on the image.
config.filterEditButtonText = "Filter"

// The text shown in the review screen to rotate the image.
config.rotateEditButtonText = "Rotate"

// The text shown in the review screen to delete the image.
config.deleteEditButtonText = "Delete"

// The text shown in the crop screen cancel editing.
config.cancelCropButtonText = "Cancel"

// The text shown in the crop screen to expand the bounding box.
config.expandCropButtonText = "Expand"

// The text shown in the crop screen to save the bounding box.
config.saveCropButtonText = "Save"

How to change the image in the instructions?

Android

Add an XML file in android/app/src/res/drawable/ with name klippa_camera_mode_single_document.xml to change the image in Single Document Mode. Add an XML file in android/app/src/res/drawable/ with name klippa_camera_mode_multiple_documents.xml to change the image in Multiple Document Mode. Add an XML file in android/app/src/res/drawable/ with name klippa_camera_mode_segmented_document.xml to change the image in Segmented Document Mode.

iOS

Use the following properties in the config:

// Change the default image in the Segmented Document Mode instructions.
config.cameraModeSegmented?.image = "{name of image in Assets.xcassets}";

// Change the default image in the Multi Document Mode instructions.
config.cameraModeMulti?.image = "{name of image in Assets.xcassets}";

// Change the default image in the Single Document Mode instructions.
config.cameraModeSingle?.image = "{name of image in Assets.xcassets}";

Important iOS notes

Older iOS versions do not ship the Swift libraries. To make sure the SDK works on older iOS versions, you can configure the build to embed the Swift libraries using the build setting EMBEDDED_CONTENT_CONTAINS_SWIFT = YES.

We started using XCFrameworks from version 0.1.0, if you want to use that version or up, you need CocoaPod version 1.9.0 or higher.

Important Android notes

When using a custom trained model for object detection, add the following to your app's build.gradle file to ensure Gradle doesn’t compress the models when building the app:

android {
    aaptOptions {
        noCompress "tflite"
    }
}

About Klippa

Klippa is a scale-up from Groningen, The Netherlands and was founded in 2015 by six Dutch IT specialists with the goal to digitize paper processes with modern technologies.

We help clients enhance the effectiveness of their organization by using machine learning and OCR. Since 2015 more than a 1000 happy clients have been served with a variety of the software solutions that Klippa offers. Our passion is to help our clients to digitize paper processes by using smart apps, accounts payable software and data extraction by using OCR.

License

The MIT License (MIT)