Unitech PA96 Series Owner's manual

HT6xx/PA96x/PA982/RH767
Programming Manual
V 1.17 2009-10-01

- 2
1INTRODUCTION..................................................................................................................10
1.1 HOW TO DOWNLOAD DATA FROM SCANNER............................................................10
1.2 COM DEFINITION FOR HT6XX/PA96X/PA982/RH767 ...................................................11
1.3 USEFUL SAMPLE PROGRAM ........................................................................................11
1.4 GET SDK FROM UNITECH?............................................................................................12
2USI.DLL – UNITECH SCANNER INTERFACE DLL............................................................13
2.1 Register the application to the USI DLL................................................................................................................13
2.2 Unregister the application from the USI.DLL.......................................................................................................14
2.3 Enable / Disable Scanner...........................................................................................................................................14
2.4 Reset Scanner..............................................................................................................................................................14
2.5 Get error code .............................................................................................................................................................. 14
2.6 Returns the system error code................................................................................................................................15
2.7 Get scan data................................................................................................................................................................15
2.8 Get length of scanned data.......................................................................................................................................16
2.9 Get Symbology name .................................................................................................................................................16
2.10 Clear scan data system buffer .............................................................................................................................18
2.11 Good read indicator................................................................................................................................................18
2.12 Wait for acknowledgement of the last sent command ..................................................................................18
2.13 Save setting to profiles..........................................................................................................................................18
2.14 Save scanner setting into specified file.............................................................................................................19
2.15 Change scanner setting from specified setting profile................................................................................. 19
2.16 Automatically enable scanner beam with pressing trigger key..................................................................19
2.17 Stop auto scanning function................................................................................................................................20
2.18 Check if auto scanning is enable........................................................................................................................20
2.19 Check if Scan2Key.exe program is running or not.........................................................................................20
2.20 Test if Scan2Key is enabled..................................................................................................................................20

- 3
2.21
Load/Unload Scan2Key.exe..................................................................................................................................21
2.22 Enable/Disable Scan2Key .....................................................................................................................................21
2.23 Send scanner command to decoding chip.......................................................................................................21
2.24 Only send single command decoding chip......................................................................................................22
2.25 Send command to decoding chip .......................................................................................................................22
2.26 2D imager supporting for PA966/967 .................................................................................................................22
3CONTROL COMMAND FOR DECODER CHIP (HAMSER: 1D ONLY)..............................23
4SCANNER3.DLL – BACKWARD COMPATIBLE API FOR PT930/PT930S’S
SCANNER3.DLL........................................................................................................................28
4.1 Enable Decoder............................................................................................................................................................28
4.2 Disable Decoder...........................................................................................................................................................28
4.3 Check barcode input ..................................................................................................................................................28
4.4 Read barcode data......................................................................................................................................................29
4.5 Get DLL version no.....................................................................................................................................................29
4.6 Reset all symbologies to default.............................................................................................................................29
5SCANKEY3.DLL – BACKWARD COMPATIBLE API FOR PT930/PT930S’S
SCANKEY3.DLL........................................................................................................................30
5.1 Enable Decoder............................................................................................................................................................30
5.2 Disable Decoder...........................................................................................................................................................30
5.3 Get DLL version no.....................................................................................................................................................30
5.4 Disable laser trigger key............................................................................................................................................30
5.5 Enable laser trigger key............................................................................................................................................. 30
5.6 Reset all symbologies to default.............................................................................................................................31
6UNITECHAPI.DLL ...............................................................................................................32
6.1 Disable ActiveSync.....................................................................................................................................................32
6.2 Enable ActiveSync ......................................................................................................................................................32
6.3 Suspend.........................................................................................................................................................................33
6.4 Disable TaskBar...........................................................................................................................................................33

- 4
6.5
Enable TaskBar............................................................................................................................................................33
6.6 Disable Desktop...........................................................................................................................................................33
6.7 Enable Desktop............................................................................................................................................................33
6.8 Disable toolbar on windows explorer....................................................................................................................34
6.9 Enable toolbar on windows explorer.....................................................................................................................34
6.10 Disable Connection.................................................................................................................................................34
6.11 Enable Connection..................................................................................................................................................34
7SYSIOAPI.DLL ....................................................................................................................35
7.1 Keypad Related Functions........................................................................................................................................35
7.1.1 Get CAPS lock status (This function call is reserved for OS using, it is not suggested to be used on
application if you are not fully understand OS operation behavior)............................................................................... 35
7.1.2 Get SHIFT status (This function call is reserved for OS using, it is not suggested to be used on
application if you are not fully understand OS operation behavior)............................................................................... 35
7.1.3 Get keypad type (This function call is reserved for OS using, it is not suggested to be used on
application if you are not fully understand OS operation behavior)............................................................................... 35
7.1.4 Disable/enable power button ............................................................................................................................... 36
7.1.5 Set keypad utility input mode............................................................................................................................... 36
7.1.6 Get keypad utility input mode (For HT660 only) ............................................................................................... 36
7.1.7 Check Alpha key is pressing (For HT680/PA96x/PA982 only)....................................................................... 36
7.1.8 Check Function key status (For HT680 only).................................................................................................... 37
7.1.9 Enable/Disable Function key (For HT680 only)................................................................................................ 37
7.2 Scanner Related Functions.......................................................................................................................................38
7.2.1 Enable/Disable Scanner trigger key ................................................................................................................... 38
7.2.2 Turn on/off Scan Engine....................................................................................................................................... 38
7.2.3 Get Trigger keys Status........................................................................................................................................ 38
7.2.4 Get Scanner Status............................................................................................................................................... 38
7.2.5 Control trigger key’s key event............................................................................................................................ 39
7.2.6 Check Trigger key is pressing ............................................................................................................................. 39
7.3 LED related function...................................................................................................................................................40
7.4 Backlight related function......................................................................................................................................... 40
7.4.1 Screen Backlight Control...................................................................................................................................... 40
7.4.2 Get Screen Backlight Status................................................................................................................................40
7.4.3 Keypad Backlight Control (For HT680/PA96x/PA982 only)............................................................................ 40
7.4.4 Get Keypad Backlight Status (For HT680/PA966/PA962/PA982 only)......................................................... 41
7.4.5 Screen Backlight Brightness Control.................................................................................................................. 41
7.5 SD slot related functions (For HT680 Only).......................................................................................................... 41
7.5.1 Inquire SD slot status............................................................................................................................................ 41
7.5.2 Enable/Disable SD Slot......................................................................................................................................... 41
7.6 Enable/Disable Vibration (For HT680 Only)..........................................................................................................41
7.7 Wireless module related functions (For HT680 Only)........................................................................................42
7.7.1 Inquire wireless module status ............................................................................................................................ 42
7.7.2 Enable/Disable wireless module ......................................................................................................................... 42

- 5
7.8
PCMCIA/CF slot related functions ..........................................................................................................................42
7.8.1 Get physical slot ID................................................................................................................................................ 42
7.8.2 Enable/Disable PCMCIA or CF slot.................................................................................................................... 43
7.8.3 Enable/Disable IO slots......................................................................................................................................... 43
7.8.4 Inquire PCMCIA/CF slot status............................................................................................................................ 43
7.8.5 Inquire IO slot status ............................................................................................................................................. 44
7.8.6 Disable PCMCIA/CF slot when resume ............................................................................................................. 44
7.9 Check battery type......................................................................................................................................................44
7.10 Enable/Disable LCD screen................................................................................................................................. 45
8BLUETOOTH RELATIVE API - BTAPI.DLL........................................................................46
8.1 Enable/Disable Bluetooth Power status................................................................................................................. 46
8.2 Get BT Power status................................................................................................................................................. 46
8.3 DLL Version................................................................................................................................................................ 46
9RH767 HF READER ............................................................................................................47
9.1 General Function.........................................................................................................................................................47
9.1.1 Get library version.................................................................................................................................................. 47
9.1.2 Connect to RFID reader........................................................................................................................................ 47
9.1.3 Close Reader ......................................................................................................................................................... 47
9.1.4 Select Card type .................................................................................................................................................... 48
9.1.5 Get Reader Information........................................................................................................................................ 48
9.1.6 Antenna Control..................................................................................................................................................... 48
9.2 ISO-15693.......................................................................................................................................................................49
9.2.1 Inventory ................................................................................................................................................................. 49
9.2.2 Set StayQuiet Mode .............................................................................................................................................. 49
9.2.3 Set Select Mode..................................................................................................................................................... 49
9.2.4 Set Ready Mode.................................................................................................................................................... 50
9.2.5 Read The Block Data form ISO15693 Tag........................................................................................................ 50
9.2.6 Write The Block Data to ISO15693 Tag............................................................................................................. 50
9.2.7 ISO15693 Lock Block............................................................................................................................................ 51
9.2.8 Write AFI to ISO15693 Tag.................................................................................................................................. 51
9.2.9 ISO15693 Lock AFI............................................................................................................................................... 51
9.2.10 Write DSFID to ISO15693 Tag............................................................................................................................ 52
9.2.11 ISO15693 Lock DSFID ......................................................................................................................................... 52
9.2.12 Get Data From Reader ......................................................................................................................................... 52
9.3 ISO-14443A....................................................................................................................................................................53
9.3.1 Write Default Key................................................................................................................................................... 53
9.3.2 ISO-14443A Open Card ....................................................................................................................................... 53
9.3.3 ISO-14443A Close Card....................................................................................................................................... 54
9.3.4 ISO-14443A Read Block Data............................................................................................................................. 54
9.3.5 ISO-14443A Read Sector Data........................................................................................................................... 55
9.3.6 ISO-14443A Write Block Data............................................................................................................................. 55
9.3.7 ISO-14443A Inventory .......................................................................................................................................... 56
9.4 ISO-14443B....................................................................................................................................................................56
9.4.1 Select ST Card....................................................................................................................................................... 56
9.4.2 Release ST Card ................................................................................................................................................... 56
9.4.3 Read SR176 Card’s Block Data.......................................................................................................................... 56
9.4.4 Write SR176 Card’s Block Data .......................................................................................................................... 57
9.4.5 Lock SR176 Block ................................................................................................................................................. 57
9.4.6 Read SRIX4K Card’s Block Data........................................................................................................................ 57

- 6
9.4.7
Write SRIX4K Card’s Block Data ........................................................................................................................ 57
9.4.8 Authenticate SRIX4K Card................................................................................................................................... 58
9.4.9 Read SRIX4K Card ID .......................................................................................................................................... 58
9.5 Error Code.....................................................................................................................................................................59
10 RH767 UHF READER FOR WJ........................................................................................60
10.1 Class “MPRReader”................................................................................................................................................60
10.2 The Parameter in MPRReader.............................................................................................................................. 60
10.3 The Function in MPRReader.................................................................................................................................61
10.3.1 Connect to RFID Reader...................................................................................................................................... 61
10.3.2 Disconnect with RFID Reader ............................................................................................................................. 61
10.3.3 Clear All Tags In The Reader .............................................................................................................................. 61
10.3.4 The Event in MPRReader..................................................................................................................................... 61
11 RH767 UHF READER FOR SKYETEK ............................................................................62
11.1 Connect to RFID reader .........................................................................................................................................62
11.2 Disconnect with RFID reader................................................................................................................................62
11.3 Select Tag..................................................................................................................................................................62
11.4 Select Gen2 Tag.......................................................................................................................................................63
11.5 Read Data from Gen2 Tag’s Blocks....................................................................................................................63
11.6 Write Data to Gen2 Tag’s Blocks.........................................................................................................................63
11.7 Select ISO18000-6B Tag ........................................................................................................................................64
11.8 Read Data from ISO18000-6B Tag’s Block........................................................................................................ 64
11.9 Write Block Data to ISO18000-6B Tag................................................................................................................64
11.10 Select All Tags of Any Type..................................................................................................................................65
11.11 Get The tags from Command InventoryTag..................................................................................................... 65
11.12 Send a Tag Password.............................................................................................................................................65
11.13 Lock Gen2 Tag.........................................................................................................................................................66
11.14 Lock ISO18000-6B Tag...........................................................................................................................................66
11.15 Get Reader’s Power Level..................................................................................................................................... 66
11.16 Set Reader’s Power Level.....................................................................................................................................67
11.17 Get the library version............................................................................................................................................67
11.18 Get Reader’s Frequency........................................................................................................................................67

- 7
11.19
Set Reader’s Frequency.........................................................................................................................................68
11.20 Get Reader’s Hop Channel Spacing...................................................................................................................68
11.21 Set Reader’s Hop Channel Spacing....................................................................................................................68
11.22 Get Reader’s Firmware Version...........................................................................................................................69
11.23 Get Reader’s LBT Setting...................................................................................................................................... 69
11.24 Set Reader’s LBT Setting ......................................................................................................................................69
12 RH767 UHF READER FOR KITTY...................................................................................70
12.1 Kitty RFID Reader API Reference........................................................................................................................70
12.2 Interface Management............................................................................................................................................ 70
12.2.1 Initializing the RFID Reader Interface................................................................................................................. 70
12.2.2 Shutting Down the RFID Reader Interface........................................................................................................ 70
12.3 RFID Reader Configuration...................................................................................................................................71
12.3.1 Open RFID Reader................................................................................................................................................ 71
12.3.2 Close RFID Reader............................................................................................................................................... 71
12.3.3 Set the Operation Mode for the RFID Reader................................................................................................... 71
12.3.4 Get the Operation Mode for the RFID Reader.................................................................................................. 71
12.3.5 Set the Response Data’s Mode of the RFID Reader....................................................................................... 72
12.3.6 Get the Response Data’s Mode of the RFID Reader....................................................................................... 72
12.3.7 Set the RFID Reaer’s Power State..................................................................................................................... 72
12.3.8 Get the RFID Reader’s Power State................................................................................................................... 72
12.3.9 Set the RFID Reader’s Low-Level Parameter................................................................................................... 72
12.3.10 Get the RFID Reader’s Low-Level Parameter............................................................................................... 73
12.4 Antenna Port Configuration..................................................................................................................................73
12.4.1 Enabling and Disabling Anennas ........................................................................................................................ 73
12.4.2 Get the RFID Reader’s Antenna-Port Status..................................................................................................... 73
12.4.3 Configuring Antenna-Port Parameters ............................................................................................................... 73
12.4.4 Retrieving Antenna-Port Configuration............................................................................................................... 74
12.5 ISO 18000-6C Tag Access.....................................................................................................................................74
12.5.1 Callback function.................................................................................................................................................... 74
12.5.2 Get Antenna’s Response Status......................................................................................................................... 75
12.5.3 Get Tag Access Response Data......................................................................................................................... 75
12.5.4 Set Tag Operation Stop Count ............................................................................................................................ 75
12.5.5 Get Tag Operation Stop Count............................................................................................................................ 75
12.5.6 Tag Inventory Operation....................................................................................................................................... 76
12.5.7 Tag Read Operation.............................................................................................................................................. 76
12.5.8 Tag Write Operation.............................................................................................................................................. 76
12.5.9 Modify EPC Operation.......................................................................................................................................... 77
12.5.10 Tag Kill Operation.............................................................................................................................................. 77
12.5.11 Tag Lock Operation........................................................................................................................................... 77
12.5.12 Tag Pre-singulation Operation......................................................................................................................... 77
12.5.13 Tag Post Singulation Operation....................................................................................................................... 79
12.5.14 Tag Query Group Operation............................................................................................................................ 79
12.5.15 Set Current Singulation Algorithm................................................................................................................... 79
12.5.16 Specifying Singulation Algorithm Parameters ............................................................................................... 79
12.5.17 Cancelling a Tag Operation ............................................................................................................................. 80
12.5.18 Aborting a Tag Operation................................................................................................................................. 80

- 8
12.5.19
Clear RFID Reader Module’s Error State ...................................................................................................... 80
12.5.20 Ability of Hold or Discard the Duplicate Tags................................................................................................ 80
12.6 Other APIs.................................................................................................................................................................80
12.6.1 Get RFID Reader’s Firmware Version................................................................................................................ 80
12.7 Structure of the Library..........................................................................................................................................81
12.7.1 RFID_ANTENNA_PORT_CONFIG .................................................................................................................... 81
12.7.2 ACCESS_STATUS................................................................................................................................................ 82
12.7.3 ANTENNA_STATUS............................................................................................................................................. 82
12.7.4 ACCESS_DATA..................................................................................................................................................... 83
12.7.5 RFID_INVENTORY............................................................................................................................................... 83
12.7.6 RFID_READ ........................................................................................................................................................... 84
12.7.7 RFID_READ_EX.................................................................................................................................................... 84
12.7.8 RFID_WRITE.......................................................................................................................................................... 85
12.7.9 RFID_WRITE_EX.................................................................................................................................................. 86
12.7.10 RFID_WRITE_EPC........................................................................................................................................... 86
12.7.11 RFID_KILL.......................................................................................................................................................... 87
12.7.12 RFID_KILL_EX................................................................................................................................................... 87
12.7.13 RFID_LOCK........................................................................................................................................................ 88
12.7.14 RFID_LOCK_EX................................................................................................................................................ 89
12.7.15 RFID_SELECT_CRITERIA.............................................................................................................................. 89
12.7.16 RFID_POST_SINGULATION .......................................................................................................................... 90
12.8 Error Code.................................................................................................................................................................91
12.9 Support Dot Net Compact Framework...............................................................................................................93
12.9.1 Class “R1000Reader”........................................................................................................................................... 93
12.9.2 Programming Model.............................................................................................................................................. 93
13 USEFUL FUNCTION CALL – WITHOUT INCLUDE SYSIOAPI.DLL...............................94
13.1.1 Warm-boot. Cold-boot and power off.................................................................................................................. 94
14 GET DEVICE ID................................................................................................................95
15 GET OEM INFO ................................................................................................................95
16 GET FIRMWARE AND BOOTLOADER VERSION INFO.................................................95
17 CAMERA RELATED FUNCTIONS (C#)...........................................................................96
17.1 Open Camera............................................................................................................................................................96
17.2 Release Camera.......................................................................................................................................................96
17.3 Start Preview.............................................................................................................................................................96
17.4 Stop Preview............................................................................................................................................................. 96
17.5 Get transparent color key......................................................................................................................................97
17.6 Capture Image.......................................................................................................................................................... 97
17.7 Start Capture Video.................................................................................................................................................97

- 9
17.8
Stop Capture Video.................................................................................................................................................98
17.9 Initial Playback Decoder........................................................................................................................................98
17.10 Release Playback Decoder ...................................................................................................................................98
17.11 Start Playback ..........................................................................................................................................................98
17.12 Stop Playback...........................................................................................................................................................99
18 FINGERPRINT RELATED FUNCTIONS ........................................................................100
19 GPS RELATED FUNCTIONS.........................................................................................101
20 USI .NET COMPACT FRAMEWORK COMPONENT.....................................................102
21 USI ACTIVEX CONTROL...............................................................................................103
21.1 Register Control..................................................................................................................................................... 103
21.2 Embedded to html.................................................................................................................................................103
21.3 Operate control by script language..................................................................................................................103
22 32WAN GPRS LIBRARY................................................................................................104
23 UPDATE NOTES ............................................................................................................105

-
1 Introduction
1.1 How to download data from scanner
The major difference between the HT6xx/PA96x/PA982 and a standard HPC/PalmPC is
barcode input capability. The WinCE Reference Manual contains no information regarding
barcode input. This section will introduce the programming structure of the barcode sub-
system and the programming utility library for the HT6xx/PA96x/PA982. Inside the
HT6xx/PA96x/PA982 there is an advanced decoding chip to control SE900 laser engine and
to handle barcode decoding. Below is system diagram for the HT6xx/PA96x/PA982
barcode:
According to the above diagram, the HT6xx/PA96x/PA982 communicates with Decoder Chip
by mean of serial port COM2. Its communication parameter is fixed on 38400,N,8.1.
Normally, the Decoder Chip is in sleep mode when COM2 is not activated. When COM2 is
activated, the Decoder Chip will start working, and it will decode the barcode “signal” from
the laser engine when the trigger key is pressed. After decoding, barcode data and its
symbology type will be sent directly to HT6xx/PA96x/PA982.
Many programmers find it difficult to control the Decoder Chip via programming language
alone, especially if they are not familiar with barcode and serial port controls. Because of
this, Unitech provides the following utility library and program for the user or application
programmer to control the Decoder Chip:
1.Application program “Scan2Key.exe” is a useful application program that can read
input data from the laser scanner and then directly input the data into
HT6XX/PA96x/PA982’s keyboard buffer. “Scan2Key.exe” makes barcode data input
simple, and can be especially valuable to those programmers not familiar with COM
port programming. User program simply reads the barcode data from the keyboard. For
barcode symbologies setting, you can run Scanner Setting from Control Panel to
define all of supporting symbologies and delimiter.
2.Utility library:
For programming control, HT6xx/PA96x/PA982 provides USI.DLL to let user control
scanner input, symbologies setting and profile controlling. Please refer to 2for detail
API lists.
USI.DLL is Unitech’s new scanner function library on HT6xx/PA96x/PA982. For
backward compatible issue, Unitech still provide Scanner3.DLL and ScanKey3.DLL for
existing PT930/PT930SA user to port their software into HT6xx/PA96x/PA982, but
several APIs on Scanner3.DLL and ScanKey3.DLL have already been removed on
HT6xx/PA96x/PA982. User can refer to 0and 5for detail supporting API.
CPU
COM2Advanced
Decoder
Chip
Laser
Engine

-
1.2 COM definition for HT6xx/PA96x/PA982/RH767
General:
COM 1 Physical full RS232 port (ActiveSync)
COM 2 Scanner (Hamster) or RFID reader
COM 3 IrComm
COM 4 USB client
COM 5 IrDA or Bluetooth
COM 6 Reserve
COM 7 Bluetooth Printer
COM 8 Bluetooth Modem
COM 9 Bluetooth ActiveSync
PA968:
COM 0 USB modem
COM 1 Bluetooth
COM 2 Scanner (Hamster) or RFID reader
COM 3 Reserve
COM 4 Reserve
COM 5 GPS
COM 6 Reserve
COM 7 Bluetooth Printer
COM 8 Bluetooth Modem
COM 9 Bluetooth ActiveSync
HT680:
COM 1 Bluetooth
COM 2 Scanner (Hamster)
COM 3 Reserve
COM 4 USB Client
COM 5 Reserve
COM 6 GPRS
COM 7 Bluetooth Printer
COM 8 Bluetooth Modem
COM 9 Bluetooth ActiveSync
1.3 Useful Sample program
You can get useful sample program for VC, C# and VB.NET from below URL
HT6xx series
C# http://w3.tw.ute.com/pub/cs/software/Sample_Program/HT660/c_sharp/c_sharp_sample.zip
Vb.net http://w3.tw.ute.com/pub/CS/software/Sample_Program/HT660/VB.NET/VB.NET_sample.zip
C++ http://w3.tw.ute.com/pub/CS/software/Sample_Program/HT660/evc/evc_sample.zip
PA96x/PA982 series
C# http://w3.tw.ute.com/pub/cs/software/Sample_Program/PA962/c_sharp/c_sharp_sample.zip
Vb.net http://w3.tw.ute.com/pub/CS/software/Sample_Program/PA962/VB.NET/VB.NET_sample.zip
C++ http://w3.tw.ute.com/pub/CS/software/Sample_Program/PA962/evc/evc_sample.zip

-
1.4 Get SDK from Unitech?
You can get SDK from below URL
HT660 SDK http://w3.tw.ute.com/pub/cs/sdk/ht660/HT660SDK.zip
HT680 SDK http://w3.tw.ute.com/pub/cs/sdk/HT680/HT680SDK.zip
PA962/963 SDK http://w3.tw.ute.com/pub/cs/sdk/pa962/pa962sdk.zip
PA966/967 SDK http://w3.tw.ute.com/pub/cs/sdk/pa966/pa966sdk.zip
PA968 SDK http://w3.tw.ute.com/pub/cs/sdk/pa968/pa968sdk.zip
PA982 SDK http://w3.tw.ute.com/pub/cs/sdk/pa982/Pa982SDK.zip
RH767 SDK http://w3.tw.ute.com/pub/cs/sdk/RH767/RH767_CE5_SDK.zip

-
2 USI.DLL – Unitech Scanner Interface DLL
2.1 Register the application to the USI DLL
Function Description:
Register the application to the USI DLL, so that the DLL can communicate with the application. It
will also open and initial scanner port (COM2, for example) and set the scanner to the working
mode. The application should call USI_Unregister to unregister from the DLL after done with the
scanner.
Function call:
BOOL USI_Register(HWND hwnd, UINT msgID);
Parameter: (input)
hwnd: Handle of the window to which USI DLL will send messages to report all
activities, including error messages, scan data ready, etc.
msgID : Specifies the message to be posted. DLL will post messages by calling:
PostMessage(hwnd, msgID, msg, param).
The window procedure will receive custom message about msgID and wParam parameter
can be one of the followings:
SM_ERROR_SYS: Indicates a system error, which is caused by a call to the system
function. Param contains the error code from GetLastEror().
SM_ERROR Indicates an error. Param contains the cause of error, which can
be on of followings:
SERR_INVALID_HWND: Invalid window handle.
SERR_INVALID_MSGID: msgID cannot be 0.
SERR_OPEN_SCANNER: Open or initial scanner port failed.
SERR_CHECKSUM: Checksum error in received packet.
SERR_DATALOST: New scan data is lost because data
buffer is not empty.
SERR_BUFFEROVERFLOW: Data buffer overflow. The default size
is 4K bytes.
SM_REPLY Indicates received a reply. All the responses from the scanner
except the scan data will be notified by this message.
SM_DATAREADY Indicates that scan data is successfully decoded and ready to
retrieve.
SM_ACK Indicates received a ACK.
SM_NAK Indicates received a NAK.
SM_NOREAD Indicates received a No-Read packet.
Note: Scanner port settings are defined in registry as described below:
[HKEY_LOCAL_MACHINE\SOFTWARE\Unitech America Inc.\Scanner\Settings]
"COMPORT"="COM2:"
"BAUDRATE"="38400"
"STOPBITS"="1"
"PARITY"="None"

-
"CHECKPARITY"="1"
Return:
BOOL: TRUE : OK
FALSE : Failure
2.2 Unregister the application from the USI.DLL
Function Description:
Unregister the application from the DLL. It will close the scanner port, and by default it will disable
the scanner.
Function call:
void USI_Unregister();
Return code:
None
2.3 Enable / Disable Scanner
Function Description:
To start or stop USI function. This function is useful for application to temporarily stop scanner
function if it is only need keypad input or keep clear input buffer.
Function call:
BOOL USI_EnableScan(BOOL bStatus);
Parameter: (input)
bStatus: TRUE : Enable Scanner
FALSE : Disable Scanner
Return:
BOOL : TRUE : OK
FALSE : Failure
2.4 Reset Scanner
Function Description:
Set the scanner to the working mode, and reset the communication control.
Function call:
BOOL USI_Reset();
Return:
Always TRUE
2.5 Get error code
Function Description:
Returns the error code (SERR_***).
Function call:
DWORD USI_GetError();
Return:
Returns the error code (SERR_***), which has been described in USI_Register function.

-
2.6 Returns the system error code
Function Description:
Returns the system error code, which is returned by GetLastError. It will also return the description
of the error in buffer if it is not NULL.
Function call:
DWORD USI_GetLastSysError(LPTSTR buffer, int len);
Parameter: (output)
buffer: LPTSTR: Data buffer for error message
len: int: Length of error message.
Return:
Returns the system error code, which is returned by system function GetLastError. It will also return
the description of the error in buffer retrieved by system function FormatMessage if it is not NULL.
For a complete list of error codes, refer to the SDK header file WINERROR.H.
2.7 Get scan data
Function Description:
Retrieves the scan data into the buffer. Returns the length of characters. It also returns the barcode
type if type is not NULL. Return 0 means that the buffer is too short to hold the data.
USI_GetData should be called when SM_DATAREADY message is received. Or call
USI_ResetData to discard the data. Both of them will reset the data buffer so that next scan data
can come in.
If the data buffer is not empty and a new scan data occurs, it will be discarded and an error
message SM_ERROR with code of SERR_DATALOST will be sent.
Function call:
UINT USI_GetData(LPBYTE buffer, UINT len, UINT* type);
Parameter: (input)
len : UINT: Len specifies the maximum length of the buffer.
Parameter: (output)
buffer: LPBYTE: Data buffer for storing scanned data
type: UINT: barcode type which is defined on USI.H.
Please refer to below list
BCT_CODE_39 // Code 39
BCT_CODABAR // CodaBar
BCT_CODE_128 // Code 128
BCT_INTERLEAVED_2OF5 // Interleaves 2 of 5
BCT_CODE_93 // Code 93
BCT_UPC_A // UPC A
BCT_UPC_A_2SUPPS // UPC A with 2 Supps
BCT_UPC_A_5SUPPS // UPC A with 5 Supps
BCT_UPC_E0 // UPC E
BCT_UPC_E0_2SUPPS // UPC E with 2 Supps
BCT_UPC_E0_5SUPPS // UPC E with 5 Supps
BCT_EAN_8 // EAN 8
BCT_EAN_8_2SUPPS // EAN 8 with 2 Supps
BCT_EAN_8_5SUPPS // EAN 8 with 5 Supps
BCT_EAN_13 // EAN 13
BCT_EAN_13_2SUPPS // EAN 13 with 2 Supps
BCT_EAN_13_5SUPPS // EAN 13 with 5 Supps
BCT_MSI_PLESSEY // MSI Plessey

-
BCT_EAN_128 // EAN 128
BCT_UPC_E1 // UPC E1
BCT_UPC_E1_2SUPPS // UPC E1 with 2 Supps
BCT_UPC_E1_5SUPPS // UPC E1 with 5 Supps
BCT_TRIOPTIC_CODE_39 // TRIOPTIC CODE 39
BCT_BOOKLAND_EAN // Bookland EAN
BCT_COUPON_CODE // Coupon Code
BCT_STANDARD_2OF5 // Standard 2 of 5
BCT_CODE_11_TELPEN // Code 11 Telpen
BCT_CODE_32 // Code 32
BCT_DELTA_CODE // Delta Code
BCT_LABEL_CODE // Label Code IV & V
BCT_PLESSEY_CODE // Plessey Code
BCT_TOSHIBA_CODE // Toshiba Code China Postal Code / Matrix 2 of 5
Return:
UINT: Data length
2.8 Get length of scanned data
Function Description:
Returns the data length of the scan data. When allocate the memory to hold the scan data, add at
least one additional byte for string terminator.
Function call:
UINT USI_GetDataLength();
Return:
UNIT: data length
2.9 Get Symbology name
Function Description:
Returns the barcode name of the type.
Function call:
LPCTSTR USI_GetBarcodeName(UINT type, LPBYTE buffer, UINT len);
Parameter: (input)
type: UINT : barcode type. (refer to 0for type definition
buffer: LPBYTE : Please refer to below table
Type Buffer
BCT_CODE_39 Code 39
BCT_CODABAR Codabar
BCT_CODE_128 Code 128
BCT_INTERLEAVED_2OF5 Interleaved 2 of 5
BCT_CODE_93 Code 93
BCT_UPC_A UPC A
BCT_UPC_A_2SUPPS UPC A with 2 Supps.
BCT_UPC_A_5SUPPS UPC A with 5 Supps.
BCT_UPC_E0 UPC E
BCT_UPC_E0_2SUPPS UPC E with 2 Supps.
BCT_UPC_E0_5SUPPS UPC E with 5 Supps.
BCT_EAN_8 EAN 8
BCT_EAN_8_2SUPPS EAN 8 with 2 Supps.
BCT_EAN_8_5SUPPS EAN 8 with 5 Supps.
BCT_EAN_13 EAN 13
BCT_EAN_13_2SUPPS EAN 13 with 2 Supps.

-
BCT_EAN_13_5SUPPS EAN 13 with 5 Supps.
BCT_MSI_PLESSEY MSI Plessey
BCT_EAN_128 EAN 128
BCT_TRIOPTIC_CODE_39 Trioptic Code 39
BCT_BOOKLAND_EAN Bookland EAN
BCT_COUPON_CODE Coupon Code
BCT_STANDARD_2OF5 Standard 2 of 5
BCT_CODE_11_TELPEN Code 11 or Telpen
BCT_CODE_32 Code 32 (Pharmacy Code)
BCT_DELTA_CODE Delta Code
BCT_LABEL_CODE Label Code IV & V
BCT_PLESSEY_CODE Plessey Code
BCT_TOSHIBA_CODE Toshiba Code (China Postal Code), Matrix 25
len: UINT : length of string on the 2
nd
parameter buffer
Return:
TRUE: if it found name for the barcode type,
FALSE: if not (type may be wrong

-
2.10 Clear scan data system buffer
Function Description:
Reset the data buffer so that next new scan data can come in.
Function call:
void USI_ResetData();
2.11 Good read indicator
Function Description:
Inform a good receiving of scan data, this will play a sound (wave file scanok.wav) and light the
LED lasting for 1 second.
Function call:
void USI_ReadOK();
Note:
USI will call the function GoodReadLEDOn function exported by the DLL defined in the registry
described below (UPI300.DLL is an example) to turn on and off the LED. If the DLL is not defined or
the function is not found, USI will bypass the call of GoodReadLEDOn.
[HKEY_LOCAL_MACHINE\SOFTWARE\Unitech America Inc.\Scanner\Settings]
"DLLLEDCONTROL"="UPI300.DLL"
The function prototype of GoodReadLEDOn is:
VOID WINAPI GoodReadLEDOn(BOOL fon);
Turn on when fon is TRUE, and turn off when fon is FALSE.
2.12 Wait for acknowledgement of the last sent command
Function Description:
Wait for acknowledgement of the last sent command until timeout. It is useful when a serial of
commands needs to be sent at a time. Before call USI_SendCommand, call
USI_WaitForSendEchoTO to make sure that the previous command is done.
Function call:
BOOL USI_WaitForSendEchoTO(DWORD timeout);
Parameter: (input)
timeout: DWORD : Specifies the timeout in millisecond.
Return:
Returns FALSE if timeout.
2.13 Save setting to profiles
Function Description:
Save current settings of scanner so that the settings will be persistent when the unit get power off
and on again.
Function call:
BOOL USI_SaveCurrentSettings();
Return :
TRUE: Success,
FALSE: Fail

-
2.14 Save scanner setting into specified file
Function Description:
Save the current settings to file. The file takes “*.USI” as extension name.
Function call:
BOOL USI_SaveSettingsToFile(LPCTSTR filename)
Parameter: (input)
filename : LPCTSTR: file name for setting profile
Return:
TRUE: Success,
FALSE: Fail
2.15 Change scanner setting from specified setting profile
Function Description:
Load and activate the settings from file.
Function call:
BOOL USI_LoadSettingsFromFile(LPCTSTR filename, BOOL formulaOnly);
Parameter: (input)
filename: LPCTSTR : name of scanner setting profile (*.USI)
formulaOnly: BOOL: if TRUE, only data editing formulas are load. The other settings
remain unchanged
Return:
TRUE: Success,
FALSE: Fail
2.16 Automatically enable scanner beam with pressing trigger key
Function Description:
Start auto scanning. Scan engine will be automatically triggerrd on.
Function call:
BOOL USI_StartAutoScan(DWORD interval);
Parameter: (input)
interval: DWORD: Specifies the interval in milli-second
Return:
TRUE: Success,
FALSE: Fail
Note:
USI will call the function SetScannerOn function exported by the DLL defined in the registry
described below (UPI300.DLL is an example) to start and stop the scanner. If the DLL is not
defined or the function is not found, then auto scanning is not available.
[HKEY_LOCAL_MACHINE\SOFTWARE\Unitech America Inc.\Scanner\Settings]
"DLLSCANNERCONTROL"="UPI300.DLL"
The function prototype of SetScannerOn is:
VOID WINAPI SetScannerOn(BOOL fon);
Start when fon is TRUE, and stop when fon is FALSE.

-
2.17 Stop auto scanning function
Function Description:
Stop auto scanning
Function call:
void USI_StopAutoScan();
2.18 Check if auto scanning is enable
Function Description:
Check if auto scanning function is enabled or not
Function call:
BOOL USI_IsAutoScanning()
Return:
BOOL: TRUE: auto-scanning is running
FALSE: auto-scanning is disabled.
2.19 Check if Scan2Key.exe program is running or not
Function Description:
Test whether Scan2Key application is running at background. (It doesn’t mean Scan2Key is routing
scanner input to keyboard, please call S2K_IsEnabled() to check if routing function is enable or not)
Function call:
HWND S2K_IsLoaded();
Return:
NULL: Scan2Key is not running
Non-NULL: Indicates scan2key is running. It actually returns window handle for scan2key, but
it is for internal use – send messages.
2.20 Test if Scan2Key is enabled
Function Description:
Test whether Scan2Key is enabled. Scan2Key routes scanning input from scanner to keypad buffer,
so that barcode data can be input as like from keystrokes on keypad.
Function call:
BOOL S2K_IsEnabled();
Return:
TRUE: Enabled.
FALSE: Disabled