USER MANUAL SmartPIN K100/ C100/ B100 API
Contents
1. Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID int minLen Example int maxLen BYTE res PIN GetPINLength amp minLen amp maxLen 7 1 30 PIN GetNumeric ee PIN GetNumeric Name Description This function is used to get the clear text with special prompt est BYTE WINAPI PIN GetClearText char InputMessage int MessageLength char ClearTextPIN int Length Parameters Description InputMessage Show message Parameters MessageLength Show message string length should be less than 12 ClearTextPIN Return clear text string length Return the length of clear text Return Value Description TRUE Succeed to get Plain text Return Values FAIL Fail to get Plain text Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID Call thread TheadProc GetNumeric AfxBeginThread ThreadProc GetNumeric this Define TreadProc GetNumeric static UINT ThreadProc GetNumeric LPVOID pParam Example char key 128 char inputMessage int length 0 Encrypt LCD message by numeric key unsigned char ebuf 0x le 0x78 0x 19 0xa6 0xd9 0xa3 0xb8 0x35 0xce 0x47 0xcb 0x41 0xc4 0x Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 40 of 44 SmartPIN K100 C100 B100 API Reference Manual a0 0x5e 0xa4 0x3e 0x87 0x34 0x5a 0x86 0x80 0xd7 0x99 0xa2. Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 28 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 1 14 Sys_GetRealTime Function Na Sys GetRealTime Description This function is used to get real time form device Format BYTE WINAPI Sys GetRealTime char RealTime int Length Parameters Description Parameters Return string s format should beYear Month Date TimeStr K Hour Minute Second Length The length of time string Return Value Description TRUE Succeed to get real time from device Return Values FAIL Fail to get device time Others Please refer to error code table a Shall be used after COM OpenPort or COM OpenUSBHID This is supported by SmartPIN K 100 and B100 char realTime int res Length 0 Example CString str realTime char malloc 128 BYTE res Sys GetModel realTime amp Length Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 29 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 1 15 Sys_GetRemovalRecord uuu Sys_GetRemovalRecord Name Description This function is used to get removal record Format BYTE WINAPI Sys_GetRemovalRecord char LogString int Length Parameters Description lt Records Number gt lt Record Block gt lt Records Number gt is Number of Record Block
3. Return Values FALSE Fail to set LCD back light status Others Please refer to error code table ER Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 e bool Flag true BYTE res BackLight_ SetControl Flag 7 1 24 BackLight_ SetTimer A Backlight SetTimer Name E Description This function is used to set the during time of back light on Format BYTE WINAPI BackLight SetTimer int Timer Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 35 of 44 SmartPIN K100 C100 B100 API Reference Manual Parameters Description Parameters 0 LCD back light is never off 1 255 LCD back light is on during timer time Return Value Description TRUE Succeed to set LCD back light timer Return Values FALSE Fail to set LCD back light timer Others Please refer to error code table A Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 id int backlightTimer 10 p BYTE res BackLight SetTimer m backlightTimer 7 1 25 PIN GetPINBlock Pynson PIN GetPINBlock Name Description This function is used to get PIN block Bene PIN GetPINBlock char Key char EncryptMethod char AccountNumber int Plength char EncryptedPIN int Length Parameters Description Key Key type Value shall be KEY DUKPT o
4. TRUE Succeed to reset device Return Values FALSE Fails to reset device Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID Fxample BYTE res Sys Reset 7 1 13 Sys_ LoadTime Function Ne Sys_LoadTime Description This function is used to load time to device Format BYTE WINAPI Sys_LoadTime char TimeStr int Length Parameters Description Parameters i Time string If current time is 2011 05 23 08 21 45 TimeStr Time string should be 20110523082145 Length The length of time string Return Return Value Description Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 27 of 44 SmartPIN K100 C100 B100 API Reference Manual Values TRUE Succeed to finish loading time process FAIL Fail to finish loading time process Others Please refer to error code table Shall be used after COM OpenPort or COM OpenUSBHID Remarks This is supported by SmartPIN K100 and B100 CString CurTime char timeStr CTime t CTime GetCurrentTime int d t GetDay int y t GetYear int m t GetMonth int h t GetHour int mm t GetMinute int s t GetSecond CurTime Format 4d 02d 02d 02d 02d 02d y m d h mm s timeStr char malloc 14 for int I 0 1 lt 14 1 timeStr ij CurTimef i BYTE res Sys LoadTime timeStr 14 Example
5. If it is O there is not lt Record Block gt O lt Record Block gt has the following format of lt UserID gt lt State gt lt gt lt 4 bytes Year gt lt 2 bytes Parameters ARE Month gt lt 2 bytes Date gt lt gt lt 2 bytes Hour gt lt 2 og 5 bytes Minute gt lt gt Where lt UserID gt is 0x31 Userl or 0x32 User2 lt State gt is 0x30 Fix or 0x31 Removal Year Month Date Hour and Minute need be ASCII code Length The length of log string The Max length is 341 Return Value Description TRUE Succeed to load numeric key into device Return Values FAIL Fail to load numeric key into device Others Please refer to error code table Remake Shall be used after COM OpenPort or COM OpenUSBHID This is supported by SmartPIN K100 and B100 char logStr int Length 0 Example CString str logStr char malloc 500 BYTE res Sys GetRemovalRecord logStr amp Length Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 30 of 44 7 1 7 1 SmartPIN K100 C100 B100 API Reference Manual 16 Sound Control Ta o Sound Control Description This function is used to open or close beeper Format BYTE WINAPI Sound_Control bool Flag Parameters Description Parameters TRUE n FALSE Beep off Return Value Description RTA TRUE Succeed to open or close beeper Values FALSE Fails to open or close beeper Others Please refer t
6. Input plaintext Output encrypt data length Encrypt data block length Return Value Description Renee TRUE Succeed to encrypt raw data Values FAIL Fail to encrypt raw data Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID int len 0 char RawData CString str Welcome to Dll Demo m Result Example len str GetLength RawData char malloc len for int i 0 i lt len i RawDatali str i BYTE res KEY EncryptData RawData amp len 7 1 34 GetDlIVersion Eo n GetDlIVersion Name Description This function is used to get the current version of PinDII Format BYTE WINAPI GetDIIVersion char DlI Version int Length Parameters Description Parameters DIIVersion Return version string of DII version Length Return the length of DI version Return Value Description Kt TRUE Succeed to get DII version number Values FAIL Fail to get DII version number Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 43 of 44 SmartPIN K100 C100 B100 API Reference Manual Others Please refer to error code table Remarks None char DIIVersion int Length 0 DII Version char malloc 128 BYTE res GetDIIVersion DIIVersion amp Length Fxample Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 44 of 44
7. Version string Length The length of version string Return Value Description TRUE Succeed to get device version number Return Values FALSE Fails to get device version number Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID char version Fre int length 0 version char malloc 128 BYTE res Sys GetVersion version amp length 11 Sys GetModel Function a Sys GeModel Description This function is used to get device model number Format Sys GetModel char ModelNumber int Length Parameters Description Parameters Model number Model number string Length The length of model number string Return Value Description TRUE Succeed to get device model number Return Values FALSE Fails to get device model number Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID Example char version Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 26 of 44 SmartPIN K100 C100 B100 API Reference Manual int length 0 version char malloc 128 BYTE res Sys GetVersion version amp length 7 1 12 Sys_Reset Function Nan Sys_ Reset Description This function is used to reset device Format Sys Reset Parameters Description Parameters None None Return Value Description
8. oka Display Clear Description This function is used to clear the prompt in the specified line Format BYTE WINAPI Display Clear int Line Parameters Description Parameters 0x00 Clear the prompt in the first line 0x01 Clear the prompt in the second line OxFF Clear the prompt in both lines Return Value Description TRUE S d to cl t Been ucceed to clear promp Values FALSE Fails to clear prompt Others Please refer to error code table Roe Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 BYTE res 0 Example Clear top line message PS res Display Clear LCD TOP LINE Clear bottom line message Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 33 of 44 SmartPIN K100 C100 B100 API Reference Manual res Display_Clear LCD_BOTTOM LINE Clear all message res Display Clea LCD BOTH LINES 7 1 21 BackLight ReviewControl Men Backlight ReviewControl Name Description This function is used to review the status of LCD back light Format BYTE WINAPI BackLight ReviewControl bool Flag Parameters Description Parameters TRUE TIET LCD back light is on FALSE LCD back light is off Return Value Description TRUE Succeed to get LCD back light status Return Values FALSE Fails to get LCD back light status Others Please refer to error code ta
9. the prompt number which is going to showed The number range is 0 9 Return Value Description TRUE S d to display th t penne ucceed to display the promp Values FALSE Fails to display the prompt Others Please refer to error code table eerie Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 Example BYTE res Display_LoadPrompt 0 3 19 Display_SavePrompt Function a Display SavePrompt Description This function is used to save prompts into device Format BYTE WINAPI Display SavePrompt int Num char Message Parameters Description Parameters Num Prompt number is an index number of the prompt The Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 32 of 44 SmartPIN K100 C100 B100 API Reference Manual number range is 0 9 Prompt Prompt message The maximum of the prompt length is 12 Return Value Description TRUE Succeed to save prompt into the device Return Values FALSE Fails to save the prompt into the device Others Please refer to error code table Keane Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 char message IDTECH Example Int lineNumber 3 BYTE res Display SavePrompt lineNumber message 7 1 20 Display Clear Function K
10. 2 0x02 0x6f 0 x87 0xb9 0xf2 0x5a 0x2d 0x8d 0x33 0x2a 0x02 0x1a 0x89 0x18 0x08 0xed 0x3a 0x65 0x63 0x65 0xb7 0x70 0x46 0xea 0x31 0xe1 0x9f 0x89 0x5b 0x2 9 0x45 0x69 0x9d 0xac 0x22 0x48 0x7c 0xef 0xbd 0xf6 0x65 0x9a 0xb4 0x 0a 0x76 0x55 0xd5 0x48 0x10 0x67 0x2e 0xd2 0x61 0x4b 0xdd 0x98 0x2c 0x46 0xaa 0x5d 0x21 0x10 0xe0 0x37 0xbd 0xe7 0x63 0xce 0xcc 0xb0 0xe b 0x92 0x65 0x44 0x95 0xec 0x38 0x95 0xc7 0xc6 0xe9 0x7e 0x38 0x5f 0x 57 0x3e 0x23 0xc0 0x15 0x33 0x58 0xef 0x19 0xca 0x38 0xf0 0xf1 0x61 0 x61 0x2d 0x8a 0x28 0xal for int 1 0 1 lt 128 1 inputMessage i ebufli BYTE res PIN GetNumeric inputMessage 128 key amp length 7 1 31 PIN GetClearText U PIN GetClearText Name Description This function is used to get the clear text Format BYTE WINAPI PIN GetClearText char ClearTextPIN int Length Parameters Description Parameters ClearTextPIN Return clear text string length Return the length of clear text Return Value Description TRUE Succeed to get Plain text Return Values FAIL Fail to get Plain text Others Please refer to error code table Ree Shall be used after COM OpenPort or COM OpenUSBHID This one is supported by SmartPIN B100 and K100 Call thread TheadProc_GetClearText AfxBeginThread ThreadProc_GetClearText this EST HIS Define TreadProc GetClearText ES static UINT ThreadProc GetClearText LPVOID pParam i CString temp char key 128
11. Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 15 of 44 SmartPIN K100 C100 B100 API Reference Manual G MFC AppWizard Step 1 ax What type of application would you like to create Application Single document Multiple documents ch What language would you like your resources in English United States APPWZENU DLL w EEE Ax What features would you like to include I Context sensitive Help IV 3D controls What other support would you like to include I Automation IV ActiveX Controls Would you like to include WOSA support I Windows Sockets Please enter a title for pour dialog Test pplication H MFC AppWizard Step 3 of 4 Copyright O 2011 International Technologies amp Systems Corp All rights reserved Would you like to generate source file comments Yes please No thank you How would you like to use the MFC library Asashared DLL C As a statically linked library lt Back Einish Cancel Page 16 of 44 SmartPIN K100 C100 B100 API Reference Manual MEC Appiizard step 4 oF JE CT est pplication pp CT est pplicationDig Class name Header file CT est pplication pp Base class Implementation file lt Back Cancel 3 Now the Pin
12. Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 41 of 44 SmartPIN K100 C100 B100 API Reference Manual char encrypt int length 0 BYTE res PIN GetClearText key amp length j 7 1 32 KEY LoadMACKEY LT KEY LoadMACKEY Name Description This function is used to load Mac key Format BYTE WINAPI KEY LoadMACKEY char Key int length Parameters Description Parameters Key Mac key length Mac key length Return Value Description TRUE Succeed to load mac key to device Return Values FAIL Fail to load mac key to device Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID unsigned char buf 10xFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF OxFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF unsigned int len 0 char key o key char malloc 16 for int 1 0 1 lt 16 1 key 1 buf 1 int res KEY LoadMACKEY key 16 7 1 33 KEY EncryptData Function Name KEY EncryptData Description This function is used to encrypt message by Mac key Format BYTE WINAPI KEY EncryptData char RawData int length Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 42 of 44 SmartPIN K100 C100 B100 API Reference Manual Parameters Description Parameters RawData
13. DII dll is willing to link statically with the TestApplication just created 4 Provide Header file path for pin h and pinDII lib as path of the Include folder to Tools gt Options gt Directories Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 17 of 44 SmartPIN K100 C100 B100 API Reference Manual amp TestApplication Microsoft Visual C TestApplication rc IDD TESTAPPLICATION DIALC Erie Edit View Insert Project Build Layout Tools Window Help als ae sel2 c Source Browser Alt F12 A Visual Component Manager A Register Control A Error Lookup A ActiveX Control Test Container A OLEICOM Object Viewer A Spy A MFC Tracer G TestApplication resources Customize Play Quick Macro ma ClassView e ResourceVView E FileView lale Options Editor Tabs Debug Compatibility Build Directories Platform Show directories for win32 v Include files v Directories y y Program Files Micro isual StudioVWWC98YMFCYNCLUDE lt C Program Files Microsoft Cancel 5 Provide Library path for pinDII lib as path of the Include folder to Project gt Settings gt Link gt Object library modules Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 18 of 44 SmartPIN K100 C100 B100 API Reference Manual amp Tes
14. IDT CH Value through Innovation USER MANUAL SmartPIN K100 C100 B100 API User Manual 80111502 001 51 09 01 2011 SmartPIN K100 C100 B100 API Reference Manual Software License Agreement CAREFULLY READ ALL THE TERMS CONDITIONS AND RESTRICTIONS OF THIS LICENSE AGREEMENT BEFORE USING OR INSTALLING THE SOFTWARE YOUR USE OR INSTALLATION OF THE SOFTWARE PRESUMES YOUR AGREEMENT WITH AND ACCEPTANCE OF THE TERMS CONDITIONS AND RESTRICTIONS CONTAINED IN THIS AGREEMENT IF YOU DO NOT AGREE WITH THESE TERMS CONDITIONS AND RESTRICTIONS PROMPTLY RETURN THE SOFTWARE AND RELATED DOCUMENTATION TO ID TECH Support 10721 Walker Street Cypress CA 90630 TERMS CONDITIONS AND RESTRICTIONS ID TECH Incorporated the Licensor owns and has the right to distribute the described software and documentation collectively referred to as the Software LICENSE Licensor grants you the Licensee the right to use the Software in conjunction with ID TECH products LICENSEE MAY NOT COPY MODIFY OR TRANSFER THE SOFTWARE IN WHOLE OR IN PART EXCEPT AS EXPRESSLY PROVIDED IN THIS AGREEMENT Licensee may not decompile disassemble or in any other manner attempt to reverse engineer the Software Licensee shall not tamper with bypass or alter any security features of the software or attempt to do so TRANSFER Licensee may not transfer the Software or license to the Software to another party without prior written authorization of the Licensor I
15. Manual dls KEY EnciypiDala ida aid PMc 34 gt GetDI Version urtene it lea tes Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 6 of 44 SmartPIN K100 C100 B100 API Reference Manual 1 0 Introduction The SmartPIN K100 C100 B100 API is to be used by the host applications to access the PIN Pad functions This document provides information for using the API which supports both USB and RS232 interfaces SmartPIN K100 C100 B100 device The operation and parameters for each API functions are listed in this document 1 1 Availability Sample dll calls are provided to show how to use the API commands in single thread method and in a multi threaded method 1 2 Usage This API can be use in any Windows based development environment such as Visual Studio Delphi etc Put the header files library files and DLL required for API into your setup program folder To successfully use all the functions that DLL includes it is required to open the COM port using function COM OpenPort or open the USB port using function com OpenUSBHID Function Com OpenPort and function Com ClosePort must be called again after changing any communication parameters Baud rate Stop bit Parity Data bit and the updated parameters must be used to open the COM port 2 0 Important Notes e For functions with required preconditions please ensure the preconditions are satisfied before making the function calls Failu
16. N K100 C100 B100 API Reference Manual 5 0 SmartPIN K100 C100 B100 SDK Error Code Description SmartPIN K100 C100 B100 SDK return error codes are listed below Error Code Error Name Error Description 0 FAIL Fail 1 SUCCESS Success 50 ERR NOT SUPPORTED Device not support this function 99 ERR PARAMETER Input parameter is not supported by device 100 ERR UNKNOWN Unknown error 101 ERR INVALID COMMAND Protocol is right but task ID is invalid 102 ERR COMMAND Protocol is wrong Timeout for Get Fun key amp Get 103 ERR_TIME OUT Encrypted PIN amp Get Plaintext PIN 104 ERR UNIT SUSPENDED Unit is suspended 105 ERR CANCELED Exit from Get PIN mode or Get plaintext gt mode by cancel command 106 ERR ABORTED Exit from Get IN made or Get plaintext mode by press cancel key 107 ERR KEY TYPE Key type was not supported by device 108 ERR NO KEY No DUKPT key or MKSK key 109 ERR NO PROMPT No prompt during get numeric key to device 110 ERR CONFIG FAIL Save or Config Failed Or Read i Config Error 111 ERR BOOTLOAD FAIL ee Block Number update 112 ERR CHECKVALUE LOADED Device was working under loading check ME 5 value mode 113 ERR LOADING KEY PROCESS Device was working under loading key mode Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 13 of 44 SmartPIN K100 C100 B100 API Reference Manua
17. SmartPIN K100 C100 B100 API Reference Manual Return Value Description TRUE Succeed to review the current parity rate of device Return Values FALSE Fails to review the current parity rate of device Others Please refer to error code table Remarks Shall be used after COM OpenPort char parity El BYTE res Com GetParity parity 7 1 9 Com GetStopBit Function Name Com_GetStopBit Description This function is used to get the current stop bit in the device Format BYTE WINAPI Com_GetStopBit char Stopbit Parameters Description Bane PARITY_NONE None Parameters PARITY ODD Odd PARITY EVEN Even Return Value Description TRUE Succeed to review the current stop bit in the device Return Values FALSE Fails to review the current stop bit in the device Others Please refer to error code table Remarks Shall be used after COM OpenPort x it Senge char stopBit BYTE res Com_GetStopBit stopBit 7 1 10 Sys_GetVersion Function Sys_GetVersion Name Ys Description This function is used to get device firmware version Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 25 of 44 7 1 SmartPIN K100 C100 B100 API Reference Manual Format Sys GetVersion char Version int Length Parameters Description Parameters VER ISTO
18. as performed successfully serial communication Remarks should be set up with new stop bit int Stopbit STOP BIT ONE Example SVS BYTE res Com SetStopBit Stopbit Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 23 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 1 7 Com GetBaud Function Name Com_GetBaud Description This function is used to get the current baud rate from device Format BYTE WINAPI Com GetBaud char Baud Parameters Description BAUDRATE_2400 Baud rate 2400 BAUDRATE 4800 Baud rate 4800 Parameters Baud BAUDRATE 9600 Baud rate 9600 BAUDRATE 19200 Baud rate 19200 BAUDRATE 38400 Baud rate 38400 BAUDRATE 115200 Baud ratel 15200 Return Value Description TRUE Succeed to get baud rate Return Values FALSE Fail to get baud rate Others Please refer to error code table Remarks Shall be used after COM OpenPort eae char baud p BYTE res Com_GetBaud baud 7 1 8 Com GetParity Function Name Com_GetParity Description This function is used to get the current parity rate from device Format BYTE WINAPI Com GetParity char Parity Parameters Description Pano PARITY_NONE None Parameters Parity PARITY ODD Odd PARITY EVEN Even Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 24 of 44
19. ble OR Shall be used after COM OpenPort or COM OpenUSBHID This function is only support by SmartPIN C100 Pa bool backlight ie BYTE res BackLight ReviewControl amp backlight 71 22 BackLight ReviewTimer EN Backlight ReviewTimer Name E Description This function is used to review the timer of back light on Format BYTE WINAPI BackLight ReviewTimer int Timer Parameters Description Parameters 0 LCD back light never off 1 255 LCD back light is on After timer time turn off Return Return Value Description Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 34 of 44 SmartPIN K100 C100 B100 API Reference Manual Values TRUE Succeed to get LCD back light timer setting FALSE Fail to get LCD back light timer setting Others Please refer to error code table Shall be used after COM OpenPort or COM OpenUSBHID Remarks This function is only support by SmartPIN C100 int backlightTimer BYTE res BackLight ReviewTimer backlightTimer Example 7 1 23 BackLight SetControl rongo Backlight SetControl Name Description This function is used to change back light on or off Format BYTE WINAPI BackLight SetControl bool Flag Parameters Description Parameters TRUE 3 7 LCD back light is on OFF LCD back light is off Return Value Description TRUE Succeed to set LCD back light status
20. e Device Self test Module and System Information Module The features of SmartPIN K100 C100 B100 devices are grouped in those seven modules The modules need to be initialized before the function can be used Here is a list of the modules and the functions included Module Name Function Name Com_OpenPort Com_ClosePort Com_SetBaud Com_GetBaud Communication Control Com_SetParity Com_GetParity Com_SetStopBit Com_GetStopBit Com_OpenUSBHID Sound_Control Sound_ Control Sound_ Tone Display LoadPrompt Display Control Display SavePrompt Display Clear BackLight SetControl BackLight ReviewControl BackLight Control BackLight SetTimer BackLight ReviewTimer PIN GetPINBlock PIN GetFuncKey PIN Control PIN CancelEnter PIN SetPINLength PIN GetPINLength Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 11 of 44 SmartPIN K100 C100 B100 API Reference Manual KEY GetRemovalRecord KEY Management Control KEY LoadMACKEY KEY EncryptData Sys GetVersion Sys GetModel Sys Reset System Information Sys LoadTime Sys GetRealTime GetDII Version The details for each function can be found in the function description section Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 12 of 44 SmartPI
21. e Description Key 0x43 Cancel key 0x42 Backspace Key 0x45 Enter Key ST 0x46 0x31 FI Key 0x46 0x32 F2 Key k key H Key we 9 key Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 37 of 44 SmartPIN K100 C100 B100 API Reference Manual Return Value Description en TRUE Succeed to get function key Values FAIL Fail to get function key Others Please refer to error code table Shall be used after COM OpenPort or COM OpenUSBHID Remarks SmartPIN C100 no and key SmartPIN K100 B100 no F1 and F key char key 128 char encrypt Example int length 0 int res 0 res PIN GetFuncKey key amp length 7 1 27 PIN_CancelEnter N PIN CancelEnter Name Description This function is used to cancel get PIN proess or get plaintext process Format BYTE WINAPI PIN CancelFnter Parameters Value Description Parameters No parameter Return Value Description TRUE Succeed to cancel PIN process Return Values FAIL Fail to cancel PIN process Others Please refer to error code table Shall be used after COM OpenPort or COM OpenUSBHID Remarks This function shall return with an error if device isn t working on get PIN or get plaintext process Example BYTE res PIN_CancelEnter Copyright 2011 International Technologies amp Systems Corp All rights rese
22. echnologies amp Systems Corp All rights reserved Page 2 of 44 SmartPIN K100 C100 B100 API Reference Manual IN NO EVENT WILL LICENSOR BE LIABLE FOR ANY DAMAGES INCLUDING ANY LOST PROFITS LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE Licensee s sole remedy in the event of a defect in material or workmanship is expressly limited to replacement of the Software disk s if applicable GOVERNING LAW If any provision of this Agreement is found to be unlawful void or unenforceable that provision shall be removed from consideration under this Agreement and will not affect the enforceability of any of the remaining provisions This Agreement shall be governed by the laws of the State of California and shall insure to the benefit of ID TECH Incorporated its successors or assigns ACKNOWLEDGMENT LICENSEE ACKNOWLEDGES THAT HE HAS READ THIS AGREEMENT UNDERSTANDS ALL OF ITS TERMS CONDITIONS AND RESTRICTIONS AND AGREES TO BE BOUND BY THEM LICENSEE ALSO AGREES THAT THIS AGREEMENT SUPERSEDES ANY AND ALL VERBAL AND WRITTEN COMMUNICATIONS BETWEEN LICENSOR AND LICENSEE OR THEIR ASSIGNS RELATING TO THE SUBJECT MATTER OF THIS AGREEMENT QUESTIONS REGARDING THIS AGREEMENT SHOULD BE ADDRESSED IN WRITING TO ID TECH INCORPORATED ATTENTION CUSTOMER SUPPORT AT THE ABOVE ADDRESS OR E MAILED TO support idtechproducts com Information Provided The information contained herein is p
23. ers Please refer to error code table ene If this function was performed successfully serial communication should be set up with new baud rate rele long ani PAUDE TE e BYTE res Com SetBaud baud 7 1 5 COM SetParity Function Name COM SetParity Description This function is used to set new parity to device Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 22 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 1 6 Format BYTE WINAPI Com SetParity char Parity Parameters Description PARITY NONE None Parameters Parity PARITY ODD Odd PARITY EVEN Even Return Value Description TRUE Succeed to set new parity to device Return Values FALSE Fails to set new parity to device Others Please refer to error code table If this function was performed successfully serial communication Remarks should be set up with new parity TA char parity PARITY NONE i BYTE res Com SetParity parity Com SetStopBit Function Name Com SetStopBit Description This function is used to set new stop bit to device Format BYTE WINAPI Com SetStopBit int Stopbit Parameters Description Parameters Stopbit STOP BIT ONE 1 bit STOP BIT TWO 2 bits Return Value Description Return Values TRUE Succeed to set new stop bit to device FALSE Fails to set new stop bit to device If this function w
24. f Licensee transfers the Software without authorization all rights granted under this Agreement are automatically terminated COPYRIGHT The Software is copyrighted Licensee may not copy the Software except to archive the Software or to load the Software for execution purposes All other copies of the Software are in violation of this Agreement TERM This Agreement is in effect as long as Licensee continues the use of the Software The Licensor also reserves the right to terminate this Agreement if Licensee fails to comply with any of the terms conditions or restrictions contained herein Should Licensor terminate this Agreement due to Licensee s failure to comply Licensee agrees to return the Software to Licensor Receipt of returned Software by the Licensor shall mark the termination LIMITED WARRANTY Licensor warrants to the Licensee that the disk s or other media on which the Software is recorded to be free from defects in material or workmanship under normal use THE SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EITHER EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE Because of the diversity of conditions and PC hardware under which the Software may be used Licensor does not warrant that the Software will meet Licensee specifications or that the operation of the Software will be uninterrupted or free of errors Copyright 2011 International T
25. itecture 5 0 SmartPIN K100 C100 B100 SDK Error Code Description 6 0 Getting Started with SmartPIN K100 C100 B100 SDK Table of Contents 6 1 Sample Application development using VC 6 uuussuses n a na na na na naene naan aeen 7 0 Function Description 7 1 Detailed Description on Functions of Reader Control Module uusssssn nnen 7 1 1 7 1 2 7 1 3 7 1 4 7 1 5 7 1 6 7 1 7 7 1 8 7 1 9 7 1 10 7 1 11 7 1 12 7 1 13 7 1 14 7 1 15 7 1 16 7 1 17 7 1 18 7 1 19 7 1 20 7 1 21 PAZ 7 1 23 7 1 24 11 25 7 1 26 1 1 27 7 1 28 7 1 29 7 1 30 7 1 31 7 1 32 COM OP n eoon iiai aE E aE nde COM Close Oia a la a a a n a e erai COM Op SiS EID ieie econ taa CONTO Ud E AE E R a i COM SREP ATi amma kissaa it e G Com SES HOP BIL ve om GBL RS bn om GP Ge Com CISL A NE ON RTS SVS GENMNO A E sates alate denied AA PV RR Sys A PE GERE mes Sys ATetR emovalBecondsumaa maa vsem auma keen audi SE La So o r in Display bodPronmpi 444427 ANE DIS Play SAV S PROM sia tinea sun MIN Set l iia DN A EE BackLight BevicWGonttol amsamustaa esim didas Backlight Review O NNN Bakte Set Onto dad PT STN See PIN CHEE BINS A ee PNG FN Celies FIN SEP iv PIN OSI PIN E Ci gth speed dier PES ETSIN UNMIS TICS EN FIN GET LSAT Cx sista ADN KEY LoadMACKEY re Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 5 of 44 SmartPIN K100 C100 B100 API Reference
26. l 114 ERR SELF TEST PROCESS Device was working under self test mode 115 ERR MAXO DISCONNECTTED Security Chip is not connect 116 ERR UNIT DEACTIVE Security Chip and MCU were both deactivation 117 ERR MAXO DEACTIVE Security Chip was d deactivation 118 ERR MCU DEACTIVE MCU was d deactivation 119 ERR NO FIRMWARE KEY Firmware Key was not existed in the ka device 121 ERR_MAXQ SUSPEND Security Chip is suspend 122 ERR DUKPT KEY NO USED DUKPT is stop 21 bit 1 125 ERR FULL LOG Fix Removal records are more than 20 126 ERR TIME LOADED Device time has been loaded to the device 127 ERR ST DEACTIVE Security Chip are all deactivation 128 ERR ST AND MAXO DEACTIVE MEU Me deactivation 200 PORT OPENED Communication port was opened 201 PORT CLOSED Communication port was closed 202 ERR DEVICE BUSY Device was working under get pin mode or get plaintext mode 203 CLEAR TEXT MODEL Plain Text mode 204 ERR NO FILE Software was not found the special file Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 14 of 44 SmartPIN K100 C100 B100 API Reference Manual 6 0 Getting Started with SmartPIN K100 C100 B100 SDK Few examples with source code samples will be covered here for application developer s reference The documentation will illustrate start on application development with SmartPIN SDK using two prog
27. ling RS232 or USB type devices Processing SmartPIN device Data encoding decoding with the specific byte level data for valid communication packet structure commands Make Direct IO calls independent on Reader Abstraction Jac Raw data processing to from data processing mechanism and SmartPIN device and first level data verification and validation provide raw data to from SmartPIN device Generic SDK Consists with 8 modules for key controls on SmartPIN device Abstracts the 7 modules 1 Serial Communication Sound control Display control Backlight control PIN control Device self test control Key management control General information DNR OD SDK Presentation Layer Export SmartPIN K100 C100 B100 Native SDK API functions Exports the SmartPIN K100 C100 B100 Native SDK API functions Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 9 of 44 SmartPIN K100 C100 B100 API Reference Manual 4 0 SmartPIN K100 C100 SDK Systems Architecture System Architecture SmartPIN K100 C100 SDK Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 10 of 44 SmartPIN K100 C100 B100 API Reference Manual The SmartPIN K100 C100 B100 SDK is consisted of seven modules PIN Handle Module Backlight Control Module Sound Control Module Display Control Module Key Management Modul
28. mitted and DataBit received Parity Specifies the parity scheme to be used StopBit Specifies the number of stop bits to be used Baud Rate Index Description BAUDRATE 2400 Baud Rate 2400 Bard BAUDRATE 4800 Baud Rate 4800 aud sates BAUDRATE 9600 Baud Rate 9600 BAUDRATE 19200 Baud Rate 19200 BAUDRATE 38400 Baud Rate 38400 BAUDRATE 115200 Baud Rate 115200 Parity Index Description Parameter Values PARITY NONE None Parity PARITY ODD ODD PARITY EVEN EVEN Stop Bit Index Description Stop Bits STOP BIT ONE 1 stop bit STOP BIT TWO 2 stop bits Remi TRUE Open port success vas FALSE Fail to open port or port was opened Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 20 of 44 SmartPIN K100 C100 B100 API Reference Manual Others Please refer to error code table Function could fail if the requested COM port is not available Remarks Function could fail if device is not available Function could fail if the requested COM port was opened Example BYTE res Com_OpenPort 1 38400 N 1 8 7 1 2 COM ClosePort J COM ClosePort Name ca Be This function is used to terminate the communication which is already Pa established byCOM OpenPort or Com OpenUSBHID Format BOOL WINAPI Com ClosePort Parameters N A Return value Description TRUE Success to close established port Retur
29. n Values FALSE Fail to close established port Others Please refer to error code table Function could fail if the COM ClosePort established port cannot be Remarks Z closed Example bool res Com ClosePort 7 1 3 COM OpenUSBHID unci n COM OpenUSBHID Name ae This function is used to control the device beeper with user defined Description duration Format BYTE WINAPI Com OpenUSBHID Parameters none Return Value Description Return Values TRUE Success to open the required USB device Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 21 of 44 SmartPIN K100 C100 B100 API Reference Manual FALSE Fail to open the required USB device Others Please refer to error code table Remarks Function could fail if the required USB Device cannot be found by PC Example BYTE res Com OpenUSBHID 7 1 4 COM SetBaud Function Name COM SetBaud Description This function is used to set device baud Format BYTE WINAPI Com SetBaud long Baud Parameters Description BAUDRATE 2400 Baud rate 2400 BAUDRATE 4800 Baud rate 4800 Parameters Baud BAUDRATE 9600 Baud rate 9600 BAUDRATE 19200 Baud rate 19200 BAUDRATE 38400 Baud rate 38400 BAUDRATE 115200 Baud ratel 15200 Return Value Description TRUE Succeed to set new baud rate to device Return Values FALSE Fails to set new baud to device Oth
30. o error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID Bre bool Flag true BYTE res Sound Control Flag 17 Sound Tone econ Sound Tone Name Description This function is used to set the frequency or duration of the beeper sound Format BYTE WINAPI Sound_Tone long Frequency long Duration Parameters Description Frequency Smart PIN K100 B100 Frequency need be more than 500 Parameters and less than 10000 Smart PIN C100 Frequency need be more than 1000 and less than 20000 Duration Duration need be more than 16 and less than 65535 Return Value Description Return TRUE Succeed to set sound Values FALSE Fails to set sound Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 31 of 44 7 1 7 1 SmartPIN K100 C100 B100 API Reference Manual Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID Example BYTE res Sound_Tone 2000 300 18 Display LoadPrompt Function Ni o Display LoadPrompt Dean This function is used to display the required Prompt at the required line number of LCD Format BYTE WINAPI Display LoadPrompt int LineNum int PromptNum Parameters Description Parameters LineNum To indicate the line number which show the prompt The value should be 0 or I Prompt To indicate
31. r Key MKSK Encrypt Method Encrypt PIN block method Value shall be Parmer ENCRYPTION TDES or ENCRYPTION DES AccountNumber Account Number string pLength Account number length Length should be less than 20 and more than 12 EncryptPIN Device returned the encrypt PIN block data Length Returned PIN block data length Reurm Return Value Description Values TRUE Succeed to get PIN Block Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 36 of 44 SmartPIN K100 C100 B100 API Reference Manual FAIL Fail to get PIN Block Others Please refer to error code table Shall be used after COM OpenPort or COM OpenUSBHID The encrypt PIN block shall be returned after enter PIN and Enter key from device Returned PIN block is encrypted block Remarks Call thread TheadProc GetPIN AfxBeginThread ThreadProc GetPIN this Define TreadProc GetPIN static UINT ThreadProcGetPIN LPVOID pParam char key KEY DUKPT char encrypt DK ENCRYPTION TDES int length 0 char EncryptedPIN 256 char AccountNumber 40123456789012345678 BYTE res PIN GetPINBlock key encrypt AccountNumber 20 EncryptedPIN amp length j Example 7 1 26 PIN_GetFunKey Ua PIN GetFunKey Description This function is used to get function key Format BYTE WINAPI PIN GetFuncKey char Key int Length Parameters Valu
32. ramming languages Visual C 6 and Visual Basic 6 SDK will provide an Include package which consists with the required dynamic link library files dll library files lib and header files h 6 1 Sample Application development using VC 6 Create a Test Application for SmartPIN K100 C100 B100 SDK to retrieve Device Firmware Version Please follow the below steps 1 Put pinDII dll Pin h and PinDIl lib into develop folder 2 Run Microsoft Visual C 6 and create a dialog based MFC AppWizard exe using File gt New Projects Tab Give a suitable name TestApplication for the project and the location Moreover click next button while customizing the dialog application follow the steps given Ctrl N Ctrl 0 Open Workspace hev we Files Projects e Cluster Reso 8 Custom AppWIN Ey Database Project ES DevStudio Add in Wizard E Extended Stored Proc Wizard 6 Other Documents Dect name TestApplication Win32 Dynamic Link Library Win32 Static Library Location D SDK Project TestApplication JA InstallShield Object Wizard ISAPI Extension Wizard Create new workspace Recent Files gt Recent Workspaces gt EZ Exit Tf Utility Project A Win32 Application Win32 Console Application pu I E Cancel b Build Debug Creates a new documer
33. re to meet the precondition might result in unexpected errors e Do not rely on observed or incidental behavior Incidental behavior is behavior observed by experiment or in practice and is not guaranteed by specification e Do not treat a null as an object or parameter Assume nulls are being used unless specifically required in the API specifications e The application must assume that the function post conditions are met upon the return of function calls e In function calls do not modify a mutable object when it s being passed as a function parameter e Thread safety must be taken into consideration when programming a multi threaded application Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 7 of 44 3 0 SmartPIN K100 C100 B100 SDK Levels SmartPIN K100 C100 B100 General Systems Architecture Extended Firmware Access m PINpad service Direct IO lt Smart PIN K100 C100 SDK General System Architecture SmartPIN K100 C100 B100 SDK Copyright O 2011 International Technologies amp Systems Corp All rights reserved Page 8 of 44 SmartPIN K100 C100 B100 API Reference Manual SDK Layer Responsibility Description Facilitate the low level This Class handles the Serial USB Serial Class USB communication interface HID communication between the host HID Class between RS232 or USB andthe side and device This is capable of SmartPIN device hand
34. rovided to the user as a convenience The software and documentation provided were current at the time of publication however they are subject to change at any time without prior notice Proprietary amp Trademark Statements This document contains proprietary information of ID TECH Its receipt or possession does not convey any rights to reproduce or disclose its contents or to manufacture use or sell anything it may describe Reproduction disclosure or use without specific written authorization from ID TECH is strictly forbidden Copyright 2011 International Technologies amp Systems Corporation All rights reserved ID TECH is a registered trademark of International Technologies amp Systems Corporation Value through Innovation and SmartPIN are trademarks of International Technologies amp Systems Corporation Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 3 of 44 SmartPIN K100 C100 B100 API Reference Manual Revision History Rev Date Description of Changes By 50 07 01 2011 Initial Draft JW 51 09 01 2011 Revised and added function examples JW Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 4 of 44 SmartPIN K100 C100 B100 API Reference Manual 1 0 Introduction 1 1 Availability 1 2 Usage 2 0 Important Notes 3 0 SmartPIN K100 C100 B100 SDK Levels 4 0 SmartPIN K100 C100 SDK Systems Arch
35. rved Page 38 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 1 28 PIN SetPINLength Function Ke PIN SetPINLength Description This function is used to set the maximum and minimum length during PIN Format BYTE WINAPI PIN SetPINLength int Minlen int Maxlen Parameters Value Description Parameters minLen 4 maxLen The Minimum of the PIN length maxLen minLen 12 The Maximum of the PIN length Return Value Description TRUE Succeed to set the length of PIN Block Return Values FAIL Fail to set the length of PIN Block Others Please refer to error code table Remarks Shall be used after COM OpenPort or COM OpenUSBHID int minLen 4 Example int maxLen 12 BYTE res PIN SetPINLength minLen maxLen 7 1 29 PIN_GetPINLength Function KS PIN GetPINLength Description This function is used to get the maximum and minimum length during PIN Format BYTE WINAPI PIN GetPINLength int Minlen int Maxlen Parameters Description Parameters minLen The Minimum of the PIN length maxLen The Maximum of the PIN length Return Value Description O TRUE Succeed to get the length of PIN Block Values FAIL Fail to get the length of PIN Block Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 39 of 44 SmartPIN K100 C100 B100 API Reference Manual
36. tApplication Microsoft Visual C TestApplication rc E file Edit view Insert Project Build Layout Tools Window Help a sE G Y Set Active Project gt in 7 p Add To Project i J BL oy Source Control E TestApplication Project Settings we Settings For win32 Debug General Debug C C Link Resouret Category General v Beset Output file name Debug T est pplication exe Object library modules Pind1l lib IV Generate debug info Ignore all default libraries IV Link incrementally I Generate mapfile I Enable profiling Copyright 2011 International Technologies amp Systems Corp All rights reserved Page 19 of 44 SmartPIN K100 C100 B100 API Reference Manual 7 0 Function Description 7 1 Detailed Description on Functions of Reader Control Module Palot COM OpenPort Function KR COM OpenPort MLS Function used to establish a communication for a given RS232 port with its Description e communication parameters b BYTE WINAPI Com OpenPort int Comport long Baud char Parity int Format Stop int DataBit Conor Pointer to a null terminated string that specifies the name of P the COM port in format x Here x should be an integer Em Specifies the baud rate at which the communication device operates Parameters E Specifies the number of bits in the bytes trans
Download Pdf Manuals
Related Search