Skip to content

Latest commit

 

History

History
226 lines (174 loc) · 11.9 KB

readme.md

File metadata and controls

226 lines (174 loc) · 11.9 KB
Raw

ZXing.Net.Mobile

Join the chat at https://gitter.im/Redth/ZXing.Net.Mobile

ZXing.Net.Mobile Logo

ZXing.Net.Mobile is a C#/.NET library based on the open source Barcode Library: ZXing (Zebra Crossing), using the ZXing.Net Port. It works with Xamarin.iOS, Xamarin.Android, and Windows Phone. The goal of ZXing.Net.Mobile is to make scanning barcodes as effortless and painless as possible in your own applications. The new iOS7 AVCaptureSession barcode scanning is now also supported!

AppVeyor CI Status

Usage

The simplest example of using ZXing.Net.Mobile looks something like this:

buttonScan.Click += (sender, e) => {

	#if __ANDROID__
	// Initialize the scanner first so it can track the current context
	MobileBarcodeScanner.Initialize (Application);
  	#endif
  	
	var scanner = new ZXing.Mobile.MobileBarcodeScanner();

	var result = await scanner.Scan();

	if (result != null)
		Console.WriteLine("Scanned Barcode: " + result.Text);
};

###Features

  • Xamarin.iOS
  • Xamarin.Android (Including Google Glass)
  • Windows Phone 8
  • Simple API - Scan in as little as 2 lines of code!
  • Scanner as a View - UIView (iOS) / Fragment (Android) / Control (WP)

###Changes

  • v1.4.7.1 - iOS: Updated Unified support

  • v1.4.7 - Updated ZXing.Net - iOS: Better destruction of default overlay to prevent memory leak - WP8: Fixed issue with HW shutter pressed after camera no longer available - Android: Fixed Scan method

  • v1.4.6 - Android: Updated Android Support Library v4 component used (20.0.0.3) - Updated ZXing.Net (SVN commit 88850) - Android: now takes UseFrontCameraIfAvailable into account (#120) - Added camera resolution selector to MobileBarcodeScanningOptions - WP8: Fixed a null reference exception (#104)

  • v1.4.5 - Android: Updated Android Support Library v4 component used (20.0.0) - Updated ZXing.Net - WP8: Fixed an issue with an exception on subsequent scans (#102) - Android: Updated Android Support Library v4 component used (4.19.0.1)

  • v1.4.4 - iOS: Fixed issue with loading view size in landscape orientation (#100) - Android: Fixed issue with scanning not working from timestamps (#98)

  • v1.4.3 - iOS: Fixed slowness after 4-5 scans (#71) - WP8: Fixed preview sometimes not starting - Android: Fixed resuming fragment which closes - Android: Scanner rotates as needed for orientation - Android: Removed YuvImage use for better, faster decoding with less memory usage - Android: Added permission checks - Updated ZXing.Net version used

  • v1.4.2

    • WP8: Fixed crash when pressing back while camera initializes
    • Android: Added merged workaround from @chrisntr support for Google Glass
    • Android: Now using the Android Support Library v4 from the component store

  • v1.4.1

    • iOS: Fixed multiple scanner launches causing Scanning to no longer work
    • Android: Fixed rotation on some tablets showing incorrectly

  • v1.4.0

    • iOS: Added iOS7's built in AVCaptureSession MetadataObject barcode scanning as an option
    • iOS: Fixed Offset of overlay and preview layers when a non-zero based offset was specified
    • iOS: Added code to remove session inputs/outputs to improve performance between scans
    • iOS: Front Camera now possible on iOS
    • Android: Fixed rotation
    • Windows Phone: Added Windows Phone 8 samples and builds
    • Windows Phone: Dropped explicit support for WP7x (code is still there, but no binaries shipped)
    • Updated ZXing.NET version used
    • General performance enhancements and bug fixes

  • v1.3.6

    • Built for Xamarin 3.0 with async/await support
    • iOS: Added PauseScanning and ResumeScanning options
    • iOS: Added empty ctor to ZXingScannerView

  • v1.3.5

    • Views for each Platform - Encapsulates scanner functionality in a reusable view
    • iOS: ZXingScannerView as a UIView
    • Android: ZXingScannerFragment as a Fragment
    • Windows Phone: ZXingScannerControl as a UserControl
    • Scanning logic improvements from ZXing.Net project
    • Compiled against Xamarin Stable channel
    • Performance improvements
    • Bug fixes

  • v1.3.4

    • iOS: Scanning Engine rebuilt to use AVCaptureSession
    • iOS: ZXingScannerView inherits from UIView can now be used independently for advanced use cases
    • Android: Fixed Torch bug on Android
    • Android: Front Cameras now work in Sample by default
    • Performance improvements

  • v1.3.3

    • Fixed Android not scanning some barcodes in Portrait
    • Fixed Android scanning very slowly
    • Added to MobileBarcodeScanningOptions: IntervalBetweenAnalyzingFrames to configure how 'fast' frames from the live scanner view are analyzed in an attempt to decode barcodes

Android Versions

The component should work on Android 2.2 or higher. In Xamarin.Android there are 3 places in the project settings relating to Android version. YOU MUST set the Project Options -> Build -> General -> Target Framework to 2.3 or higher. If you still want to use 2.2, you can set the Project Options -> Build -> Android Application -> Minimum Android version to 2.2, but be sure to set the Target Android version in this section to 2.3 or higher.

###Custom Overlays By default, ZXing.Net.Mobile provides a very simple overlay for your barcode scanning interface. This overlay consists of a horizontal red line centered in the scanning 'window' and semi-transparent borders on the top and bottom of the non-scanning area. You also have the opportunity to customize the top and bottom text that appears in this overlay.

If you want to customize the overlay, you must create your own View for each platform. You can customize your overlay like this:

var scanner = new ZXing.Mobile.MobileBarcodeScanner();
scanner.UseCustomOverlay = true;
scanner.CustomOverlay = myCustomOverlayInstance;
var result = await scanner.Scan();
//Handle result

Keep in mind that when using a Custom Overlay, you are responsible for the entire overlay (you cannot mix and match custom elements with the default overlay). The ZxingScanner instance has a CustomOverlay property, however on each platform this property is of a different type:

  • Xamarin.iOS => UIView
  • Xamarin.Android => View
  • Windows Phone => UIElement

All of the platform samples have examples of custom overlays.

###Barcode Formats By default, all barcode formats are monitored while scanning. You can change which formats to check for by passing a ZxingScanningOptions instance into the StartScanning method:

//NOTE: On Android you should call the initialize method with an application instance
#if __ANDROID__
// Initialize the scanner first so it can track the current context
MobileBarcodeScanner.Initialize (Application);
#endif

var options = new ZXing.Mobile.MobileBarcodeScanningOptions();
options.PossibleFormats = new List<ZXing.BarcodeFormat>() { 
    ZXing.BarcodeFormat.Ean8, ZXing.BarcodeFormat.Ean13 
};

var scanner = new ZXing.Mobile.MobileBarcodeScanner(); 
var result = await scanner.Scan(options);
//Handle result

###Samples Samples for implementing ZXing.Net.Mobile can be found in the /sample/ folder. There is a sample for each platform including examples of how to use custom overlays.

###Using the ZXingScanner View / Fragment / Control On each platform, the ZXing scanner has been implemented as a reusable component (view, fragment, or control), and it is possible to use the reusable component directly without using the MobileBarcodeScanner class at all. On each platform, the instance of the view/fragment/control contains the necessary properties and methods required to control your scanner. By default, the default overlay is automatically used, unless you set the CustomOverlay property as well as the UseCustomOverlay property on the instance of the view/fragment/control. You can use methods such as ToggleTorch() or StopScanning() on the view/fragment/control, however you are responsible for calling StartScanning(...) with a callback and an instance of MobileBarcodeScanningOptions when you are ready for the view's scanning to begin. You are also responsible for stopping scanning if you want to cancel at any point.

The view/fragment/control classes for each platform are:

  • iOS: ZXingScannerView (UIView) - See ZXingScannerViewController.cs View Controller for an example of how to use this view
  • iOS: AVCaptureScannerView (UIView) - This is API equivalent to ZXingScannerView, but uses Apple's AVCaptureSession Metadata engine to scan the barcodes instead of ZXing.Net. See AVCaptureScannerViewController.cs View Controller for an example of how to use this view
  • Android: ZXingScannerFragment (Fragment) - See ZXingActivity.cs Activity for an example of how to use this fragment
  • Windows Phone: ZXingScannerControl (UserControl) - See ScanPage.xaml Page for an example of how to use this Control

###Using Apple's AVCaptureSession (iOS7 Built in) Barcode Scanning In iOS7, Apple added some API's to allow for scanning of barcodes in an AVCaptureSession. The latest version of ZXing.Net.Mobile gives you the option of using this instead of the ZXing scanning engine. You can use the AVCaptureScannerView or the AVCaptureScannerViewController classes directly just the same as you would use their ZXing* equivalents. Or, in your MobileBarcodeScanner, there is now an overload to use the AV Capture Engine:

//Scan(MobileBarcodeScanningOptions options, bool useAVCaptureEngine)
scanner.Scan(options, true);

In the MobileBarcodeScanner, even if you specify to use the AVCaptureSession scanning, it will gracefully degrade to using ZXing if the device doesn't support this (eg: if it's not iOS7 or newer), or if you specify a barcode format in your scanning options which the AVCaptureSession does not support for detection. The AVCaptureSession can only decode the following barcodes:

  • Aztec
  • Code 128
  • Code 39
  • Code 93
  • EAN13
  • EAN8
  • PDF417
  • QR
  • UPC-E

###Thanks ZXing.Net.Mobile is a combination of a lot of peoples' work that I've put together (including my own). So naturally, I'd like to thank everyone who's helped out in any way. Those of you I know have helped I'm listing here, but anyone else that was involved, please let me know!

###License Apache ZXing.Net.Mobile Copyright 2012 The Apache Software Foundation This product includes software developed at The Apache Software Foundation (http://www.apache.org/).

ZXing.Net

ZXing.Net is released under the Apache 2.0 license. ZXing.Net can be found here: http://code.google.com/p/zxing/ A copy of the Apache 2.0 license can be found here: http://www.apache.org/licenses/LICENSE-2.0

ZXing

ZXing is released under the Apache 2.0 license. ZXing can be found here: http://code.google.com/p/zxing/ A copy of the Apache 2.0 license can be found here: http://www.apache.org/licenses/LICENSE-2.0

System.Drawing

The System.Drawing classes included are from the mono source code which is property of Novell. Copyright notice is intact in source code files.