Package-level declarations

Types

Link copied to clipboard
class AimIDPrefix(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption

AIM (Automatic Identification Manufacturers) ID defines symbology identifier (For the details, see the “AIM ID Table” section in Appendix). If AIM ID prefix is enabled, the engine will add the symbology identifier before the scanned data after decoding

Link copied to clipboard
class AimingOption(val activated: Any = AdvancedActivation.Normal) : IScannerOption

When scanning/capturing image, the engine projects an aiming pattern which allows positioning the target barcode within its field of view and thus makes decoding easier.

Link copied to clipboard
class Audio

This Audio class play alert (song, message and vribration)

Link copied to clipboard
class BadReadMessageOption(var activated: IScannerOption.Activation = Activation.Off) : IScannerOption

Define whether or not to send a bad read message (user-programmable) when a good read does not occur before trigger release, or the decode session timeout expires, or the engine receives the Stop Scanning command.

Link copied to clipboard

Scanning the Restore All Custom Defaults barcode can reset all parameters to the custom defaults. Scanning the Save as Custom Defaults barcode can set the current settings as custom defaults. Custom defaults are stored in the non-volatile me

Link copied to clipboard
class DecodeAreaOption(val activated: IScannerOption.DecodeArea = DecodeArea.WholeArea) : IScannerOption

Define the way the engine will decode barcodes on the image with DecodeArea.

Link copied to clipboard
class DecodeSessionTimeout(val activated: IScannerOption.DecodeSessionTimeout = DecodeSessionTimeout.Medium) : IScannerOption

This parameter sets the maximum time decode session continues during a scan attempt. It is programmable in 1ms increments from 1ms to 3,600,000ms. When it is set to 0, the timeout is infinite. The default setting is 3,000ms

Link copied to clipboard
class ExternalIlluminationOption(val activated: IScannerOption.AdvancedActivation = AdvancedActivation.Off) : IScannerOption

/!\ Important : You must plug a illumination external to use this option else report you to Internal Illumination /!\

Link copied to clipboard

/!\ IMPORTANT /!
Scanning the following barcode can restore the engine to the factory defaults. You may need to reset all parameters to the factory defaults when:  engine is not properly configured so that it fails to decode barcodes.  you forget previous configuration and want to avoid its impact

Link copied to clipboard
class GoodReadDelayOption(val activated: IScannerOption.Activation = Activation.On) : IScannerOption

Good Read Delay sets the minimum amount of time before the engine can read another barcode. This parameter is programmable in 1ms increments from 1ms to 3,600,000ms. The default setting is 500ms.

Link copied to clipboard
class ImageDecodingTimeoutOption(val activated: IScannerOption.ImageDecodingTimeout = ImageDecodingTimeout.Medium) : IScannerOption

Image Decoding Timeout specifies the maximum time the engine will spend decoding an image. This parameter is programmable in 1ms increments from 1ms to 3,000ms. The default timeout is 500ms.

Link copied to clipboard
class ImageFlippingOption(val activated: IScannerOption.ImageFlipping = ImageFlipping.DoNotFlip) : IScannerOption

Image Flipping option

Link copied to clipboard
class ImageStabilizationTimeout(val activated: IScannerOption.StabilizationImageTimeout = StabilizationImageTimeout.Medium) : IScannerOption
Link copied to clipboard
class InternalIlluminationOption(val activated: IScannerOption.AdvancedActivation = AdvancedActivation.Normal) : IScannerOption

A couple of illumination options are provided to improve the lighting conditions during every image capture.

Link copied to clipboard
interface IScannerOption

Interface to encapsule all the Scanner option

Link copied to clipboard
class PrefixModeOption(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption
Link copied to clipboard
class ReadBarcodeOption(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption

Read Barcode On/Off Sending the Read Barcode Off to the engine can disable it from reading barcode, and the engine is unable to scan barcode unless you send the Read Barcode On command to it or power cycle it. By default, Read Barcode is O

Link copied to clipboard
class ReReadTimeoutOption(val activated: IScannerOption.Activation = Activation.On) : IScannerOption

Reread Timeout can avoid undesired rereading of same barcode in a given period of time. This feature is only applicable to the Sense and Continuous modes.

Link copied to clipboard
class ScanModeOption(val activated: IScannerOption.ScanMode = ScanMode.LevelMode) : IScannerOption

ScanModeOption defined the usability of the scanner, you can trigger the scan of multiple ways

Link copied to clipboard

ScanningAlert is a class is used to param the alert to trigger with the Audio class

Link copied to clipboard
class ScanningPreferenceOption(val activated: IScannerOption.ScanningMode = ScanningMode.Normal) : IScannerOption

Scanning Preference Option defined the support of the barcode wrote, if the preference is set at the good support the performance of the reading is improved

Link copied to clipboard
class SensitivityOption(val activated: IScannerOption.SensitivityMode = SensitivityMode.DefaultSensitivity) : IScannerOption
Link copied to clipboard
class SuffixModeOption(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption
Link copied to clipboard

If Surround GS1 AI’s with Parentheses is selected, the barcode above is output as (01)00614141999996(10)10ABCEDF123456. If Do Not Surround GS1 AI’s with Parentheses is selected, the barcode above is output as 01006141419999961010ABCEDF123456.

Link copied to clipboard
class TerminatingCharSuffix(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption
Link copied to clipboard
class TriggerCommandOption(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption

When Enable Trigger Commands is selected, you can activate and deactivate the engine in the Level mode with serial trigger commands. Sending the Start Scanning command (default: T , user-programmable) to the engine in the Level mode activates a decode session. The decode session continues until a barcode is decoded or the decode session timeout expires or the engine receives the Stop Scanning command (default: P , user- programmable).

Link copied to clipboard
class VideoReverseGlobalOption(val activated: IScannerOption.Activation = Activation.Off) : IScannerOption

Video Reverse allows the engine to read barcodes that are inverted