Run our Sample Apps#

The best way to start working with the Scandit Data Capture SDK is to run one of our sample apps. In this guide we will go through the available apps and how to run them.

Available Samples#

We have created both simple and advanced samples that show you how to capture barcodes and how to use the MatrixScan functionality. The simple samples allow you to get going quickly, while the advanced samples show you how to use additional settings and setup the scanner for the best user experience.

Here’s a list of our available samples on Cordova:

  • BarcodeCaptureSimpleSample

  • MatrixScanBubblesSample

  • MatrixScanSimpleSample

  • StockCountSample

Barcode Capture Samples#

Simple Sample

Views Sample

Settings Sample

_images/sample-bc-simple-1.jpg
_images/sample-bc-simple-2.jpg

Basic sample that uses the camera to read a single barcode.

Coming Soon

Coming Soon

MatrixScan Samples#

Simple Sample

Bubbles Sample

Stock Count Sample

_images/sample-ms-simple-1.jpg
_images/sample-ms-simple-2.jpg
_images/sample-ms-bubble-1.png
_images/sample-ms-bubble-2.png
_images/sample-ms-sc-1.jpg
_images/sample-ms-sc-2.jpg

Very simple sample which shows how you can highlight barcodes on screen with the Scandit Data Capture SDK.

Demonstrates the use of more advanced augmented reality use cases with the Scandit Data Capture SDK.

Demonstrates a use case to count tracked codes.

Text Capture Samples#

Text Capture samples for Cordova are coming soon.

All our samples can be found in the archive that can be downloaded from our dashboard. Check the following section for more details.

Run the Samples#

Before you can run a sample app, you need to go through a few simple steps:

  1. Sign in to your Scandit account and download the newest Cordova plugins at ssl.scandit.com/sdk. Unzip the archive and go to the samples folder.

  2. Set the license key. To do this, sign in to your Scandit account and find your license key at ssl.scandit.com/licenses.

Once you have the license key, add it to the sample that you’d like to run:

Scandit.DataCaptureContext.forLicenseKey('-- ENTER YOUR SCANDIT LICENSE KEY HERE --')
  1. Create the Cordova project for the sample that you’d like to run. Make sure you always have the most recent version of Cordova installed.

For example, to create a Cordova project for the simple Barcode Capture sample in a helloscandit directory:

cordova create helloscandit --template ./BarcodeCaptureSimpleSample

Note

Make sure that you’re creating the Cordova project for the sample in the samples folder of the archive you downloaded, as the samples relatively reference the plugins included in the archive.

  1. Add a platform to the Cordova project.

Once you created the Cordova project for the sample you’d like to run, navigate to the root of the project, e.g. cd helloscandit, and add the platform you’d like to run the sample on:

cordova platform add [ios|android]

4a. Depending on the Cordova version you’re using, add the WKWebView dependency for iOS.

If you’re using Cordova 9.x or earlier, you’ll need to manually add a plugin to add WKWebView to the project. This was a breaking change between Cordova 9 and 10, and so the samples need slightly different steps to be ran depending on the version you’re using.

This step must not be done if using Cordova 10+, as the default webview on iOS is already set by Cordova to be of type WKWebView, so adding this plugin would cause issues.

If you’re unsure what Cordova version you’re using, you can check with the cordova -v command.

cordova plugin add cordova-plugin-wkwebview-engine
  1. Run the sample. We recommend running the samples on a physical device as otherwise no camera is available.

cordova run [ios|android] --device

Note

You probably need to setup signing for iOS. To do this, open the Xcode project from platforms/ios and setup signing in the project settings. You can also run the sample from Xcode by clicking the Build & Run button.

Next steps#

You are now ready to tackle the following guide: