Skip to main content

Advanced Configurations

SparkScan is optimized by default for efficiency, accuracy, and a seamless user experience. However, there are some cases where you might want to customize the behavior of SparkScan. This guide will show you how to add additional capabilities and further customize SparkScan to best fit your needs.

Advanced Capabilities​

Hardware Button Control​

Allowing the end user to control the scanner with hardware buttons can be useful if your users typically wear gloves. It can also improve ergonomics in some workflows.

SparkScan offers a built-in API to let you do this via SparkScanViewSettings.hardwareTriggerEnabled.

Trigger Error State​

You may want to introduce logic in your app to show an error message when scanning specific barcodes (e.g. barcodes already added to the list, barcodes from the wrong lot etc.). SparkScan offers a built-in error state you can easily set to trigger an error feedback prompt to the user.

You can customize:

  • The text message.
  • The timeout of the error message: in this case, scanner is paused for the specified amount of time; however, user can quickly restart the scanning process by tapping the trigger button.
  • The color of the flashing screen upon scan. You can enable or disable the visual feedback via SparkScanViewSettings.visualFeedbackEnabled and control the color via SparkScanViewFeedback.
  • The color of the highlight for the scanned barcode.
  • The feedback (sound, vibration).

To emit an error, you have to implement a barcode.spark.feedback.ISparkScanFeedbackDelegate and set it to the barcode.spark.ui.SparkScanView.FeedbackDelegate:

sparkScanView.feedbackDelegate = this;

In the scandit.datacapture.barcode.spark.feedback.ISparkScanFeedbackDelegate.GetFeedbackForBarcode method you can then return an error or a success feedback:

@override
SparkScanBarcodeFeedback? feedbackForBarcode(Barcode barcode) {
  if (isValidBarcode(barcode)) {
        return SparkScanBarcodeSuccessFeedback();
  } else {
        return SparkScanBarcodeErrorFeedback.fromMessage('This code should not have been scanned', Duration(seconds: 60));
  }
}
note

You can have different error states triggered by different logic conditions. For example you can trigger an error state when a wrong barcode is scanned, and another one when a duplicate barcode is scanned. These errors can show different colors and have different timeouts.

A high timeout (for instance, 10+ seconds) typically requires the users to interact with the UI to start scanning again. This is a good choice when you want to interrupt the scanning workflow (e.g. because a wrong barcode is scanned and some actions need to be performed).

A small timeout (for instance, less than 2seconds) could allow the user to scan again without having to interact with the app, just momentarily pausing the workflow to acknowledge that a “special” barcode has been scanned. If timeout is set to 0 workflow is not paused at all.

Reject Barcodes​

To prevent scanning unwanted barcodes (like those already listed or from incorrect lots), use SparkScan's built-in error state. Setting the scandit.datacapture.barcode.spark.feedback.Error.ResumeCapturingDelay parameter to 0 allows the user to continue scanning immediately without pausing on rejected codes.

Add Advanced Scanning Modes to the Setting Toolbar​

SparkScan is our best solution for high-speed single scanning and scan-intensive workflows. Depending on your use case, you can use SparkScan in conjunction with other Scandit advanced scanning modes, such as MatrixScan Find or MatrixScan Count, to speed up your workflows.

SparkScan offers pre-build buttons you can add to the setting toolbar to easily move to different scan modes from within the SparkScan UI.

First you need to show these buttons:

// Show the MatrixScan Count and MatrixScan Find buttons
sparkScanView.barcodeCountButtonVisible = true;
sparkScanView.barcodeFindButtonVisible = true;

In addition you have to add a listener to the SparkScanView via SparkScanView.setListener(). Subsequent to this, you receive callbacks when the Barcode Find button or Barcode Count button is tapped from the toolbar.

sparkScanView.setListener(this);

//...

@override
void didTapBarcodeCountButton(SparkScanView view) {
}

@override
void didTapBarcodeFindButton(SparkScanView view) {
}

Customization​

Customize Color and Text​

All text, colors and opacity of the SparkScan UI elements (trigger button, setting toolbar, toasts) can be customized to match the desired language and color scheme.

See SparkScanView for the full list of parameters.

Add Controls to the Setting Toolbar​

The Setting Toolbar comes with default buttons included, but the full list of available controls includes:

  • Target Mode (visible by default)
  • Continuous Mode
  • Torch Control (visible by default)
  • Audio Feedback Control
  • Haptics Control
  • Left-handed Mode

In some cases you want to avoid end users from accessing these controls, for example to prevent them from:

  • Disabling audio feedback on scan, as the work environment is always noisy
  • Toggling the continuous mode, as you want them to pick items one by one

To add controls to the settings toolbar, just change the visibility of these buttons. Please refer to SparkScanView for the full list of parameters.