Skip to main content

DLBarcodeMgr

Summary

The DLBarcodeMgr namespace handles the configuration and use of the device's scanner. The interface described here is found in dl_barcode.js.

Functions

FunctionDescription
commitPropertiesCommit scanner property values.
enableAllSymbologiesEnable/disable all symbologies.
getMaxGet the maximum value of a scanner property.
getMinGet the minimum value of a scanner property.
getPropertyGet the value of a scanner property.
ignoreScanRemove any callback function from the scan event.
ignoreTimeoutRemove any callback function from the timeout event.
isAvailableCheck if a scanner property is available.
isInitializedCheck if the scanner service is correctly initialized.
onScanAttach a callback function to the scan event.
onTimeoutAttach a callback function to the timeout event.
setDefaultsSet scanner properties to system defaults.
setPropertiesSet the values of a list of scanner properties.
setPropertySet the value of a scanner property.
startDecodeStart scanning with a given timeout.
stopDecodeStop any scanning currently in progress.

Constants

ConstantsDescription
DL_BARCODE_MGR_VERThe version of DLBarcodeMgr.
BcdPropIdsScanner property identifiers.
SymIdsSymbology identifiers.
BeamModeScan beam operating mode.
CharacterSetModeCharacter set encoding for a symbology.
Code128AggressivenessCode 128 aggressiveness level.
Code39AggressivenessCode 39 aggressiveness level.
DatamatrixAggressivenessData Matrix aggressiveness level.
DatamatrixMirrorAllow regular/mirror Data Matrix labels.
DatamatrixOpModeData Matrix decoding mode.
ECIPolicyECI transmission policy.
IlluminationTimeScan illumination time.
IlluminationTypeScan illumination type.
ImageCaptureProfileScanner profile for image capture.
IntentDeliveryModeMethod for issuing intents.
Interleaved25AggressivenessInterleaved 2/5 aggressiveness level.
InverseModeAllow regular/reverse labels.
Isbt128ModeAllow regular/reverse ISBT 128 labels.
KeyWedgeModeMethod of keyboard wedge input.
LengthControlModeHandling of symbology length parameters.
MsiAggressivenessMSI aggressiveness level.
PartialResultModeHandling for partial multi-scan results.
ScanModeScanning mode.
SendCodeIDCode ID transmission mode.
ToneNotificationChannelGood read audio notification channel.
ToneNotificationModeGood read audio notification tone.
UpcEanAggressivenessUPC/EAN aggressiveness level.
UpcEanCompositeModeGS1 Composite transmission with UPC/EAN labels.

Functions

commitProperties

commitProperties(): boolean

Commit scanner property values to persistent across a system reboot.

Returns

True if the commit was successful.

Example

if (!DLBarcodeMgr.commitProperties()) {
alert("Error saving scanner properties.");
}

enableAllSymbologies

enableAllSymbologies(enable: boolean): boolean

Enable (or disable) all barcode symbologies.

Parameters

  • enable: Set true to enable all symbologies, false to disable all symbologies.

Returns

True if the property changes were successful.

Example

if (!DLBarcodeMgr.enableAllSymbologies(false)) {
alert("Error disabling all symbologies.");
}

getMax

getMax(id: number): any

Get the maximum value of a scanner property.

Parameters

  • id: Property ID from BcdPropIds for the scanner property to query.

Returns

The maximum value of the property. The type of value returned will be Number or Boolean, depending on the property. If the property is not found or is a type that does not have a maximum (such as String), the return value is undefined.

Example

let max = DLBarcodeMgr.getMax(BcdPropIds.CODE39_LENGTH1);

getMin

getMin(id: number): any

Get the minimum value of a scanner property.

Parameters

  • id: Property ID from BcdPropIds for the scanner property to query.

Returns

The minimum value of the property. The type of value returned will be Number or Boolean, depending on the property. If the property is not found or is a type that does not have a maximum (such as String), the return value is undefined.

Example

let min = DLBarcodeMgr.getMin(BcdPropIds.CODE39_LENGTH1);

getProperty

getProperty(id: number): any

Get the current value of a scanner property.

Parameters

  • id: Property ID from BcdPropIds for the scanner property to query.

Returns

The current value of the property. The type of value returned will be Number, Boolean or String depending on the property. If the property is not found, the return value is undefined.

Example

let code39Max = DLBarcodeMgr.getProperty(BcdPropIds.CODE39_LENGTH2);

ignoreScan

ignoreScan(): boolean

Remove any callback function from the scan read event.

Returns

True if callbacks were successfully removed.

Example

if (!DLBarcodeMgr.ignoreScan()) {
alert("Error trying to clear onScan callback.");
}

ignoreTimeout

ignoreTimeout(): boolean

Remove any callback function from the scan timeout event.

Returns

True if callbacks were successfully removed.

Example

if (!DLBarcodeMgr.ignoreTimeout()) {
alert("Error trying to clear onTimeout callback.");
}

isAvailable

isAvailable(id: number): boolean

Checks if the given scanner property is available (supported by the scanning device).

Parameters

  • id: Property ID from BcdPropIds for the scanner property to query.

Returns

True if the scanner property is available. False is returned if the property is not found.

Example

if (DLBarcodeMgr.isAvailable(BcdPropIds.CODE39_ENABLE)) {
alert("Code 39 enable is available.");
}

isInitialized

isInitialized(): boolean

Check if the scanner service is correctly initialized (ready for use).

Returns

True if the scanner service is correctly initialized.

Example

if (!DLBarcodeMgr.isInitialized()) {
alert("Scanner service is not ready.");
}

onScan

onScan(callback: (scan: {id: number, rawData: string, text: string}) => void): boolean

Attach a callback function to the scan event. Only one callback can be attached at a time. If called multiple times, only the callback from the last call to onScan() will be used.

Parameters

  • callback: Function to call when a scan event occurs. The callback function receives a single parameter, which is an object representing the scanned result. It contains the following properties:
    • id: Symbology ID from SymIds which specifies the symbology of the scanned result.
    • rawData: The raw content of the barcode label represented as a string of hexadecimal values.
    • text: The content of the barcode label represented as a string.

Returns

True if the callback was successfully attached.

Example

if (!DLBarcodeMgr.onScan(scanReceived)) {
alert("Error trying to listen for scan events.");
}

// Called when a barcode label is scanned.
function scanReceived(scan) {
const idStr = "Barcode ID: " + Object.keys(SymIds)[scan.id];
const dataStr = "Data: " + scan.text;
alert(idStr + "\n" + dataStr);
}

onTimeout

onTimeout(callback: () => void): boolean

Attach a callback function to the scan timeout event. Only one callback can be attached at a time. If called multiple times, only the callback from the last call to onTimeout() will be used.

Parameters

  • callback: Function to call when a scan timeout event occurs. The callback function receives no parameters.

Returns

True if the callback was successfully attached.

Example

if (!DLBarcodeMgr.onTimeout(scanTimeout)) {
alert("Error trying to listen for scan timeout events.");
}

// Called when a scan attempt times out.
function scanTimeout() {
alert("Scan timeout.");
}

setDefaults

setDefaults(): boolean

Set scanner properties to system defaults.

Returns

True if the property changes were successful.

Example

if (!DLBarcodeMgr.setDefaults()) {
alert("Error trying to reset scanner properties.");
}

setProperties

setProperties(ids: Array<number>, values: Array<any>): boolean

Set the values of a list of scanner properties.

Parameters

  • ids: Array of property IDs from BcdPropIds which specify the scanner properties to set.
  • values: Array of objects which contain the values for each property to set.

Returns

True if the property changes were successful. False is returned if the length of the input parameters do not match, or if one or more properties fail to be set.

Example

if (!DLBarcodeMgr.setProperties(
[BcdPropIds.CODE39_ENABLE, BcdPropIds.CODE128_LENGTH1], // IDs
[true, 8]) { // Values
alert("Error trying to set scanner properties.");
}

setProperty

setProperty(id: number, value: any): boolean

Set the value of a scanner property.

Parameters

  • id: Property ID from BcdPropIds for the scanner property to set.
  • value: New value of the property. The type of the parameter depends on the property being set.

Returns

True if the property was successfully changed. False is returned if the property is not found.

Example

if (!DLBarcodeMgr.setProperty(BcdPropIds.CODE39_ENABLE, true)) {
alert("Error trying to enable Code 39.");
}

startDecode

startDecode(timeout: number): boolean

Start scanning with a given timeout.

Parameters

  • timeout: (Optional) The number of milliseconds to continue scanning before signalling a scan timeout event. If the parameter is not supplied, the default timeout of 5000 is used.

Returns

True if scanning was started successfully.

Example

<button onclick="DLBarcodeMgr.startDecode()">Start Scan</button>

stopDecode

stopDecode(): boolean

Stop any scanning currently in progress as a result of calling startDecode().

Returns

True if scanning was stopped successfully (including if scanning was not active).

Example

<button onclick="DLBarcodeMgr.stopDecode()">Stop Scan</button>

Constants

DL_BARCODE_MGR_VER

The version of the DLBarcodeMgr.

BcdPropIds

Scanner property identifiers. To be used with functions receiving an id argument.

ValueDescription
AIM_ENABLEEnable aim pattern when scanning.
AUSTRALIAN_CODE_USER_IDUsed defined symbology identifier for Australian Postal.
AUSTRALIAN_POST_ENABLEEnable Australian Postal symbology.
AZTEC_CHARACTER_SET_MODECharacter set encoding for Aztec.
AZTEC_ENABLEEnable Aztec symbology.
AZTEC_LENGTH1First label length for Aztec.
AZTEC_LENGTH2Second label length for Aztec.
AZTEC_LENGTH_CONTROLDefines length properties for Aztec.
AZTEC_USER_IDUsed defined symbology identifier for Aztec.
CODABAR_CLSIRestrict Codabar to CLSI specifications.
CODABAR_ENABLEEnable Codabar symbology.
CODABAR_ENABLE_CHECKEnable check digit for Codabar.
CODABAR_LENGTH1First label length for Codabar.
CODABAR_LENGTH2Second label length for Codabar.
CODABAR_LENGTH_CONTROLDefines length properties for Codabar.
CODABAR_SEND_CHECKTransmit check digit for Codabar.
CODABAR_SEND_STARTTransmit start/stop characters for Codabar.
CODABAR_SHORT_QUIET_ZONESEnable reading with short quiet zones for Codabar.
CODABAR_USER_IDUsed defined symbology identifier for Codabar.
CODE128_AGGRESSIVENESSAggressiveness level for reading Code 128.
CODE128_ENABLEEnable Code 128 symbology.
CODE128_GS1_ENABLEEnable GS1-128 symbology.
CODE128_GS1_USER_IDUsed defined symbology identifier for GS1-128.
CODE128_LENGTH1First label length for Code 128.
CODE128_LENGTH2Second label length for Code 128.
CODE128_LENGTH_CONTROLDefines length properties for Code 128.
CODE128_SHORT_QUIET_ZONESEnable reading with short quiet zones for Code 128.
CODE128_USER_IDUsed defined symbology identifier for Code 128.
CODE32_ENABLEEnable Code 32 symbology.
CODE32_USER_IDUsed defined symbology identifier for Code 32.
CODE39_AGGRESSIVENESSAggressiveness level for reading Code 39.
CODE39_ENABLEEnable Code 39 symbology.
CODE39_ENABLE_CHECKEnable check digit for Code 39.
CODE39_FULL_ASCIIEnable Code 39 full ASCII conversion.
CODE39_LENGTH1First label length for Code 39.
CODE39_LENGTH2Second label length for Code 39.
CODE39_LENGTH_CONTROLDefines length properties for Code 39.
CODE39_SEND_CHECKTransmit check digit for Code 39.
CODE39_SHORT_QUIET_ZONESEnable reading with short quiet zones for Code 39.
CODE39_USER_IDUsed defined symbology identifier for Code 39.
CODE93_ENABLEEnable Code 93 symbology.
CODE93_LENGTH1First label length for Code 93.
CODE93_LENGTH2Second label length for Code 93.
CODE93_LENGTH_CONTROLDefines length properties for Code 93.
CODE93_SHORT_QUIET_ZONESEnable reading with short quiet zones for Code 93.
CODE93_USER_IDUsed defined symbology identifier for Code 93.
COMPOSITE_EAN_UPC_MODEControls UPC/EAN label recognition.
COMPOSITE_ENABLEEnable Composite symbology.
COMPOSITE_GS1_128_MODETransmit Composite as GS1-128.
COMPOSITE_LINEAR_TRANSMISSION_ENABLEEnable Composite linear code transmission.
COMPOSITE_USER_IDUsed defined symbology identifier for Composite.
D25_ENABLEEnable Discrete 2/5 symbology.
D25_LENGTH1First label length for Discrete 2/5.
D25_LENGTH2Second label length for Discrete 2/5.
D25_LENGTH_CONTROLDefines length properties for Discrete 2/5.
D25_USER_IDUser defined symbology identifier for Discrete 2/5.
DATAMATRIX_AGGRESSIVENESSAggressiveness level for reading Data Matrix.
DATAMATRIX_CHARACTER_SET_MODECharacter set encoding for Data Matrix.
DATAMATRIX_ENABLEEnable Data Matrix symbology.
DATAMATRIX_GS1_ENABLEEnable GS1 Data Matrix symbology.
DATAMATRIX_LENGTH1First label length for Data Matrix.
DATAMATRIX_LENGTH2Second label length for Data Matrix.
DATAMATRIX_LENGTH_CONTROLDefines length properties for Data Matrix.
DATAMATRIX_MIRRORControl reading mirrored Data Matrix.
DATAMATRIX_OPERATING_MODEData Matrix operating mode.
DATAMATRIX_USER_IDUser defined symbology identifier for Data Matrix.
DECODE_TIMEOUTMaximum time before scanning stops.
DIGIMARC_ENABLEEnable Digimarc symbology.
DISPLAY_MODE_ENABLEEnable reading from displays/reflective surfaces.
DISPLAY_NOTIFICATION_ENABLEEnable display notification.
DOTCODE_CHARACTER_SET_MODECharacter set encoding for Dot Code.
DOTCODE_ENABLEEnable Dot Code symbology.
DOTCODE_LENGTH1First label length for Dot Code.
DOTCODE_LENGTH2Second label length for Dot Code.
DOTCODE_LENGTH_CONTROLDefines length properties for Dot Code.
DOTCODE_USER_IDUser defined symbology identifier for Dot Code.
DOUBLE_READ_TIMEOUTMinimum time required between reads of the same label.
EAN13_COMPOSITE_ENABLEEnable Composite with EAN-13.
EAN13_ENABLEEnable EAN_13 symbology.
EAN13_SEND_CHECKTransmit check digit for EAN-13.
EAN13_SEND_SYSTransmit system digit for EAN-13.
EAN13_TO_ISBNConvert EAN-13 to ISBN.
EAN13_TO_ISSNConvert EAN-13 to ISSN.
EAN13_USER_IDUser defined symbology identifier for EAN-13.
EAN8_COMPOSITE_ENABLEEnable Composite with EAN-8.
EAN8_ENABLEEnable EAN_8 symbology.
EAN8_SEND_CHECKTransmit check digit for EAN-8.
EAN8_TO_EAN13Expand EAN-8 to EAN-13.
EAN8_USER_IDUser defined symbology identifier for EAN-8.
EAN_EXT_ENABLE_2_DIGITAllow a two digit extension for UPC/EAN.
EAN_EXT_ENABLE_5_DIGITAllow a five digit extension for UPC/EAN.
EAN_EXT_REQUIRERequire a two/five digit extension for UPC/EAN.
ECI_POLICYECI transmission policy.
EXTERNAL_FORMATTING_ENABLEEnable external formatting service.
GOOD_READ_AUDIO_CHANNELAudio channel for good read.
GOOD_READ_AUDIO_FILEAudio file used for good read.
GOOD_READ_AUDIO_MODEAudio notification mode.
GOOD_READ_AUDIO_VOLUMEVolume of good read tone.
GOOD_READ_COUNTNumber of good read tones per notification.
GOOD_READ_DURATIONDuration of each good read notification.
GOOD_READ_ENABLEEnable good read notification.
GOOD_READ_INTERVALDelay between good read notifications.
GOOD_READ_LED_ENABLEEnable LED notification on good read.
GOOD_READ_VIBRATE_ENABLEEnable vibrator notification on good read.
GREEN_SPOT_ENABLEEnable green spot notification on good read.
GS1_14_ENABLEEnable GS1 DataBar-14 symbology.
GS1_14_GS1_128_MODEConvert GS1 DataBar-14 to GS1-128.
GS1_14_USER_IDUser defined symbology identifier for GS1 DataBar-14.
GS1_EXP_ENABLEEnable GS1 DataBar Extended symbology.
GS1_EXP_GS1_128_MODEConvert GS1 DataBar Expanded to GS1-128.
GS1_EXP_LENGTH1First label length for GS1 DataBar Expanded.
GS1_EXP_LENGTH2Second label length for GS1 DataBar Expanded.
GS1_EXP_LENGTH_CONTROLDefines length properties for GS1 DataBar Expanded.
GS1_EXP_USER_IDUser defined symbology identifier for GS1 DataBar Expanded.
GS1_LIMIT_ENABLEEnable GS1 DataBar Limited symbology.
GS1_LIMIT_GS1_128_MODEConvert GS1 DataBar Limited to GS1-128.
GS1_LIMIT_USER_IDUser defined symbology identifier for GS1 DataBar Limited.
GS_SUBSTITUTIONString to replace GS characters with in label transmission.
I25_AGGRESSIVENESSAggressiveness level for reading Interleaved 2/5.
I25_ENABLEEnable Interleaved 2/5 symbology.
I25_ENABLE_CHECKEnable check digit for Interleaved 2/5.
I25_LENGTH1First label length for Interleaved 2/5.
I25_LENGTH2Second label length for Interleaved 2/5.
I25_LENGTH_CONTROLDefines length properties for Interleaved 2/5.
I25_SEND_CHECKTransmit check digit for Interleaved 2/5.
I25_SHORT_QUIET_ZONESEnable reading with short quiet zones for Interleaved 2/5.
I25_USER_IDUser defined symbology identifier for Interleaved 2/5.
ILLUMINATION_ENABLEEnable scanner illumination.
ILLUMINATION_TIMEScanner illumination pulse length.
ILLUMINATION_TYPEScanner illumination type.
IMAGE_CAPTURE_PROFILEScanner image capture profile.
INVERSE_1D_SYMBOLOGIESAllow inverse labels for 1D symbologies.
INVERSE_2D_SYMBOLOGIESAllow inverse labels for 2D symbologies.
ISBT_128_COMMONLY_CONCATENATED_PAIRSAllow concatenation of common concatenated pairs for ISBT 128.
ISBT_128_ENABLEEnable ISBT 128 symbology.
ISBT_128_MODEAllow inverse labels for ISBT 128.
ISBT_128_USER_IDUser defined symbology identifier for ISBT 128.
ITF14_ENABLEEnable GS1 Interleaved 2/5 symbology.
JAPANESE_POST_CODE_USER_IDUser defined symbology identifier for Japanese Postal.
JAPANESE_POST_ENABLEEnable Japanese Postal symbology.
KIX_CODE_ENABLEEnable/disable the KIX Postal symbology.
KIX_CODE_USER_IDUser defined symbology identifier for KIX Postal.
LABEL_PREFIXString prepended to scanned result.
LABEL_SUFFIXString appended to scanned result.
M25_ENABLEEnable Matrix 2/5 symbology.
M25_LENGTH1First label length for Matrix 2/5.
M25_LENGTH2Second label length for Matrix 2/5.
M25_LENGTH_CONTROLDefines length properties for Matrix 2/5.
M25_SHORT_QUIET_ZONESEnable reading with short quiet zones for Matrix 2/5.
M25_USER_IDUser defined symbology identifier for Matrix 2/5.
MAXICODE_ENABLEEnable MaxiCode symbology.
MAXICODE_LENGTH1First label length for MaxiCode.
MAXICODE_LENGTH2Second label length for MaxiCode.
MAXICODE_LENGTH_CONTROLDefines length properties for MaxiCode.
MAXICODE_USER_IDUser defined symbology identifier for MaxiCode.
MICROPDF417_CHARACTER_SET_MODECharacter set encoding for MicroPDF-417.
MICROPDF417_ENABLEEnable MicroPDF-417 symbology.
MICROPDF417_LENGTH1First label length for MicroPDF-417.
MICROPDF417_LENGTH2Second label length for MicroPDF-417.
MICROPDF417_LENGTH_CONTROLDefines length properties for MicroPDF-417.
MICROPDF417_USER_IDUser defined symbology identifier for MicroPDF-417.
MICRO_QR_CHARACTER_SET_MODECharacter set encoding for Micro QR Code.
MICRO_QR_ENABLEEnable Micro QR Code symbology.
MICRO_QR_LENGTH1First label length for Micro QR Code.
MICRO_QR_LENGTH2Second label length for Micro QR Code.
MICRO_QR_LENGTH_CONTROLDefines length properties for Micro QR Code.
MICRO_QR_USER_IDUser defined symbology identifier for Micro QR Code.
MSI_AGGRESSIVENESSAggressiveness level for reading MSI.
MSI_CHECK_2_MOD_11Treat second MSI check digit as modulo 11.
MSI_ENABLEEnable MSI symbology.
MSI_LENGTH1First label length for MSI.
MSI_LENGTH2Second label length for MSI.
MSI_LENGTH_CONTROLDefines length properties for MSI.
MSI_REQUIRE_2_CHECKRequire two check digits for MSI.
MSI_SEND_CHECKTransmit check digit(s) for MSI.
MSI_SHORT_QUIET_ZONESEnable reading with short quiet zones for MSI.
MSI_USER_IDUser defined symbology identifier for MSI.
MULTISCAN_ENABLEEnable Multi-scan.
MULTISCAN_NOTIFICATION_ENABLENotification method for Multi-scan.
MULTISCAN_PARTIAL_RESULT_MODEPartial result handling for Multi-scan.
MULTISCAN_REQUIRED_LABELSNumber of required labels for Multi-scan transmission.
OCR_CONFIDENCEMinimum confidence for OCR algorithm.
OCR_ENABLEEnable Optical Character Recognition.
OCR_ID_ENABLEEnable reading official travel document in TD1 size.
OCR_MULTIFRAMEDecoded frame redundancy for OCR.
OCR_PASSPORT_ENABLEEnable reading passport booklet in TD3 size.
OCR_USER_IDUser defined symbology identifier for OCR.
PDF417_CHARACTER_SET_MODECharacter set encoding for PDF-417.
PDF417_ENABLEEnable PDF-417 symbology.
PDF417_LENGTH1First label length for PDF-417.
PDF417_LENGTH2Second label length for PDF-417.
PDF417_LENGTH_CONTROLDefines length properties for PDF-417.
PDF417_USER_IDUser defined symbology identifier for PDF-417.
PICKLIST_ENABLELimits reading to targeted selection.
PRESENTATION_MODE_AIMER_ENABLEEnable aimer in presentation mode.
PRESENTATION_MODE_ENABLEEnable presentation mode.
PRESENTATION_MODE_SENSITIVITYSensitivity in presentation mode.
QRCODE_CHARACTER_SET_MODECharacter set encoding for QR Code.
QRCODE_ENABLEEnable QR Code symbology.
QRCODE_GS1_ENABLEEnable GS1 QR Code symbology.
QRCODE_LENGTH1First label length for QR Code.
QRCODE_LENGTH2Second label length for QR Code.
QRCODE_LENGTH_CONTROLDefines length properties for QR Code.
QRCODE_S2D_ENABLEEnable Scan2Deploy device configuration through QR Code.
QRCODE_USER_IDUser defined symbology identifier for QR Code.
QRCODE_WIFI_ENABLEEnable Wi-Fi configuration through QR Code.
REMOVE_NON_PRINTABLE_CHARSRemove non-printable ASCII characters from label transmission.
ROYAL_MAIL_CODE_USER_IDUser defined symbology identifier for Royal Mail Postal.
ROYAL_MAIL_ENABLEEnable Postal Royal Mail symbology.
ROYAL_MAIL_SEND_CHECKTransmit check digit for Royal Mail Postal.
SCAN_MODEScanning mode.
SEND_CODE_IDSymbology identifier included in label transmission.
TARGET_MODETarget beam mode.
TARGET_MODE_ENABLEEnable target beam.
TARGET_RELEASE_TIMEOUTMaximum scanning time in Release Scan target beam mode.
TARGET_TIMEOUTTarget beam timeout in Target Timeout target beam mode.
TRIOPTIC_ENABLEEnable Trioptic symbology.
TRIOPTIC_USER_IDUser defined symbology identifier for Trioptic.
UPCA_COMPOSITE_ENABLEEnable Composite with UPC-A.
UPCA_ENABLEEnable UPC-A symbology.
UPCA_SEND_CHECKTransmit check digit for UPC-A.
UPCA_SEND_SYSTransmit system digit for UPC-A.
UPCA_TO_EAN13Expand UPC-A to EAN-13.
UPCA_USER_IDUser defined symbology identifier for UPC-A.
UPCE1_ENABLEEnable UPC-E1 variant of UPC-E.
UPCE_COMPOSITE_ENABLEEnable Composite with UPC-E.
UPCE_ENABLEEnable UPC-E symbology.
UPCE_SEND_CHECKTransmit check digit for UPC-E.
UPCE_SEND_SYSTransmit system digit for UPC-E.
UPCE_TO_UPCAExpand UPC-E to UPC-A.
UPCE_USER_IDUser defined symbology identifier for UPC-E.
UPC_EAN_AGGRESSIVENESSAggressiveness level for reading UPC/EAN.
UPC_EAN_SHORT_QUIET_ZONESEnable reading with short quiet zones for UPC/EAN.
USPS_4STATE_CODE_USER_IDUser defined symbology identifier for USPS 4-State.
USPS_4STATE_ENABLEEnable USPS 4-State.
US_PLANET_CODE_USER_IDUser defined symbology identifier for US Postal PLANET.
US_PLANET_ENABLEEnable US Postal PLANET.
US_POSTNET_CODE_USER_IDUser defined symbology identifier for US Postal POSTNET.
US_POSTNET_ENABLEEnable US Postal POSTNET.
WEDGE_INTENT_ACTION_NAMEWedge intent action string.
WEDGE_INTENT_CATEGORY_NAMEWedge intent category string.
WEDGE_INTENT_DELIVERY_MODEWedge intent issuing method.
WEDGE_INTENT_ENABLEWedge intent mode.
WEDGE_INTENT_EXTRA_BARCODE_DATAWedge intent extra data.
WEDGE_INTENT_EXTRA_BARCODE_STRINGWedge intent extra tag name.
WEDGE_INTENT_EXTRA_BARCODE_TYPEWedge intent extra data type.
WEDGE_KEYBOARD_DELIVERY_MODEKeyboard wedge transmission method.
WEDGE_KEYBOARD_ENABLEEnable keyboard wedge.
WEDGE_KEYBOARD_ONLY_ON_FOCUSEnable keyboard wedge only with input focus and an IME active.
WEDGE_WEB_ENABLEEnable direct web browsing from scanner.

SymIds

Symbology identifiers. The callback function for onScan() receives a parameter, where the id property is given a value from this list.

ValueSymbology
NOT_DEFINEDSymbology is unknown
CODE39Code 39
DISCRETE25Discrete 2/5
MATRIX25Matrix 2/5
INTERLEAVED25Interleaved 2/5
CODABARCodabar
CODE93Code 93
CODE128Code 128
UPCAUPC-A
UPCA_ADDON2UPC-A with a 2-digit extension
UPCA_ADDON5UPC-A with a 5-digit extension
UPCEUPC-E
UPCE_ADDON2UPC-E with a 2-digit extension
UPCE_ADDON5UPC-E with a 5-digit extension
UPCE1UPC-E (E1 variant)
UPCE1_ADDON2UPC-E (E1 variant) with a 2-digit extension
UPCE1_ADDON5UPC-E (E1 variant) with a 5-digit extension
EAN13EAN-13
EAN13_ADDON2EAN-13 with a 2-digit extension
EAN13_ADDON5EAN-13 with a 5-digit extension
EAN8EAN-8
EAN8_ADDON2EAN-8 with a 2-digit extension
EAN8_ADDON5EAN-8 with a 5-digit extension
MSIMSI
GS1_14GS1 DataBar-14
GS1_LIMITGS1 DataBar Limited
GS1_EXPGS1 DataBar Expanded
PDF417PDF-417
DATAMATRIXData Matrix
MAXICODEMaxiCode
TRIOPTICTrioptic
CODE32Code 32
MICROPDF417MicroPDF-417
QRCODEQR Code
AZTECAztec
POSTAL_PLANETUS Postal PLANET
POSTAL_POSTNETUS Postal POSTNET
POSTAL_4STATEUSPS 4-State
POSTAL_ROYALMAILRoyal Mail Postal
POSTAL_AUSTRALIANAustralian Postal
POSTAL_KIXKIX Postal
POSTAL_JAPANJapanese Postal
GS1_128GS1-128
CODE39_FULLASCIICode 39 with Full ASCII
EAN13_ISBNISBN (EAN-13)
EAN13_ISSNISSN (EAN-13)
MICRO_QRMicro QR Code
COMPOSITE_GS1_128_AGS1-128 with Composite CC-A
COMPOSITE_GS1_128_BGS1-128 with Composite CC-B
COMPOSITE_GS1_128_CGS-1128 with Composite CC-C
COMPOSITE_GS1_14_AGS1 DataBar-14 with Composite CC-A
COMPOSITE_GS1_14_BGS1 DataBar-14 with Composite CC-B
COMPOSITE_GS1_LIMIT_AGS1 DataBar Limited with Composite CC-A
COMPOSITE_GS1_LIMIT_BGS1 DataBar Limited with Composite CC-B
COMPOSITE_GS1_EXP_AGS1 DataBar Expanded with Composite CC-A
COMPOSITE_GS1_EXP_BGS1 DataBar Expanded with Composite CC-B
COMPOSITE_CC_AComposite CC-A portion (sent after UPC/EAN)
COMPOSITE_CC_BComposite CC-B portion (sent after UPC/EAN)
DOTCODEDot Code
ISBT_128ISBT 128
ISBT_128_CONCATENATEDISBT 128 concatenated from multiple labels
GS1_DATAMATRIXData Matrix transmitted as GS1-128
OCROptical Character Recognition
GS1_QRCODEQR Code transmitted as GS1-128
ITF14Interleaved 2/5 with length of 14

BeamMode

Scan beam operating mode. Used with BcdPropIds, TARGET_MODE property.

ValueDescription
RELEASE_SCANAiming pattern stops when hardware trigger is released.
TARGET_TIMEOUTAiming pattern stops after a timeout.

CharacterSetMode

Character set encoding for a symbology. Used with BcdPropIds, <symbology>_CHARACTER_SET_MODE properties.

ValueDescription
BIG_5Big5, Traditional Chinese
EUC_CNGB2312, EUC encoding, Simplified Chinese
EUC_KRKS C 5601, EUC encoding, Korean
GB18030Simplified Chinese, PRC standard
GBKGBK, Simplified Chinese
IBM_437MS-DOS United States, Australia, New Zealand, South Africa
ISO_8859_1Latin Alphabet No. 1
ISO_8859_2Latin Alphabet No. 2
ISO_8859_3Latin Alphabet No. 3
ISO_8859_4Latin Alphabet No. 4
ISO_8859_5Latin/Cyrillic Alphabet
ISO_8859_6Latin/Arabic Alphabet
ISO_8859_7Latin/Greek Alphabet
ISO_8859_8Latin/Hebrew Alphabet
ISO_8859_9Latin No. 5/Turkish Alphabet
ISO_8859_11Latin/Thai Alphabet
ISO_8859_13Latin No. 7/Baltic Rim Alphabet
ISO_8859_14Latin No. 8/Celtic Alphabet
ISO_8859_15Latin Alphabet No. 9
SHIFT_JISShift-JIS, Japanese
US_ASCIIASCII
UTF_8UTF-8
UTF_16UTF-16
WINDOWS_1250Windows Eastern European
WINDOWS_1251Windows Cyrillic
WINDOWS_1252Windows Latin-1
WINDOWS_1254Windows Turkish
WINDOWS_1256Windows Arabic

Code128Aggressiveness

Code 128 aggressiveness level. Used with BcdPropIds, CODE128_AGGRESSIVENESS property.

ValueDescription
VERY_LOWLeast aggressive, most secure.
LOWLess aggressive, more secure.
MEDIUMBalance between performance and misreads.
HIGHMore aggressive, less secure.
VERY HIGHMost aggressive, least secure; to improve ability to read labels with very poor quality.

Code39Aggressiveness

Code 39 aggressiveness level. Used with BcdPropIds, CODE39_AGGRESSIVENESS property.

ValueDescription
VERY_LOWLeast aggressive, most secure.
LOWLess aggressive, more secure.
MEDIUMBalance between performance and misreads.
HIGHMore aggressive, less secure.
VERY HIGHMost aggressive, least secure; to improve ability to read labels with very poor quality.

DatamatrixAggressiveness

Data Matrix aggressiveness level. Used with BcdPropIds, DATAMATRIX_AGGRESSIVENESS property.

ValueDescription
LOWLess aggressive, more secure.
HIGHMore aggressive, less secure.

DatamatrixMirror

Allow regular/mirror Data Matrix labels. Used with BcdPropIds, DATAMATRIX_MIRROR property.

ValueDescription
REGULAR ONLYOnly regular Data Matrix labels are allowed.
MIRROR ONLYOnly mirrored Data Matrix labels are allowed.
BOTHBoth regular and mirrored Data Matrix labels are allowed.

DatamatrixOpMode

Data Matrix decoding mode. Used with BcdPropIds, DATAMATRIX_OPERATING_MODE property.

ValueDescription
VERY FASTFastest performance, lowest security.
FASTFast performance, lower security.
ROBUSTSlower performance, higher security.
VERY ROBUSTSlowest performance highest security.

ECIPolicy

ECI transmission policy. Used with BcdPropIds, ECI_POLICY property.

ValueDescription
TRANSMITTransmit ECI escape sequence.
REMOVERemove ECI escape sequence.

IlluminationTime

Scan illumination time. Used with BcdPropIds, ILLUMINATION_TIME property.

ValueDescription
SHORT_PULSEIllumination uses a short pulse.
LONG_PULSEIllumination uses a long pulse.

IlluminationType

Scan illumination type. Used with BcdPropIds, ILLUMINATION_TYPE property.

ValueDescription
AUTOIllumination type is selected per the enabled symbologies.
REDRed illumination is used.
WHITEWhite illumination is used.

ImageCaptureProfile

Scanner profile for image capture. Used with BcdPropIds, IMAGE_CAPTURE_PROFILE property.

ValueDescription
AUTOMATIC_BY_ENABLED_SYMBOLOGIESCapture frames per the enabled symbologies.
MOTION_TOLERANCECapture frames based on motion.
REFLECTIONS_TOLERANCECapture frames based on possible reflections.

IntentDeliveryMode

Method for issuing intents. Used with BcdPropIds, WEDGE_INTENT_DELIVERY_MODE property.

ValueDescription
START_ACTIVITYIntent issued via StartActivity.
START_SERVICEIntent issued via StartService.
BROADCASTIntent issued as broadcast intent.

Interleaved25Aggressiveness

Interleaved 2/5 aggressiveness level. Used with BcdPropIds, I25_AGGRESSIVENESS property.

ValueDescription
VERY_LOWLeast aggressive, most secure.
LOWLess aggressive, more secure.
MEDIUMBalance between performance and misreads.
HIGHMore aggressive, less secure.
VERY HIGHMost aggressive, least secure; to improve ability to read labels with very poor quality.

InverseMode

Allow regular/reverse labels. Used with BcdPropIds, INVERSE_1D_SYMBOLOGIES and INVERSE_2D_SYMBOLOGIES properties.

ValueDescription
REGULAR ONLYOnly read regular labels.
REVERSE ONLYOnly read reverse labels.
BOTHRead both regular and reverse labels.

Isbt128Mode

Allow regular/reverse ISBT 128 labels. Used with BcdPropIds, ISBT_128_MODE property.

ValueDescription
REGULAR ONLYOnly read regular labels.
REVERSE ONLYOnly read reverse labels.
BOTHRead both regular and reverse labels.

KeyWedgeMode

Method of keyboard wedge input. Used with BcdPropIds, WEDGE_KEYBOARD_DELIVERY_MODE property.

ValueDescription
TEXT_INJECTIONInject the data, as text, directly in the text area.
KEY_PRESSUREEmulate the typing of keyboard keys.
COMMIT_TEXTInject printable characters, as text, directly in the text area and emulate the typing of keyboard keys for non-printable characters.

LengthControlMode

Handling of symbology length parameters. Used with BcdPropIds, <symbology>_LENGTH_CONTROL properties.

ValueDescription
NONENo length check is performed.
ONE_FIXEDOnly labels with fixed LENGTH1 value will be allowed.
TWO_FIXEDOnly labels with fixed LENGTH1 or LENGTH2 will be allowed.
RANGEOnly labels with length between LENGTH1 and LENGTH2 (inclusive) will be allowed.

MsiAggressiveness

MSI aggressiveness level. Used with BcdPropIds, MSI_AGGRESSIVENESS property.

ValueDescription
VERY_LOWLeast aggressive, most secure.
LOWLess aggressive, more secure.
MEDIUMBalance between performance and misreads.
HIGHMore aggressive, less secure.
VERY HIGHMost aggressive, least secure; to improve ability to read labels with very poor quality.

PartialResultMode

Handling for partial multi-scan results. Used with BcdPropIds, MULTISCAN_PARTIAL_RESULT_MODE property.

ValueDescription
NEVERPartial results are never returned.
TIMEOUTPartial results are returned only after a timeout.
RELEASEPartial results are returned only after the trigger is released.
BOTHPartial results are returned after a timeout or the trigger is released.

ScanMode

Scanning mode. Used with BcdPropIds, SCAN_MODE property.

ValueDescription
SINGLEScan a single label.
HOLD_MULTIPLEScan multiple labels until the trigger is released. Scan timeout is measured from the last good read.
PULSE_MULTIPLESame as HOLD_MULTIPLE, but scanning stops when trigger is released and pressed again.
ALWAYS_ONScan multiple labels continuously. Stops when mode is changed. Note that scanner properties cannot be changed while in this mode.

SendCodeID

Symbology ID transmission mode. Used with BcdPropIds, SEND_CODE_ID property.

ValueDescription
DATALOGIC_IDENTIFIER_BEFORE_LABELDatalogic ID before label data
AIM_IDENTIFIER_BEFORE_LABELAIM ID before data
USERDEFINED_IDENTIFIER_BEFORE_LABELCustom ID before label data
DATALOGIC_IDENTIFIER_AFTER_LABELDatalogic ID after label data
USERDEFINED_IDENTIFIER_AFTER_LABELCustom ID after label data
NONELabel data transmitted with no identifier.

ToneNotificationChannel

Good read audio notification channel. Used with BcdPropIds, GOOD_READ_AUDIO_CHANNEL property.

ValueDescription
SCANNERScanner audio channel. Volume controlled by GOOD_READ_AUDIO_VOLUME property.
MUSICMusic audio channel. Volume controlled by both channel and GOOD_READ_AUDIO_VOLUME property.
VOICE_CALLVoice call audio channel. Volume controlled by both channel and GOOD_READ_AUDIO_VOLUME property.
ALARMAlarm audio channel. Volume controlled by both channel and GOOD_READ_AUDIO_VOLUME property.
RINGPhone ring audio channel. Volume controlled by both channel and GOOD_READ_AUDIO_VOLUME property.

ToneNotificationMode

Good read audio notification tone. Used with BcdPropIds, GOOD_READ_AUDIO_MODE property.

ValueDescription
NONETurn off audio notifications.
BEEPPlay a simple beep.
AUDIO_FILEPlay the audio file specified by GOOD_READ_AUDIO_FILE property.
VIPERPlay Viper beep sound.
BAROQUEPlay Baroque beep sound.

UpcEanAggressiveness

UPC/EAN aggressiveness level. Used with BcdPropIds, UPC_EAN_AGGRESSIVENESS property.

ValueDescription
VERY_LOWLeast aggressive, most secure.
LOWLess aggressive, more secure.
MEDIUMBalance between performance and misreads.
HIGHMore aggressive, less secure.
VERY HIGHMost aggressive, least secure; to improve ability to read labels with very poor quality.

UpcEanCompositeMode

Composite label transmission with UPC/EAN labels. Used with BcdPropIds, COMPOSITE_EAN_UPC_MODE property.

ValueDescription
AUTOTransmit UPC/EAN label, followed by Composite CC-A or CC-B label, if found.
ALWAYS_LINKEDTransmit UPC/EAN label only if Composite CC-A or CC-B is also found.
NEVER_LINKEDNever transmit UPC/EAN label with Composite CC-A or CC-B label.