com.symbol.emdk.barcode

Class ScannerConfig.ReaderParams.ReaderSpecific.ImagerSpecific

java.lang.Object

com.symbol.emdk.barcode.ScannerConfig.ReaderParams.ReaderSpecific.ImagerSpecific

Enclosing class:

ScannerConfig.ReaderParams.ReaderSpecific

public class ScannerConfig.ReaderParams.ReaderSpecific.ImagerSpecific
extends java.lang.Object

ImagerSpecific provides access to the imager specific parameters.

Field Summary

Fields

Modifier and Type	Field and Description
ScannerConfig.AimingPattern	aimingPattern Type of aiming pattern to be used for barcode scanning.
int	aimTimer Duration in milliseconds for timed aim types ScannerConfig.AimType.TIMED_HOLD and ScannerConfig.AimType.TIMED_RELEASE.
ScannerConfig.AimType	aimType Describes the type of aiming to use.
ScannerConfig.AutoCharacterSetFailureOption	autoCharacterSetFailureOption If the system cannot find a character set from the preferred order that can correctly decode the data, this will be used as the character set.
ScannerConfig.AutoCharacterSetPreference[]	autoCharacterSetPreferredOrder Sets the preferred character set order to decode the barcode data when character set selection is set to "Auto".
int	beamTimer Sets the maximum amount of time that the reader remains on (0 - 60,000 ms in increments of 100 ms).
ScannerConfig.CharacterSet	characterSetSelection Sets the character set to be used to decode the returned barcode data.
int	connectionIdleTime This is the time (in seconds) when an external scanner is idle in a particular state (ScannerStates.IDLE to ScannerStates.WAITING) after which the connection between the terminal and the scanner is severed to conserve power.
ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead	continuousRead Deprecated. We recommend using the new fields aimType, sameSymbolTimeout, differentSymbolTimeout in your new applications. ContinuousRead class provides access to continuous scanning related parameters.
int	differentSymbolTimeout This setting is used to prevent the scanner from decoding another symbol within this time interval.
boolean	digimarcDecoding Enables or disables the Digimarc decoding.
boolean	disconnectOnExit This parameter indicates to the scan driver to disconnect any existing connection between an external Bluetooth scanner and the terminal.
ScannerConfig.DpmIlluminationControl	dpmIlluminationControl This setting(DPM Illumination Control) is used to control the illumination for DPM barcode reading.
ScannerConfig.DpmModes	dpmMode Select the DPM mode based on the type of barcode being scanned.
int	illuminationBrightness This parameter controls the illumination brightness (intensity) of the imager during the scanning session.
ScannerConfig.IlluminationMode	illuminationMode Turns imager illumination on and off.
ScannerConfig.Inverse1DMode	inverse1DMode This parameter allows the user to select decoding on inverse 1D barcodes.
ScannerConfig.LcdMode	lcdMode Enables or disables LCD mode.
ScannerConfig.LinearSecurityLevel	linearSecurityLevel Sets the number of times a barcode is read to confirm an accurate decode.
ScannerConfig.OneDQuietZoneLevel	oneDQuietZoneLevel This parameter sets the effort at which the decoder will attempt to decode margin-less barcodes.
ScannerConfig.PairAfterScannerReboot	pairAfterScannerReboot Enable/disable automatic reconnection after scanner reboot.
ScannerConfig.PickList	pickList Deprecated. We recommend using the new field picklistEx in your new applications.
ScannerConfig.PicklistEx	picklistEx Allows the imager to decode only the barcode that is directly under the cross-hair/reticle (+) part of the pattern.
ScannerConfig.PoorQualityDecodeEffortLevel	poorQualityDecodeEffortLevel This parameter permits selection of enhancement modes for decoding barcodes of poor or degraded quality.
int	sameSymbolTimeout This setting is used to prevent the scanner driver from decoding the same symbol within this time interval.
ScannerConfig.ScanMode	scanMode Sets the scan mode.
ScannerConfig.SceneDetectionQualifier	sceneDetectionQualifier Activate the Presentation mode of scanning based on a Scene Detection Qualifier.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

continuousRead

@Deprecated
public ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead continuousRead

Deprecated.

We recommend using the new fields aimType, sameSymbolTimeout, differentSymbolTimeout in your new applications.

ContinuousRead class provides access to continuous scanning related parameters.

beamTimer

public int beamTimer

Sets the maximum amount of time that the reader remains on (0 - 60,000 ms in increments of 100 ms). A value of 0 sets the reader to stay on indefinitely.

 
 	Example Usage:
 	readerParams.beamTimer = 1500;
 

Note: The beam timer for RS507 scanners has a maximum value of 10,000 ms.

linearSecurityLevel

public ScannerConfig.LinearSecurityLevel linearSecurityLevel

Sets the number of times a barcode is read to confirm an accurate decode. Use enum ScannerConfig.LinearSecurityLevel.

 
 	Example Usage:
 	readerParams.linearSecurityLevel = LinearSecurityLevel.ALL_THRICE;
 

pickList

@Deprecated
public ScannerConfig.PickList pickList

Deprecated.

We recommend using the new field picklistEx in your new applications.

picklistEx

public ScannerConfig.PicklistEx picklistEx

Allows the imager to decode only the barcode that is directly under the cross-hair/reticle (+) part of the pattern. This feature is useful in applications where multiple barcodes may appear in the field of view during a decode session and only one of them is targeted for decode. Use enum ScannerConfig.PicklistEx.

 
 	Example Usage:
 	imagerSpecific.picklistEx = PicklistEx.DISABLED;
 

lcdMode

public ScannerConfig.LcdMode lcdMode

Enables or disables LCD mode. LCD mode enhances the ability of the imager to read barcodes from LCD displays such as cellphones (imager only). Use enum ScannerConfig.LcdMode.

 
 	Example Usage:
 	imagerSpecific.lcdMode = LcdMode.DISABLED;
 

inverse1DMode

public ScannerConfig.Inverse1DMode inverse1DMode

This parameter allows the user to select decoding on inverse 1D barcodes. Use enum ScannerConfig.Inverse1DMode.

 
 	Example Usage:
 	imagerSpecific.inverse1DMode = Inverse1DMode.AUTO;
 

illuminationBrightness

public int illuminationBrightness

This parameter controls the illumination brightness (intensity) of the imager during the scanning session. Note: Supported value ranges from 1 to 10 in steps of 1. Default is 10.

 
 	Example Usage:
 	imagerSpecific.illuminationBrightness = 2;
 

disconnectOnExit

public boolean disconnectOnExit

This parameter indicates to the scan driver to disconnect any existing connection between an external Bluetooth scanner and the terminal. When a BT scanner establishes connection to the terminal it will not automatically disconnect when the scanner is disabled by calling Scanner.disable(). If this parameter is set the scanning driver will force the scanner to disconnect. Note: If this parameter is set to false, it will not fire the DISCONNECTED state. This parameter will be ignored, if the scanner is being used by any other application. For example, EMDK Notification APIs, RSM CSP, Battery notification. This parameter will be ignored till the last client releases the scanner.

connectionIdleTime

public int connectionIdleTime

This is the time (in seconds) when an external scanner is idle in a particular state (ScannerStates.IDLE to ScannerStates.WAITING) after which the connection between the terminal and the scanner is severed to conserve power. This is currently applicable to Bluetooth scanners only. For Android L and above the valid range start from 0. When time is set to 0, BT scanner will remain connected with terminal.

illuminationMode

public ScannerConfig.IlluminationMode illuminationMode

Turns imager illumination on and off. Use enum ScannerConfig.IlluminationMode.

 
 	Example Usage:
 	readerParams.imagerSpecific.illuminationMode = IlluminationMode.ON;
 

aimingPattern

public ScannerConfig.AimingPattern aimingPattern

Type of aiming pattern to be used for barcode scanning. Use enum ScannerConfig.AimingPattern.

 
 	Example Usage:
 	readerParams.imagerSpecific.aimingPattern = AimingPattern.OFF;
 

oneDQuietZoneLevel

public ScannerConfig.OneDQuietZoneLevel oneDQuietZoneLevel

This parameter sets the effort at which the decoder will attempt to decode margin-less barcodes. Behavior of the level set to this parameter will vary based on the margin-less decoder selected. Note: Higher margin-less levels will increase decoding times and the risk of decoding errors. Zebra therefore recommends enabling only the symbologies that require a higher margin-less level, and leaving all other symbologies at the default level of 1. Use enum ScannerConfig.OneDQuietZoneLevel.

 
 	Example Usage:
 	readerParams.imagerSpecific.oneDQuietZoneLevel = OneDQuietZoneLevel.LEVEL_0;
 

poorQualityDecodeEffortLevel

public ScannerConfig.PoorQualityDecodeEffortLevel poorQualityDecodeEffortLevel

This parameter permits selection of enhancement modes for decoding barcodes of poor or degraded quality. Use enum ScannerConfig.PoorQualityDecodeEffortLevel.

 
 	Example Usage:
 	readerParams.imagerSpecific.poorQualityDecodeEffortLevel = PoorQualityDecodeEffortLevel.LEVEL_0;
 

aimType

public ScannerConfig.AimType aimType

Describes the type of aiming to use.

Note: Setting aimType is recommended instead of ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.isContinuousScan. If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.isContinuousScan and aimType, the aimType settings will take precedence.

aimTimer

public int aimTimer

Duration in milliseconds for timed aim types ScannerConfig.AimType.TIMED_HOLD and ScannerConfig.AimType.TIMED_RELEASE. Note than this duration must be less than the beamTimer.

sameSymbolTimeout

public int sameSymbolTimeout

This setting is used to prevent the scanner driver from decoding the same symbol within this time interval. This is applicable only for the aim type ScannerConfig.AimType.CONTINUOUS_READ. Basically in the continuous mode the user can perform rapid scan and to prevent the user from decoding the same barcode twice user can set this value to an appropriate interval (in milliseconds). A value of 0 means no interval is required between two successive reads. Boundary values are 0 to 5000 in milliseconds in 500 increments such as 0, 500, 1000... etc

Note: If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.sameSymbolTimeout and sameSymbolTimeout, the sameSymbolTimeout settings will take precedence.

differentSymbolTimeout

public int differentSymbolTimeout

This setting is used to prevent the scanner from decoding another symbol within this time interval. This is applicable only for the aim type ScannerConfig.AimType.CONTINUOUS_READ. The user may want to prevent decoding too quickly and set an interval that the user can aim before decoding the next barcode. A value of 0 means no interval is required between two successive reads. Boundary values are 0 to 5000 in milliseconds in 500 increments such as 0, 500, 1000... etc

Note: If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.differentSymbolTimeout and differentSymbolTimeout, the differentSymbolTimeout settings will take precedence.

pairAfterScannerReboot

public ScannerConfig.PairAfterScannerReboot pairAfterScannerReboot

Enable/disable automatic reconnection after scanner reboot. Applicable to DS3678 Bluetooth scanner only. Use enum ScannerConfig.PairAfterScannerReboot.

 
 	Example Usage:
 	readerParams.imagerSpecific.pairAfterScannerReboot = PairAfterScannerReboot.ENABLE;
 

scanMode

public ScannerConfig.ScanMode scanMode

Sets the scan mode. This allows to select one type from the ScanMode enum.

 
 	Example Usage:
 	readerParams.scanMode = ScanMode.SINGLE_BARCODE;
 

digimarcDecoding

public boolean digimarcDecoding

Enables or disables the Digimarc decoding.

 
 	Example Usage:
 	readerParams.readerSpecific.imagerSpecific.digimarcDecoding = true;
 

characterSetSelection

public ScannerConfig.CharacterSet characterSetSelection

Sets the character set to be used to decode the returned barcode data. This is generally set to match the encoding of the physical barcode to be scanned. If not set, default character set UTF-8 is used.

 
 	Example Usage:
 	readerParams.readerSpecific.imagerSpecific.characterSetSelection = CharacterSet.UTF_8;
 

autoCharacterSetFailureOption

public ScannerConfig.AutoCharacterSetFailureOption autoCharacterSetFailureOption

If the system cannot find a character set from the preferred order that can correctly decode the data, this will be used as the character set. The output string may not fully accurate.

 
 	Example Usage:
 	readerParams.readerSpecific.imagerSpecific.autoCharacterSetFailureOption = AutoCharacterSetFailureOption.UTF_8;
 

autoCharacterSetPreferredOrder

public ScannerConfig.AutoCharacterSetPreference[] autoCharacterSetPreferredOrder

Sets the preferred character set order to decode the barcode data when character set selection is set to "Auto". Preference order cannot be empty.

 
 	Example Usage:
 	readerParams.readerSpecific.imagerSpecific.autoCharacterSetPreferredOrder = new AutoCharacterSetPreference[]{AutoCharacterSetPreference.GB2312, AutoCharacterSetPreference.UTF_8};
 

sceneDetectionQualifier

public ScannerConfig.SceneDetectionQualifier sceneDetectionQualifier

Activate the Presentation mode of scanning based on a Scene Detection Qualifier. e.g. Proximity sensor input. If not set, default value SceneDetectionQualifier.NONE is used.

 
 	Example Usage:
 	readerParams.readerSpecific.imagerSpecific.sceneDetectionQualifier = SceneDetectionQualifier.NONE;
 

dpmMode

public ScannerConfig.DpmModes dpmMode

Select the DPM mode based on the type of barcode being scanned. There are two DPM modes(MODE_1/MODE_2) which are recommended for different sets of barcode characteristics. The combinations of these characteristics vary and it is recommended that all modes are tested on the target barcode to determine the best mode for the application. If not set, default value DpmModes.MODE_2 is used and no special processing occurs related to DPM. Use enum ScannerConfig.DpmModes.

 
 Example Usage:
 readerParams.readerSpecific.imagerSpecific.dpmMode = DpmModes.MODE_1;
 

dpmIlluminationControl

public ScannerConfig.DpmIlluminationControl dpmIlluminationControl

This setting(DPM Illumination Control) is used to control the illumination for DPM barcode reading. If not set, default value DpmIlluminationControl.CYCLE is used. Use enum ScannerConfig.DpmIlluminationControl.

 
 Example Usage:
 readerParams.readerSpecific.imagerSpecific.dpmIlluminationControl = DpmIlluminationControl.CYCLE;