IDTech Universal SDK  1.0.35.027
API reference for C++
libIDT_Augusta.h
Go to the documentation of this file.
1 #ifndef __LIBIDT_AUGUSTA_H___
2 # define __LIBIDT_AUGUSTA_H___
3 
4 
5 # define IN
6 # define OUT
7 # define IN_OUT
8 # include "IDTDef.h"
9 
15 typedef void (* pMessageHotplug)(int, int);
16 
21 typedef void (* pSendDataLog)(BYTE *, int);
22 
27 typedef void (* pReadDataLog)(BYTE *, int);
28 
33 typedef void (* pEMV_callBack)(int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int);
34 
39 typedef void (* pMSR_callBack)(int, IDTMSRData);
40 
45 typedef void (* pMSR_callBackp)(int, IDTMSRData *);
46 
51 typedef void (* pPIN_callBack)(int, IDTPINData *);
52 
57 typedef void (* pCMR_callBack)(int, IDTCMRData *);
58 
63 typedef void (* pCSFS_callBack)(BYTE status);
64 
69 typedef void (* pFW_callBack)(int, int, int, int, int);
70 
81 typedef void (* ftpComm_callBack)(int, int, int);
82 
87 typedef void (* httpComm_callBack)(BYTE *, int);
88 
95 typedef void (* v4Comm_callBack)(BYTE, BYTE, BYTE *, int);
96 
97 
98 # ifdef __cplusplus
99 extern "C" {
100 # endif
101 
105 void
107 
111 void
113 
117 void
119 
123 void
125 
129 void
131 
135 void
137 
141 void
143 
147 void
149 
153 void
155 
160 char *
161 SDK_Version();
162 
171 int
172 setAbsoluteLibraryPath(const char * absoluteLibraryPath);
173 
181 int
182 device_init();
183 
184 
226 int
227 device_setCurrentDevice(int deviceType);
228 
229 
235 int
236 device_close();
237 
596 void
597 device_getResponseCodeString(IN int returnCode, OUT char * despcrition);
598 
603 int
605 
612 int
613 device_isAttached(int deviceType);
614 
623 int
624 device_getFirmwareVersion(OUT char * firmwareVersion);
625 
637 int
638 device_getFirmwareVersion_Len(OUT char * firmwareVersion, IN_OUT int * firmwareVersionLen);
639 
645 int
647 
665 // int device_SendDataCommand(IN BYTE* cmd, IN int cmdLen, OUT BYTE* response, IN_OUT int *respLen);
666 int
667 device_SendDataCommand(IN BYTE * cmd, IN int cmdLen, IN BYTE * data, IN int dataLen, OUT BYTE * response,
668  IN_OUT int * respLen);
669 
695 int
696 device_updateFirmware(IN BYTE * firmwareData, IN int firmwareDataLen, IN char * firmwareName, IN int encryptionType,
697  IN BYTE * keyBlob, IN int keyBlobLen);
698 
708 int
710 
733 // intervalOn = 500, int intervalOff = 500
734 int
735 device_controlLED(byte indexLED, byte control, int intervalOn, int intervalOff);
736 
737 
751 int
752 device_controlLED_ICC(int controlMode, int interval);
753 
774 // int intervalOn = 500, int intervalOff = 500)
775 
776 int
777 device_controlLED_MSR(byte control, int intervalOn, int intervalOff);
778 
792 int
793 device_controlBeep(int index, int frequency, int duration);
794 
830 int
831 device_getDRS(BYTE * codeDRS, int * codeDRSLen);
832 
898 int
899 device_getKeyStatus(int * newFormat, BYTE * status, int * statusLen);
900 
909 int
911 
921 void
922 device_setSDKWaitTime(int waitTime);
923 
932 int
934 
942 void
943 device_setThreadStackSize(int threadSize);
944 
953 int
954 config_getModelNumber(OUT char * sNumber);
955 
967 int
968 config_getModelNumber_Len(OUT char * sNumber, IN_OUT int * sNumberLen);
969 
980 int
981 config_getSerialNumber(OUT char * sNumber);
982 
992 int
993 config_getSerialNumber_Len(OUT char * sNumber, IN_OUT int * sNumberLen);
994 
1009 int
1010 config_setLEDController(IN int firmwareControlMSRLED, IN int firmwareControlICCLED);
1011 
1025 int
1026 config_getLEDController(OUT int * firmwareControlMSRLED, OUT int * firmwareControlICCLED);
1027 
1037 int
1038 config_setBeeperController(IN int firmwareControlBeeper);
1039 
1048 int
1049 config_getBeeperController(OUT int * firmwareControlBeeper);
1050 
1070 int
1071 config_setEncryptionControl(IN int msr, IN int icc);
1072 
1092 int
1093 config_getEncryptionControl(OUT int * msr, OUT int * icc);
1094 
1105 int
1106 icc_enable(IN int withNotification);
1107 
1113 int
1114 icc_disable();
1115 
1125 int
1126 icc_powerOnICC(OUT BYTE * ATR, IN_OUT int * inLen);
1127 
1138 int
1139 icc_powerOffICC();
1140 
1154 int
1155 icc_exchangeAPDU(IN BYTE * c_APDU, IN int cLen, OUT BYTE * reData, IN_OUT int * reLen);
1156 
1189 int
1190 icc_exchangeEncryptedAPDU(IN BYTE * c_APDU, IN int cLen, OUT BYTE * reData, IN_OUT int * reLen);
1191 
1202 int
1203 icc_getAPDU_KSN(OUT BYTE * KSN, IN_OUT int * inLen);
1204 
1216 int
1217 icc_getFunctionStatus(OUT int * enabled, OUT int * withNotification);
1218 
1229 int
1230 icc_getICCReaderStatus(OUT BYTE * status);
1231 
1243 int
1244 icc_getKeyFormatForICCDUKPT(OUT BYTE * format);
1245 
1258 int
1259 icc_getKeyTypeForICCDUKPT(OUT BYTE * type);
1260 
1271 int
1272 emv_getEMVKernelVersion(OUT char * version);
1273 
1284 int
1285 emv_getEMVKernelVersion_Len(OUT char * version, IN_OUT int * versionLen);
1286 
1296 int
1297 emv_getEMVKernelCheckValue(OUT BYTE * checkValue, IN_OUT int * checkValueLen);
1298 
1307 int
1308 emv_getEMVConfigurationCheckValue(OUT BYTE * checkValue, IN_OUT int * checkValueLen);
1309 
1314 void
1315 emv_allowFallback(IN int allow);
1316 
1322 void
1323 emv_setAutoAuthenticateTransaction(IN int authenticate);
1324 
1330 void
1331 emv_setAutoCompleteTransaction(IN int complete);
1332 
1337 int
1339 
1344 int
1346 
1368 int
1369 emv_startTransaction(IN double amount, IN double amtOther, IN int exponent, IN int type, IN int timeout, IN BYTE * tags,
1370  IN int tagsLen, IN int forceOnline);
1371 
1372 
1391 int
1392 emv_activateTransaction(IN int timeout, IN BYTE * tags, IN int tagsLen, IN int forceOnline);
1393 
1398 void
1399 device_setTransactionExponent(int exponent);
1400 
1428 int
1429 device_startTransaction(IN double amount,
1430  IN double amtOther,
1431  IN int type,
1432  IN const int _timeout,
1433  IN BYTE * tags,
1434  IN int tagsLen);
1435 
1452 int
1453 emv_authenticateTransaction(IN BYTE * updatedTLV, IN int updatedTLVLen);
1454 
1472 int
1473 emv_authenticateTransactionWithTimeout(IN int timeout, IN BYTE * updatedTLV, IN int updatedTLVLen);
1474 
1494 int
1495 emv_completeTransaction(IN int commError, IN BYTE * authCode, IN int authCodeLen,
1496  IN BYTE * iad, IN int iadLen, IN BYTE * tlvScripts, IN int tlvScriptsLen, IN BYTE * tlv, IN int tlvLen);
1497 
1504 int
1506 
1511 int
1513 
1527 int
1528 emv_retrieveTransactionResult(IN BYTE * tags, IN int tagsLen, IDTTransactionData * cardData);
1529 
1545 int
1546 emv_callbackResponseLCD(IN int type, byte selection);
1547 
1559 int
1560 emv_callbackResponseMSR(IN BYTE * MSR, IN_OUT int MSRLen);
1561 
1574 int
1575 emv_retrieveApplicationData(IN BYTE * AID, IN int AIDLen, OUT BYTE * tlv, IN_OUT int * tlvLen);
1576 
1589 int
1590 emv_setApplicationData(IN BYTE * name, IN int nameLen, IN BYTE * tlv, IN int tlvLen);
1591 
1601 int
1602 emv_removeApplicationData(IN BYTE * AID, IN int AIDLen);
1603 
1613 int
1615 
1627 int
1628 emv_retrieveAIDList(OUT BYTE * AIDList, IN_OUT int * AIDListLen);
1629 
1641 int
1642 emv_retrieveTerminalData(OUT BYTE * tlv, IN_OUT int * tlvLen);
1643 
1655 int
1656 emv_setTerminalData(IN BYTE * tlv, IN int tlvLen);
1657 
1666 int
1668 
1689 int
1690 emv_retrieveCAPK(IN BYTE * capk, IN int capkLen, OUT BYTE * key, IN_OUT int * keyLen);
1691 
1710 int
1711 emv_setCAPK(IN BYTE * capk, IN int capkLen);
1712 
1723 int
1724 emv_removeCAPK(IN BYTE * capk, IN int capkLen);
1725 
1734 int
1736 
1747 int
1748 emv_retrieveCAPKList(OUT BYTE * keys, IN_OUT int * keysLen);
1749 
1758 int
1759 emv_retrieveTerminalID(OUT char * terminalID);
1760 
1769 int
1770 emv_retrieveTerminalID_Len(OUT char * terminalID, IN_OUT int * terminalIDLen);
1771 
1778 int
1779 emv_setTerminalID(IN char * terminalID);
1780 
1791 int
1792 emv_retrieveCRL(OUT BYTE * list, IN_OUT int * lssLen);
1793 
1806 int
1807 emv_setCRL(IN BYTE * list, IN int lsLen);
1808 
1819 int
1820 emv_removeCRL(IN BYTE * list, IN int lsLen);
1821 
1831 int
1833 
1841 int
1842 msr_getMSRData(OUT BYTE * reData, IN_OUT int * reLen);
1843 
1849 int
1851 
1858 int
1859 msr_startMSRSwipe(IN int _timeout);
1860 
1874 int
1875 executeTransaction(WorldPayData * data, pWP_callBack wpCallback, int requestOnly);
1876 
1881 int
1882 cancelWorldPay();
1883 
1890 void
1891 parseMSRData(IN BYTE * resData, IN int resLen, IN_OUT IDTMSRData * cardData);
1892 
1904 int
1905 msr_getKeyFormatForICCDUKPT(OUT BYTE * format);
1906 
1919 int
1920 msr_getKeyTypeForICCDUKPT(OUT BYTE * type);
1921 
1933 int
1934 msr_setKeyFormatForICCDUKPT(IN BYTE format);
1935 
1947 int
1948 msr_setKeyTypeForICCDUKPT(IN BYTE type);
1949 
1968 int
1969 msr_captureMode(IN int isBufferMode, IN int withNotification);
1970 
1983 int
1984 msr_setSetting(IN BYTE setting, IN BYTE * val, IN int valLen);
1985 
2000 int
2001 msr_getSetting(IN byte setting, OUT BYTE * value, IN_OUT int * valueLen);
2002 
2017 int
2018 msr_setSwipeForcedEncryptionOption(IN int track1, IN int track2, IN int track3, IN int track3card0);
2019 
2033 int
2035 
2050 int
2051 msr_setSwipeMaskOption(IN int track1, IN int track2, IN int track3);
2052 
2068 int
2069 msr_getSwipeMaskOption(OUT BYTE * option);
2070 
2081 int
2082 msr_setExpirationMask(IN int mask);
2083 
2093 int
2094 msr_getExpirationMask(OUT BYTE * value);
2095 
2104 int
2105 msr_setClearPANID(IN BYTE val);
2106 
2118 int
2119 msr_getClearPANID(OUT BYTE * value);
2120 
2126 int
2127 msr_disable();
2128 
2136 int
2138 
2139 # ifdef __cplusplus
2140 }
2141 # endif
2142 
2143 
2144 #endif // ifndef __LIBIDT_AUGUSTA_H___
2145 
int pin_cancelPINEntry()
void(* httpComm_callBack)(BYTE *, int)
Definition: libIDT_Augusta.h:87
int icc_enable(IN int withNotification)
int msr_cancelMSRSwipe()
int device_controlLED_ICC(int controlMode, int interval)
int emv_getAutoAuthenticateTransaction()
int emv_retrieveCRL(OUT BYTE *list, IN_OUT int *lssLen)
int emv_authenticateTransaction(IN BYTE *updatedTLV, IN int updatedTLVLen)
int device_isAttached(int deviceType)
void device_getResponseCodeString(IN int returnCode, OUT char *despcrition)
int emv_setCAPK(IN BYTE *capk, IN int capkLen)
int msr_getSwipeForcedEncryptionOption(OUT BYTE *option)
int emv_activateTransaction(IN int timeout, IN BYTE *tags, IN int tagsLen, IN int forceOnline)
int emv_cancelTransaction()
void(* pFW_callBack)(int, int, int, int, int)
Definition: libIDT_Augusta.h:69
int device_getKeyStatus(int *newFormat, BYTE *status, int *statusLen)
void(* pPIN_callBack)(int, IDTPINData *)
Definition: libIDT_Augusta.h:51
int emv_removeAllApplicationData()
int msr_setExpirationMask(IN int mask)
int config_getModelNumber(OUT char *sNumber)
void device_setTransactionExponent(int exponent)
int emv_removeTerminalData()
int emv_setCRL(IN BYTE *list, IN int lsLen)
int emv_callbackResponseLCD(IN int type, byte selection)
int config_setEncryptionControl(IN int msr, IN int icc)
int device_getThreadStackSize()
int emv_getEMVKernelVersion_Len(OUT char *version, IN_OUT int *versionLen)
char * SDK_Version()
int config_setLEDController(IN int firmwareControlMSRLED, IN int firmwareControlICCLED)
int msr_setSwipeForcedEncryptionOption(IN int track1, IN int track2, IN int track3, IN int track3card0)
#define OUT
int device_SendDataCommand(IN BYTE *cmd, IN int cmdLen, IN BYTE *data, IN int dataLen, OUT BYTE *response, IN_OUT int *respLen)
int msr_captureMode(IN int isBufferMode, IN int withNotification)
int icc_powerOffICC()
int emv_getEMVKernelCheckValue(OUT BYTE *checkValue, IN_OUT int *checkValueLen)
int msr_getKeyTypeForICCDUKPT(OUT BYTE *type)
int emv_getEMVConfigurationCheckValue(OUT BYTE *checkValue, IN_OUT int *checkValueLen)
void emv_registerCallBk(pEMV_callBack pEMVf)
int msr_setKeyTypeForICCDUKPT(IN BYTE type)
int emv_authenticateTransactionWithTimeout(IN int timeout, IN BYTE *updatedTLV, IN int updatedTLVLen)
void msr_registerCallBk(pMSR_callBack pMSRf)
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)
void msr_registerCallBkp(pMSR_callBackp pMSRf)
void pin_registerCallBk(pPIN_callBack pPINf)
int device_startTransaction(IN double amount, IN double amtOther, IN int type, IN const int _timeout, IN BYTE *tags, IN int tagsLen)
void device_registerCardStatusFrontSwitchCallBk(pCSFS_callBack pCSFSf)
int emv_retrieveCAPKList(OUT BYTE *keys, IN_OUT int *keysLen)
int emv_callbackResponseMSR(IN BYTE *MSR, IN_OUT int MSRLen)
int device_getFirmwareVersion(OUT char *firmwareVersion)
void parseMSRData(IN BYTE *resData, IN int resLen, IN_OUT IDTMSRData *cardData)
int emv_removeApplicationData(IN BYTE *AID, IN int AIDLen)
int emv_setTerminalID(IN char *terminalID)
int msr_setSwipeMaskOption(IN int track1, IN int track2, IN int track3)
int device_close()
void registerHotplugCallBk(pMessageHotplug pMsgHotplug)
void device_registerFWCallBk(pFW_callBack pFWf)
int emv_retrieveTransactionResult(IN BYTE *tags, IN int tagsLen, IDTTransactionData *cardData)
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)
void(* pCSFS_callBack)(BYTE status)
Definition: libIDT_Augusta.h:63
int msr_getExpirationMask(OUT BYTE *value)
int emv_retrieveTerminalID_Len(OUT char *terminalID, IN_OUT int *terminalIDLen)
int config_getModelNumber_Len(OUT char *sNumber, IN_OUT int *sNumberLen)
int device_isConnected()
void emv_setAutoCompleteTransaction(IN int complete)
void(* v4Comm_callBack)(BYTE, BYTE, BYTE *, int)
Definition: libIDT_Augusta.h:95
int icc_getKeyFormatForICCDUKPT(OUT BYTE *format)
int emv_retrieveTerminalID(OUT char *terminalID)
int msr_setKeyFormatForICCDUKPT(IN BYTE format)
int icc_getFunctionStatus(OUT int *enabled, OUT int *withNotification)
int device_getCurrentDeviceType()
int config_getEncryptionControl(OUT int *msr, OUT int *icc)
int emv_removeCAPK(IN BYTE *capk, IN int capkLen)
void(* pMSR_callBackp)(int, IDTMSRData *)
Definition: libIDT_Augusta.h:45
int icc_getKeyTypeForICCDUKPT(OUT BYTE *type)
int device_controlLED(byte indexLED, byte control, int intervalOn, int intervalOff)
void(* pWP_callBack)(char *, int, int)
Definition: libIDT_Device.h:53
int cancelWorldPay()
int emv_getEMVKernelVersion(OUT char *version)
void device_setThreadStackSize(int threadSize)
int device_controlBeep(int index, int frequency, int duration)
int msr_getSetting(IN byte setting, OUT BYTE *value, IN_OUT int *valueLen)
void device_registerCameraCallBk(pCMR_callBack pCMRf)
int config_getSerialNumber_Len(OUT char *sNumber, IN_OUT int *sNumberLen)
void(* pSendDataLog)(BYTE *, int)
Definition: libIDT_Augusta.h:21
int msr_getClearPANID(OUT BYTE *value)
int device_cancelTransaction()
int executeTransaction(WorldPayData *data, pWP_callBack wpCallback, int requestOnly)
void device_setSDKWaitTime(int waitTime)
void emv_setAutoAuthenticateTransaction(IN int authenticate)
int msr_disable()
int device_setCurrentDevice(int deviceType)
int device_getFirmwareVersion_Len(OUT char *firmwareVersion, IN_OUT int *firmwareVersionLen)
int emv_setApplicationData(IN BYTE *name, IN int nameLen, IN BYTE *tlv, IN int tlvLen)
int emv_retrieveCAPK(IN BYTE *capk, IN int capkLen, OUT BYTE *key, IN_OUT int *keyLen)
int emv_removeAllCAPK()
int device_rebootDevice()
void(* pMSR_callBack)(int, IDTMSRData)
Definition: libIDT_Augusta.h:39
void(* pCMR_callBack)(int, IDTCMRData *)
Definition: libIDT_Augusta.h:57
int emv_retrieveAIDList(OUT BYTE *AIDList, IN_OUT int *AIDListLen)
#define IN_OUT
void emv_allowFallback(IN int allow)
int emv_setTerminalData(IN BYTE *tlv, IN int tlvLen)
void(* pMessageHotplug)(int, int)
Definition: libIDT_Augusta.h:15
int device_getSDKWaitTime()
int setAbsoluteLibraryPath(const char *absoluteLibraryPath)
int config_getSerialNumber(OUT char *sNumber)
void registerLogCallBk(pSendDataLog pFSend, pReadDataLog pFRead)
int msr_getSwipeMaskOption(OUT BYTE *option)
int icc_exchangeAPDU(IN BYTE *c_APDU, IN int cLen, OUT BYTE *reData, IN_OUT int *reLen)
int emv_retrieveApplicationData(IN BYTE *AID, IN int AIDLen, OUT BYTE *tlv, IN_OUT int *tlvLen)
int emv_getAutoCompleteTransaction()
int config_setBeeperController(IN int firmwareControlBeeper)
int icc_getAPDU_KSN(OUT BYTE *KSN, IN_OUT int *inLen)
int device_controlLED_MSR(byte control, int intervalOn, int intervalOff)
int config_getLEDController(OUT int *firmwareControlMSRLED, OUT int *firmwareControlICCLED)
int icc_powerOnICC(OUT BYTE *ATR, IN_OUT int *inLen)
int emv_removeAllCRL()
int msr_startMSRSwipe(IN int _timeout)
int msr_getMSRData(OUT BYTE *reData, IN_OUT int *reLen)
void(* pReadDataLog)(BYTE *, int)
Definition: libIDT_Augusta.h:27
int icc_exchangeEncryptedAPDU(IN BYTE *c_APDU, IN int cLen, OUT BYTE *reData, IN_OUT int *reLen)
int emv_retrieveTerminalData(OUT BYTE *tlv, IN_OUT int *tlvLen)
int device_getDRS(BYTE *codeDRS, int *codeDRSLen)
int config_getBeeperController(OUT int *firmwareControlBeeper)
int device_updateFirmware(IN BYTE *firmwareData, IN int firmwareDataLen, IN char *firmwareName, IN int encryptionType, IN BYTE *keyBlob, IN int keyBlobLen)
int msr_setClearPANID(IN BYTE val)
#define IN
int icc_getICCReaderStatus(OUT BYTE *status)
int msr_getKeyFormatForICCDUKPT(OUT BYTE *format)
int icc_disable()
void(* ftpComm_callBack)(int, int, int)
Definition: libIDT_Augusta.h:81
int device_init()
int emv_removeCRL(IN BYTE *list, IN int lsLen)
void(* pEMV_callBack)(int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int)
Definition: libIDT_Augusta.h:33
int msr_setSetting(IN BYTE setting, IN BYTE *val, IN int valLen)