![]() |
IDTech Universal SDK
1.0.35.038
API reference for C++
|
L80 API. More...
#include "IDTDef.h"
Go to the source code of this file.
Macros | |
#define | IN |
#define | OUT |
#define | IN_OUT |
Typedefs | |
typedef void(* | pMessageHotplug) (int, int) |
typedef void(* | pSendDataLog) (BYTE *, int) |
typedef void(* | pReadDataLog) (BYTE *, int) |
typedef void(* | pEMV_callBack) (int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int) |
typedef void(* | pMSR_callBack) (int, IDTMSRData) |
typedef void(* | pMSR_callBackp) (int, IDTMSRData *) |
typedef void(* | pPIN_callBack) (int, IDTPINData *) |
typedef void(* | pCMR_callBack) (int, IDTCMRData *) |
typedef void(* | pCSFS_callBack) (BYTE status) |
typedef void(* | pFW_callBack) (int, int, int, int, int) |
typedef void(* | ftpComm_callBack) (int, int, int) |
typedef void(* | httpComm_callBack) (BYTE *, int) |
typedef void(* | v4Comm_callBack) (BYTE, BYTE, BYTE *, int) |
Functions | |
void | registerHotplugCallBk (pMessageHotplug pMsgHotplug) |
void | registerLogCallBk (pSendDataLog pFSend, pReadDataLog pFRead) |
void | emv_registerCallBk (pEMV_callBack pEMVf) |
void | msr_registerCallBk (pMSR_callBack pMSRf) |
void | msr_registerCallBkp (pMSR_callBackp pMSRf) |
void | pin_registerCallBk (pPIN_callBack pPINf) |
void | device_registerCameraCallBk (pCMR_callBack pCMRf) |
void | device_registerCardStatusFrontSwitchCallBk (pCSFS_callBack pCSFSf) |
void | device_registerFWCallBk (pFW_callBack pFWf) |
char * | SDK_Version () |
int | setAbsoluteLibraryPath (const char *absoluteLibraryPath) |
int | device_init () |
int | device_setCurrentDevice (int deviceType) |
int | device_close () |
void | device_getResponseCodeString (IN int returnCode, OUT char *despcrition) |
int | device_isConnected () |
int | device_isAttached (int deviceType) |
int | device_getFirmwareVersion (OUT char *firmwareVersion) |
int | device_getFirmwareVersion_Len (OUT char *firmwareVersion, IN_OUT int *firmwareVersionLen) |
int | device_getDateTime (OUT BYTE *dateTime) |
int | device_getDateTime_Len (OUT BYTE *dateTime, IN_OUT int *dateTimeLen) |
int | device_getCurrentDeviceType () |
int | device_SendDataCommand (IN BYTE *cmd, IN int cmdLen, IN BYTE *data, IN int dataLen, OUT BYTE *response, IN_OUT int *respLen) |
int | device_updateFirmware (IN BYTE *firmwareData, IN int firmwareDataLen, IN char *firmwareName, IN int encryptionType, IN BYTE *keyBlob, IN int keyBlobLen) |
int | device_rebootDevice () |
int | device_getKeyStatus (int *newFormat, BYTE *status, int *statusLen) |
int | device_enterStopMode () |
int | device_setSleepModeTime (int time) |
int | config_getModelNumber (OUT char *sNumber) |
int | config_getModelNumber_Len (OUT char *sNumber, IN_OUT int *sNumberLen) |
int | config_getSerialNumber (OUT char *sNumber) |
int | config_getSerialNumber_Len (OUT char *sNumber, IN_OUT int *sNumberLen) |
int | pin_getEncryptedPIN (int keyType, char *PAN, int PANLen, char *message, int messageLen, int timeout) |
int | pin_promptForKeyInput (int messageID, int languageID, int maskInput, int minLen, int maxLen, int timeout) |
int | pin_promptForAmountInput (int messageID, int languageID, int minLen, int maxLen, int timeout) |
int | pin_getFunctionKey (int timeout) |
int | pin_sendBeep (int frequency, int duration) |
int | pin_setKeyValues (int mode) |
int | lcd_savePrompt (int promptNumber, char *prompt, int promptLen) |
int | lcd_displayPrompt (int promptNumber, int lineNumber) |
int | lcd_displayMessage (int lineNumber, char *message, int messageLen) |
int | lcd_enableBacklight (int enable) |
int | lcd_getBacklightStatus (int *enabled) |
L80 API.
L80 Global API methods.
#define IN |
INPUT parameter.
#define IN_OUT |
INPUT / OUTPUT PARAMETER.
#define OUT |
OUTPUT parameter.
typedef void(* ftpComm_callBack) (int, int, int) |
Define the comm callback function to get FTP file transfer status
It should be passed as a parameter in a FTP request, Signature (int, int, int) = response code, current block, total blocks RESPONSE CODES: 100 = FILE DOWNLOAD STARTED 101 = FILE BLOCK XX OF XX RECEIVED 102 = FILE DOWNLOAD COMPLETED 103 = FILE DOWNLOAD TERMINATED PREMATURELY
typedef void(* httpComm_callBack) (BYTE *, int) |
Define the comm callback function to get the async url data
It should be registered using the comm_registerHTTPCallback
typedef void(* pCMR_callBack) (int, IDTCMRData *) |
Define the camera callback function to get the image data
It should be registered using the device_registerCameraCallBk,
typedef void(* pCSFS_callBack) (BYTE status) |
Define the card status and front switch callback function to get card and front switch status
It should be registered using the device_registerCardStatusFrontSwitchCallBk,
typedef void(* pEMV_callBack) (int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int) |
Define the EMV callback function to get the transaction message/data/result.
It should be registered using the emv_registerCallBk,
typedef void(* pFW_callBack) (int, int, int, int, int) |
Define the firmware update callback function to get the status of firmware update
It should be registered using the device_registerFWCallBk,
typedef void(* pMessageHotplug) (int, int) |
Define the USB hot-plug callback function to monitor the info when plug in/out the reader.
It should be registered using the registerHotplugCallBk, The first integer parameter is device type, and the second integer parameter is either 0: Device Plugged Out or 1: Device Plugged In
typedef void(* pMSR_callBack) (int, IDTMSRData) |
Define the MSR callback function to get the MSR card data
It should be registered using the msr_registerCallBk, this callback function is for backward compatibility
typedef void(* pMSR_callBackp) (int, IDTMSRData *) |
Define the MSR callback function to get pointer to the MSR card data
It should be registered using the msr_registerCallBk, this callback function is recommended instead of pMSR_callBack
typedef void(* pPIN_callBack) (int, IDTPINData *) |
Define the PINPad callback function to get the input PIN Pad data
It should be registered using the pin_registerCallBk,
typedef void(* pReadDataLog) (BYTE *, int) |
Define the read response callback function to monitor the reading response from the reader.
It should be registered using the registerLogCallBk,
typedef void(* pSendDataLog) (BYTE *, int) |
Define the send command callback function to monitor the sending command into the reader.
It should be registered using the registerLogCallBk,
typedef void(* v4Comm_callBack) (BYTE, BYTE, BYTE *, int) |
Define the comm callback function to receive the V4 Protocol packets received by the device from an external source (IP/USB/RS-232) It should be registered using the comm_registerV4Callback, Data callback will contain command, sub-command, and data from V4 packet
int config_getModelNumber | ( | OUT char * | sNumber | ) |
DEPRECATED : please use config_getModelNumber_Len(OUT char* sNumber, IN_OUT int *sNumberLen)
Polls device for Model Number
sNumber | Returns Model Number; needs to have at least 64 bytes of memory |
Polls device for Model Number
sNumber | Returns Model Number |
sNumber | length of Model Number |
int config_getSerialNumber | ( | OUT char * | sNumber | ) |
DEPRECATED : please use config_getSerialNumber_Len(OUT char* sNumber, IN_OUT int *sNumberLen)
Polls device for Serial Number
sNumber | Returns Serial Number; needs to have at least 64 bytes of memory |
Polls device for Serial Number
sNumber | Returns Serial Number |
sNumberLen | Length of Serial Number |
int device_close | ( | ) |
Close the device
int device_enterStopMode | ( | ) |
Enter Stop Mode
Set device enter to stio mode. In stop mode, LCD display and backlight is off. Stop mode reduces power consumption to the lowest possible level. A unit in stop mode can only be woken up by a physical key press.
int device_getCurrentDeviceType | ( | ) |
Get current active device type
int device_getDateTime | ( | OUT BYTE * | dateTime | ) |
Polls device for Date and Time
dateTime | Response returned of Date and Time; needs to have at least 6 bytes of memory |
Polls device for Date and Time
dateTime | Response returned of Date and Time |
dateTime | Length of Date and Time |
int device_getFirmwareVersion | ( | OUT char * | firmwareVersion | ) |
DEPRECATED : please use device_getFirmwareVersion_Len(OUT char* firmwareVersion, IN_OUT int *firmwareVersionLen)
Polls device for Firmware Version
firmwareVersion | Response returned of Firmware Version; needs to have at least 128 bytes of memory |
Polls device for Firmware Version
firmwareVersion | Response returned of Firmware Version |
firmwareVersionLen | Length of Firmware Version |
int device_getKeyStatus | ( | int * | newFormat, |
BYTE * | status, | ||
int * | statusLen | ||
) |
Get Key Status
Gets the status of loaded keys
status | newFormat for Augusta and miniSmartII only 1: new format of key status 0: reserved format for support previous device |
status | For L80, L100, Augusta and miniSmartII: When the newFormat is 0, data format as follows. For Augusta and miniSmartII: byte 0: PIN DUKPT Key, Does not support, always 0 byte 1: PIN Master Key, Does not support, always 0 byte 2: PIN Session Key, Does not support, always 0 byte 3: Account/MSR DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 4: Account/ICC DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 5: Admin DUKPT Key, 1 Exists, 0 None, 0xFF STOP For L80 and L100: byte 0: PIN DUKPT Key byte 1: PIN Master Key byte 2: Standard PIN Session Key byte 3: Desjardins PIN Session Key byte 4: Account/MSR DUKPT Key, 1 Exists, 0 None, 0xFF STOP, Does not support, always 0 byte 5: Account/ICC DUKPT Key, 1 Exists, 0 None, 0xFF STOP, Does not support, always 0 byte 6: Admin DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 7: Data DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 8: MAC DUKPT Key, 1 Exists, 0 None, 0xFF STOP |
when the newFormat is 1, data format as follows. [Block Length] [KeyStatusBlock1] [KeyStatusBlock2]...[KeyStatusBlockN] Where: [Block Length] is 2 bytes, format is Len_L Len_H, is KeyStatusBlock Number [KeyStatusBlockX> is 4 bytes, format is [Key Index and Key Name] [key slot] [key status]: [Key Index and Key Name] is 1 byte. Please refer to following table 0x14 LCL-KEK to Encrypt Other Keys 0x02 Data encryption Key to Encrypt ICC/MSR 0x05 MAC DUKPT Key for Host-Device - MAC Verification 0x05 MTK DUKPT Key for TTK Self-Test 0x0C RKI-KEK for Remote Key Injection [key slot] is 2 bytes. Range is 0 - 9999 the MTK DUKPT Key slot is 16, the others are all 0 [key status] is 1 byte. 0 - Not Exist 1 - Exist 0xFF - (Stop. Only Valid for DUKPT Key) For NEO2 and SREDKey2: Each unit of three bytes represents one key's parameters (index and slot). Key Name Index (1 byte): 0x14 - LCL-KEK 0x01 - Pin encryption Key (NEO2 only) 0x02 - Data encryption Key 0x05 - MAC DUKPT Key 0x0A - PCI Pairing Key (NEO2 only) Key Slot (2 bytes): Indicate different slots of a certain Key Name Example: slot =5 (0x00 0x05), slot=300 (0x01 0x2C) For BTPay380, slot is always 0 For example, 0x14 0x00 0x00 0x02 0x00 0x00 0x0A 0x00 0x00 will represent [KeyNameIndex=0x14,KeySlot=0x0000], [KeyNameIndex=0x02,KeySlot=0x0000] and [KeyNameIndex=0x0A,KeySlot=0x0000]
statusLen | the length of status |
Review the return code description.
returnCode | the response result. |
description |
the | string for description of response result |
int device_init | ( | ) |
Initial the device by USB
It will detect the device and trying connect.
The connect status can be checked by device_isConnected().
Note: after the function returns success, the function device_setCurrentDevice() has to be called to set the device type.
int device_isAttached | ( | int | deviceType | ) |
Check if the device is attached to the USB port The function device_init() must be called before this function.
deviceType,the | device type of the USB device |
int device_isConnected | ( | ) |
Check the device conntected status
int device_rebootDevice | ( | ) |
Reboot Device Executes a command to restart the device.
void device_registerCameraCallBk | ( | pCMR_callBack | pCMRf | ) |
To register the camera callback function to get the image data. (Pass NULL to disable the callback.)
void device_registerCardStatusFrontSwitchCallBk | ( | pCSFS_callBack | pCSFSf | ) |
To register the card status and front switch callback function to get status. (Pass NULL to disable the callback.)
void device_registerFWCallBk | ( | pFW_callBack | pFWf | ) |
To register the firmware update callback function to get the status of firmware update. (Pass NULL to disable the callback.)
int device_SendDataCommand | ( | IN BYTE * | cmd, |
IN int | cmdLen, | ||
IN BYTE * | data, | ||
IN int | dataLen, | ||
OUT BYTE * | response, | ||
IN_OUT int * | respLen | ||
) |
Send a Command to device
Sends a command to the device .
cmd | buffer of command to execute. |
cmdLen,the | length of the buffer cmd. |
data | buffer of IDG command data. |
dataLen,the | length of the buffer data. |
response | Response data |
respLen,the | length of Response data |
int device_setCurrentDevice | ( | int | deviceType | ) |
Sets the current device to talk to
The connect status can be checked by device_isConnected().
deviceType | Device to connect to enum DEVICE_TYPE { IDT_DEVICE_UNKNOWN=0, IDT_DEVICE_AUGUSTA_HID, IDT_DEVICE_AUGUSTA_KB, IDT_DEVICE_AUGUSTA_S_HID, IDT_DEVICE_AUGUSTA_S_KB, IDT_DEVICE_AUGUSTA_S_TTK_HID, IDT_DEVICE_SPECTRUM_PRO, IDT_DEVICE_MINISMART_II, IDT_DEVICE_L80, IDT_DEVICE_L100, IDT_DEVICE_UNIPAY, IDT_DEVICE_UNIPAY_I_V, IDT_DEVICE_VP3300_AJ, IDT_DEVICE_KIOSK_III, IDT_DEVICE_KIOSK_III_S, IDT_DEVICE_PIP_READER, IDT_DEVICE_VENDI, IDT_DEVICE_VP3300_USB, IDT_DEVICE_UNIPAY_I_V_TTK, IDT_DEVICE_VP3300_BT, IDT_DEVICE_VP8800, IDT_DEVICE_SREDKEY2_HID, IDT_DEVICE_SREDKEY2_KB, IDT_DEVICE_NEO2, IDT_DEVICE_MINISMART_II_COM = IDT_DEVICE_NEO2+5, IDT_DEVICE_SPECTRUM_PRO_COM, IDT_DEVICE_KIOSK_III_COM, IDT_DEVICE_KIOSK_III_S_COM, IDT_DEVICE_PIP_READER_COM, IDT_DEVICE_VP3300_COM, IDT_DEVICE_NEO2_COM, IDT_DEVICE_MAX_DEVICES = IDT_DEVICE_NEO2_COM+5 }; |
int device_setSleepModeTime | ( | int | time | ) |
Set Sleep Mode Timer
Set device enter to sleep mode after the given time. In sleep mode, LCD display and backlight is off. Sleep mode reduces power consumption to the lowest possible level. A unit in Sleep mode can only be woken up by a physical key press.
time | Enter sleep time value, in second. |
int device_updateFirmware | ( | IN BYTE * | firmwareData, |
IN int | firmwareDataLen, | ||
IN char * | firmwareName, | ||
IN int | encryptionType, | ||
IN BYTE * | keyBlob, | ||
IN int | keyBlobLen | ||
) |
Update Firmware Updates the firmware of Augusta.
firmwareData | Signed binary data of a firmware file provided by IDTech |
firmwareDataLen | Length of firmwareData |
firmwareName | Firmware name.
|
encryptionType | Encryption type
|
keyBlob | Encrypted firmware session key blob, TR-31 Rev B, wrapped by FW Key (Optional, none if firmware is plaintext) |
keyBlobLen | Length of keyBlob |
Firmware update status is returned in the callback with the following values: sender = AUGUSTA state = DeviceState.FirmwareUpdate data = File Progress. Two bytes, with byte[0] = current block, and byte[1] = total blocks. 0x0310 = block 3 of 16 transactionResultCode:
void emv_registerCallBk | ( | pEMV_callBack | pEMVf | ) |
To register the emv callback function to get the EMV processing response. (Pass NULL to disable the callback.)
int lcd_displayMessage | ( | int | lineNumber, |
char * | message, | ||
int | messageLen | ||
) |
Display Message on Line
Displays a message on a display line.
lineNumber | Line number to display message on (1-4) |
message | Message to display |
messageLen | length of message |
int lcd_displayPrompt | ( | int | promptNumber, |
int | lineNumber | ||
) |
Display Prompt on Line
Displays a message prompt from L80 or L100 memory.
promptNumber | Prompt number (0-9) |
lineNumber | Line number to display message prompt (1-4) |
int lcd_enableBacklight | ( | int | enable | ) |
Enable/Disable LCD Backlight
Turns on/off the LCD back lighting.
enable | TRUE = turn ON backlight, FALSE = turn OFF backlight |
int lcd_getBacklightStatus | ( | int * | enabled | ) |
Get Backlight Status
Returns the status of the LCD back lighting.
enabled | 1 = Backlight is ON, 0 = Backlight is OFF |
int lcd_savePrompt | ( | int | promptNumber, |
char * | prompt, | ||
int | promptLen | ||
) |
Save Prompt
Saves a message prompt to L80 or L100 memory.
promptNumber | Prompt number (0-9) |
prompt | Prompt string (up to 20 characters) |
promptLen | length of prompt |
void msr_registerCallBk | ( | pMSR_callBack | pMSRf | ) |
To register the msr callback function to get the MSR card data. (Pass NULL to disable the callback.)
void msr_registerCallBkp | ( | pMSR_callBackp | pMSRf | ) |
To register the msr callback function to get the MSR card data pointer. (Pass NULL to disable the callback.)
int pin_getEncryptedPIN | ( | int | keyType, |
char * | PAN, | ||
int | PANLen, | ||
char * | message, | ||
int | messageLen, | ||
int | timeout | ||
) |
Get Encrypted PIN
Requests PIN Entry
keyType |
|
PAN | Account Number |
PANLen | length of PAN |
message | Message to display |
messageLen | length of message |
timeout | PIN entry timeout |
int pin_getFunctionKey | ( | int | timeout | ) |
Get Function Key
Captures a function key
- Backspace = B - Cancel = C - Enter = E - * = * - # = # - Help = ? - Function Key 1 = F1 - Function Key 2 = F2 - Function Key 3 = F3 @param timeout Timeout, in seconds
int pin_promptForAmountInput | ( | int | messageID, |
int | languageID, | ||
int | minLen, | ||
int | maxLen, | ||
int | timeout | ||
) |
Prompt for Amount Input
Prompts for amount input using the secure message according to the following table
Msg Id | English Prompt | Portuguese Prompt | Spanish Prompt | French Prompt |
---|---|---|---|---|
1 | ENTER | ENTER | INGRESE | ENTREZ |
2 | REENTER | RE-INTRODUZIR | REINGRESE | RE-ENTREZ |
3 | ENTER YOUR | INTRODUZIR O SEU | INGRESE SU | ENTREZ VOTRE |
4 | REENTER YOUR | RE-INTRODUZIR O SEU | REINGRESE SU | RE-ENTREZ VOTRE |
5 | PLEASE ENTER | POR FAVOR DIGITE | POR FAVOR INGRESE | SVP ENTREZ |
6 | PLEASE REENTER | POR FAVO REENTRAR | POR FAVO REINGRESE | SVP RE-ENTREZ |
7 | PO NUMBER | N锟筋┖ERO PO | NUMERO PO | No COMMANDE |
8 | DRIVER ID | LICEN锟斤墽 | LICENCIA | ID CONDUCTEUR |
9 | ODOMETER | ODOMETER | ODOMETRO | ODOMETRE |
10 | ID NUMBER | N锟筋┖ERO ID | NUMERO ID | No IDENT |
11 | EQUIP CODE | EQUIP CODE | CODIGO EQUIP | CODE EQUIPEMENT |
12 | DRIVERS ID | DRIVER ID | ID CONDUCTOR | ID CONDUCTEUR |
13 | JOB NUMBER | EMP N锟筋┖ERO | NUMERO EMP | No TRAVAIL |
14 | WORK ORDER | TRABALHO ORDEM | ORDEN TRABAJO | FICHE TRAVAIL |
15 | VEHICLE ID | ID VE锟斤槜ULO | ID VEHICULO | ID VEHICULE |
16 | ENTER DRIVER | ENTER DRIVER | INGRESE CONDUCTOR | ENTR CONDUCTEUR |
17 | ENTER DEPT | ENTER DEPT | INGRESE DEPT | ENTR DEPARTEMNT |
18 | ENTER PHONE | ADICIONAR PHONE | INGRESE TELEFONO | ENTR No TELEPH |
19 | ENTER ROUTE | ROUTE ADD | INGRESE RUTA | ENTREZ ROUTE |
20 | ENTER FLEET | ENTER FROTA | INGRESE FLOTA | ENTREZ PARC AUTO |
21 | ENTER JOB ID | ENTER JOB ID | INGRESE ID TRABAJO | ENTR ID TRAVAIL |
22 | ROUTE NUMBER | N锟筋┖ERO PATH | RUTA NUMERO | No ROUTE |
23 | ENTER USER ID | ENTER USER ID | INGRESE ID USUARIO | ID UTILISATEUR |
24 | FLEET NUMBER | N锟筋┖ERO DE FROTA | FLOTA NUMERO | No PARC AUTO |
25 | ENTER PRODUCT | ADICIONAR PRODUTO | INGRESE PRODUCTO | ENTREZ PRODUIT |
26 | DRIVER NUMBER | N锟筋┖ERO DRIVER | CONDUCTOR NUMERO | No CONDUCTEUR |
27 | ENTER LICENSE | ENTER LICEN锟斤墽 | INGRESE LICENCIA | ENTREZ PERMIS |
28 | ENTER FLEET NO | ENTER NRO FROTA | INGRESE NRO FLOTA | ENT No PARC AUTO |
29 | ENTER CAR WASH | WASH ENTER | INGRESE LAVADO | ENTREZ LAVE-AUTO |
30 | ENTER VEHICLE | ENTER VE锟斤槜ULO | INGRESE VEHICULO | ENTREZ VEHICULE |
31 | ENTER TRAILER | TRAILER ENTER | INGRESE TRAILER | ENTREZ REMORQUE |
32 | ENTER ODOMETER | ENTER ODOMETER | INGRESE ODOMETRO | ENTREZ ODOMETRE |
33 | DRIVER LICENSE | CARTEIRA DE MOTORISTA | LICENCIA CONDUCTOR | PERMIS CONDUIRE |
34 | ENTER CUSTOMER | ENTER CLIENTE | INGRESE CLIENTE | ENTREZ CLIENT |
35 | VEHICLE NUMBER | N锟筋┖ERO DO VE锟斤槜ULO | VEHICULO NUMERO | No VEHICULE |
36 | ENTER CUST DATA | ENTER CLIENTE INFO | INGRESE INFO CLIENTE | INFO CLIENT |
37 | REENTER DRIVID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENTR ID COND |
38 | ENTER USER DATA | ENTER INFO USU锟筋粖IO | INGRESE INFO USUARIO | INFO UTILISATEUR |
39 | ENTER CUST CODE | ENTER CODE. CLIENTE | INGRESE COD. CLIENTE | ENTR CODE CLIENT |
40 | ENTER EMPLOYEE | ENTER FUNCION锟筋粖IO | INGRESE EMPLEADO | ENTREZ EMPLOYE |
41 | ENTER ID NUMBER | ENTER N锟筋┖ERO ID | INGRESE NUMERO ID | ENTREZ No ID |
42 | ENTER DRIVER ID | ENTER ID DRIVER | INGRESE ID CONDUCTOR | No CONDUCTEUR |
43 | ENTER FLEET PIN | ENTER PIN FROTA | INGRESE PIN DE FLOTA | NIP PARC AUTO |
44 | ODOMETER NUMBER | N锟筋┖ERO ODOMETER | ODOMETRO NUMERO | No ODOMETRE |
45 | ENTER DRIVER LIC | ENTER DRIVER LIC | INGRESE LIC CONDUCTOR | PERMIS CONDUIRE |
46 | ENTER TRAILER NO | NRO TRAILER ENTER | INGRESE NRO TRAILER | ENT No REMORQUE |
47 | REENTER VEHICLE | REENTRAR VE锟斤槜ULO | REINGRESE VEHICULO | RE-ENTR VEHICULE |
48 | ENTER VEHICLE ID | ENTER VE锟斤槜ULO ID | INGRESE ID VEHICULO | ENTR ID VEHICULE |
49 | ENTER BIRTH DATE | INSERIR DATA NAC | INGRESE FECHA NAC | ENT DT NAISSANCE |
50 | ENTER DOB MMDDYY | ENTER FDN MMDDYY | INGRESE FDN MMDDAA | NAISSANCE MMJJAA |
51 | ENTER FLEET DATA | ENTER FROTA INFO | INGRESE INFO DE FLOTA | INFO PARC AUTO |
52 | ENTER REFERENCE | ENTER REFER锟斤憢CIA | INGRESE REFERENCIA | ENTREZ REFERENCE |
53 | ENTER AUTH NUMBR | ENTER N锟筋┖ERO AUT | INGRESE NUMERO AUT | No AUTORISATION |
54 | ENTER HUB NUMBER | ENTER HUB NRO | INGRESE NRO HUB | ENTREZ No NOYAU |
55 | ENTER HUBOMETER | MEDIDA PARA ENTRAR HUB | INGRESE MEDIDO DE HUB | COMPTEUR NOYAU |
56 | ENTER TRAILER ID | TRAILER ENTER ID | INGRESE ID TRAILER | ENT ID REMORQUE |
57 | ODOMETER READING | QUILOMETRAGEM | LECTURA ODOMETRO | LECTURE ODOMETRE |
58 | REENTER ODOMETER | REENTRAR ODOMETER | REINGRESE ODOMETRO | RE-ENT ODOMETRE |
59 | REENTER DRIV. ID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENT ID CONDUC |
60 | ENTER CUSTOMER ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
61 | ENTER CUST. ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
62 | ENTER ROUTE NUM | ENTER NUM ROUTE | INGRESE NUM RUTA | ENT No ROUTE |
63 | ENTER FLEET NUM | FROTA ENTER NUM | INGRESE NUM FLOTA | ENT No PARC AUTO |
64 | FLEET PIN | FROTA PIN | PIN DE FLOTA | NIP PARC AUTO |
65 | DRIVER # | DRIVER # | CONDUCTOR # | CONDUCTEUR |
66 | ENTER DRIVER # | ENTER DRIVER # | INGRESE CONDUCTOR # | ENT # CONDUCTEUR |
67 | VEHICLE # | VE锟斤槜ULO # | VEHICULO # | # VEHICULE |
68 | ENTER VEHICLE # | ENTER VE锟斤槜ULO # | INGRESE VEHICULO # | ENT # VEHICULE |
69 | JOB # | TRABALHO # | TRABAJO # | # TRAVAIL |
70 | ENTER JOB # | ENTER JOB # | INGRESE TRABAJO # | ENTREZ # TRAVAIL |
71 | DEPT NUMBER | N锟筋┖ERO DEPT | NUMERO DEPTO | No DEPARTEMENT |
72 | DEPARTMENT # | DEPARTAMENTO # | DEPARTAMENTO # | DEPARTEMENT |
73 | ENTER DEPT # | ENTER DEPT # | INGRESE DEPTO # | ENT# DEPARTEMENT |
74 | LICENSE NUMBER | N锟筋┖ERO DE LICEN锟斤墽 | NUMERO LICENCIA | No PERMIS |
75 | LICENSE # | LICEN锟斤墽 # | LICENCIA # | # PERMIS |
76 | ENTER LICENSE # | ENTER LICEN锟斤墽 # | INGRESE LICENCIA # | ENTREZ # PERMIS |
77 | DATA | INFO | INFO | INFO |
78 | ENTER DATA | ENTER INFO | INGRESE INFO | ENTREZ INFO |
79 | CUSTOMER DATA | CLIENTE INFO | INFO CLIENTE | INFO CLIENT |
80 | ID # | ID # | ID # | # ID |
81 | ENTER ID # | ENTER ID # | INGRESE ID # | ENTREZ # ID |
82 | USER ID | USER ID | ID USUARIO | ID UTILISATEUR |
83 | ROUTE # | ROUTE # | RUTA # | # ROUTE |
84 | ENTER ROUTE # | ADD ROUTE # | INGRESE RUTA # | ENTREZ # ROUTE |
85 | ENTER CARD NUM | ENTER N锟筋┖ERO DE CART锟斤�� | INGRESE NUM TARJETA | ENTREZ NO CARTE |
86 | EXP DATE(YYMM) | VALIDADE VAL (AAMM) | FECHA EXP (AAMM) | DATE EXPIR(AAMM) |
87 | PHONE NUMBER | TELEFONE | NUMERO TELEFONO | NO TEL |
88 | CVV START DATE | CVV DATA DE IN锟斤槜IO | CVV FECHA INICIO | CVV DATE DE DEBUT |
89 | ISSUE NUMBER | N锟筋┖ERO DE EMISS锟斤�� | NUMERO DE EMISION | NO DEMISSION |
90 | START DATE (MMYY) | DATA DE IN锟斤槜IO (AAMM) | FECHA INICIO (AAMM) | DATE DE DEBUT-AAMM |
@param messageID Message (1-90) @param languageID 0=English Prompt, 1=Portuguese Prompt, 2=Spanish Prompt, 3=French Prompt @param minLen Minimum input length. Cannot be less than 1 @param maxLen Maximum input length. Cannot be greater than 15 @param timeout Timout value, in seconds
int pin_promptForKeyInput | ( | int | messageID, |
int | languageID, | ||
int | maskInput, | ||
int | minLen, | ||
int | maxLen, | ||
int | timeout | ||
) |
Prompt for Key Input
Prompts for a numeric key using the secure message according to the following table
Msg Id | English Prompt | Portuguese Prompt | Spanish Prompt | French Prompt |
---|---|---|---|---|
1 | ENTER | ENTER | INGRESE | ENTREZ |
2 | REENTER | RE-INTRODUZIR | REINGRESE | RE-ENTREZ |
3 | ENTER YOUR | INTRODUZIR O SEU | INGRESE SU | ENTREZ VOTRE |
4 | REENTER YOUR | RE-INTRODUZIR O SEU | REINGRESE SU | RE-ENTREZ VOTRE |
5 | PLEASE ENTER | POR FAVOR DIGITE | POR FAVOR INGRESE | SVP ENTREZ |
6 | PLEASE REENTER | POR FAVO REENTRAR | POR FAVO REINGRESE | SVP RE-ENTREZ |
7 | PO NUMBER | N锟筋┖ERO PO | NUMERO PO | No COMMANDE |
8 | DRIVER ID | LICEN锟斤墽 | LICENCIA | ID CONDUCTEUR |
9 | ODOMETER | ODOMETER | ODOMETRO | ODOMETRE |
10 | ID NUMBER | N锟筋┖ERO ID | NUMERO ID | No IDENT |
11 | EQUIP CODE | EQUIP CODE | CODIGO EQUIP | CODE EQUIPEMENT |
12 | DRIVERS ID | DRIVER ID | ID CONDUCTOR | ID CONDUCTEUR |
13 | JOB NUMBER | EMP N锟筋┖ERO | NUMERO EMP | No TRAVAIL |
14 | WORK ORDER | TRABALHO ORDEM | ORDEN TRABAJO | FICHE TRAVAIL |
15 | VEHICLE ID | ID VE锟斤槜ULO | ID VEHICULO | ID VEHICULE |
16 | ENTER DRIVER | ENTER DRIVER | INGRESE CONDUCTOR | ENTR CONDUCTEUR |
17 | ENTER DEPT | ENTER DEPT | INGRESE DEPT | ENTR DEPARTEMNT |
18 | ENTER PHONE | ADICIONAR PHONE | INGRESE TELEFONO | ENTR No TELEPH |
19 | ENTER ROUTE | ROUTE ADD | INGRESE RUTA | ENTREZ ROUTE |
20 | ENTER FLEET | ENTER FROTA | INGRESE FLOTA | ENTREZ PARC AUTO |
21 | ENTER JOB ID | ENTER JOB ID | INGRESE ID TRABAJO | ENTR ID TRAVAIL |
22 | ROUTE NUMBER | N锟筋┖ERO PATH | RUTA NUMERO | No ROUTE |
23 | ENTER USER ID | ENTER USER ID | INGRESE ID USUARIO | ID UTILISATEUR |
24 | FLEET NUMBER | N锟筋┖ERO DE FROTA | FLOTA NUMERO | No PARC AUTO |
25 | ENTER PRODUCT | ADICIONAR PRODUTO | INGRESE PRODUCTO | ENTREZ PRODUIT |
26 | DRIVER NUMBER | N锟筋┖ERO DRIVER | CONDUCTOR NUMERO | No CONDUCTEUR |
27 | ENTER LICENSE | ENTER LICEN锟斤墽 | INGRESE LICENCIA | ENTREZ PERMIS |
28 | ENTER FLEET NO | ENTER NRO FROTA | INGRESE NRO FLOTA | ENT No PARC AUTO |
29 | ENTER CAR WASH | WASH ENTER | INGRESE LAVADO | ENTREZ LAVE-AUTO |
30 | ENTER VEHICLE | ENTER VE锟斤槜ULO | INGRESE VEHICULO | ENTREZ VEHICULE |
31 | ENTER TRAILER | TRAILER ENTER | INGRESE TRAILER | ENTREZ REMORQUE |
32 | ENTER ODOMETER | ENTER ODOMETER | INGRESE ODOMETRO | ENTREZ ODOMETRE |
33 | DRIVER LICENSE | CARTEIRA DE MOTORISTA | LICENCIA CONDUCTOR | PERMIS CONDUIRE |
34 | ENTER CUSTOMER | ENTER CLIENTE | INGRESE CLIENTE | ENTREZ CLIENT |
35 | VEHICLE NUMBER | N锟筋┖ERO DO VE锟斤槜ULO | VEHICULO NUMERO | No VEHICULE |
36 | ENTER CUST DATA | ENTER CLIENTE INFO | INGRESE INFO CLIENTE | INFO CLIENT |
37 | REENTER DRIVID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENTR ID COND |
38 | ENTER USER DATA | ENTER INFO USU锟筋粖IO | INGRESE INFO USUARIO | INFO UTILISATEUR |
39 | ENTER CUST CODE | ENTER CODE. CLIENTE | INGRESE COD. CLIENTE | ENTR CODE CLIENT |
40 | ENTER EMPLOYEE | ENTER FUNCION锟筋粖IO | INGRESE EMPLEADO | ENTREZ EMPLOYE |
41 | ENTER ID NUMBER | ENTER N锟筋┖ERO ID | INGRESE NUMERO ID | ENTREZ No ID |
42 | ENTER DRIVER ID | ENTER ID DRIVER | INGRESE ID CONDUCTOR | No CONDUCTEUR |
43 | ENTER FLEET PIN | ENTER PIN FROTA | INGRESE PIN DE FLOTA | NIP PARC AUTO |
44 | ODOMETER NUMBER | N锟筋┖ERO ODOMETER | ODOMETRO NUMERO | No ODOMETRE |
45 | ENTER DRIVER LIC | ENTER DRIVER LIC | INGRESE LIC CONDUCTOR | PERMIS CONDUIRE |
46 | ENTER TRAILER NO | NRO TRAILER ENTER | INGRESE NRO TRAILER | ENT No REMORQUE |
47 | REENTER VEHICLE | REENTRAR VE锟斤槜ULO | REINGRESE VEHICULO | RE-ENTR VEHICULE |
48 | ENTER VEHICLE ID | ENTER VE锟斤槜ULO ID | INGRESE ID VEHICULO | ENTR ID VEHICULE |
49 | ENTER BIRTH DATE | INSERIR DATA NAC | INGRESE FECHA NAC | ENT DT NAISSANCE |
50 | ENTER DOB MMDDYY | ENTER FDN MMDDYY | INGRESE FDN MMDDAA | NAISSANCE MMJJAA |
51 | ENTER FLEET DATA | ENTER FROTA INFO | INGRESE INFO DE FLOTA | INFO PARC AUTO |
52 | ENTER REFERENCE | ENTER REFER锟斤憢CIA | INGRESE REFERENCIA | ENTREZ REFERENCE |
53 | ENTER AUTH NUMBR | ENTER N锟筋┖ERO AUT | INGRESE NUMERO AUT | No AUTORISATION |
54 | ENTER HUB NUMBER | ENTER HUB NRO | INGRESE NRO HUB | ENTREZ No NOYAU |
55 | ENTER HUBOMETER | MEDIDA PARA ENTRAR HUB | INGRESE MEDIDO DE HUB | COMPTEUR NOYAU |
56 | ENTER TRAILER ID | TRAILER ENTER ID | INGRESE ID TRAILER | ENT ID REMORQUE |
57 | ODOMETER READING | QUILOMETRAGEM | LECTURA ODOMETRO | LECTURE ODOMETRE |
58 | REENTER ODOMETER | REENTRAR ODOMETER | REINGRESE ODOMETRO | RE-ENT ODOMETRE |
59 | REENTER DRIV. ID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENT ID CONDUC |
60 | ENTER CUSTOMER ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
61 | ENTER CUST. ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
62 | ENTER ROUTE NUM | ENTER NUM ROUTE | INGRESE NUM RUTA | ENT No ROUTE |
63 | ENTER FLEET NUM | FROTA ENTER NUM | INGRESE NUM FLOTA | ENT No PARC AUTO |
64 | FLEET PIN | FROTA PIN | PIN DE FLOTA | NIP PARC AUTO |
65 | DRIVER # | DRIVER # | CONDUCTOR # | CONDUCTEUR |
66 | ENTER DRIVER # | ENTER DRIVER # | INGRESE CONDUCTOR # | ENT # CONDUCTEUR |
67 | VEHICLE # | VE锟斤槜ULO # | VEHICULO # | # VEHICULE |
68 | ENTER VEHICLE # | ENTER VE锟斤槜ULO # | INGRESE VEHICULO # | ENT # VEHICULE |
69 | JOB # | TRABALHO # | TRABAJO # | # TRAVAIL |
70 | ENTER JOB # | ENTER JOB # | INGRESE TRABAJO # | ENTREZ # TRAVAIL |
71 | DEPT NUMBER | N锟筋┖ERO DEPT | NUMERO DEPTO | No DEPARTEMENT |
72 | DEPARTMENT # | DEPARTAMENTO # | DEPARTAMENTO # | DEPARTEMENT |
73 | ENTER DEPT # | ENTER DEPT # | INGRESE DEPTO # | ENT# DEPARTEMENT |
74 | LICENSE NUMBER | N锟筋┖ERO DE LICEN锟斤墽 | NUMERO LICENCIA | No PERMIS |
75 | LICENSE # | LICEN锟斤墽 # | LICENCIA # | # PERMIS |
76 | ENTER LICENSE # | ENTER LICEN锟斤墽 # | INGRESE LICENCIA # | ENTREZ # PERMIS |
77 | DATA | INFO | INFO | INFO |
78 | ENTER DATA | ENTER INFO | INGRESE INFO | ENTREZ INFO |
79 | CUSTOMER DATA | CLIENTE INFO | INFO CLIENTE | INFO CLIENT |
80 | ID # | ID # | ID # | # ID |
81 | ENTER ID # | ENTER ID # | INGRESE ID # | ENTREZ # ID |
82 | USER ID | USER ID | ID USUARIO | ID UTILISATEUR |
83 | ROUTE # | ROUTE # | RUTA # | # ROUTE |
84 | ENTER ROUTE # | ADD ROUTE # | INGRESE RUTA # | ENTREZ # ROUTE |
85 | ENTER CARD NUM | ENTER N锟筋┖ERO DE CART锟斤�� | INGRESE NUM TARJETA | ENTREZ NO CARTE |
86 | EXP DATE(YYMM) | VALIDADE VAL (AAMM) | FECHA EXP (AAMM) | DATE EXPIR(AAMM) |
87 | PHONE NUMBER | TELEFONE | NUMERO TELEFONO | NO TEL |
88 | CVV START DATE | CVV DATA DE IN锟斤槜IO | CVV FECHA INICIO | CVV DATE DE DEBUT |
89 | ISSUE NUMBER | N锟筋┖ERO DE EMISS锟斤�� | NUMERO DE EMISION | NO DEMISSION |
90 | START DATE (MMYY) | DATA DE IN锟斤槜IO (AAMM) | FECHA INICIO (AAMM) | DATE DE DEBUT-AAMM |
@param messageID Message (1-90) @param languageID 0=English Prompt, 1=Portuguese Prompt, 2=Spanish Prompt, 3=French Prompt @param maskInput 1 = entry is masked with '*', 0 = entry is displayed on keypad @param minLen Minimum input length. Cannot be less than 1 @param maxLen Maximum input length. Cannot be greater than 16 @param timeout Timout value, in seconds
void pin_registerCallBk | ( | pPIN_callBack | pPINf | ) |
To register the pin callback function to get the PINPad data. (Pass NULL to disable the callback.)
int pin_sendBeep | ( | int | frequency, |
int | duration | ||
) |
Send Beep
Executes a beep request.
frequency | Frequency, range 200-20000Hz Not used for NEO 2 devices |
duration | Duration, range 16-65535ms Not used for NEO 2 devices |
int pin_setKeyValues | ( | int | mode | ) |
Set Key Values
Set return key values on or off
mode | On: 1, Off: 0 |
void registerHotplugCallBk | ( | pMessageHotplug | pMsgHotplug | ) |
To register the USB HID hot-plug callback function which implemented in the application to monitor the hotplug message from the SDK.
void registerLogCallBk | ( | pSendDataLog | pFSend, |
pReadDataLog | pFRead | ||
) |
To register the log callback function which implemented in the application to monitor sending/reading data between application and reader.
char* SDK_Version | ( | ) |
To Get SDK version
int setAbsoluteLibraryPath | ( | const char * | absoluteLibraryPath | ) |
Set the path to use when searching for ID TECH's libraries. If this is not set, the libraries will be searched for with the system's default procedures.
absoluteLibraryPath | The absolute path to ID TECH's libraries. |