Unitech PA700 Series Owner's manual

PA700 UNITECH
PA700 Series Programming Manual
V2. 6 . 1 20 15- 02 - 03

PA700 1 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

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)
Barcode Scanner
&
Decoder
Trigger keys left/right
unitech.scanservice.
software_scankey
unitech.scanservice.close
Unitech
Scan
Service
(V1.95 and above)
unitech.scanservice.data
unitech.scanservice.datatype
Unitech
Scan2Key
unitech.scanservice.scan
2key_setting
Keyboard buffer
unitech.scanservice.start
unitech.scanservice.save_setting
unitech.scanservice.load_setting
com.unitech.scanservice.adapter
Data
Data
Settings
unitech.scanservice.init
X

PA700 3 UNITECH
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 4 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 5 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 6 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 7 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 8 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 9 UNITECH
"'0'":"'No Preamble'",
"'1'":"'System Character'",
"'2'":"'System Character and Country Code'"
}
}</item>
<item>{
"Parameter":"'UPC-E Preamble'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0x23,
"Tag":{
"'0'":"'No Preamble'",
"'1'":"'System Character'",
"'2'":"'System Character and Country Code'"
}
}</item>
<item>{
"Parameter":"'UPC-E1 Preamble'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0x24,
"Tag":{
"'0'":"'No Preamble'",
"'1'":"'System Character'",
"'2'":"'System Character and Country Code'"
}
}</item>
<item>{
"Parameter":"'Convert UPC-E to A'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x25
}</item>
<item>{
"Parameter":"'Convert UPC-E1 to A'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x26
}</item>
<item>{
"Parameter":"'EAN-8 Zero Extend'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x27
}</item>
<item>{
"Parameter":"'UPC/EAN Security Level'",

PA700 10 UNITECH
"Type":2,
"Min":0,
"Max":3,
"Hex":0x4D,
"Tag":{
"'0'":"'UPC/EAN Security Level 0'",
"'1'":"'UPC/EAN Security Level 1'",
"'2'":"'UPC/EAN Security Level 2'",
"'3'":"'UPC/EAN Security Level 3'"
}
}</item>
<item>{
"Parameter":"'UCC Coupon Extended Code'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x55
}</item>
<item>{
"Parameter":"'Coupon Report'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0xF1DA,
"Tag":{
"'0'":"'Old Coupon Symbols'",
"'1'":"'New Coupon Symbols'",
"'2'":"'Both Coupon Format'"
}
}</item>
<item>{
"Parameter":"'ISSN EAN'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF169
}</item>
</string-array>
<string-array name="Code_128">
<item>{
"Parameter":"'Code 128'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x08
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":55,

PA700 11 UNITECH
"Hex":0xD1
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":55,
"Hex":0xD2
}</item>
<item>{
"Parameter":"'GS1-128'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x0E
}</item>
<item>{
"Parameter":"'ISBT 128'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x54
}</item>
<item>{
"Parameter":"'ISBT Concatenation'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0xF141,
"Tag":{
"'0'":"'Disable ISBT Concatenation'",
"'1'":"'Enable ISBT Concatenation'",
"'2'":"'Autodiscriminate ISBT Concatenation'"
}
}</item>
<item>{
"Parameter":"'Check ISBT Table'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF142
}</item>
<item>{
"Parameter":"'ISBT Concatenation Redundancy'",
"Type":3,
"Min":2,
"Max":20,
"Hex":0xDF
}</item>
</string-array>
<string-array name="Code_39">

PA700 12 UNITECH
<item>{
"Parameter":"'Code 39'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x00
}</item>
<item>{
"Parameter":"'Trioptic Code 39'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x0D
}</item>
<item>{
"Parameter":"'Convert Code 39 to Code 32'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x56
}</item>
<item>{
"Parameter":"'Code 32 Prefix'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xE7
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":0,
"Max":48,
"Hex":0x12
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":0,
"Max":48,
"Hex":0x13
}</item>
<item>{
"Parameter":"'Check Digit Verification'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x30
}</item>
<item>{
"Parameter":"'Transmit Code 39 Check Digit'",
"Type":1,

PA700 13 UNITECH
"Min":0,
"Max":1,
"Hex":0x2B
}</item>
<item>{
"Parameter":"'Code 39 Full ASCII'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x11
}</item>
</string-array>
<string-array name="Code_93">
<item>{
"Parameter":"'Code 93'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x09
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x1A
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x1B
}</item>
</string-array>
<string-array name="Code_11">
<item>{
"Parameter":"'Code 11'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x0A
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x1C
}</item>

PA700 14 UNITECH
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x1D
}</item>
<item>{
"Parameter":"'Check Digit Verification'",
"Type":2,
"Min":0,
"Max":2,
"Hex":0x34,
"Tag":{
"'0'":"'Disable'",
"'1'":"'One Check Digit'",
"'2'":"'Two Check Digit'"
}
}</item>
<item>{
"Parameter":"'Transmit Code 11 Check Digits'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x2F
}</item>
</string-array>
<string-array name="I2of5">
<item>{
"Parameter":"'Interleaved 2 of 5'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x06
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":2,
"Max":55,
"Hex":0x16
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":2,
"Max":55,
"Hex":0x17
}</item>
<item>{
"Parameter":"'Check Digit Verification'",

PA700 15 UNITECH
"Type":2,
"Min":0,
"Max":2,
"Hex":0x31,
"Tag":{
"'0'":"'Disable'",
"'1'":"'USS Check Digit'",
"'2'":"'OPCC Check Digit'"
}
}</item>
<item>{
"Parameter":"'Transmit I 2 of 5 Check Digits'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x2C
}</item>
<item>{
"Parameter":"'Convert I 2 of 5 to EAN-13'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x52
}</item>
</string-array>
<string-array name="D2of5">
<item>{
"Parameter":"'Discrete 2 of 5'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x05
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x14
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0x15
}</item>
</string-array>
<string-array name="C2of5">
<item>{

PA700 16 UNITECH
"Parameter":"'Chinese 2 of 5'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF098
}</item>
</string-array>
<string-array name="M2of5">
<item>{
"Parameter":"'Matrix 2 of 5'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF16A
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0xF16B
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":48,
"Hex":0xF16C
}</item>
<item>{
"Parameter":"'Matrix 2 of 5 Redundancy'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF16D
}</item>
<item>{
"Parameter":"'Matrix 2 of 5 Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF16E
}</item>
<item>{
"Parameter":"'Transmit Matrix 2 of 5 Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF16F
}</item>
</string-array>

PA700 17 UNITECH
<string-array name="Codabar">
<item>{
"Parameter":"'Codabar'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x07
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":3,
"Max":48,
"Hex":0x18
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":3,
"Max":48,
"Hex":0x19
}</item>
<item>{
"Parameter":"'CLSI Editing'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x36
}</item>
<item>{
"Parameter":"'NOTIS Editing'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x37
}</item>
</string-array>
<string-array name="MSI">
<item>{
"Parameter":"'MSI'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x0B
}</item>
<item>{
"Parameter":"'Length L1'",
"Type":3,
"Min":1,
"Max":16,

PA700 18 UNITECH
"Hex":0x1E
}</item>
<item>{
"Parameter":"'Length L2'",
"Type":3,
"Min":1,
"Max":16,
"Hex":0x1F
}</item>
<item>{
"Parameter":"'MSI Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x32
}</item>
<item>{
"Parameter":"'Transmit MSI Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x2E
}</item>
<item>{
"Parameter":"'MSI Check Digit Algorithm'",
"Type":2,
"Min":0,
"Max":1,
"Hex":0x33,
"Tag":{
"'0'":"'MOD 10/MOD 11'",
"'1'":"'MOD 10/MOD 10'"
}
}</item>
</string-array>
<string-array name="GS1_DataBar">
<item>{
"Parameter":"'GS1 DataBar Omnidirectional'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF052
}</item>
<item>{
"Parameter":"'GS1 DataBar Limited'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF053
}</item>
<item>{

PA700 19 UNITECH
"Parameter":"'GS1 DataBar Expanded'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF054
}</item>
<item>{
"Parameter":"'Convert GS1 DataBar to UPC/EAN'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0xF08D
}</item>
</string-array>
<string-array name="Postal_Codes">
<item>{
"Parameter":"'US Postnet'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x59
}</item>
<item>{
"Parameter":"'US Planet'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x5A
}</item>
<item>{
"Parameter":"'Transmit US Postal Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x5F
}</item>
<item>{
"Parameter":"'UK Postal'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x5B
}</item>
<item>{
"Parameter":"'Transmit UK Postal Check Digit'",
"Type":1,
"Min":0,
"Max":1,
"Hex":0x60
}</item>
<item>{