Unitech HT6 Series, Programming Manual

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

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

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

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

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

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

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

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

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

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

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 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 ...

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 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 ...

Page 13: ...dicates 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_DATAL...

Page 14: ...cation 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 Alw...

Page 15: ...en 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 spec...

Page 16: ...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 0 for type definition buffer LPBYTE Please refer to below table Type Buffer BCT_CODE_39 Code 3...

Page 17: ...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 2nd parameter buffer Return TRUE if it found name for the barcode type FALSE if not type may be wrong ...

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

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

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

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 FALSE 2 23 Send scanner command to decoding chip Function Description Send scanner command to decoder chip This command will send a serial of bytes to decoder chip as following Esc and BCC will be calcu...

Page 22: ...er 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 number of parameters is specified by first parameter num Function call BOOL HAM_SendCommand2 BYTE num BYTE parameter1 Parameter input num BYTE number of total parameters parameterx BYTE Parameter Return...

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 send command again normally when received a wrong BCC it can send the NAK The Hamster sends back NAK whenever it receives a no sense command COMMAND FROM HOST TO HMASTER Command format Esc Lh Ll n m S1 ...

Page 24: ...1 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 BCC define Code 39 standard ID Here S1 is 1 CHARACTER Define_EAN13 Esc 0 4 1f m S1 BCC define EAN13 ID Here S1 is 1 CHARACTER Define_UPCA Esc 0 4 20 m S1 BCC define UPC A ID Here S1 is 1 CHARACTER D...

Page 25: ...c 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 calculate S25_min Esc 0 4 4b m S1 BCC S1 is 1 48 4 min data len S25_max Esc 0 4 4c m S1 BCC S1 is 1 48 48 data len max Code32_set Esc 0 4 4d m S1 BCC S1 is S1 b0 is for Code32_enable S1 b1 is for Cod...

Page 26: ...1 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 1_not send Upc_e_expand Esc 0 4 7c m S1 BCC S1 is 0 zero expansion on 1_off Upc_e_nsc Esc 0 4 7d m S1 BCC S1 is 0_disable 1 enable Ean_13_set Esc 0 4 7e m S1 BCC S1 is S1 b0 is for Ean_13_enable S1 b...

Page 27: ...ecute 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 format Code_number Lh Ll string Here The Lh Ll is string length Lh is high byte Ll is low byte The string length is excluded the Code_number and Lh Ll The string contains the Code ID pre_amble scanned ...

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 Decoder Function Description This function will close COM2 port and then remove thread which is created by PT_EnableBarcode Function call VOID PT_DisableBarcode VOID 4 3 Check barcode input Function Des...

Page 29: ...08H 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 version no Function description This function is used to get DLL version no Function call INT PT_DllVersion void Return Integer 4 6 Reset all symbologies to default Function Description This function c...

Page 30: ...rameter 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_DisableBarToKey VOID 5 3 Get DLL version no Function description This function is used to get DLL version number Function call for VC int PT_Version void Return Integer 5 4 Disable laser trigger key Func...

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 call for VB PT_ SetToDefault ...

Page 32: ...terminal 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 ability to disable enable task bar keyboard and etc You can get demo program from HT6XX PA96x PA982 technical binder zip files from programming UnitechAPI 6 1 Disable ActiveSync Function Description ...

Page 33: ...urn 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 code TRUE OK FALSE Fail 6 6 Disable Desktop Function Description This function will hide all icons on desktop it mean that any short cut or files cannot be accessed or executed Function call BOOL Di...

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 LPTSTR Parameter Input Specify the connection name in parameter Return code TRUE Success FAULE Fail 6 11 Enable Connection Function Description This function will enable the specify connection in Settings...

Page 35: ...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 Function Description To check if SHIFT key is lock or not Function call BOOL GetShift void Return code TRUE Shift lock FALSE Shift unlock 7 1 3 Get keypad type This function call is reserved for OS using it is not suggested to be used ...

Page 36: ...Parameter 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 utility input mode For HT660 only Function Description This function is used to check alpha key input mode Function call BYTE GetAlphaKeyWorkingMode void Return code 0 normal 1 lower case 2 upper case 7...

Page 37: ...ction 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 used to enabled disable function key Function call void SetFnKeyDisable BOOL bOff Return code TRUE Disable function key FALSE Enable function key ...

Page 38: ...ulates 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 scan engine off 7 2 3 Get Trigger keys Status Function Description This function returns enable disable status of trigger keys Function call BOOL GetScannerTrigger void Return code TRUE trigger keys ar...

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 trigger key RIGHT_TRIGGER_KEY right trigger key Return code TRUE trigger is pressed FALSE trigger is released Example define kKeybdTriggerEventName TEXT KeybdTriggerChangeEvent define kKeybdAlphaKeyEve...

Page 40: ...4 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 turn off backlight 7 4 2 Get Screen Backlight Status Function Description This function returns the status of screen backlight Function call BOOL GetBacklightStatus void Return code TRUE screen backligh...

Page 41: ...E 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 GetSDStatus Return code TRUE Slot is enabled FALSE Slot is disabled 7 5 2 Enable Disable SD Slot Function Description This function enables disables SD slot Function call void EnableSDSlot BOOL bEnable Par...

Page 42: ...werEnable 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 slot So please note that PCMCIA function is not work on following API in this section 7 8 1 Get physical slot ID Function Description PA96x PA982 has two PC card slots slot 0 and slot 1 for PCMCIA a...

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 PCMCIA slot and enable CF slot define PCMCIA_SOCKET 0 PA966 PA962 PA982 only define CF_SOCKET 1 EnablePCMCIASlot1 GetPCMCIASlotID PCMCIA_SLOT FALSE EnablePCMCIASlot1 GetPCMCIASlotID CF_SLOT TRUE 7 8 ...

Page 44: ...nly 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 though that slot is enabled before suspend Function call void DisablePCMCIAUponResume UINT uSocket BOOL bDisable Parameters Input uSocket UINT 1 physical socket 1 0 for physical socket 0 bDisable BOOL TR...

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: ...r 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 BYTE BT_PowerStatus void Return code BYTE 1 Bluetooth Module is Power ON 0 Bluetooth Module is Power OFF 8 3 DLL Version Function Description Get BTAPI dll Version Function call DWORD BT_DllVersion vo...

Page 47: ...COMPort 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 rate and the defualt is 19200 It supports 9600 19200 38400 and 115200 strAccessCode The reader s access code default is 00000000 u1SecurityMode To set use security mode or not TURN_ON Open TURN_OFF ...

Page 48: ...T32 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 pu8FirmwareVer Get reader s firmware version Length FIRMWARE_VER_LEN Return code Please refer to section 9 5 9 1 6 Antenna Control Function Description Enable Disable antenna to save power Function Ca...

Page 49: ...Dsfid 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 StayQuiet Mode Function Description Set the card to StayQuiet mode Function Call INT32 RDINT_ISO15693StayQuiet BYTE u8COMPort BYTE u8Flag LPBYTE pu8Uid Parameter u8COMPort The reader s COM port number 1 255...

Page 50: ...ifies 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 read ex 0 1 2 u8BlockCount The number of blocks which you want to read pu8Data The point of the buffer which receive the block data Return code Please refer to section 9 5 9 2 6 Write The Block Data...

Page 51: ...i 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 fields are present or not pu8Uid The point of the buffer which contains the tag ID u8AfiValue The value of AFI and about this value please refer to ISO15693 document Return code Please refer to sectio...

Page 52: ...INT_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 corresponding fields are present or not pu8Uid The point of the buffer which contains the tag ID Return code Please refer to section 9 5 9 2 12 Get Data From Reader Function Description Get the data from the re...

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 RDINT_OpenCard BYTE u8COMPort BYTE u1AutoFind LPBYTE pu8Uid LPBYTE pu8Atqa LPBYTE pu8Sak Parameter u8COMPort The reader s COM port number 1 255 u1AutoFind Auto search card TURN_ON TURN_OFF pu8Uid Receive...

Page 54: ...ecify block data Function Call INT32 RDINT_ReadMifareOneBlock BYTE u8COMPort BYTE u1KeyType BYTE u1DefaultKey BYTE u8DefaultKeyIndx BYTE u8Block LPBYTE pu8Key LPBYTE pu8Data Parameter u8COMPort The reader s COM port number 1 255 u1KeyType The private key type CARD_KEY_A CARD_KEY_B u1DefaultKey Use the default password in the reader TURN_ON TURN_OFF u8DefaultKeyIndx The index of the default key whi...

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 RDINT_WriteMifareOneBlock BYTE u8COMPort BYTE u1KeyType BYTE u1DefaultKey BYTE u8DefaultKeyIndx BYTE u8Block LPBYTE pu8Key LPBYTE pu8Data Parameter u8COMPort The reader s COM port number 1 255 u1KeyTy...

Page 56: ...MPort 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_STCardIntoDeactive BYTE u8COMPort Parameter u8COMPort The reader s COM port number 1 255 Return code Please refer to section 9 5 9 4 3 Read SR176 Card s Block Data Function Description Read the block from specif...

Page 57: ...ich 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_SRIX4KReadBlock BYTE u8COMPort BYTE u8BlkNo LPBYTE pu8Data Parameter u8COMPort The reader s COM port number 1 255 u8BlkNo The block number which user wants to read Ex 0 1 2 pu8Data Receive the data Return ...

Page 58: ...Port 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 INT32 RDINT_SRIX4KReadUID BYTE u8COMPort LPBYTE pu8Uid Parameter u8COMPort The reader s COM port number 1 255 pu8Uid Receive the card ID Return code Please refer to section 9 5 ...

Page 59: ...reate 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 0x1c Cannot load application LRKEYCARD 0x1d Keycard Error LRUNFORMAT 0x1e Card has files on it LRNOKBDCHAR 0x20 No keyboard character LRNOTIMPL 0x7f Function not implemented LRUNKNOWN 0x80 Unknown er...

Page 60: ...nna 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 between two inventories Please set this value to 0 to get good performance y TimeSpan PersistTime How long a tag that has been read will persist in the inventory without being read while an inventory ...

Page 61: ...ail 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 Remove all tags in the buffer of reader Function Call void ClearInventory 10 3 4 The Event in MPRReader y EventHandler InvTimerEnabledChanged Fired when manufacturing information is read from the re...

Page 62: ...1 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 connection with reader Function Call void ClosePort 11 3 Select Tag Function Description To select any type of supported tag Function Call BOOL SelectTags char szData TAG_TYPE TagType Parameter szData...

Page 63: ...he 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 data Return code TRUE Read blocks success FALSE Read blocks fail 11 6 Write Data to Gen2 Tag s Blocks Function Description To write data to Gen2 tag s blocks Function Call BOOL WriteGen2Block char szAdd...

Page 64: ...ock 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 Data to ISO18000 6B Tag Function Description To write data to ISO18000 6B tag s block Function Call BOOL WriteISO180006BBlock char szAddress int nBlock char szTagID char szData Parameter szAddress Th...

Page 65: ...ata 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 to a tag that support passwords you must send the password to the reader before the reader can execute any other Secure State operations for that tag This remains a requirement until the password is c...

Page 66: ...en 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 address to lock nBlock The number of blocks which user wants to lock Return code TRUE Lock tag success FALSE Lock tag fail 11 15 Get Reader s Power Level Function Description To get reader s power level...

Page 67: ...ary 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 To get reader s frequency Function Call BOOL GetFrequency FREQUENCY_TYPE nFrequencyType char szFrequency Parameter nFrequencyType The frequency type typedef enum FREQUENCY_TYPE START_FREQUENCY 1 STOP...

Page 68: ...der 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 code TRUE Get value success FALSE Get value fail 11 21 Set Reader s Hop Channel Spacing Function Description To set reader s hop channel spacing Function Call BOOL SetHopChannelSpacing char szSpacin...

Page 69: ...alk 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 Reader s LBT Setting Function Description To set reader s LBT listen before talk setting Function Call BOOL SetListenBeforeTalk BOOL bEnable BOOL bSetDefault Parameter bEnable The return value to show...

Page 70: ...n 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 applications it may necessary to reset the RFID Reader module and or reboot the device 12 2 Interface Management 12 2 1 Initializing the RFID Reader Interface Description Allows the RFID Reader Inter...

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 operation cycle i e one iteration through all enabled antenna ports has completed the RFID Reader module begins a new tag protocol operation cycle with the first enabled antenna port and continues to do so u...

Page 72: ...sponseMode 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 Reader module s power state not to be confused with the antenna RF power Function Call RFID_STATUS RFIDSetPowerState RFID_RADIO_POWER_STATE state Parameters state the power state for the RFID Reader...

Page 73: ...state 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 RFIDGetAntennaPortStatus INT32U antennaPort RFID_ANTENNA_PORT_STATUS pStatus Parameters antennaPort the logical antenna port for which status is to be retrieved pStatus pointer to the structure which...

Page 74: ...h 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 have the access command applied to them Note when perform tag read write kill lock operation the RFID Reader module uses only the first enabled logical antenna Tag Operation Functions When the appli...

Page 75: ...etAccessData 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 structure of ACCESS_DATA that contain the access s data Returns True False 12 5 4 Set Tag Operation Stop Count Description Set the maximum number of tags to which the tag operation will be applied If ...

Page 76: ...d 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 lpAccessStatus BOOL bBlock FALSE int nTimeout 3000 Parameters stRead stReadEx read operation parameters lpAccessStatus Contain the operation result Use in block mode bBlock Block mode nTimeout Timeout for th...

Page 77: ...sions 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 bBlock int nTimeout Parameters stLock stLockEx Lock operation parameter lpAccessStatus Contain the operation result Use in block mode bBlock Block mode nTimeout Timeout for the access operation use in b...

Page 78: ... Returns RFID_STATUS ...

Page 79: ...FID_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 group Returns RFID_STATUS 12 5 15 Set Current Singulation Algorithm Description Select the current singulation algorithms Based upon usage scenarios different singulation algorithms i e Q adustment may b...

Page 80: ...eader 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 tags when inventory Call this function before inventory Function Call RFID_STATUS RFIDEnableDuplicate BOOL bEnable TRUE Parameters bEnable TRUE hold the duplicate tags FALSE discard the duplicate tags ...

Page 81: ...f 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 to perform with this antenna port Zero indicates that the antenna usage will be controlled by the dwellTime field physicalRxPort he underlying physical receive antenna port associated with the logical...

Page 82: ...non 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 Zero indicates no error unAntennas The amount of antennas 12 7 3 ANTENNA_STATUS Description Contains the information of the antenna that take effect in the tag operation executed Define typedef struct...

Page 83: ...EPC 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 RFID_INVENTORY_TAG HWND hWnd Parent window RFIDPROC lpfnStartProc RFIDPROC lpfnStopProc RFID_INVENTORY Fields hWnd The parent window which issue the Tag operation lpfnStartProc Application defined cal...

Page 84: ...ry 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 This value must be in the range 1 to 255 inclusive accessPassword The access passowrd for the tags A value of zero indicates no access password 12 7 7 RFID_READ_EX Description Tag read extension funct...

Page 85: ...ify 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 verify failure This value must be between 0 and 7 accessPassword The access password for the tags A value of zero indicates no access password bank The memory bank from which to read offset The offset of...

Page 86: ...e 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 pnData 256 Contains the data to be written to the tag s specified memory bank HEX chars string 12 7 10 RFID_WRITE_EPC Description The structure of Modify a tag s EPC Define typedef struct RFID_WRITE_EPC_T...

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 Kill extension function s parameter Define typedef struct RFID_KILL_EX_TAG HWND hWnd Parent window RFIDPROC lpfnStartProc RFIDPROC lpfnStopProc BYTE accessPassword 8 password is 8 bytes hex char 0 f ...

Page 88: ...dPermissions 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 memory bank userBankPermissions The access permissions for the tag s USER memory bank The access permissions can be set as below Name Value Description Allow 0 Password permission Can be read and write ...

Page 89: ...ermissions 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 INT32U offset INT32U count INT8U mask RFID_18K6C_SELECT_MASKBYTE_LEN RFID_18K6C_TARGET target RFID_18K6C_ACTION action BOOL32 enableTruncate RFID_SELECT_CRITERIA Fields bank The memory bank to match ag...

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 the tag is considered non matching valid values are 0 to 396 mask RFID_18K6C_SINGULATION_MASK_BYTE_LEN the bit pattern to match hex chars match Determines if the associated tag operation will be applie...

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 be performed because the radio is currently busy RFID_ERROR_RADIO_FAILURE 9984 The underlying radio module encountered an error RFID_ERROR_RADIO_NOT_PRESENT 9983 The radio has been detached from the ...

Page 92: ...tag 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 kill 0x0D tag responded with an invalid handle on first kill command 0xFA tag has insufficient power to perform the memory write 0xFB specified memory location is locked and or permalocked 0xFC specifie...

Page 93: ...ID 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_INVENTORY ACCESS_STATUS stAccessStatus new ACCESS_STATUS operation in blocking mode R1000Reader RFIDInventory stInventory ref stAccessStatus true 3000 if stAccessStatus dwStatus 0 stAccessStatus dwErrorCode ...

Page 94: ...d 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 dwExtraInfo 0 BYTE bScan 0 keybd_event VK_OFF bScan KEYEVENTF_SILENT dwExtraInfo keybd_event VK_OFF bScan KEYEVENTF_KEYUP dwExtraInfo ...

Page 95: ...setIDBytes 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 sample code for read OEM ID as follow TCHAR szBuff 500 ZeroMemory szBuff sizeof szBuff SystemParametersInfo SPI_GETOEMINFO 500 LPVOID szBuff 0 MessageBox szBuff 16 Get firmware and bootloader version i...

Page 96: ...ion 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 smaller than the rectangle for hardware reasons Preview is camera real time image This must be called before capturing image or recording video Function Call bool StartPreview int left int top int width ...

Page 97: ...tring 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 Description Start video capturing with the specified resolution and frame rate This will record video in m4v file format continuously until called EndVideoCapture This must be called within StartPreview and S...

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 Release Playback Decoder Function Description Release the playback decoder Function Call void UnInitializeDecoder 17 11 Start Playback Function Description Start playing video Playback will be displayed...

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: ...unction 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 onClick OnRegister INPUT NAME ENABLE TYPE BUTTON VALUE Enable onClick OnEnable INPUT NAME DISABLE1 TYPE BUTTON VALUE Disable onClick OnDisable INPUT NAME UNREGISTER TYPE BUTTON VALUE Unregister onCli...

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: ...ng 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 of 5 supporting which sharing setting with Toshiba code on page 14 15 and 22 V1 14 Add description about retrieve firmware and bootloader version info V1 15 Add RFID reader Kitty V1 16 Modify for HT6...