Unitech PA700 Series, PA700 Programming Manual

PA700 Series Programming Manual

V2. 6. 1 20 1 5 - 02 - 03

PA700 UNITECH

Contents

1. USI Communication ................................................................................................................................................... 2

1.1. Enable/disable Scan2Key ................................................................................................................................... 3

1.2. Initialize Data Receiving Procedure .................................................................................................................... 3

1.3. Receive scanned data ........................................................................................................................................ 3

1.4. Receive symbology type ..................................................................................................................................... 3

1.5. Save scanner settings ........................................................................................................................................ 3

1.6. Load scanner settings ......................................................................................................................................... 4

1.7. Close scan service .............................................................................................................................................. 4

1.8. Enable Scan Service .......................................................................................................................................... 4

1.9. Set Preamble ...................................................................................................................................................... 4

1.10. Set Postamble .................................................................................................................................................... 4

1.11. Set Terminator .................................................................................................................................................... 4

1.12. Set Vibration ....................................................................................................................................................... 5

1.13. Set Sound ........................................................................................................................................................... 5

1.14. Set EAN128 Field Separator .............................................................................................................................. 5

1.15. Set Intercharacter Delay ..................................................................................................................................... 5

1.16. Set Keep Scan Timeout ...................................................................................................................................... 5

1.17. Set Intercharacter Delay ..................................................................................................................................... 5

1.18. Send param command ....................................................................................................................................... 6

2. USI Examples .......................................................................................................................................................... 26

2.1. Enable/Disable scanner .................................................................................................................................... 26

2.2. Receive scanned data ...................................................................................................................................... 26

2.3. Programming example ...................................................................................................................................... 26

3. Tips using Scan2Key ............................................................................................................................................... 26

3.1. Want to know the barcode symbology ? ........................................................................................................... 26

3.2. The received data is longer the barcode data .................................................................................................. 26

3.3. Enable/Disable barcode scanning through HTML5 .......................................................................................... 26

4. Simple Data Editing ................................................................................................................................................. 26

4.1. Enable data editing ........................................................................................................................................... 26

4.2. rule.txt ............................................................................................................................................................... 26

PA700 1 UNITECH

2key_setting

X

1. USI Communication

All USI cross application communications are done by broadcast intent between USI and user applications.
The below schematic sketches the scanner integration.
ScanServer V1.95 and above (as integrated in OS Built 3230 and above)

unitech.scanservice.start

unitech.scanservice.close

unitech.scanservice.init

Barcode Scanner

&

Decoder

Data

Unitech

Scan

Service

(V1.95 and above)

Data

Settings

Trigger keys left/right

unitech.scanservice.

software_scankey

unitech.scanservice.save_setting

unitech.scanservice.load_setting

com.unitech.scanservice.adapter

unitech.scanservice.scan

Unitech

Scan2Key

unitech.scanservice.datatype

unitech.scanservice.data

Keyboard buffer

1.1. Enable/disable Scan2Key

Description: Enable/Disable the Scan2Key which supports keyboard emulation features.
Action: “unitech.scanservice.scan2key_setting”
Extended data: Name: “scan2key”

Type: Boolean (true=ON, false=false)

1.2. Initialize Data Receiving Procedure

Description: Initialize data receiving procedure.
Action: "unitech.scanservice.init"
Extended data: Name: “enable”

Type: Boolean (true=ON, false=false)

Note: Data receiving flow:
Scan2Key Init Scan Trigger Output

ON ON Working Keyboardbuffer
ON OFF Working Keyboardbuffer
OFF ON Working Intent
OFF OFF Not Working None

1.3. Receive scanned data

Description: Receive the data from scanner via intent.
Action: "unitech.scanservice.data"
Extended data: Name: “text”

Type: String

1.4. Receive symbology data

Description: Receive the type of scanned barcode symbology.

Also refer to chapter 3.1

Action: "unitech.scanservice.datatype"
Extended data: Name: “text”

Type: Integer

1.5. Save scanner settings

Description: Save the scanner’s setting.
Action: "unitech.scanservice.save_setting"
Extended data: Name: “Path”

Type: String

Note: File name is fixed: USISETTING.CFG
And default “Path” is /sdcard/ if “Path” is left empty. Make sure path exist.

PA700 3 UNITECH

1.6. Load scanner settings

Description: Load the scanner’s setting.
Action: "unitech.scanservice.load_setting"
Extended data: Name: “Path”

Type: String

Note: File name is fixed: USISETTING.CFG.
And default “Path” is /sdcard/ if “Path” is left empty. Make sure path exist.

1.7. Close scan service

Description: Close the scan service.
Action: "unitech.scanservice.close"
Extended data: Name: “close”

Type: Boolean

1.8. Enable Scan Service

Description: Start the scan service
Action: “unitech.scanservice.start”
Extended data: Name: “close”

Type: Boolean (true=ON, false=false)

1.9. Set Preamble

ScanServer V2.05 or above

Description: set preamble to the output data
Action: “unitech.scanservice.preamble”
Extended data: Name: “preamble”

Type: String

1.10. Set Postamble

ScanServer V2.05 or above

Description: set postamble to the output data
Action: “unitech.scanservice.postamble”
Extended data: Name: “postamble”

Type: String

1.11. Set Terminator

ScanServer V2.05 or above

Description: set terminator to the output data
Action: “unitech.scanservice.terminator”
Extended data: Name: “terminator”

Type: String

PA700 4 UNITECH

1.12. Set Vibration

ScanServer V2.05 or above

Description: set vibration on/off on good read
Action: “unitech.scanservice.vibration”
Extended data: Name: “vibration”

Type: Boolean (true=ON, false=false)

1.13. Set Sound

ScanServer V2.05 or above

Description: set sound on/off on good read
Action: “unitech.scanservice.sound”
Extended data: Name: “sound”

Type: Boolean (true=ON, false=false)

1.14. Set EAN128 Field Separator

ScanServer V2.05 or above

Description: set EAN128 Field Separator
Action: “unitech.scanservice.fieldseparator”
Extended data: Name: “fieldseparator”

Type: String

1.15. Set Intercharacter Delay

ScanServer V2.05 or above

Description: set intercharacter delay (ms)
Action: “unitech.scanservice.interchar_delay”
Extended data: Name: “intercharDelay”

Type: Integer

1.16. Set Keep Scan Timeout

ScanServer V2.07 or above

Description: set the timeout duration in second(s) which is how long the engine will stay on after the trigger

has been released.

Action: “unitech.scanservice.keepscan”
Extended data: Name: “keepscan”

Type: Integer

Note: Set it to 0 if you want the engine to turn off right after you release the trigger. And maximum should be
less than 10.

1.17. Disable All Symbologies

ScanServer V2.25 or above

Description: disable all symbologies.
Action: “unitech.scanservice.disable_all”

Note: No extended data required.

PA700 5 UNITECH

1.18. Send param command

Description: Send parameter command to engine.
Action: "unitech.scanservice.setting "
Extended data: Name: “INDEX”

Type: Integer

Name: “EXTEND”
Type: Boolean

Name: “EXT”
Type: Byte
Name: “NUM”
Type: Byte
Name: “VALUE”
Type: Byte

Note: PA700 1D engine INDEX = 1; 2D engine INDEX = 2.
If parameter number is bigger than 0xEF, set EXTEND to true; else set EXTEND to false.

If EXTEND is true, set EXT to extended parameter code. And NUM to param_num offset.

If EXTEND is false, set NUM to param_num.

And for each parameter, please check out the following JSON data.
“Parameter” is human readable name of the parameter.
“Hex” is the <param_num> or <extended parameter code><param_num offset>.
To get the <value>, please check the “Type”.
If type is 1, that means this parameter only has enable(1)/disable(0) or true(1)/false(0) option.
If type is 2, that means this parameter has multiple options, and the values are listed in “Tag”.
If type is 3, that means this parameter has a range of options, and the range values are between “Min” and “Max”.

<string-array name="UPC_EAN">
<item>{
"Parameter":"UPC-A",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x01
}</item>
<item>{
"Parameter":"UPC-E",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x02

PA700 6 UNITECH

}</item>
<item>{
"Parameter":"UPC-E1",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x0C
}</item>
<item>{
"Parameter":"EAN-8",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x04
}</item>
<item>{
"Parameter":"EAN-13",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x03
}</item>
<item>{
"Parameter":"'Bookland EAN'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x53
}</item>
<item>{
"Parameter":"'Bookland ISBN Format'",
"Type":2,
"Min":0,
"Max":1,
"Hex":0xF140,
"Tag":{
"'0'":"'Bookland ISBN-10'",
"'1'":"'Bookland ISBN-13'"
}
}</item>
<item>{
"Parameter":"'Decode UPC/EAN Supplementals'",
"Type":2,
"Min":0,
"Max":8,
"Hex":0x10,
"Tag":{
"'0'":"'Ignore UPC/EAN With Supplementals'",
"'1'":"'Decode UPC/EAN With Supplementals'",
"'2'":"'Autodiscriminate UPC/EAN Supplementals'",
"'3'":"'Enable Smart Supplemental Mode'",
"'4'":"'Enable 378/379 Supplemental Mode'",

PA700 7 UNITECH

"'5'":"'Enable 978/979 Supplemental Mode'",
"'6'":"'Enable 414/419/434/439 Supplemental Mode'",
"'7'":"'Enable 977 Supplemental Mode'",
"'8'":"'Enable 491 Supplemental Mode'"
}
}</item>
<item>{
"Parameter":"'Decocde UPC/EAN Supplemental Reddundacy'",
"Type":3,
"Min":2,
"Max":20,
"Hex":0x50
}</item>
<item>{
"Parameter":"'UPC/EAN/JAN Supplemental AIM ID Format'",
"Type":2,
"Min":0,
"Max":1,
"Hex":0xF1A0,
"Tag":{
"'0'":"'Separate'",
"'1'":"'Combined'"
}
}</item>
<item>{
"Parameter":"'Transmit UPC-A Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x28
}</item>
<item>{
"Parameter":"'Transmit UPC-E Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x29
}</item>
<item>{
"Parameter":"'Transmit UPC-E1 Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x2A
}</item>
<item>{
"Parameter":"'UPC-A Preamble'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0x22,
"Tag":{

PA700 8 UNITECH