Skip to content

dually8/BarcodeScanner

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PhoneGap Plugin BarcodeScanner

Adaptation by CJ Coffey -- Github

================================

DEPRECATED - PLEASE USE THE ORIGINAL LOCATED HERE

This project was initially made to bridge the gap between the phonegap plugin not being able to scan certain data matrix codes. Recently, the original repo has fixed this error, so I recommend just going there since I'm unable to keep up with a lot of my open source projects nowadays. Thank you for your support and understanding.

Original repo can be found here

Example Cordova app can be found here

Installation

cordova plugin add https://github.com/dually8/BarcodeScanner.git

Supported Platforms

  • Android
  • iOS
  • Windows 8
  • Windows Phone 8
  • BlackBerry 10
  • Browser

Note: the Android source for this project includes an Android Library Project. plugman currently doesn't support Library Project refs, so its been prebuilt as a jar library. Any updates to the Library Project should be committed with an updated jar.

Using the plugin

The plugin creates the object cordova/plugin/BarcodeScanner with the method scan(success, fail).

The following barcode types are currently supported:

Android

  • QR_CODE
  • DATA_MATRIX
  • UPC_E
  • UPC_A
  • EAN_8
  • EAN_13
  • CODE_128
  • CODE_39
  • CODE_93
  • CODABAR
  • ITF
  • RSS14
  • PDF417
  • RSS_EXPANDED

iOS

  • QR_CODE
  • DATA_MATRIX
  • UPC_E
  • UPC_A
  • EAN_8
  • EAN_13
  • CODE_128
  • CODE_39
  • ITF

Windows8

  • UPC_A
  • UPC_E
  • EAN_8
  • EAN_13
  • CODE_39
  • CODE_93
  • CODE_128
  • ITF
  • CODABAR
  • MSI
  • RSS14
  • QR_CODE
  • DATA_MATRIX
  • AZTEC
  • PDF417

Windows Phone 8

  • UPC_A
  • UPC_E
  • EAN_8
  • EAN_13
  • CODE_39
  • CODE_93
  • CODE_128
  • ITF
  • CODABAR
  • MSI
  • RSS14
  • QR_CODE
  • DATA_MATRIX
  • AZTEC
  • PDF417

BlackBerry 10

  • UPC_A
  • UPC_E
  • EAN_8
  • EAN_13
  • CODE_39
  • CODE_128
  • ITF
  • DATA_MATRIX
  • AZTEC

success and fail are callback functions. Success is passed an object with data, type and cancelled properties. Data is the text representation of the barcode data, type is the type of barcode detected and cancelled is whether or not the user cancelled the scan.

A full example could be:

   cordova.plugins.barcodeScanner.scan(
      function (result) {
          alert("We got a barcode\n" +
                "Result: " + result.text + "\n" +
                "Format: " + result.format + "\n" +
                "Cancelled: " + result.cancelled);
      },
      function (error) {
          alert("Scanning failed: " + error);
      }
   );

Encoding a Barcode

The plugin creates the object cordova.plugins.barcodeScanner with the method encode(type, data, success, fail).

Supported encoding types:

  • TEXT_TYPE
  • EMAIL_TYPE
  • PHONE_TYPE
  • SMS_TYPE

Supported encoding OSes

  • Android
A full example could be:

   cordova.plugins.barcodeScanner.encode(cordova.plugins.barcodeScanner.Encode.TEXT_TYPE, "http://www.nytimes.com", function(success) {
            alert("encode success: " + success);
          }, function(fail) {
            alert("encoding failed: " + fail);
          }
        );

Windows8 quirks

Windows 8 implementation currently doesn't support encode functionality.

Windows Phone 8 quirks

Windows Phone 8 implementation currently doesn't support encode functionality.

BlackBerry 10 quirks

BlackBerry 10 implementation currently doesn't support encode functionality. Cancelling a scan on BlackBerry 10 is done by touching the screen.

Thanks on Github

So many -- check out the original iOS, Android and BlackBerry 10 repos.

Special thanks

TheLevelUp -- This version would not be possible without their port of the ZXing library.

Licence

The MIT License

Copyright (c) 2015 CJ Coffey

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Official repository at http://github.com/phonegap/phonegap-plugin-barcodescanner. This repo combines the updated ZXing library with the phonegap plugin.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Objective-C 80.8%
  • C++ 11.5%
  • JavaScript 3.6%
  • Objective-C++ 2.0%
  • C# 1.1%
  • Java 0.6%
  • Other 0.4%