libIDT_NEO2.h

Go to the documentation of this file.

#ifndef __LIBIDT_NEO2_H___
# define __LIBIDT_NEO2_H___


# define IN
# define OUT
# define IN_OUT
# include "IDTDef.h"

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 (* pWP_callBack)(char *,
  int,
  int);

typedef void (* pFW_callBack)(int,
  int,
  int,
  int,
  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 (* pLCD_callBack)(int,
  IDTLCDItem *);

typedef void (* pRKI_callBack)(int,
  char *);

typedef void (* ftpComm_callBack)(int,
  int,
  int);

typedef void (* httpComm_callBack)(BYTE *,
  int);

typedef void (* v4Comm_callBack)(BYTE,
  BYTE,
  BYTE *,
  int);


# ifdef __cplusplus
extern "C" {
# endif

void
registerHotplugCallBk(pMessageHotplug pMsgHotplug);

void
registerLogCallBk(pSendDataLog pFSend,
  pReadDataLog                 pFRead);

void
device_registerFWCallBk(pFW_callBack pFWf);

void
device_registerCameraCallBk(pCMR_callBack pCMRf);

void
device_registerCardStatusFrontSwitchCallBk(pCSFS_callBack pCSFSf);

void
device_registerRKICallBk(pRKI_callBack pRKIf);

void
emv_registerCallBk(pEMV_callBack pEMVf);

void
loyalty_registerCallBk(pEMV_callBack pEMVf);

void
msr_registerCallBk(pMSR_callBack pMSRf);

void
msr_registerCallBkp(pMSR_callBackp pMSRf);

// *To register the loyalty MSR callback function to get the MSR card data.  (Pass NULL to disable the callback.)
// */
// void loyalty_registerMSRCallBk(pMSR_callBack pMSRf);
//
// *To register the loyalty MSR callback function to get the MSR card data pointer.  (Pass NULL to disable the callback.)
// */
// void loyalty_registerMSRCallBkp(pMSR_callBackp pMSRf);

void
ctls_registerCallBk(pMSR_callBack pCTLSf);

void
ctls_registerCallBkp(pMSR_callBackp pCTLSf);

void
pin_registerCallBk(pPIN_callBack pPINf);

void
lcd_registerCallBk(pLCD_callBack pLCDf);

void
comm_registerHTTPCallback(httpComm_callBack cBack);

void
comm_registerV4Callback(v4Comm_callBack cBack);

char *
SDK_Version();

int
setAbsoluteLibraryPath(const char * absoluteLibraryPath);

int
device_setConfigPath(const char * path);

int
device_setNEO2DevicesConfigs(IN const char * configs,
  IN int                                     len);

int
device_init();

int
rs232_device_init(int deviceType, int port_number, int brate);

void
set_open_com_port_timeout(int timeout);

int
device_setCurrentDevice(int deviceType);

int
device_isAttached(int deviceType);

int
device_close();

void
device_getIDGStatusCodeString(IN int returnCode,
  OUT char *                         despcrition);

int
device_isConnected();

int
device_getFirmwareVersion(OUT char * firmwareVersion);

int
device_getFirmwareVersion_Len(OUT char * firmwareVersion, IN_OUT int * firmwareVersionLen);

int
device_pingDevice();

int
device_controlUserInterface(IN BYTE * values);

int
device_getCurrentDeviceType();

int
device_SendDataCommandNEO(IN int cmd,
  IN int                         subCmd,
  IN BYTE *                      data,
  IN int                         dataLen,
  OUT BYTE *                     response,
  IN_OUT int *                   respLen);

int
device_rebootDevice();

int
device_stopAudio();

int
device_playAudio(IN char * fileName, IN int fileNameLen, IN int onSD);

int
device_getAudioVolume(OUT BYTE * volume);

int
device_setAudioVolume(IN BYTE volume);

int
device_getCameraParameters(OUT BYTE * isAutoFocus, OUT BYTE * focalLength);

int
device_setCameraParameters(IN BYTE isAutoFocus, IN BYTE focalLength);

int
device_getSDKWaitTime();

void
device_setSDKWaitTime(int waitTime);

int
device_getThreadStackSize();

void
device_setThreadStackSize(int threadSize);

void
device_toSDCard(int forSDCard);

int
device_startRKI(const char * caPath, int isProduction);

int
ctls_displayOnlineAuthResult(IN int statusCode,
  IN BYTE *                         TLV,
  IN int                            TLVLen);


int
device_enablePassThrough(int enablePassThrough);

int
device_enableL80PassThrough(int enableL80PassThrough);

int
device_enableL100PassThrough(int enableL100PassThrough);

int
device_getL80PassThroughMode();

int
device_getL100PassThroughMode();

int
device_setBurstMode(IN BYTE mode);

int
device_setPollMode(IN BYTE mode);

int
device_pollForToken(IN int timeout, OUT BYTE * respData, IN_OUT int * respDataLen);

int
device_setMerchantRecord(int index,
  int                        enabled,
  char *                     merchantID,
  char *                     merchantURL);

int
device_getMerchantRecord(IN int index,
  OUT BYTE *                    record);

int
device_getMerchantRecord_Len(IN int index,
  OUT BYTE * record, IN_OUT int * recordLen);

int
device_getTransactionResults(IDTMSRData * cardData);

int
device_startTransaction(IN double amount,
  IN double                       amtOther,
  IN int                          type,
  IN const int                    _timeout,
  IN BYTE *                       tags,
  IN int                          tagsLen);

int
loyalty_startTransaction(IN double amount, IN double amtOther, IN int type, IN const int _timeout, IN BYTE * tags,
  IN int tagsLen,
  IN const int cardType, IN const int iccReadType);

void
device_setTransactionExponent(int exponent);

int
device_activateTransaction(IN const int _timeout,
  IN BYTE *                             tags,
  IN int                                tagsLen);

int
device_cancelTransaction();

int
loyalty_cancelTransaction();

int
device_setCancelTransactionMode(int mode);

int
device_cancelTransactionSilent(int enable);

int
loyalty_cancelTransactionSilent(int enable);

int
device_configureButtons(IN BYTE done,
  IN BYTE                       swipe,
  IN BYTE                       delay);

int
device_getButtonConfiguration(OUT BYTE * done,
  OUT BYTE *                             swipe,
  OUT BYTE *                             delay);

int
device_disableBlueLED();

int
device_enableBlueLED(IN BYTE * data,
  IN int                       dataLen);

int
device_lcdDisplayClear();

int
device_enableExternalLCDMessages(IN int enableExtLCDMsg);

int
device_enableRFAntenna(IN int enableAntenna);

int
device_turnOffYellowLED();

int
device_turnOnYellowLED();

int
device_buzzerOnOff();

int
device_lcdDisplayLine1Message(IN BYTE * message,
  IN int                                messageLen);

int
device_lcdDisplayLine2Message(IN BYTE * message,
  IN int                                messageLen);

int
device_getKeyStatus(int * newFormat, BYTE * status, int * statusLen);

int
device_updateFirmware(IN BYTE * firmwareData,
  IN int                        firmwareDataLen,
  IN char *                     firmwareName,
  IN int                        encryptionType,
  IN BYTE *                     keyBlob,
  IN int                        keyBlobLen);

//int
//device_updateFirmwareWithZipFile(IN char *firmwareZipFilename, IN int firmwareZipFilenameLen);

int
device_transferFile(IN char * fileName, IN int fileNameLen, IN BYTE * file, IN int fileLen);

int
device_deleteFile(IN char * fileName, IN int fileNameLen);

int
device_queryFile(IN char * directoryName, IN int directoryNameLen, IN char * fileName, IN int fileNameLen,
  OUT int * isExist, OUT BYTE * timeStamp, IN_OUT int * timeStampLen, OUT char * fileSize, IN_OUT int * fileSizeLen);

int
device_readFileFromSD(IN char * directoryName, IN int directoryNameLen, IN char * fileName, IN int fileNameLen,
  IN int startingOffset, IN int numBytes, OUT BYTE * fileData, IN_OUT int * fileDataLen);

int
device_startListenNotifications();

int
device_stopListenNotifications();

int
device_startQRCodeScan(IN int _timeout);

int
device_startQRCodeScanWithDisplayWindowInfo(IN int _timeout, IN int x, IN int y, IN int width, IN int height);

int
device_stopQRCodeScan();

int
device_startTakingPhoto(IN int _timeout);

int
device_stopTakingPhoto();

void
device_getResponseCodeString(IN int returnCode, OUT char * despcrition);

void
device_getIDGStatusCodeString(IN int returnCode, OUT char * despcrition);

int
device_listDirectory(IN char * directoryName, IN int directoryNameLen, IN int recursive, IN int onSD,
  OUT char * directory, IN_OUT int * directoryLen);

int
device_deleteDirectory(IN char * dirName,
  IN int                         dirNameLen);

int
device_getDeviceMemoryUsageInfo(OUT int * freeHeapSize, OUT int * notFreedBlockCnt, OUT int * minEverFreeHeapSize);

int
device_getDRS(BYTE * codeDRS,
  int *              codeDRSLen);

int
device_setCoreDumpLogFile(IN char * filename, IN int filenameLen);

int
device_outputLog(IN char * filename, IN int filenameLen);

int
device_getTamperStatus(OUT int * isTampered);

int
felica_authentication(IN BYTE * key, IN int keyLen);

int
felica_readWithMac(IN int blockCnt, IN BYTE * blockList, IN int blockListLen, OUT BYTE * blockData,
  OUT int * blockDataLen);

int
felica_writeWithMac(IN BYTE blockNum, IN BYTE * blockData, IN int blockDataLen);

int
felica_read(IN BYTE * serviceCodeList, IN int serviceCodeListLen, IN int blockCnt, IN BYTE * blockList,
  IN int blockListLen, OUT BYTE * blockData, OUT int * blockDataLen);

int
felica_write(IN BYTE * serviceCodeList, IN int serviceCodeListLen, IN int blockCnt, IN BYTE * blockList,
  IN int blockListLen, IN BYTE * blockData, IN int blockDataLen, OUT BYTE * statusFlag,
  OUT int * statusFlagLen);


int
felica_poll(IN BYTE * systemCode, IN int systemCodeLen, OUT BYTE * respData, OUT int * respDataLen);

int
felica_SendCommand(IN BYTE * command, IN int commandLen, OUT BYTE * respData, OUT int * respDataLen);

int
felica_requestService(IN BYTE * nodeCode, IN int nodeCodeLen, OUT BYTE * respData, OUT int * respDataLen);

int
felica_getCode();

int
felica_cancelCodeEntry();

// long long timeInMilliseconds(void);
// int felica_SendCommandTest(IN BYTE *command, IN int commandLen, OUT BYTE *respData, OUT int *respDataLen);

int
config_getSerialNumber(OUT char * sNumber);

int
config_getSerialNumber_Len(OUT char * sNumber, IN_OUT int * sNumberLen);

int
config_getModelNumber(OUT char * sNumber);

int
config_getModelNumber_Len(OUT char * sNumber, IN_OUT int * sNumberLen);

int
config_setCmdTimeOutDuration(IN int millisecond);

int
ctls_startTransaction(IN double amount,
  IN double                     amtOther,
  IN int                        type,
  IN const int                  _timeout,
  IN BYTE *                     tags,
  IN int                        tagsLen);

int
ctls_activateTransaction(IN const int _timeout,
  IN BYTE *                           tags,
  IN int                              tagsLen);

int
ctls_cancelTransaction();

int
ctls_retrieveApplicationData(IN BYTE * AID,
  IN int                               AIDLen,
  OUT BYTE *                           tlv,
  IN_OUT int *                         tlvLen);

int
ctls_setApplicationData(IN BYTE * tlv,
  IN int                          tlvLen);

int
ctls_removeApplicationData(IN BYTE * AID,
  IN int                             AIDLen);

int
ctls_removeAllApplicationData();

int
ctls_retrieveAIDList(OUT BYTE * AIDList,
  IN_OUT int *                  AIDListLen);

int
ctls_retrieveTerminalData(OUT BYTE * tlv,
  IN_OUT int *                       tlvLen);

int
ctls_setTerminalData(IN BYTE * tlv,
  IN int                       tlvLen);

int
ctls_retrieveCAPK(IN BYTE * capk,
  IN int                    capkLen,
  OUT BYTE *                key,
  IN_OUT int *              keyLen);

int
ctls_setCAPK(IN BYTE * capk,
  IN int               capkLen);

int
ctls_removeCAPK(IN BYTE * capk,
  IN int                  capkLen);

int
ctls_removeAllCAPK();

int
ctls_retrieveCAPKList(OUT BYTE * keys,
  IN_OUT int *                   keysLen);

int
ctls_setConfigurationGroup(IN BYTE * tlv,
  IN int                             tlvLen);

int
ctls_getConfigurationGroup(IN int group,
  OUT BYTE *                      tlv,
  OUT int *                       tlvLen);

int
ctls_getAllConfigurationGroups(OUT BYTE * tlv,
  IN_OUT int *                            tlvLen);

int
ctls_removeConfigurationGroup(int group);

int
emv_getEMVKernelVersion(OUT char * version);

int
emv_getEMVKernelVersion_Len(OUT char * version, IN_OUT int * versionLen);

int
emv_getEMVKernelCheckValue(OUT BYTE * checkValue,
  IN_OUT int *                        checkValueLen);

int
emv_getEMVConfigurationCheckValue(OUT BYTE * checkValue,
  IN_OUT int *                               checkValueLen);

void
emv_allowFallback(IN int allow);

void
emv_setAutoAuthenticateTransaction(IN int authenticate);

void
emv_setAutoCompleteTransaction(IN int complete);

int
emv_getAutoAuthenticateTransaction();

int
emv_getAutoCompleteTransaction();

void
emv_setTransactionParameters(IN double amount,
  IN double                            amtOther,
  IN int                               type,
  IN int                               timeout,
  IN BYTE *                            tags,
  IN int                               tagsLen);

int
emv_startTransaction(IN double amount,
  IN double                    amtOther,
  IN int                       exponent,
  IN int                       type,
  IN int                       timeout,
  IN BYTE *                    tags,
  IN int                       tagsLen,
  IN int                       forceOnline);

int
emv_activateTransaction(IN int timeout,
  IN BYTE *                    tags,
  IN int                       tagsLen,
  IN int                       forceOnline);

int
emv_authenticateTransaction(IN BYTE * updatedTLV,
  IN int                              updatedTLVLen);

int
emv_authenticateTransactionWithTimeout(IN int timeout, IN BYTE * updatedTLV, IN int updatedTLVLen);

int
emv_completeTransaction(IN int commError,
  IN BYTE *                    authCode,
  IN int                       authCodeLen,
  IN BYTE *                    iad,
  IN int                       iadLen,
  IN BYTE *                    tlvScripts,
  IN int                       tlvScriptsLen,
  IN BYTE *                    tlv,
  IN int                       tlvLen);

int
emv_cancelTransaction();

int
emv_retrieveTransactionResult(IN BYTE * tags,
  IN int                                tagsLen,
  OUT IDTTransactionData *              cardData);

int
emv_retrieveApplicationData(IN BYTE * AID,
  IN int                              AIDLen,
  OUT BYTE *                          tlv,
  IN_OUT int *                        tlvLen);

int
emv_setApplicationData(IN BYTE * name,
  IN int                         nameLen,
  IN BYTE *                      tlv,
  IN int                         tlvLen);

int
emv_setApplicationDataTLV(IN BYTE * tlv,
  IN int                            tlvLen);

int
emv_removeApplicationData(IN BYTE * AID,
  IN int                            AIDLen);

int
emv_removeAllApplicationData();

int
emv_retrieveAIDList(OUT BYTE * AIDList,
  IN_OUT int *                 AIDListLen);

int
emv_retrieveTerminalData(OUT BYTE * tlv,
  IN_OUT int *                      tlvLen);

int
emv_setTerminalData(IN BYTE * tlv,
  IN int                      tlvLen);

int
emv_setTerminalMajorConfiguration(IN int configuration);

int
emv_retrieveCAPK(IN BYTE * capk,
  IN int                   capkLen,
  OUT BYTE *               key,
  IN_OUT int *             keyLen);

int
emv_setCAPK(IN BYTE * capk,
  IN int              capkLen);

int
emv_removeCAPK(IN BYTE * capk,
  IN int                 capkLen);

int
emv_removeAllCAPK();

int
emv_retrieveCAPKList(OUT BYTE * keys,
  IN_OUT int *                  keysLen);

int
emv_retrieveCRL(OUT BYTE * list,
  IN_OUT int *             lssLen);

int
emv_setCRL(IN BYTE * list,
  IN int             lsLen);

int
emv_removeCRL(IN BYTE * list,
  IN int                lsLen);

int
emv_removeAllCRL();

int
icc_getICCReaderStatus(OUT BYTE * status);

int
icc_powerOnICC(OUT BYTE * ATR,
  IN_OUT int *            inLen);

int
icc_powerOffICC();

int
icc_exchangeAPDU(IN BYTE * c_APDU,
  IN int                   cLen,
  OUT BYTE *               reData,
  IN_OUT int *             reLen);

int
lcd_createScreen(IN char * screenName, IN int screenNameLen, OUT int * ScreenID);

int
lcd_destroyScreen(IN char * screenName, IN int screenNameLen);

int
lcd_getActiveScreen(OUT char * screenName, IN_OUT int * screenNameLen);

int
lcd_showScreen(IN char * screenName, IN int screenNameLen);

int
lcd_getButtonEvent(OUT int * screenID, OUT int * objectID, OUT char * screenName, IN_OUT int * screenNameLen,
  OUT char * objectName, IN_OUT int * objectNameLen, OUT int * isLongPress);

int
lcd_addButton(IN char * screenName, IN int screenNameLen, IN char * buttonName, IN int buttonNameLen, IN BYTE type,
  IN BYTE alignment, IN int xCord, IN int yCord, IN char * label, IN int labelLen,
  OUT IDTLCDItem * returnItem);

int
lcd_addEthernet(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen,
  IN BYTE alignment, IN int xCord, IN int yCord, OUT IDTLCDItem * returnItem);

int
lcd_addLED(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN BYTE alignment,
  IN int xCord, IN int yCord, OUT IDTLCDItem * returnItem, IN BYTE * LED, IN int LEDLen);

int
lcd_addText(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN BYTE alignment,
  IN int xCord, IN int yCord, IN int width, IN int height, IN BYTE fontID, IN BYTE * color, IN int colorLen,
  IN char * label, IN int labelLen, OUT IDTLCDItem * returnItem);

int
lcd_addImage(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN BYTE alignment,
  IN int xCord, IN int yCord, IN char * filename, IN int filenameLen, OUT IDTLCDItem * returnItem);

int
lcd_addVideo(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN BYTE alignment,
  IN int xCord, IN int yCord, IN char * filename, IN int filenameLen, OUT IDTLCDItem * returnItem);

int
lcd_addExtVideo(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen,
  IN BYTE alignment, IN int xCord, IN int yCord, IN BYTE loop, IN BYTE numVideos, IN char * filenames,
  IN int filenamesLen, OUT IDTLCDItem * returnItem);

int
lcd_cloneScreen(IN char * screenName, IN int screenNameLen, IN char * cloneName, IN int cloneNameLen,
  OUT int * cloneID);

int
lcd_updateLabel(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN char * label,
  IN int labelLen);

int
lcd_updateColor(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen, IN BYTE * color,
  IN int colorLen);

int
lcd_updatePosition(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen,
  IN BYTE alignment, IN int new_xCord, IN int new_yCord);

int
lcd_removeItem(IN char * screenName, IN int screenNameLen, IN char * objectName, IN int objectNameLen);

int
lcd_storeScreenInfo();

int
lcd_loadScreenInfo();

int
lcd_clearScreenInfo();

int
lcd_clearDisplay(IN BYTE control);

int
lcd_displayMessage(int lineNumber,
  char *               message,
  int                  messageLen);

int
lcd_getAllScreens(IN_OUT int * screenNumbers, OUT IDTScreenInfo * screenInfo);

int
lcd_getAllObjects(IN char * screenName, IN int screenNameLen, IN_OUT int * objectNumbers,
  OUT IDTObjectInfo * objectInfo);

int
lcd_queryScreenbyName(IN char * screenName, IN int screenNameLen, OUT int * result);

int
lcd_linkUIWithTransactionMessageId(IN BYTE MessageId, IN char * screenName, IN int screenNameLen);

int
lcd_queryObjectbyName(IN char * objectName, IN int objectNameLen, IN_OUT int * objectNumbers,
  OUT IDTScreenInfo * screenInfo);

int
lcd_queryScreenbyID(IN int screenID, OUT int * result, OUT int * screenName, IN_OUT int * screenNameLen);

int
lcd_queryObjectbyID(IN int objectID, OUT int * objectNumbers, OUT IDTScreenInfo * screenInfo);

int
lcd_setBacklight(IN BYTE isBacklightOn, IN BYTE backlightVal);

int
msr_cancelMSRSwipe();

int
msr_startMSRSwipe(IN int _timeout);

int
executeTransaction(WorldPayData * data, pWP_callBack wpCallback, int requestOnly);

int
cancelWorldPay();

void
parseMSRData(IN BYTE * resData,
  IN int               resLen,
  IN_OUT IDTMSRData *  cardData);

int
pin_capturePin(IN int timeout, IN int type, IN char * PAN, IN int PANLen, IN int minPIN, IN int maxPIN,
  IN char * message, IN int messageLen);

int
pin_capturePinExt(IN int type, IN char * PAN, IN int PANLen, IN int minPIN, IN int maxPIN, IN char * message,
  IN int messageLen, IN char * verify, IN int verifyLen);

int
pin_promptForNumericKeyWithSwipe(IN int timeout, IN BYTE function, IN int minLen, IN int maxLen, IN char * line1,
  IN int line1Len, IN char * line2, IN int line2Len, BYTE * signature,
  IN int signatureLen);

int
pin_promptForNumericKey(IN int timeout, IN int maskInput, IN int minLen, IN int maxLen, IN char * message,
  IN int messageLen, BYTE * signature, IN int signatureLen);

int
pin_inputFromPrompt(BYTE mask, BYTE preClearText, BYTE postClearText, int minLen, int maxLen, char * lang,
  BYTE promptID, char * defaultResponse, int defaultResponseLen, int timeout);

int
pin_getPanEntry(IN int csc, IN int expDate, IN int ADR, IN int ZIP, IN int mod10CK, IN int timeout, IN int encPANOnly);

int
pin_cancelPINEntry();

int
pin_setKeyValues(int mode);

# ifdef __cplusplus
}
# endif


#endif // ifndef __LIBIDT_NEO2_H___