/anyline-ocr-xamarin-module

Anyline Xamarin Module for iOS and Android

Primary LanguageC#OtherNOASSERTION

Anyline Xamarin SDK

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

Quick Start

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

Download git lfs from https://help.github.com/articles/installing-git-large-file-storage/

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.

File summary

  • BindingSource - Xamarin iOS and Android Binding Libraries, including wrappers
  • Examples - Xamarin.iOS, Xamarin.Android and Xamarin.Forms example apps
  • AnylineXamarinSDK.Droid.dll - Precompiled library for Xamarin.Android
  • AnylineXamarinSDK.iOS.dll - Precompiled library for Xamarin.iOS
  • AnylineResources.Bundle - The iOS Resource files that have to be included to your app project as BundleResource (iOS only!)
  • com.anyline.xamarin.examples_<version>.apk - Prebuilt Android APK ready to install on your Android device
  • README.md - This readme.
  • LICENSE.md - The license file.

BindingSource

The Anyline Xamarin SDK.sln Visual Studio solution located in the /BindingSource directory inhibits two projects: The project for Android bindings AnylineXamarinSDK.Droid and the iOS bindings project AnylineXamarinSDK.iOS.

Android: AnylineXamarinSDK.Droid

The Android Binding project creates a Bindings library from the provided Anyline Java library (.aar file), given Metadata.xml transforms and Additional C# code.

Located in the Assets/tools directory lies the javadoc and python scripts to automatize parameter naming fixes, as the Xamarin build tool is not able to keep the correct parameter names after binding.

iOS: AnylineXamarinSDK.iOS

The iOS Binding project provides easy compilation from the provided Anyline framework, given linker & binding definitions via Anyline.linkwith.cs, ApiDefinition.cs and StructsAndEnums.cs.

The binding definitions are generated by the Xamarin tool Objective Sharpie

Examples

The Examples directory provides source code for the Anyline Xamarin.iOS and Xamarin.Android Example apps. Simply build & run the example project for your desired platform and enjoy scanning :)

Quick start & setup

For a detailed setup guide on how to integrate Anyline for your scanning application, please visit the Anyline Xamarin documentation.

Available Technical Capabilities

  • Barcode: Scan 40+ types of international barcode & QR code formats.
  • Meter: Scan meter readings of various electric, gas, and water meters.
  • ID: Reliable scanning of data from passports, IDs, Driver's Licenses, and IDs' machine readable zones (MRZ).
  • OCR: Create your own custom use case.
  • License Plate: Scan license plates.
  • Tire: Scan tire side-wall information such as identification number and size.

Requirements

  • Visual Studio with the "Mobile development with .NET" (Xamarin) package installed.

Android

  • Android device with SDK >= 21.
  • Ddecent camera functionality (recommended: 720p and adequate auto focus).

iOS

  • Minimum iOS 12.0
  • Minimum iPhone 5s
  • A Mac computer for building / deploying to the iPhone

To be able to use the NFC reader on iOS, your Provisioning Profile must contain the NFC Capability, and the Entitlements.plist file must be referenced in the CodesignEntitlements (or Custom Entitlements) part of the iOS project's properties. Check the Advanced Topics for more information.

Get Help (Support)

We don't actively monitor the GitHub Issues, please raise a support request using the Anyline Helpdesk. When raising a support request based on this GitHub Issue, please fill out and include the following information:

Support request concerning Anyline GitHub Repository: anyline-ocr-xamarin-module

Thank you!

License

See LICENSE file.