Get Started With SparkScan

In this guide you will learn step by step how to add SparkScan to your application.

Roughly, the steps are:

1. Create a new Data Capture Context instance.

2. Configure the Spark Scan Mode.

3. Create the SparkScanView with the desired settings and bind it to the application’s lifecycle.

4. Register the listener to be informed when new barcodes are scanned and update your data whenever this event occurs.

1. Create a New Data Capture Context Instance

The first step to add capture capabilities to your application is to create a new Data Capture Context. The context expects a valid Scandit Data Capture SDK license key during construction.

await configure({
  libraryLocation: new URL("library/engine", document.baseURI).toString(),
  licenseKey: "-- ENTER YOUR SCANDIT LICENSE KEY HERE --",
  moduleLoaders: [barcodeCaptureLoader()],
});

const dataCaptureContext = await DataCaptureContext.create();

2. Configure the SparkScan Mode

The SparkScan Mode is configured through SparkScanSettings and allows you to register one or more listeners that are informed whenever a new barcode is scanned.

For this tutorial, we will set up SparkScan for scanning EAN13 codes. Change this to the correct symbologies for your use case (for example, Code 128, Code 39…).

const sparkScanSettings = new SparkScanSettings();
sparkScanSettings.enableSymbologies([Symbology.EAN13UPCA]);

Next, create a SparkScan instance with the settings initialized in the previous step:

const sparkScan = SparkScan.forSettings(settings)

3. Setup the Spark Scan View

The SparkScan built-in user interface includes the camera preview and scanning UI elements. These guide the user through the scanning process.

The SparkScanView appearance can be customized through SparkScanViewSettings.

const viewSettings = new SparkScanViewSettings()
// setup the desired appearance settings by updating the fields in the object above

By adding a SparkScanView, the scanning interface (camera preview and scanning UI elements) will be added automatically to your application.

Add a SparkScanView to your view hierarchy:

const sparkScanView = SparkScanView.forElement(
  document.body,
  dataCaptureContext,
  sparkScan,
  sparkScanViewSettings,
);

Additionally, make sure to call SparkScanView.stopScanning() in your app state handling logic. You have to call this for the correct functioning of the SparkScanView.

function closeApp() {
  sparkScanView.stopScanning()
}

4. Register the Listener to Be Informed When a New Barcode Is Scanned

To keep track of the barcodes that have been scanned, implement the SparkScanListener interface and register the listener to the SparkScan mode.

const listener: SparkScanListener = {
  didScan: (sparkScan, session, frameData) => {
    const barcode = session.newlyRecognizedBarcodes[0];
    ...
  },
};

sparkScan.addListener(listener);

SparkScanListener.didScan() is called when a new barcode has been scanned. This result can be retrieved from SparkScanSession.newlyRecognizedBarcode. Please note that this list only contains one barcode entry.

function onBarcodeScanned(sparkScan: SparkScan, session: SparkScanSession, frameData: FrameData) {
  // Gather the recognized barcode
  const [barcode] = session.newlyRecognizedBarcodes

  // Do something with the recognized barcode
  ...
};

5. Scan Some Barcodes

Now that you’re up and running, go find some barcodes to scan. Don’t feel like getting up from your desk? Here’s a handy pdf of barcodes you can print out.