cordova-plugin-barcodescanner

Cordova Barcode Scanner Plugin

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cordova-plugin-barcodescanner
0.7.45 years ago7 years agoMinified + gzip package size for cordova-plugin-barcodescanner in KB

Readme

BarcodeScanner
Greenkeeper badge
Build Status Build status Bountysource
cross-platform barcode scanner for cordova

Plugin is still WIP
NPM
Feel free to donate
Click here to lend your support and make a donation at www.pledgie.com ! Or donate Bitcoins: bitcoin:3NKtxw1SRYgess5ev4Ri54GekoAgkR213D
Bitcoin
Also via greenaddress

Supported Platforms

  • Android
  • iOS
  • Windows 8
  • Windows Phone 8

Installation

cordova plugin add cordova-plugin-barcodescanner
Or if you want to use the development version (nightly build), which maybe not stable!:
cordova plugin add cordova-plugin-barcodescanner@next

On Android you have to the following entry to config.xml
<config-file target="AndroidManifest.xml" parent="/*" mode="merge">
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-feature android:name="android.hardware.camera" />
    <uses-feature android:name="android.hardware.camera.autofocus" />
</config-file>

Development

Running integration tests

execute the runIntegrationTests.sh script for a specific platform:
PLATFORM='android' ./runIntegrationTests.sh

PLATFORM='ios' ./runIntegrationTests.sh

Details

>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

  • QRCODE
  • DATAMATRIX
  • UPCE
  • UPCA
  • EAN8
  • EAN13
  • CODE128
  • CODE39
  • CODE93
  • CODABAR
  • ITF
  • RSS14
  • PDF417
  • RSSEXPANDED

iOS

  • QRCODE
  • DATAMATRIX
  • UPCE
  • UPCA
  • EAN8
  • EAN13
  • CODE128
  • CODE39
  • ITF

Windows8

  • UPCA
  • UPCE
  • EAN8
  • EAN13
  • CODE39
  • CODE93
  • CODE128
  • ITF
  • CODABAR
  • MSI
  • RSS14
  • QRCODE
  • DATAMATRIX
  • AZTEC
  • PDF417

Windows Phone 8

  • UPCA
  • UPCE
  • EAN8
  • EAN13
  • CODE39
  • CODE93
  • CODE128
  • ITF
  • CODABAR
  • MSI
  • RSS14
  • QRCODE
  • DATAMATRIX
  • AZTEC
  • PDF417

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 window.plugins.barcodeScanner with the method encode(type, data, success, fail). Supported encoding types:
  • TEXTTYPE
  • EMAILTYPE
  • PHONETYPE
  • SMSTYPE

A full example could be:

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

Windows8 quirks ##

Windows 8 implenemtation currently doesn't support encode functionality.

Windows Phone 8 quirks ##

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

Licence ##

The MIT License
Copyright (c) 2010 Matt Kane
Copyright (c) 2015 Martin Reinhardt
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.