IDTech iOS SDK Guide  1.1.101
API reference for VP3300
IDT_VP3300.h
1 //
2 // IDT_VP3300.h
3 // IDTech
4 //
5 // Created by Randy Palermo on 10/29/14.
6 // Copyright (c) 2014 IDTech Products. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import "IDTMSRData.h"
11 #import "IDT_Device.h"
12 
14 @protocol IDT_VP3300_Delegate <NSObject>
15 @optional
16 -(void) deviceConnected;
17 -(void) deviceDisconnected;
18 - (void) plugStatusChange:(BOOL)deviceInserted;
19 - (void) dataInOutMonitor:(NSData*)data incoming:(BOOL)isIncoming;
21 
26 - (void) swipeMSRData:(IDTMSRData*)cardData;
27 
29 - (void) deviceMessage:(NSString*)message;
30 
32 
33 
34 
48 - (void) lcdDisplay:(int)mode lines:(NSArray*)lines;
49 
67 - (void) pinRequest:(EMV_PIN_MODE_Types)mode key:(NSData*)key PAN:(NSData*)PAN startTO:(int)startTO intervalTO:(int)intervalTO language:(NSString*)language;
68 
69 
70 
83 - (void) emvTransactionData:(IDTEMVData*)emvData errorCode:(int)error;
84 
85 @end
86 
90 @interface IDT_VP3300 : NSObject<IDT_Device_Delegate>{
91  id<IDT_VP3300_Delegate> delegate;
92 }
93 
94 @property(strong) id<IDT_VP3300_Delegate> delegate;
95 
96 
97 
105 +(NSString*) SDK_version;
106 
115 
120 -(void) close;
121 
129 -(void) device_connectToUSB;
130 
131 
132 
139 -(RETURN_CODE) ctls_cancelTransaction;
140 
141 
142 
149 -(RETURN_CODE) emv_cancelTransaction;
150 
151 
152 
159 -(RETURN_CODE) device_cancelTransaction;
160 
161 
174 -(RETURN_CODE) ctls_getConfigurationGroup:(int)group response:(NSDictionary**)response;
175 
176 
177 
178 
188 -(RETURN_CODE) ctls_removeAllCAPK;
189 
200 -(RETURN_CODE) ctls_removeApplicationData:(NSString*)AID;
201 
212 -(RETURN_CODE) ctls_removeCAPK:(NSData*)capk;
213 
224 -(RETURN_CODE) ctls_removeConfigurationGroup:(int)group;
225 
226 
237 -(RETURN_CODE) ctls_retrieveAIDList:(NSArray**)response;
238 
249 -(RETURN_CODE) ctls_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)response;
250 
268 -(RETURN_CODE) ctls_retrieveCAPK:(NSData*)capk key:(NSData**)key;
269 
270 
280 -(RETURN_CODE) ctls_retrieveCAPKList:(NSArray**)keys;
281 
294 -(RETURN_CODE) ctls_retrieveTerminalData:(NSData**)tlv;
295 
311 -(RETURN_CODE) ctls_setApplicationData:(NSData*)tlv;
312 
330 -(RETURN_CODE) ctls_setCAPK:(NSData*)key;
331 
332 
346 -(RETURN_CODE) ctls_setConfigurationGroup:(NSData*)tlv;
347 
348 
362 -(RETURN_CODE) ctls_setTerminalData:(NSData*)tlv;
363 
364 
365 
366 
414 -(RETURN_CODE) ctls_startTransaction:(double)amount type:(int)type timeout:(int)timeout tags:(NSMutableDictionary *)tags;
415 
416 
417 
430 -(RETURN_CODE) ctls_startTransaction;
431 
432 
433 
443 -(RETURN_CODE) device_cancelConnectToAudioReader;
452 -(RETURN_CODE) device_connectToAudioReader;
453 
454 
473 -(RETURN_CODE) device_getFirmwareVersion:(NSString**)response;
474 
475 
494 -(bool) device_enableBLEDeviceSearch:(NSUUID*)identifier;
495 
496 
497 
505 -(NSString*) device_getBLEFriendlyName;
506 
507 
515 -(void) device_setBLEFriendlyName:(NSString*)friendlyName;
516 
517 
528 
536 -(NSUUID*) device_connectedBLEDevice;
537 
538 
539 
551 
552 
562 -(RETURN_CODE) device_getAutoPollTransactionResults:(IDTEMVData**)result;
563 
576 -(NSString *) device_getResponseCodeString: (int) errorCode;
577 
593 -(bool) device_isConnected:(IDT_DEVICE_Types)device;
594 
608 -(RETURN_CODE) device_sendIDGCommand:(unsigned char)command subCommand:(unsigned char)subCommand data:(NSData*)data response:(NSData**)response;
609 
630 -(RETURN_CODE) device_setAudioVolume:(float)val;
631 
651 -(RETURN_CODE) device_setPassThrough:(BOOL)enablePassThrough;
652 
653 
664 -(RETURN_CODE) device_setBurstMode:(int) mode;
665 
666 
677 -(RETURN_CODE) device_setPollMode:(int) mode;
678 
679 
697 -(RETURN_CODE) device_startRKI;
698 
724 -(RETURN_CODE) emv_authenticateTransaction:(NSData*)tags;
741 -(RETURN_CODE) emv_callbackResponseLCD:(int)mode selection:(unsigned char) selection;
742 
759 -(RETURN_CODE) emv_callbackResponsePIN:(EMV_PIN_MODE_Types)mode KSN:(NSData*)KSN PIN:(NSData*)PIN;
760 
803 -(RETURN_CODE) emv_completeOnlineEMVTransaction:(BOOL)isSuccess hostResponseTags:(NSData*)tags;
804 
805 
806 
815 -(void) emv_disableAutoAuthenticateTransaction:(BOOL)disable;
816 
817 
818 
837 -(RETURN_CODE) emv_getEMVL2Version:(NSString**)response;
838 
858 -(RETURN_CODE) emv_removeApplicationData:(NSString*)AID;
859 
880 -(RETURN_CODE) emv_removeCAPK:(NSString*)rid index:(NSString*)index ;
881 
893 -(RETURN_CODE) emv_setTerminalMajorConfiguration:(int)configuration;
894 
906 -(RETURN_CODE) emv_getTerminalMajorConfiguration:(NSUInteger**)configuration;
907 
908 
926 -(RETURN_CODE) emv_removeCRLList;
927 
928 
947 -(RETURN_CODE) emv_removeTerminalData;
948 
968 -(RETURN_CODE) emv_retrieveAIDList:(NSArray**)response;
969 
970 
999 -(RETURN_CODE) emv_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)responseAID;
1000 
1023 -(RETURN_CODE) emv_retrieveCAPK:(NSString*)rid index:(NSString*)index response:(CAKey**)response;
1024 
1025 
1057 -(RETURN_CODE) emv_retrieveCAPKFile:(NSString*)rid index:(NSString*)index response:(NSData**)response;
1058 
1078 -(RETURN_CODE) emv_retrieveCAPKList:(NSArray**)response;
1079 
1080 
1081 
1101 -(RETURN_CODE) emv_retrieveCRLList:(NSMutableArray**)response;
1102 
1103 
1104 
1105 
1106 
1128 -(RETURN_CODE) emv_retrieveTerminalData:(NSDictionary**)responseData;
1129 
1151 -(RETURN_CODE) emv_retrieveTransactionResult:(NSData*)tags retrievedTags:(NSDictionary**)retrievedTags;
1152 
1199 -(RETURN_CODE) emv_setApplicationData:(NSString*)aidName configData:(NSDictionary*)data;
1200 
1220 -(RETURN_CODE) emv_setCAPK:(CAKey)key;
1221 
1239 -(RETURN_CODE) emv_setCAPKFile:(NSData*)file;
1240 
1264 -(RETURN_CODE) emv_setCRLEntries:(NSData*)data;
1265 
1266 
1267 
1268 
1314 -(RETURN_CODE) emv_setTerminalData:(NSDictionary*)data;
1315 
1316 
1317 
1318 
1319 
1346 -(RETURN_CODE) emv_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
1347 
1348 
1359 -(RETURN_CODE) config_getSerialNumber:(NSString**)response;
1360 
1375 -(RETURN_CODE) icc_exchangeAPDU:(NSData*)dataAPDU response:(APDUResponse**)response;
1406 -(RETURN_CODE) icc_getICCReaderStatus:(ICCReaderStatus**)readerStatus;
1407 
1423 -(RETURN_CODE) icc_powerOnICC:(NSData**)response;
1424 
1425 
1426 
1441 -(RETURN_CODE) icc_powerOffICC:(NSString**)error;
1442 
1453 -(RETURN_CODE) msr_cancelMSRSwipe;
1454 
1467 -(RETURN_CODE) msr_startMSRSwipe;
1468 
1472 -(bool) isConnected;
1473 
1474 
1475 
1500 -(RETURN_CODE) device_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
1501 
1502 
1503 @end
BOOL device_isAudioReaderConnected()
void deviceDisconnected()
Fires when device disconnects.
bool isConnected()
RETURN_CODE emv_cancelTransaction()
void deviceConnected()
Fires when device connects. If a connection is established before the delegate is established (no del...
Definition: IDTMSRData.h:21
RETURN_CODE ctls_startTransaction()
Definition: IDT_VP3300.h:14
bool device_disableBLEDeviceSearch()
RETURN_CODE device_cancelTransaction()
NSString * device_getBLEFriendlyName()
void device_connectToUSB()
Definition: APDUResponse.h:14
RETURN_CODE device_connectToAudioReader()
RETURN_CODE emv_removeCRLList()
RETURN_CODE msr_cancelMSRSwipe()
Definition: IDTCommon.h:13
NSString * SDK_version()
Definition: IDTCommon.h:42
RETURN_CODE ctls_removeAllCAPK()
RETURN_CODE device_cancelConnectToAudioReader()
NSUUID * device_connectedBLEDevice()
RETURN_CODE emv_removeTerminalData()
RETURN_CODE msr_startMSRSwipe()
IDT_VP3300 * sharedController()
id< IDT_VP3300_Delegate > delegate
Definition: IDT_VP3300.h:91
Definition: IDT_VP3300.h:90
RETURN_CODE device_startRKI()
Definition: IDTEMVData.h:16
RETURN_CODE ctls_cancelTransaction()