/
Newland Scanner setup

Newland Scanner setup

Owned by Ruofan Wu
Last updated: Feb 07, 2025
13 min read

This page covers the setup of Newland scanner when using Mobile WMS.

GS1 DataMatrix support

If the scanner needs to process GS1 DataMatrix barcodes in Mobile WMS. The AIM identifier can be enabled by scanning the barcode below:

newland_datamatrix_script.webp

Then check the “exec script” box and click “OK”.

Scanner Settings

This section covers the list of configurations applicable to the scanners using the start.cfg file. The behaviors of Newland Scanners are configurable in the start.cfg file and further applied when entering Mobile WMS. Here is an example of how it can be done:

start.cfg (xml)
... <!-- SCANNER --> <scanner> <type>internal</type> ... <scanEngineProperties> ... <scanEngineProperty key="KEY" value="VALUE"/> ... </scanEngineProperties> ... </scanner> ...

A configuration option is set within <scanEngineProperty key="KEY" value="VALUE"/>, where KEY and VALUE are set based on the configurations listed in the following tables.

Scanner behavior configurations

The table below the setup example consists of all configuration options supported in Mobile WMS. The details about the configuration ID can be found in the Newland scanner handbook.

Setup example

Here are some examples of changing the scanner behaviors within the <scanEngineProperties> tag in start.cfg file:

start.cfg (xml)
<!-- Syntax: key="Configuration ID" value="Value" --> <!-- Example: Change scan mode to level mode --> <scanEngineProperty key="EXTRA_TRIG_MODE" value="0"/> <!-- Example: Enable overwrite output --> <scanEngineProperty key="OUTPUT_RECOVERABLE" value="true"/> <!-- Example: Set suffix to 0x61 --> <scanEngineProperty key="SCAN_SUFFIX" value="61"/>

Where the content of the key is a Configuration ID and content of the value is the corresponding Value to the Configuration ID as key.

 

Configuration ID

Value (* indicates default)

Configuration ID

Value (* indicates default)

EXTRA_SCAN_POWER

Value = 0 Disable scanner
          = 1 Enable scanner*
Note: When scanner is enabled, it will take some time to initialize during which all scan requests will be ignored.

EXTRA_TRIG_MODE

Value = 0 Level mode
          = 1 Continuous mode
          = 2 Pulse mode*
          = 4 Delay mode*

EXTRA_SCAN_MODE

Value = 1 Fill in EditText directly*
          = 2 Simulate keystroke
          = 3 Output via API (required to use Mobile WMS)

SEND_SCAN_FAIL_BROADCAST

Value = 0 Disable the send scan fail broadcast
          = 1 Enable the send scan fail broadcast

EXTRA_SCAN_AUTOENT

Value = 0 Do not add a line feed*
          = 1 Add a line feed

EXTRA_SCAN_NOTY_SND

Value = 0 Sound notification off
          = 1 Sound notification on*

EXTRA_SCAN_NOTY_VIB

Value = 0 Vibration notification off*
          = 1 Vibration notification on 

EXTRA_SCAN_NOTY_LED

Value = 0 LED notification off
          = 1 LED notification on*

SCAN_TIMEOUT

Set decode session timeout (millisecond)
Value = 0-9000; default: 3000*

SCAN_INTERVAL

Set timeout between decode sessions (millisecond)
Value >= 50; default: 50*

TRIGGER_MODE_MAIN

Value = 0 Disable the Scan key on front panel as scan trigger
         = 1 Enable the Scan key on front panel as scan trigger*

TRIGGER_MODE_LEFT

Value = 0 Disable the Scan key on left side as scan trigger
          = 1 Enable the Scan key on left side as scan trigger*

TRIGGER_MODE_RIGHT

Value = 0 Disable the Scan key on right side as scan trigger
          = 1 Enable the Scan key on right side as scan trigger* 

TRIGGER_MODE_BLACK

Value = 0 Disable the trigger on pistol grip as scan trigger
          = 1 Enable the trigger on pistol grip as scan trigger*
(Precondition: The terminal supports this feature)

NON_REPEAT_TIMEOUT

Set reread delay (millisecond)
Value = 0 Reread same barcode with no delay*
          > 0 Do not allow to reread same barcode before the delay expires

SCAN_PREFIX_ENABLE

Value = 0 Disable prefix
          = 1 Enable prefix*

SCAN_SUFFIX_ENABLE

Value = 0 Disable suffix
          = 1 Enable suffix*

SCAN_PREFIX

Set prefix
Value = Hexadecimal value of prefix character; default: null*
e.g. 0x61 should be entered as 61.

SCAN_SUFFIX

Set suffix
Value = Hexadecimal value of suffix character; default: null*
e.g. 0x61 should be entered as 61.

SCAN_ENCODE

Character encoding
Value = 1 UTF-8
          = 2 GBK*
          = 3 ISO-8859-1
          = 4 AUTO
          = 5 Other
          Should enter the value of SCAN_OTHER_ENCODE at the same time
          = 6 windows-1251

OUTPUT_RECOVERABLE

Value = true  Enable overwrite output
          = false Disable overwrite output*

EXTRA_OUTPUT_EDITOR_ACTION_ENABLE

Value = 0 Disable software key event output *
          = 1 Enable software key event output

EXTRA_OUTPUT_EDITOR_ACTION

Value = 0 IME_ACTION_UNSPECIFIED
          = 1 IME_ACTION_NONE
          = 2 IME_ACTION_GO
          = 3 IME_ACTION_SEARCH
          = 4 IME_ACTION_SEND
          = 5 IME_ACTION_NEXT
          = 6 IME_ACTION_DONE *
          = 7 IME_ACTION_PREVIOUS

Scanner symbology configurations

The table below the setup example consists of all symbology configurations supported in Mobile WMS:

Setup example

Here are some examples of changing the scanner symbologies configurations within the <scanEngineProperties> tag in start.cfg file:

start.cfg (xml)
<!-- Syntax --> <!-- key="Symbology" value="ConfigurationID:ConfigurationValue" --> <!-- Example: Disable Code 128 --> <scanEngineProperty key="CODE128" value="Enable:0"/> <!-- Example: Set GS1-128 (UCC/EAN-128) maximum length to 127 --> <scanEngineProperty key="UCCEAN128" value="Maxlen:127"/>

Where the content of the key is a Symbology and content of the value consists of an Configuration ID followed by ":" and the corresponding Configuration Value to the ID.

 

 

Symbology (marked with bold)

 

Configuration

ID (marked with bold)

Value

Code 128

CODE128

 

 

Enable/Disable Code 128

Enable

"0" or "1" (default: 1)
"0": Disable Code 128
"1": Enable Code 128

Set minimum length

Minlen

"1" – "127" (default: 1)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

GS1-128 (UCC/EAN-128)

UCCEAN128

 

 

Enable/Disable GS1-128

Enable

"0" or "1" (default: 1)
"0": Disable GS1-128(UCC/EAN-128)
"1": Enable GS1-128(UCC/EAN-128)

Set minimum length

Minlen

"1" – "127" (default: 1)

Set maximum length

Maxlen

"1" - "127" (default: 48)

AIM 128

AIM128

 

 

 

Enable/Disable AIM 128

Enable

"0" or "1" (default: 0)
"0": Disable AIM 128
"1": Enable AIM 128

Set minimum length

Minlen

"1" - "127" (default: 1)

Set maximum length

Maxlen

"1" - "127" (default: 48)

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

EAN-8

EAN8

 

 

 

 

 

 

Enable/Disable EAN-8

Enable

"0" or "1" (default: 1)
"0": Disable EAN-8
"1": Enable EAN-8

Transmit check character

TrsmtChkChar

"0" or "1" (default: 1)
"0": Do not transmit EAN-8 check character
"1": Transmit EAN-8 check character

2-digit add-on code

Digit2

"0" or "1" (default: 0)
"0": Disable 2-digit add-on code
"1": Enable 2-digit add-on code

5-digit add-on code

Digit5

"0" or "1" (default: 0)
"0": Disable 5-digit add-on code
"1": Enable 5-digit add-on code

Add-on code required

AddonRequired

"0" or "1" (default: 0)
"0": EAN-8 add-on code not required
"1": EAN-8 add-on code required

Enable EAN-8 zero extend

MsgtoEan13

"0" or "1" (default: 0)
"0": Disable EAN-8 zero extend
"1": Enable EAN-8 zero extend

Convert EAN-8 to EAN-13

TypetoEan13

"0" or "1" (default: 0)
"0": Do not convert EAN-8 to EAN-13
"1": Convert EAN-8 to EAN-13

EAN-13

EAN13

 

 

 

 

Enable/Disable EAN-13

Enable

"0" or "1" (default: 1)
"0": Disable EAN-13
"1": Enable EAN-13

Transmit check character

TrsmtChkChar

"0" or "1" (default: 1)
"0": Do not transmit EAN-13 check character
"1": Transmit EAN-13 check character

2-digit add-on code

Digit2

"0" or "1" (default: 0)
"0": Disable 2-digit add-on code
"1": Enable 2-digit add-on code

5-digit add-on code

Digit5

"0" or "1" (default: 0)
"0": Disable 5-digit add-on code
"1": Enable 5-digit add-on code

Add-on code required

AddonRequired

"0" or "1" (default: 0)
"0": EAN-13 add-on code not required
"1": EAN-13 add-on code required

ISSN

ISSN

Enable/Disable ISSN

Enable

"0" or "1" (default: 0)
"0": Disable ISSN
"1": Enable ISSN

ISBN

ISBN

 

Enable/Disable ISBN

Enable

"0" or "1" (default: 0)
"0": Disable ISBN
"1": Enable ISBN

Set ISBN format

Length

"0" or "1" (default: 1)
"0": ISBN-13
"1": ISBN-10

UPC-E

UPCE

 

 

 

 

 

 

Enable/Disable UPC-E

Enable

"0" or "1" (default: 1)
"0": Disable UPC-E
"1": Enable UPC-E

Transmit check character

TrsmtChkChar

"0" or "1" (default: 1)
"0": Do not transmit UPC-E check character
"1": Transmit UPC-E check character

2-digit add-on code

Digit2

"0" or "1" (default: 0)
"0": Disable 2-digit add-on code
"1": Enable 2-digit add-on code

5-digit add-on code

Digit5

"0" or "1" (default: 0)
"0": Disable 5-digit add-on code
"1": Enable 5-digit add-on code

Add-on code required

AddonRequired

"0" or "1" (default: 0)
"0": UPC-E add-on code not required
"1": UPC-E add-on code required 

Transmit system character

TrsmtSysDigit

"0" or "1" (default: 1)
"0": Do not transmit system character
"1": Transmit system character

Enable UPC-E extend

MsgToupca

"0" or "1" (default: 0)
"0": Disable UPC-E extend
"1": Enable UPC-E extend

UPC-A

UPCA

 

 

 

 

 

 

 

 

Enable/Disable UPC-A

Enable

"0" or "1" (default: 1)
"0": Disable UPC-A
"1": Enable UPC-A

Transmit check character

TrsmtChkChar

"0" or "1" (default: 1)
"0": Do not transmit UPC-A check character
"1": Transmit UPC-A check character

2-digit add-on code

Digit2

"0" or "1" (default: 0)
"0": Disable 2-digit add-on code
"1": Enable 2-digit add-on code

5-digit add-on code

Digit5

"0" or "1" (default: 0)
"0": Disable 5-digit add-on code
"1": Enable 5-digit add-on code

Add-on code required

AddonRequired

"0" or "1" (default: 0)
"0": UPC-A add-on code not required
"1": UPC-A add-on code required

Transmit preamble character

TrsmtSysDigit

"0" or "1" (default: 0)
"0": Do not transmit UPC-A preamble character
"1": Transmit UPC-A preamble character

Enable UPC-A + Coupon

Coupon

"0" or "1" (default: 0)
"0": Enable UPC-A + Coupon
"1": Disable UPC-A + Coupon

Require coupon

ReqCoupon

"0" or "1" (default: 0)
"0": Do not require coupon
"1": Require coupon

Coupon GS1 Databar output

Gs1Coupon

"0" or "1" (default: 0)
"0": GS1 output off
"1": GS1 output on

Interleaved 2 of 5

ITF

 

 

 

 

Enable/Disable Interleaved 2 of 5

Enable

"0" or "1" (default: 1)
"0": Disable Interleaved 2 of 5
"1": Enable Interleaved 2 of 5 

Set minimum length

Minlen

"1" – "127" (default: 6)

Set maximum length

Maxlen

"1" – "127" (default: 80)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

ITF-6

ITF6

 

Enable/Disable ITF-6

Enable

"0" or "1" (default: 0)
"0": Disable ITF-6
"1": Enable ITF-6

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

ITF-14

ITF14

 

Enable/Disable ITF-14

Enable

"0" or "1" (default: 0)
"0": Disable ITF-14
"1": Enable ITF-14 

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Matrix 2 of 5

MATRIX25

 

 

 

 

Enable/Disable Matrix 2 of 5

Enable

"0" or "1" (default: 1)
"0": Disable Matrix 2 of 5
"1": Enable Matrix 2 of 5

Set minimum length

Minlen

"1" – "127" (default: 4)

Set maximum length

Maxlen

"1" – "127" (default: 80)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Industrial 25

IND25

 

 

 

 

Enable/Disable Industrial 25

Enable

"0" or "1" (default: 0)
"0": Disable Industrial 25
"1": Enable Industrial 25

Set minimum length

Minlen

"1" – "127" (default: 6)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Standard 25

STD25

 

 

 

 

Enable/Disable Standard 25

Enable

"0" or "1" (default: 0)
"0": Disable Standard 25
"1": Enable Standard 25

Set minimum length

Minlen

"1" – "127" (default: 6)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification 

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Code 39

CODE39

 

 

 

 

 

 

Enable/Disable Code 39

Enable

"0" or "1" (default: 1)
"0": Disable Code 39
"1": Enable Code 39

Set minimum length

Minlen

"1" – "127" (default: 1)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Transmit start/stop character

TrsmtStasrtStop

"0" or "1" (default: 0)
"0": Do not transmit start/stop character
"1": Transmit start/stop character

Code 39 Full ASCII

FullAscii

"0" or "1" (default: 0)
"0": Disable Code 39 Full ASCII
"1": Enable Code 39 Full ASCII

Codabar

CODABAR

 

 

 

 

 

 

Enable/Disable Codabar

Enable

"0" or "1" (default: 1)
"0": Disable Codabar
"1": Enable Codabar

Set minimum length

Minlen

"1" – "127" (default: 2)

Set maximum length

Maxlen

"1" – "127" (default: 60)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Transmit start/stop character

TrsmtStasrtStop

"0" or "1" (default: 0)
"0": Do not transmit start/stop character
"1": Transmit start/stop character

Start/Stop character format

StartStopMode

"0" or "1" (default: 0)
"0": ABCD/ABCD
"1": ABCD/TN*E

Code 93

CODE93

 

 

 

 

Enable/Disable Code 93

Enable

"0" or "1" (default: 0)
"0": Disable Code 93
"1": Enable Code 93

Set minimum length

Minlen

"1" – "127" (default: 1)

Set maximum length

Maxlen

"1" – "127" (default: 48) 

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Code 11

CODE11

 

 

 

 

Enable/Disable Code 11

Enable

"0" or "1" (default: 0)
"0": Disable Code 11
"1": Enable Code 11

Set minimum length

Minlen

"1" – "127" (default: 4)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Check character verification

Check

"0" - "5" (default: 1)
"0": Disable
"1": 1 check character, MOD11
"2": 2 check characters, MOD11/MOD11
"3": 2 check characters, MOD11/MOD9
"4": 1 check character, MOD11;
2 check characters, MOD11/MOD11
"5": 1 check character, MOD11;
 2 check characters, MOD11/MOD9

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

Plessey

PLSY

 

 

 

 

Enable/Disable Plessey

Enable

"0" or "1" (default: 0)
"0": Disable Plessey
"1": Enable Plessey

Set minimum length

Minlen

"1" – "127" (default: 1)

Set maximum length

Maxlen

"1" – "127" (default: 127)

Check character verification

Check

"0" - "1" (default: 0)
"0": Disable check character verification
"1": Enable check character verification 

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

MSI-Plessey

MSIPLSY

 

 

 

 

Enable/Disable MSI-Plessey

Enable

"0" or "1" (default: 0)
"0": Disable MSI-Plessey
"1": Enable MSI-Plessey

Set minimum length

Minlen

"1" – "127" (default: 4)

Set maximum length

Maxlen

"1" – "127" (default: 48)

Check character verification

Check

"0" - "3" (default: 1)
"0": Disable
"1": 1 check character, MOD10
"2": 2 check characters, MOD10/MOD10
"3": 2 check characters, MOD10/MOD11

Transmit check character

TrsmtChkChar

"0" or "1" (default: 0)
"0": Do not transmit check character
"1": Transmit check character

PDF417

PDF417

 

 

 

 

 

Enable/Disable PDF417

Enable

"0" or "1" (default: 1)
"0": Disable PDF417
"1": Enable PDF417

Set minimum length

Minlen

"1" – "2710" (default: 1)

Set maximum length

Maxlen

"1" – "2710" (default: 2710)

PDF417 twin code

CodeNum

"1" or "2" (default: 1)
"1": Read single PDF417 code
"2": Read two PDF417 codes

Fixed number of barcodes on an image

NumFixed

"0" or "1" (default: 1)
"0": Varied number of barcodes on an image
"1": Fixed number of barcodes on an image

PDF417 inverse

VideoMode

"0" or "2" (default: 0)
"0": Decode regular PDF417 barcodes only
"1": Decode inverse PDF417 barcodes only
"2": Decode both 

QR Code

QR

 

 

 

 

 

Enable/Disable QR Code

Enable

"0" or "1" (default: 1)
"0": Disable QR Code
"1": Enable QR Code

Set minimum length

Minlen

"1" – "7089" (default: 1) 

Set maximum length

Maxlen

"1" – "7089" (default: 7089)

QR twin code

CodeNum

"1" or "2" (default: 1)
"1": Read single QR code
"2": Read two QR codes

Fixed number of barcodes on an image

NumFixed

"0" or "1" (default: 1)
"0": Varied number of barcodes on an image
"1": Fixed number of barcodes on an image

QR Code inverse

VideoMode

"0" or "2" (default: 0)
"0": Decode regular QR barcodes only
"1": Decode inverse QR barcodes only
"2": Decode both

Data Matrix

DM

 

 

 

 

 

 

Enable/Disable Data Matrix

Enable

"0" or "1" (default: 1)
"0": Disable Data Matrix
"1": Enable Data Matrix

Set minimum length

Minlen

"1" – "3116" (default: 1) 

Set maximum length

Maxlen

"1" – "3116" (default: 3116)

Rectangular barcode

RectAngle

"0" or "1" (default: 1)
"0": Disable rectangular DM
"1": Enable rectangular DM

Data Matrix twin code

CodeNum

"1" or "2" (default: 1)
"1": Read single Data Matrix code
"2": Read two Data Matrix codes

Fixed number of barcodes on an image

NumFixed

"0" or "1" (default: 1)
"0": Varied number of barcodes on an image
"1": Fixed number of barcodes on an image

Data Matrix inverse

VideoMode

: "0" or "2" (default: 0)
"0": Decode regular Data Matrix barcodes only
"1": Decode inverse Data Matrix barcodes only
"2": Decode both

Chinese Sensible (CS) Code

CSC

 

 

 

 

 

Enable/Disable CS Code

Enable

"0" or "1" (default: 0)
"0": Disable CS Code
"1": Enable CS Code

Set minimum length

Minlen

"1" – "7827" (default: 1)

Set maximum length

Maxlen

"1" – "7827" (default: 7827)

CS twin code

CodeNum

"1" or "2" (default: 1)
"1": Read single CS code
"2": Read two CS codes 

Fixed number of barcodes on an image

NumFixed

"0" or "1" (default: 1)
"0": Varied number of barcodes on an image
"1": Fixed number of barcodes on an image

CS Code inverse

VideoMode

"0" or "2" (default: 0)
"0": Decode regular CS barcodes only
"1": Decode inverse CS barcodes only
"2": Decode both

Aztec

AZTEC

 

 

 

 

 

Enable/Disable Aztec

Enable

"0" or "1" (default: 0)
"0": Disable Aztec
"1": Enable Aztec

Set minimum length

Minlen

"1" – "3832" (default: 1)

Set maximum length

Maxlen

"1" – "3832" (default: 3832) 

Aztec twin code

CodeNum

"1" or "2" (default: 1)
"1": Read single Aztec code
"2": Read two Aztec codes

Fixed number of barcodes on an image

NumFixed

"0" or "1" (default: 1)
"0": Varied number of barcodes on an image
"1": Fixed number of barcodes on an image

Aztec inverse

VideoMode

"0" or "2" (default: 0)
"0": Decode regular Aztec barcodes only
"1": Decode inverse Aztec barcodes only
"2": Decode both 

MicroPDF417

MICROPDF

 

 

Enable/Disable MicroPDF417

Enable

"0" or "1" (default: 0)
"0": Disable MicroPDF417
"1": Enable MicroPDF417 

Set minimum length

Minlen

"1" – "366" (default: 1)

Set maximum length

Maxlen

"1" – "366" (default: 366)

Micro QR

MICROQR

 

 

Enable/Disable Micro QR

Enable

"0" or "1" (default: 0)
"0": Disable Micro QR
"1": Enable Micro QR

Set minimum length

Minlen

"1" – "35" (default: 1) 

Set maximum length

Maxlen

"1" – "35" (default: 35)

Common issues & fix

This section covers the common issues from the users and their corresponding fix.

Scanner related issues

If the scanner does not behave correctly according to the setup in start.cfg, please consider resetting the scanner settings:

  1. Open "Quick Settings" app:

  2. Select "Scan".

  3. Make sure the "Enable scan" option is checked.

  4. Select "Restore default".

  5. After restore default, if the device needs to support GS1 barcodes, please scan the QR-code shown in the first section of this page to enable GS1 barcode support.

  6. Restart Mobile WMS and check if the issue still occurs.