Configure Which Barcodes Are Read#
In this guide you will learn how to configure a barcode based capture mode (BarcodeCapture and BarcodeTracking) to read the barcodes that you need it to read. The available symbol count range, checksum, extensions, etc. for all symbologies are listed in Symbology Properties
Before you start…
To get the most out of this guide, we recommend that you have read the following articles:
Enable the Symbologies You Want to Read#
The type of a barcode is referred to as its symbology, e.g QR Code or Code 128. To enable scanning of a particular barcode, its symbology must be enabled. This is done through calling BarcodeCaptureSettings.enableSymbology() on the BarcodeCaptureSettings and then applying the settings to the barcode capture instance. Similarly, for barcode tracking (MatrixScan), the barcode’s symbology must be enabled by calling BarcodeTrackingSettings.enableSymbology() on the BarcodeTrackingSettings and then applying the settings to the barcode tracking instance.
If you already know the names of the symbologies you want to scan/read, take a look at the list of symbologies supported by the Scandit Data Capture SDK. If you are unsure what the symbology of your barcode is, use the Scandit Demo App available in the iOS App Store or Android Play Store. After you have installed the app, select the “Any Code” mode and scan the codes you are interested in. The name of the symbology will appear on the result screen.
The following lines of code show you how to enable scanning Code 128 codes for barcode capture:
const settings = new BarcodeCaptureSettings(); settings.enableSymbology(Symbology.Code128, true);
Configure the Active Symbol Count#
Barcode symbologies such as Code 128, Code 39, Code 93 or Interleaved Two of Five can store variable-length data. As an example, Code 39 can be used to store a string anywhere from 1 up to around 40-50 symbols. There is no fixed upper limit, though there are practical limitations to the code’s length for it to still be conveniently readable by barcode scanners. For performance reasons, the Scandit Data Capture SDK limits the possible symbol range for variable-length symbologies. If you want to read codes that are shorter/longer than the specified default range or you want to tailor your app to only read codes of a certain length, you need to change the active symbol count of the symbology to accommodate the data length you want to use in your application.
The below lines of code show how to change the active symbol count for Code 128 to read codes with 6, 7 and 8 symbols.
const settings = new BarcodeCaptureSettings(); const symbologySettings = settings.settingsForSymbology(Symbology.Code128); symbologySettings.activeSymbolCounts = [6, 7, 8];
How to Calculate the Active Symbol Count#
Calculating the active symbol count is symbology-specific as each symbology has a different symbol definition. To understand what a symbology’s default active symbol count range is and to learn how to compute the active symbol count for a particular symbology, consult the documentation on symbology properties. As an alternative, you can also use the Scandit Demo App in the iOS App Store, or Android Play Store. After you have installed the app, select the “Any Code” mode and scan the codes you are interested in. The active symbol count will appear on the result screen.
Read Bright-on-Dark Barcodes#
Most barcodes are printed using dark ink on a bright background. Some symbologies allow the colors to be inverted and can also be printed using bright ink on a dark background. This is not possible for all symbologies as it could lead to false reads when the symbology is not designed for this use case. Which symbologies allow color inversion can be seen in the documentation on symbology properties. When you enable a symbology as described above, only dark-on-bright codes are enabled (see SymbologySettings.isEnabled). When you also want to read bright-on-dark codes, color-inverted reading for that symbology must also be enabled (see SymbologySettings.isColorInvertedEnabled:
const settings = new BarcodeCaptureSettings(); const symbologySettings = settings.settingsForSymbology(Symbology.Code128); symbologySettings.isColorInvertedEnabled = true;
Some symbologies have a mandatory checksum that will always be enforced while others only have optional checksums. Enforcing an optional checksum will reduce false positives as an additional check can be performed. When enabling a checksum you have to make sure that the data of your codes contains the calculated checksum otherwise the codes will be discarded as they checksum doesn’t match. All available checksums per symbology can be found in the documentation on symbology properties. You can enforce a specific checksum by setting it through SymbologySettings.checksums:
const settings = new BarcodeCaptureSettings(); const symbologySettings = settings.settingsForSymbology(Symbology.Code39); symbologySettings.checksums = [Checksum.Mod43];
Enable Symbology-Specific Extensions#
Some symbologies allow further configuration. These configuration options are available as symbology extensions that can be enabled/disabled for each symbology individually. Some of the extensions affect how the data in the code is formatted, others allow to enable more relaxed recognition modes that are disabled by default to eliminate false reads. All available extensions per symbology and a description of what they do can be found in the documentation on symbology properties.
To enable/disable a symbology extension, use SymbologySettings.setExtensionEnabled().
const settings = new BarcodeCaptureSettings(); const symbologySettings = settings.settingsForSymbology(Symbology.Code39); symbologySettings.setExtensionEnabled("full_ascii", true);