Skip to main content

Get Started

In this guide you will learn step-by-step how to add MatrixScan Pick to your application. Implementing MatrixScan Pick involves two primary elements:

  • Barcode Pick: The data capture mode that is used for scan and pick functionality.
  • A Barcode Pick View: The pre-built UI elements used to highlight items to be picked.

The general steps are:

  • Creating a new Data Capture Context instance
  • Configuring the Barcode Pick Mode
  • Setup the Barcode Pick View
  • Registering the Listener to notify about found items

Prerequisites​

Before starting with adding a capture mode, make sure that you have a valid Scandit Data Capture SDK license key and that you added the necessary dependencies. If you have not done that yet, check out this guide.

tip

You can retrieve your Scandit Data Capture SDK license key by signing in to your account Dashboard.

External Dependencies​

The Scandit Data Capture SDK modules depend on a few standard libraries that you can find listed below. If you are including the Scandit Data Capture SDK through Gradle or Maven, all of these dependencies are automatically pulled in and there is no need for you to do anything further.

If you directly add the AAR files to the project, you need to add these dependencies yourself.

  • org.jetbrains.kotlin:kotlin-stdlib:[version]
  • androidx.annotation:annotation:[version]

Internal Dependencies​

Some of the Scandit Data Capture SDK modules depend on others to work:

ModuleDependenciesOptional Dependencies
ScanditCaptureCoreNoneNone
ScanditBarcodeCaptureScanditCaptureCoreNone
ScanditParserNoneNone
ScanditLabelCaptureScanditCaptureCore
ScanditBarcodeCapture		ScanditLabelCaptureText
ScanditPriceLabel
ScanditIdCaptureScanditCaptureCoreScanditIdCaptureBackend
ScanditIdEuropeDrivingLicense
ScanditIdAamvaBarcodeVerification
ScanditIdVoidedDetection
tip

When using ID Capture or Label Capture, consult the respective module's getting started guides to identify the optional dependencies required for your use case. The modules you need to include will vary based on the features you intend to use.

Please be aware that your license may only cover a subset of Barcode and/or ID Capture features. If you require additional features, contact us.

Create a Data Capture Context​

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.

DataCaptureContext dataCaptureContext = DataCaptureContext.forLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --");

Configure the Barcode Pick Mode​

The main entry point for the Barcode Pick Mode is the BarcodePick object. You can configure the supported Symbologies through its BarcodePickSettings, and set up the list of items that you want MatrixScan Pick to highlight.

Here we configure it for tracking EAN13 codes, but you should change this to the correct symbologies for your use case.

BarcodePickSettings settings = new BarcodePickSettings();
settings.enableSymbology(Symbology.EAN13_UPCA, true);

Then you have to create the product provider for the Barcode Pick mode. This provider is responsible for providing the items that should be highlighted in the AR view. Note that in this example we are using a hardcoded list of items, but in a real-world scenario, you would fetch this list from your backend.

List<ProductDatabaseEntry> productDatabase = new ArrayList<>();
        productDatabase.add(
            new ProductDatabaseEntry(
                /*product identifier*/"product_1",
                /*quantity to pick*/2,
                /*items for the product*/new HashSet<String>() {{
                    add("9783598215438");
                    add("9783598215414");
                    add("9783598215441");
                    add("9783598215412");
                }})
        );
        productDatabase.add(
            new ProductDatabaseEntry(
                /*product identifier*/"product_2",
                /*quantity to pick*/3,
                /*items for the product*/new HashSet<String>() {{
                    add("9783598215471");
                    add("9783598215481");
                    add("9783598215458");
                    add("9783598215498");
                    add("9783598215421");
                }})
        );

        // Map the database products to create the Scandit product provider input.
        Set<BarcodePickProduct> items = new HashSet<>();
        for (ProductDatabaseEntry productDatabaseEntry : productDatabase) {
            items.add(
                new BarcodePickProduct(
                    productDatabaseEntry.productIdentifier,
                    productDatabaseEntry.quantityToPick
                )
            );
        }

        // Finally, create the product provider itself
        BarcodePickProductProvider productProvider = new BarcodePickAsyncMapperProductProvider(
            items,
            new BarcodePickAsyncMapperProductProviderCallback() {
                @Override
                public void productIdentifierForItems(
                    @NonNull List<String> itemsData,
                    @NonNull BarcodePickProductProviderCallback callback
                ) {
                    ArrayList<BarcodePickProductProviderCallbackItem> results = new ArrayList<>();

                    // Use the scanned itemsData list to retrieve the identifier of the product they belong to.
                    // This should be an async query in real world scenarios if there are a lot of products/items to loop.
                    for (String itemData : itemsData) {
                        for (ProductDatabaseEntry entry : productDatabase) {
                            if (entry.items.contains(itemData)) {
                                results.add(
                                    new BarcodePickProductProviderCallbackItem(
                                        /*item data*/itemData,
                                        /*product identifier*/entry.productIdentifier
                                    )
                                );
                                break;
                            }
                        }
                    }
                    callback.onData(results);
                }
            }
        );

Create the mode with the previously created settings:

BarcodePick mode = new BarcodePick(dataCaptureContext, settings, productProvider);

Setup the BarcodePickView​

MatrixScan Pick’s built-in AR user interface includes buttons and overlays that guide the user through the scan and pick process. By adding a BarcodePickView, the scanning interface is added automatically to your application.

The BarcodePickView appearance can be customized through BarcodePickViewSettings to match your application’s look and feel. The following settings can be customized:

  • Colors of dots in augmented reality overlay
  • Enable sound and haptic alerts
  • Guidelines text
  • Showing hints
  • Finish button
  • Pause button
  • Zoom button
  • Loading Dialog
BarcodePickViewSettings viewSettings = new BarcodePickViewSettings();
// ...

Next, create a BarcodePickView instance with the Data Capture Context and the settings initialized in the previous step. The BarcodePickView is automatically added to the provided parent view.

BarcodePickView barcodePickView = BarcodePickView.newInstance(parentView, dataCaptureContext, mode, viewSettings);

Connect the BarcodePickView to the Android lifecycle. The view is dependent on calling BarcodePickView.onPause(), BarcodePickView.onResume(), and BarcodePickView.onDestroy() to set up the camera and its overlays properly.

@Override
public void onResume() {
    super.onResume();
    barcodePickView.onResume();
}

@Override
public void onPause() {
    super.onPause();
    barcodePickView.onPause();
}

@Override
public void onDestroyView() {
    super.onDestroyView(); 
    barcodePickView.onDestroy();
}

Register the Listener​

The BarcodePickView displays a Finish button next to its shutter button.

Register a BarcodePickViewUiListener to be notified what items have been found once the finish button is pressed.

In this tutorial, we will then navigate back to the previous screen to finish the find session.

barcodePickView.setUiListener(new BarcodePickViewUiListener() {
    @Override
    public void onFinishButtonTapped(@NonNull BarcodePickView view) {
        requireActivity().onBackPressed();
    }
});

Start Searching​

With everything configured, you can now start searching for items. This is done by calling barcodePickView.start().

barcodePickView.start();

This is the equivalent of pressing the Play button programmatically. It will start the search process, turn on the camera, and hide the item carousel.