Unitech PA96 Series, Programming Manual

Page 1: ...HT6xx PA96x PA982 RH767 Programming Manual V 1 17 2009 10 01...

Page 2: ...em 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...

Page 3: ...T930S 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 5 SCANKEY3 DL...

Page 4: ...ad 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 on...

Page 5: ...ol 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 ISO1...

Page 6: ...EK 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...

Page 7: ...2 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 RF...

Page 8: ...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 F...

Page 9: ...ayback 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...

Page 10: ...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...

Page 11: ...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 belo...

Page 12: ...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...

Page 13: ...icates 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 f...

Page 14: ...ation 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 D...

Page 15: ...n 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 d...

Page 16: ...ne 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 LPC...

Page 17: ...CT_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_TOSHI...

Page 18: ...ettings 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...

Page 19: ...gs 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...

Page 20: ...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 N...

Page 21: ...timeout DWORD when enable or disable Scan2Key it will wait until Scan2Key has been removed from memory or timeout specified by this parameter Return TRUE if successfully enabled Scan2Key otherwise FAL...

Page 22: ...r chip This is a variation of command HAM_SendCommand It will read a number of parameters and packet them as in following format and send it to decoder chip Esc parameter1 parameter2 BCC The total num...

Page 23: ...from Hamster to Host If Hamster receive a command and this command do not need send message back Hamster reply the ACK NAK Esc 80H NAK 15H It is from Hamster to Host Hamster require the Host to re sen...

Page 24: ...to 8 CHARACTERS Scan_post_data Esc 0 L 1c m S1 Si BCC Si can be 1 to 8 CHARACTERS Define_code39f Esc 0 4 1d m S1 BCC define Code 39 full ASCII ID Here S1 is 1 CHARACTER Define_code39s Esc 0 4 1e m S1...

Page 25: ...0 4 48 m S1 BCC S1 is 0_disable 1 enable S2of5_fixlength Esc 0 4 49 m S1 BCC S1 is 0_on 1 off record first 3 record len S2of5_cd Esc 0 4 4a m S1 BCC S1 is 0 calculate send 1 calculate not send 2_not...

Page 26: ...b0 is for Upc_e_nsc Upc_e_enable Esc 0 4 79 m S1 BCC S1 is 0 disable 1_enable Upc_e_ld Esc 0 4 7a m S1 BCC S1 is 0_leading digit send 1 not send Upc_e_cd Esc 0 4 7b m S1 BCC S1 is 0 check digit send...

Page 27: ...cute command Esc ENQ Hamster execute the command after receive an Esc ENQ then send back a reply The Max Length of data is 264 The m and the reply define as following DATA TO HOST FROM HAMSTER Data fo...

Page 28: ...data from the system buffer Function call INT PT_EnableBarcode VOID Return code 1 Create new thread fail 2 Cannot re enable 3 Cannot open COM2 4 Upload parameter from Hamster fail 0 OK 4 2 Disable Dec...

Page 29: ...8H Code 128 09H Code 93 0Ah STD 25 0BH MSI 0CH EAN 128 0DH Code 32 0EH DELTA 0FH LABEL 10H PLESSEY 11H Code 11 12H TOSHIBA Return code TRUE There is barcode input FALSE No Barcode Input 4 5 Get DLL ve...

Page 30: ...ameter from Hamster fail 0 OK 5 2 Disable Decoder Function Description This function will close COM2 port and then remove thread which is created by PT_EnableBarToKey Function call for VC VOID PT_Disa...

Page 31: ...Reset all symbologies to default Function Description This function call will reset decoder chip s symbologies setting to system default value Function call for VC int PT_ SetToDefault VOID Function c...

Page 32: ...erminal so it mean that operator can change modify or delete any setting If system developer don t want operator to do any extra operation beside application Unitech provide function call to provides...

Page 33: ...code TRUE OK FALSE Fail 6 5 Enable TaskBar Function Description This function will show TaskBar again after Disable_TaskBar was executed to hide taskbar Function call BOOL EnableTaskbar VOID Return c...

Page 34: ...TRUE OK FALSE Fail 6 10 Disable Connection Function Description This function will disable the specify connection in Settings Network and Dial up Connections Function call BOOL DisableConnection LPTST...

Page 35: ...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 Function Description To check if SHI...

Page 36: ...arameter input For HT660 0 normal 1 lower case 2 upper case For HT680 PA96x PA982 0 hide the selection window 1 show lower case selection window 2 show upper case selection window 7 1 6 Get keypad uti...

Page 37: ...tion call BOOL GetFnKeyStatus void Return code TRUE Function key is enabled FALSE Function key is enabled 7 1 9 Enable Disable Function key For HT680 PA968 only Function Description This function is u...

Page 38: ...lates trigger keys to turn scan engine on or off It functions even if trigger keys are disabled Function call void SetScannerOn BOOL fON Parameter Input fON BOOL TRUE turn scan engine on FALSE turn sc...

Page 39: ...pressing Function Description This function is used to check if left or right trigger key is pressed or not Function call BOOL TriggerKeyStatus int key Parameter Input key int LEFT_TRIGGER_KEY left tr...

Page 40: ...1 Screen Backlight Control Function Description This function turns screen backlight on or off Function call void BacklightOn BOOL fON Parameter Input fON BOOL TRUE turn on screen backlight FALSE tur...

Page 41: ...adjust one step down 7 5 SD slot related functions For HT680 Pa968 Only 7 5 1 Inquire SD slot status Function Description This function returns SD slot enable disable status Function call BOOL GetSDS...

Page 42: ...erEnable BOOL bOn Parameters Input bOn BOOL TRUE Enable module FALSE Disable module 7 8 PCMCIA CF slot related functions In HT660 it only support CF slot and PA96x PA982 can support both CF and PCMCIA...

Page 43: ...Function call void EnablePCMCIASlot1 UINT uSocket BOOL bEnable Parameters Input uSocket UINT slot to be applied bEnable BOOL TRUE enable specified slot FALSE disable specified slot Example To disable...

Page 44: ...ly define CF_SOCKET 1 if GetPCMCIAStatus1 GetPCMCIASlotID PCMCIA_SLOT 7 8 6 Disable PCMCIA CF slot when resume Function Description This function will disable the specified slot after resume even thou...

Page 45: ...7 10 Enable Disable LCD screen Function Description Turn on off LCD screen Function call void PowerOnColorLCD BOOL fON Parameters Input fON BOOL TRUE Power on LCD screen FALSE Power off LCD screen...

Page 46: ...ON OFF Function call void BT_PowerEnable BOOL bEnable Parameter Input bON BOOL TRUE Enable FALSE Disable 8 2 Get BT Power status Function Description Get Bluetooth Module Power Status Function call B...

Page 47: ...OMPort UINT32 u32Baudrate CONST LPTSTR strAccessCode BYTE u1SecurityMode UINT32 u32OpenDelayMs PUINT32 pu32Baudrate Parameter u8COMPort The reader s COM port number 1 255 u32Baudrate The reader s baud...

Page 48: ...32 RDINTv2_ReaderInfo BYTE u8COMPort LPBYTE pu8SerialNum LPBYTE pu8FirmwareVer Parameter u8COMPort The reader s COM port number 1 255 pu8SerialNum Get reader s serial number Length READER_SERIAL_LEN p...

Page 49: ...sfid The Data Storage Format Identifier parameter please refer to ISO15693 document pu8Uid The point of the buffer which to receive the tag ID Return code Please refer to section 9 5 9 2 2 Set StayQui...

Page 50: ...fies the actions to be performed by the VICC and whether corresponding fields are present or not pu8Uid The point of the buffer which contains the tag ID u8BlockStart The first block which you want to...

Page 51: ...BYTE u8COMPort BYTE u8Flag LPBYTE pu8Uid BYTE u8AfiValue Parameter u8COMPort The reader s COM port number 1 255 u8Flag It specifies the actions to be performed by the VICC and whether corresponding f...

Page 52: ...NT_ISO15693LockDsfid BYTE u8COMPort BYTE u8Flag LPBYTE pu8Uid Parameter u8COMPort The reader s COM port number 1 255 u8Flag It specifies the actions to be performed by the VICC and whether correspondi...

Page 53: ...5 9 3 2 ISO 14443A Open Card Function Description Lock the ISO 14443A tag and get the tag ID After select card type user should call this API before control the ISO 14443A tag Function Call INT32 RDIN...

Page 54: ...cify block data Function Call INT32 RDINT_ReadMifareOneBlock BYTE u8COMPort BYTE u1KeyType BYTE u1DefaultKey BYTE u8DefaultKeyIndx BYTE u8Block LPBYTE pu8Key LPBYTE pu8Data Parameter u8COMPort The rea...

Page 55: ...The user defines key value pu8Data Receive the data Return code Please refer to section 9 5 9 3 6 ISO 14443A Write Block Data Function Description Write data to the specify block Function Call INT32 R...

Page 56: ...Port The reader s COM port number 1 255 pu8IDNum The card data Return code Please refer to section 9 5 9 4 2 Release ST Card Function Description Release ST card Function Call INT32 RDINT_STCardIntoDe...

Page 57: ...ch user wants to lock Ex 0 1 2 Return code Please refer to section 9 5 9 4 6 Read SRIX4K Card s Block Data Function Description Read the block from specify SRIX4K card Function Call INT32 RDINT_SRIX4K...

Page 58: ...ort The reader s COM port number 1 255 pu8Auth The authentication data Return code Please refer to section 9 5 9 4 9 Read SRIX4K Card ID Function Description Read the SRIX4K card ID Function Call INT3...

Page 59: ...eate error LRDELETE 0x18 Card file delete error LRALREADOPEN 0x19 Card has been opened already LRALREADCLOSED 0x1a Card has been closed already LRMSTRKEYLOAD 0x1b Cannot load master keys LRAPPKEYLOAD...

Page 60: ...na on reader and this value should be 0 on RH767 y byte TxPower This parameter to set and get the current antenna power and this value should between 18 30 y int InvUpdateGap To set and get the time b...

Page 61: ...il 10 3 2 Disconnect with RFID Reader Function Description Close the connection and disable inventory with reader Function Call void Disconnect 10 3 3 Clear All Tags In The Reader Function Description...

Page 62: ...255 default is COM2 dwBaudRate The baud rate with the reader the default is 57600 Return code TRUE Connect success FALSE Connect fail 11 2 Disconnect with RFID reader Function Description Close the c...

Page 63: ...e EPC memory bank the szAddress is 1002 the 1 specifies the EPC memory bank and 002 specifies the block memory 0x002 nBlock The number of blocks which user wants to read szData Receive the block s dat...

Page 64: ...ck The number of blocks which user wants to read szTagID The tag ID which user wants to read szData Receive the block s data Return code TRUE Read block success FALSE Read block fail 11 9 Write Block...

Page 65: ...ta Parameter TagData The structure of tag information typedef struct TAG_DATA char szTag 50 TAG_TYPE TagType TAG_DATA 11 12 Send a Tag Password Function Description After assigned an access password t...

Page 66: ...n locked they cannot be unlocked or written to Function Call BOOL LockISO180006BTag char szTagID char szAddress int nBlock Parameter szTagID The tag ID which user wants to lock szAddress The start add...

Page 67: ...ry version Function Description To get SkeyDll dll version Function Call void GetLibraryVersion char szVersion Parameter szVersion Return the version 11 18 Get Reader s Frequency Function Description...

Page 68: ...er s Hop Channel Spacing Function Description To get reader s hop channel spacing Function Call BOOL GetHopChannelSpacing char szSpacing Parameter szSpacing Return the hop channel spacing value Return...

Page 69: ...lk setting Function Call BOOL GetListenBeforeTalk BOOL bEnable Parameter bEnable The return value to show enable disable Return code TRUE Get LBT setting success FALSE Get LBT setting fail 11 24 Set R...

Page 70: ...before an application exits in order to release any internally held resources If an application fails to shut down the RFID Reader interface the RFID Reader interface will not be available for other...

Page 71: ...RFID_STATUS 12 3 3 Set the Operation Mode for the RFID Reader Description The RFID Reader module may operate either in continuous or non continuous mode In continuous mode when a tag protocol operatio...

Page 72: ...ponseMode RFID_RESPONSE_MODE pMode Parameters pMode A pointer to RFID_RESPONSE_MODE contain the data reporting mode Returns RFID_STATUS 12 3 7 Set the RFID Reaer s Power State Description Set the RFID...

Page 73: ...tate of the logical antenna port Returns RFID_STATUS 12 4 2 Get the RFID Reader s Antenna Port Status Description Retrieves the status of a RFID Reader module s antenna port Function Call RFID_STATUS...

Page 74: ...mask to the singulated tag s EPC to further filter the singulated tag Apply ISO 18000 6C access command Only tags that match the optionally supplied selection criteria and post singulation match mask...

Page 75: ...tAccessData int nAntenna int nIndex LPACCESS_DATA lpAccessData Parameters nAntenna Indicate which antenna s access data to be retrieve nIndex Index of the access s data lpAccessData A pointer to the s...

Page 76: ...from the tag fails Function Call void RFIDTagRead RFID_READ stRead LPACCESS_STATUS lpAccessStatus BOOL bBlock FALSE int nTimeout 3000 void RFIDTagReadEx RFID_READ_EX stReadEx LPACCESS_STATUS lpAccess...

Page 77: ...ions Function Call void RFIDTagLock RFID_LOCK stLock LPACCESS_STATUS lpAccessStatus BOOL bBlock FALSE int nTimeout 3000 void RFIDTagLockEx RFID_LOCK_EX stLockEx LPACCESS_STATUS lpAccessStatus BOOL bBl...

Page 78: ...Returns RFID_STATUS...

Page 79: ...ID_STATUS RFIDTagQueryGroup RFID_18K6C_TAG_GROUP pGroup BOOL bSet TRUE Parameters pGroup Contain the parameters of specifying the tag group bSet TRUE specify the tag group FALSE retrieves the tag grou...

Page 80: ...ader module MAC firmware Function Call RFID_STATUS RFIDClearError Parameters None Returns RFID_STATUS 12 5 20 Ability of Hold or Discard the Duplicate Tags Description Hold or discard the duplicate ta...

Page 81: ...milliseconds to spend on this antenna port during a cycle Zero indicates that antenna usage will be ontrolled by the numberInventoryCycles field numberInventoryCycles The number of inventory rounds t...

Page 82: ...on continuous dwErrorCode If tag operation failed this field contains the error code Zero indicates no error dwStatus Return by the Tag operation function indicate the library status and error codes Z...

Page 83: ...PC 2 bytes PC EPC 2 bytes CRC unDataLength Access Data length pnData 256 Data retrieve from Tag of write to Tag 12 7 5 RFID_INVENTORY Description Inventory operation parameters Define typedef struct R...

Page 84: ...y bank count The number of 16 bit words to read If this value zero and bank is EPC the read returns the contents of the EPC starting at the 16 bit word specified by offset through the end of the EPC T...

Page 85: ...fy that it was successfully written A non zero value indicates that the tag s memory should be read to verify verifyRetryCount The maximum number of times the write should be retried if the write veri...

Page 86: ...data will be written to the tags in the field Otherwise data will be written to the tag specify by the EPC bank the same as RFID_WRITE offset the same as RFID_WRITE count the same as RFID_WRITE pnDat...

Page 87: ...operation accessPassword The access password for the tags A valueof zero indicates no access password killPassword The kill password for the tags Must not be zero 12 7 12 RFID_KILL_EX Description Tag...

Page 88: ...Permissions The access permissions for the tag s access password epcBankPermissions The access permissions for the tag s EPC memory bank tidBankPermissions The access permissions for the tag s TID mem...

Page 89: ...rmissions The same as RFID_LOCK 12 7 15 RFID_SELECT_CRITERIA Description The structure of pre singulation matches criteria Define typedef struct RFID_SELECT_CRITERIA_TAG RFID_18K6C_MEMORY_BANK bank IN...

Page 90: ...POST_SINGULATION Fields offset offset in bits from the start of the EPC count The number of bits in the mask Alength of zero causes all EPC to match If offset count falls beyond the end of the mask th...

Page 91: ...cancelled by call to cancel operation close radio or shut down the library RFID_ERROR_OUT_OF_MEMORY 9986 Library encountered an error allocating memory RFID_ERROR_RADIO_BUSY 9985 The operation cannot...

Page 92: ...ag possible timeout 0x07 Failure requesting a new tag handle 0x0A error waiting for tag response possible timeout 0x0B CRC error on tag response to a kill 0x0C Problem transmitting 2nd half of tag kil...

Page 93: ...D Library String strVersion String Empty R1000Reader RFIDCreate ref strVersion Open the RFID Reader R1000Reader RFIDOpen 0 Inventory retrieve the tag s epc RFID_INVENTORY stInventory new RFID_INVENTOR...

Page 94: ...boot and power off include pkfuncs h include oemioctl h Warn boot KernelIoControl IOCTL_HAL_REBOOT NULL 0 NULL 0 NULL Cold boot KernelIoControl IOCTL_COLD_BOOT NULL 0 NULL 0 NULL Power off DWORD dwEx...

Page 95: ...etIDBytes The code will have platformID holds Platform ID and deviceID holds Device ID 15 Get OEM Info In HT6xx PA96x an OEM ID had been burnt into terminal user can check it by pressing Func 9 The sa...

Page 96: ...on Call void ReleaseCamera 17 3 Start Preview Function Description Start preview within a rectangle area as given in the parameters Using screen coordinates Actual displaying area can be a little smal...

Page 97: ...ring filename int width int height Parameter filename Storing path width Width of resolution height Height of resolution Return code TRUE Success FALSE Fail 17 7 Start Capture Video Function Descripti...

Page 98: ...Parameter filename Video file path left Left of playback position top Top of playback position width Width of playback size height Height of playback size Return code TRUE Success FALSE Fail 17 10 Rel...

Page 99: ...17 12 Stop Playback Function Description Stop playing video Function Call void ReleaseAudio...

Page 100: ...18 Fingerprint related functions Please get sample program and manual from below URL http w3 tw ute com pub cs software Sample_Program PA968 Fingerprint zip...

Page 101: ...19 GPS related functions Please get sample program and manual from below URL http w3 tw ute com pub cs software Sample_Program PA968 GPS_SDK1 01 zip...

Page 102: ...20 USI NET Compact Framework Component Please get sample program and manual from below URL http w3 tw ute com pub cs software Sample_Program USICF usicf_v25 zip...

Page 103: ...nction OnRegister Scanner Register 1 function OnUnregister Scanner Register 0 function OnEnable Scanner Scan 1 function OnDisable Scanner Scan 0 SCRIPT INPUT NAME REGISTER1 TYPE BUTTON VALUE Register...

Page 104: ...22 32WAN GPRS library Please get sample program and manual from below URL http w3 tw ute com pub cs software Sample_Program 32WAN 32WAN_SDK zip...

Page 105: ...g on chapter 11 V1 9 Add HF API in chapter 9 V1 10 PA968 support and include camera fingerprint GPS and GPRS programming guide V1 11 Update the HF API V1 12 Remove HF multi tag API V1 13 Add Matrix 2...