Public Member Functions
RETURN_CODE	msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode)

RETURN_CODE	msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode, ref string ident)

RETURN_CODE	device_getOutputType (bool isSwipe, ref int response, string ident="")

RETURN_CODE	device_setOutputType (bool isSwipe, int value, string ident="")

RETURN_CODE	config_getModelNumber (ref string response, string ident="")

RETURN_CODE	device_sendVivoCommandP3 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="")

RETURN_CODE	device_sendVivoCommandP3_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ident="")

RETURN_CODE	device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="")

RETURN_CODE	device_StartRKI (int type, string ident="")

RETURN_CODE	device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ident="")

RETURN_CODE	config_getSerialNumber (ref string response, string ident="")

RETURN_CODE	device_getFirmwareVersion (ref string response, string ident="")

string	device_getResponseCodeString (RETURN_CODE eCode)

RETURN_CODE	device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ident="")

RETURN_CODE	device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse, string ident="")

RETURN_CODE	device_capturePINFromLast12 (int min, int max, int timeout, string last12, string ident="")

RETURN_CODE	device_sendPAE (string command, ref string response, int timeout, string ident="")

RETURN_CODE	device_getRKIStatus (bool isProd, bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="")

RETURN_CODE	device_getAnyRKIStatus (bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="")

RETURN_CODE	device_updateFirmwareFromZip (byte[] zipfile, string ident="", bool isForeground=false)

RETURN_CODE	device_sendConfigurationFromZip (byte[] zip, string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false)

RETURN_CODE	device_sendConfiguration (string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false)

RETURN_CODE	device_readConfigurationToMemory (string memo, Configs.InstallRules rules, List< Configs.DeviceCommand > cmds, string ident="", bool isForeground=false)

RETURN_CODE	device_getConfigurationFromMemory (ref string json, string ident="")

RETURN_CODE	device_RemoteKeyInjection (RKI_KEY_TYPE type, string keyName, string ident="", bool performOnForeground=false)

Static Public Member Functions
static void	initSC ()

static int	getCommandTimeout (string ident="")

static void	setCommandTimeout (int milliseconds, string ident="")

static void	setCallback (CallBack my_Callback)

static void	setCallback (IntPtr my_Callback, SynchronizationContext context)

static String	SDK_Version ()

static void	lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2)

Properties
static IDT_SecureKey	SharedController `[get]`

Detailed Description

Class for SecureKey MSR reder

Member Function Documentation

RETURN_CODE IDTechSDK.IDT_SecureKey.config_getModelNumber	(	ref string	response,
		string	ident = `""`
	)

Polls device for Model Number

Parameters

response	Returns Model Number
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.config_getSerialNumber	(	ref string	response,
		string	ident = `""`
	)

Polls device for Serial Number

Parameters

response	Returns Serial Number
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_capturePINFromLast12	(	int	min,
		int	max,
		int	timeout,
		string	last12,
		string	ident = `""`
	)

Capture PIN From Last 12

Captures a PIN from provided last 12 PAN.

Parameters

min	Minimum PIN entry
max	Maximum PIN Entry
timeout	Timeout
last12	Last 12 digits of PAN
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_getAnyRKIStatus	(	bool	isMultiKey,
		ref string	status,
		ref Dictionary< string, RKI_KEY_TYPE >	keys,
		string	ident = `""`
	)

Get RKI Status Polls the RKI servers to validate device RKI eligiblity. Note: if device type is known in advance (production or demo device), it is more efficient to use device_getRKIStatus instead

Parameters

isMultiKey	True = MultiKey, False = SingleKey
status	RKI status returned as a string
keys	Returns all available keys
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_getConfigurationFromMemory	(	ref string	json,
		string	ident = `""`
	)

Read Device Configuration From Memory Retrieves the ViVOconfig configuration data from memory after a successful device_readConfigurationToMemory

Parameters

json	Returns the .json file data that can be saved to disk
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_getFirmwareVersion	(	ref string	response,
		string	ident = `""`
	)

Polls device for Firmware Version

Parameters

response	Response returned of Firmware Version
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_getOutputType	(	bool	isSwipe,
		ref int	response,
		string	ident = `""`
	)

Get Captured Data Output Type

Parameters

isSwipe	TRUE = settings for Swipe, FALSE = settings for MSR (only applicable for Original/Enhanced formats, string ident = "") NOTE: IF XML is chosen, this parameter is ignored
response	0 : Original Format 1 : Enhanced Format 2 : XML Format
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

string IDTechSDK.IDT_SecureKey.device_getResponseCodeString ( RETURN_CODE eCode )

Get the description of response result.

Parameters

eCode the response result.

Return values

the	string for description of response result

case 0: "no error, beginning task";
case 1: "no response from reader";
case 2: "invalid response data";
case 3: "time out for task or CMD";
case 4: "wrong parameter";
case 5: "SDK is doing MSR or ICC task";
case 6: "SDK is doing PINPad task";
case 7: "SDK is doing CTLS task";
case 8: "SDK is doing EMV task";
case 9: "SDK is doing Other task";
case 10: "err response or data";
case 11: "no reader attached";
case 12: "mono audio is enabled";
case 13: "did connection";
case 14: "audio volume is too low";
case 15: "task or CMD be canceled";
case 16: "UF wrong string format";
case 17: "UF file not found";
case 18: "UF wrong file format";
case 19: "Attempt to contact online host failed";
case 20: "Attempt to perform RKI failed";
case 0x300: "Key Type(TDES) of Session Key is not same as the related Master Key.";
case 0x400: "Related Key was not loaded.";
case 0x500: "Key Same.";
case 0x501: "Key is all zero";
case 0x502: "TR-31 format error";
case 0x702: "PAN is Error Key.";
case 0x705: "No Internal MSR PAN (or Internal MSR PAN is erased timeout)";
case 0X0C01: "Incorrect Frame Tag";
case 0X0C02: "Incorrect Frame Type";
case 0X0C03: "Unknown Frame Type";
case 0X0C04: "Unknown Command";
case 0X0C05: "Unknown Sub-Command";
case 0X0C06: "CRC Error";
case 0X0C07: "Failed";
case 0X0C08: "Timeout";
case 0X0C0A: "Incorrect Parameter";
case 0X0C0B: "Command Not Supported";
case 0X0C0C: "Sub-Command Not Supported";
case 0X0C0D: "Parameter Not Supported / Status Abort Command";
case 0X0C0F: "Sub-Command Not Allowed";
case 0X0D01: "Incorrect Header Tag";
case 0X0D02: "Unknown Command";
case 0X0D03: "Unknown Sub-Command";
case 0X0D04: "CRC Error in Frame";
case 0X0D05: "Incorrect Parameter";
case 0X0D06: "Parameter Not Supported";
case 0X0D07: "Mal-formatted Data";
case 0X0D08: "Timeout";
case 0X0D0A: "Failed / NACK";
case 0X0D0B: "Command not Allowed";
case 0X0D0C: "Sub-Command not Allowed";
case 0X0D0D: "Buffer Overflow (Data Length too large for reader buffer)";
case 0X0D0E: "User Interface Event";
case 0X0D11: "Communication type not supported, VT-1, burst, etc.";
case 0X0D12: "Secure interface is not functional or is in an intermediate state.";
case 0X0D13: "Data field is not mod 8";
case 0X0D14: "Pad 0x80 not found where expected";
case 0X0D15: "Specified key type is invalid";
case 0X0D1: "Could not retrieve key from the SAM(InitSecureComm)";
case 0X0D17: "Hash code problem";
case 0X0D18: "Could not store the key into the SAM(InstallKey)";
case 0X0D19: "Frame is too large";
case 0X0D1A: "Unit powered up in authentication state but POS must resend the InitSecureComm command";
case 0X0D1B: "The EEPROM may not be initialized because SecCommInterface does not make sense";
case 0X0D1C: "Problem encoding APDU";
case 0X0D20: "Unsupported Index(ILM) SAM Transceiver error – problem communicating with the SAM(Key Mgr)";
case 0X0D2: "Unexpected Sequence Counter in multiple frames for single bitmap(ILM) Length error in data returned from the SAM(Key Mgr)";
case 0X0D22: "Improper bit map(ILM)";
case 0X0D23: "Request Online Authorization";
case 0X0D24: "ViVOCard3 raw data read successful";
case 0X0D25: "Message index not available(ILM) ViVOcomm activate transaction card type(ViVOcomm)";
case 0X0D26: "Version Information Mismatch(ILM)";
case 0X0D27: "Not sending commands in correct index message index(ILM)";
case 0X0D28: "Time out or next expected message not received(ILM)";
case 0X0D29: "ILM languages not available for viewing(ILM)";
case 0X0D2A: "Other language not supported(ILM)";
case 0X0D41: "Unknown Error from SAM";
case 0X0D42: "Invalid data detected by SAM";
case 0X0D43: "Incomplete data detected by SAM";
case 0X0D44: "Reserved";
case 0X0D45: "Invalid key hash algorithm";
case 0X0D46: "Invalid key encryption algorithm";
case 0X0D47: "Invalid modulus length";
case 0X0D48: "Invalid exponent";
case 0X0D49: "Key already exists";
case 0X0D4A: "No space for new RID";
case 0X0D4B: "Key not found";
case 0X0D4C: "Crypto not responding";
case 0X0D4D: "Crypto communication error";
case 0X0D4E: "Module-specific error for Key Manager";
case 0X0D4F: "All key slots are full (maximum number of keys has been installed)";
case 0X0D50: "Auto-Switch OK";
case 0X0D51: "Auto-Switch failed";
case 0X0D90: "Account DUKPT Key not exist";
case 0X0D91: "Account DUKPT Key KSN exausted";
case 0x0D00: "This Key had been loaded.";
case 0x0E00: "Base Time was loaded.";
case 0x0F00: "Encryption Or Decryption Failed.";
case 0x1000: "Battery Low Warning (It is High Priority Response while Battery is Low.)";
case 0x1800: "Send “Cancel Command” after send “Get Encrypted PIN” &”Get Numeric “& “Get Amount”";
case 0x1900: "Press “Cancel” key after send “Get Encrypted PIN” &”Get Numeric “& “Get Amount”";
case 0x30FF: "Security Chip is not connect";
case 0x3000: "Security Chip is deactivation & Device is In Removal Legally State.";
case 0x3101: "Security Chip is activation & Device is In Removal Legally State.";
case 0x5500: "No Admin DUKPT Key.";
case 0x5501: "Admin DUKPT Key STOP.";
case 0x5502: "Admin DUKPT Key KSN is Error.";
case 0x5503: "Get Authentication Code1 Failed.";
case 0x5504: "Validate Authentication Code Error.";
case 0x5505: "Encrypt or Decrypt data failed.";
case 0x5506: "Not Support the New Key Type.";
case 0x5507: "New Key Index is Error.";
case 0x5508: "Step Error.";
case 0x5509: "KSN Error";
case 0x550A: "MAC Error.";
case 0x550B: "Key Usage Error.";
case 0x550C: "Mode Of Use Error.";
case 0x550F: "Other Error.";
case 0x6000: "Save or Config Failed / Or Read Config Error.";
case 0x6200: "No Serial Number.";
case 0x6900: "Invalid Command - Protocol is right, but task ID is invalid.";
case 0x6A01: "Unsupported Command – Protocol and task ID are right, but command is invalid – In this State";
case 0x6A00: "Unsupported Command - Protocol and task ID are right, but command is invalid.";
case 0x6B00: "Unknown parameter in command - Protocol task ID and command are right, but parameter is invalid.";
case 0x6C00: "Unknown parameter in command – Protocol task ID and command are right, but length is out of the requirement.";
case 0x7200: "Device is suspend (MKSK suspend or press password suspend).";
case 0x7300: "PIN DUKPT is STOP (21 bit 1).";
case 0x7400: "Device is Busy.";
case 0xE100: "Can not enter sleep mode";
case 0xE200: "File has existed";
case 0xE300: "File has not existed";
case 0xE313: "IO line low -- Card error after session start";
case 0xE400: "Open File Error";
case 0xE500: "SmartCard Error";
case 0xE600: "Get MSR Card data is error";
case 0xE700: "Command time out";
case 0xE800: "File read or write is error";
case 0xE900: "Active 1850 error!";
case 0xEA00: "Load bootloader error";
case 0xEF00: "Protocol Error- STX or ETX or check error.";
case 0xEB00: "Picture is not exist";
case 0x2C02: "No Microprocessor ICC seated";
case 0x2C06: "no card seated to request ATR";
case 0x2D01: "Card Not Supported,";
case 0x2D03: "Card Not Supported, wants CRC";
case 0x690D: "Command not supported on reader without ICC support";
case 0x8100: "ICC error time out on power-up";
case 0x8200: "invalid TS character received - Wrong operation step";
case 0x8300: "Decode MSR Error";
case 0x8400: "TriMagII no Response";
case 0x8500: "No Swipe MSR Card";
case 0x8510: "No Financial Card";
case 0x8600: "Unsupported F, D, or combination of F and D";
case 0x8700: "protocol not supported EMV TD1 out of range";
case 0x8800: "power not at proper level";
case 0x8900: "ATR length too long";
case 0x8B01: "EMV invalid TA1 byte value";
case 0x8B02: "EMV TB1 required";
case 0x8B03: "EMV Unsupported TB1 only 00 allowed";
case 0x8B04: "EMV Card Error, invalid BWI or CWI";
case 0x8B06: "EMV TB2 not allowed in ATR";
case 0x8B07: "EMV TC2 out of range";
case 0x8B08: "EMV TC2 out of range";
case 0x8B09: "per EMV96 TA3 must be > 0xF";
case 0x8B10: "ICC error on power-up";
case 0x8B11: "EMV T=1 then TB3 required";
case 0x8B12: "Card Error, invalid BWI or CWI";
case 0x8B13: "Card Error, invalid BWI or CWI";
case 0x8B17: "EMV TC1/TB3 conflict-";
case 0x8B20: "EMV TD2 out of range must be T=1";
case 0x8C00: "TCK error";
case 0xA304: "connector has no voltage setting";
case 0xA305: "ICC error on power-up invalid (SBLK(IFSD) exchange";
case 0xE301: "ICC error after session start";
case 0xFF00: "Request to go online";
case 0xFF01: "EMV: Accept the offline transaction";
case 0xFF02: "EMV: Decline the offline transaction";
case 0xFF03: "EMV: Accept the online transaction";
case 0xFF04: "EMV: Decline the online transaction";
case 0xFF05: "EMV: Application may fallback to magstripe technology";
case 0xFF06: "EMV: ICC detected tah the conditions of use are not satisfied";
case 0xFF07: "EMV: ICC didn't accept transaction";
case 0xFF08: "EMV: Transaction was cancelled";
case 0xFF09: "EMV: Application was not selected by kernel or ICC format error or ICC missing data error";
case 0xFF0A: "EMV: Transaction is terminated";
case 0xFF0B: "EMV: Other EMV Error";
case 0xFFFF: "NO RESPONSE";
case 0xF002: "ICC communication timeout";
case 0xF003: "ICC communication Error";
case 0xF00F: "ICC Card Seated and Highest Priority, disable MSR work request";
case 0xF200: "AID List / Application Data is not exist";
case 0xF201: "Terminal Data is not exist";
case 0xF202: "TLV format is error";
case 0xF203: "AID List is full";
case 0xF204: "Any CA Key is not exist";
case 0xF205: "CA Key RID is not exist";
case 0xF206: "CA Key Index it not exist";
case 0xF207: "CA Key is full";
case 0xF208: "CA Key Hash Value is Error";
case 0xF209: "Transaction format error";
case 0xF20A: "The command will not be processing";
case 0xF20B: "CRL is not exist";
case 0xF20C: "CRL number exceed max number";
case 0xF20D: "Amount,Other Amount,Trasaction Type are missing";
case 0xF20E: "The Identification of algorithm is mistake";
case 0xF20F: "No Financial Card";
case 0xF210: "In Encrypt Result state, TLV total Length is greater than Max Length";
case 0x1001: "INVALID ARG";
case 0x1002: "FILE_OPEN_FAILED";
case 0x1003: "FILE OPERATION_FAILED";
case 0x2001: "MEMORY_NOT_ENOUGH";
case 0x3002: "SMARTCARD_FAIL";
case 0x3003: "SMARTCARD_INIT_FAILED";
case 0x3004: "FALLBACK_SITUATION";
case 0x3005: "SMARTCARD_ABSENT";
case 0x3006: "SMARTCARD_TIMEOUT";
case 0x5001: "EMV_PARSING_TAGS_FAILED";
case 0x5002: "EMV_DUPLICATE_CARD_DATA_ELEMENT";
case 0x5003: "EMV_DATA_FORMAT_INCORRECT";
case 0x5004: "EMV_NO_TERM_APP";
case 0x5005: "EMV_NO_MATCHING_APP";
case 0x5006: "EMV_MISSING_MANDATORY_OBJECT";
case 0x5007: "EMV_APP_SELECTION_RETRY";
case 0x5008: "EMV_GET_AMOUNT_ERROR";
case 0x5009: "EMV_CARD_REJECTED";
case 0x5010: "EMV_AIP_NOT_RECEIVED";
case 0x5011: "EMV_AFL_NOT_RECEIVED";
case 0x5012: "EMV_AFL_LEN_OUT_OF_RANGE";
case 0x5013: "EMV_SFI_OUT_OF_RANGE";
case 0x5014: "EMV_AFL_INCORRECT";
case 0x5015: "EMV_EXP_DATE_INCORRECT";
case 0x5016: "EMV_EFF_DATE_INCORRECT";
case 0x5017: "EMV_ISS_COD_TBL_OUT_OF_RANGE";
case 0x5018: "EMV_CRYPTOGRAM_TYPE_INCORRECT";
case 0x5019: "EMV_PSE_NOT_SUPPORTED_BY_CARD";
case 0x5020: "EMV_USER_SELECTED_LANGUAGE";
case 0x5021: "EMV_SERVICE_NOT_ALLOWED";
case 0x5022: "EMV_NO_TAG_FOUND";
case 0x5023: "EMV_CARD_BLOCKED";
case 0x5024: "EMV_LEN_INCORRECT";
case 0x5025: "CARD_COM_ERROR";
case 0x5026: "EMV_TSC_NOT_INCREASED";
case 0x5027: "EMV_HASH_INCORRECT";
case 0x5028: "EMV_NO_ARC";
case 0x5029: "EMV_INVALID_ARC";
case 0x5030: "EMV_NO_ONLINE_COMM";
case 0x5031: "TRAN_TYPE_INCORRECT";
case 0x5032: "EMV_APP_NO_SUPPORT";
case 0x5033: "EMV_APP_NOT_SELECT";
case 0x5034: "EMV_LANG_NOT_SELECT";
case 0x5035: "EMV_NO_TERM_DATA";
case 0x6001: "CVM_TYPE_UNKNOWN";
case 0x6002: "CVM_AIP_NOT_SUPPORTED";
case 0x6003: "CVM_TAG_8E_MISSING";
case 0x6004: "CVM_TAG_8E_FORMAT_ERROR";
case 0x6005: "CVM_CODE_IS_NOT_SUPPORTED";
case 0x6006: "CVM_COND_CODE_IS_NOT_SUPPORTED";
case 0x6007: "NO_MORE_CVM";
case 0x6008: "PIN_BYPASSED_BEFORE";
case 0x7001: "PK_BUFFER_SIZE_TOO_BIG";
case 0x7002: "PK_FILE_WRITE_ERROR";
case 0x7003: "PK_HASH_ERROR";
case 0x8001: "NO_CARD_HOLDER_CONFIRMATION";
case 0x8002: "GET_ONLINE_PIN";
case 0xD000: "Data not exist";
case 0xD001: "Data access error";
case 0xD100: "RID not exist";
case 0xD101: "RID existed";
case 0xD102: "Index not exist";
case 0xD200: "Maximum exceeded";
case 0xD201: "Hash error";
case 0xD205: "System Busy";
case 0x0E01: "Unable to go online";
case 0x0E02: "Technical Issue";
case 0x0E03: "Declined";
case 0x0E04: "Issuer Referral transaction";
case 0x0F01: "Decline the online transaction";
case 0x0F02: "Request to go online";
case 0x0F03: "Transaction is terminated";
case 0x0F05: "Application was not selected by kernel or ICC format error or ICC missing data error";
case 0x0F07: "ICC didn't accept transaction";
case 0x0F0A: "Application may fallback to magstripe technology";
case 0x0F0C: "Transaction was cancelled";
case 0x0F0D: "Timeout";
case 0x0F0F: "Other EMV Error";
case 0x0F10: "Accept the offline transaction";
case 0x0F11: "Decline the offline transaction";
case 0x0F21: "ICC detected tah the conditions of use are not satisfied";
case 0x0F22: "No app were found on card matching terminal configuration";
case 0x0F23: "Terminal file does not exist";
case 0x0F24: "CAPK file does not exist";
case 0x0F25: "CRL Entry does not exist";
case 0x0FFE: "code when blocking is disabled";
case 0x0FFF: "code when command is not applicable on the selected device";
case 0xF005: "ICC Encrypted C-APDU Data Structure Length Error Or Format Error.";
case 0xBBE0: "CM100 Success";
case 0xBBE1: "CM100 Parameter Error";
case 0xBBE2: "CM100 Low Output Buffer";
case 0xBBE3: "CM100 Card Not Found";
case 0xBBE4: "CM100 Collision Card Exists";
case 0xBBE5: "CM100 Too Many Cards Exist";
case 0xBBE6: "CM100 Saved Data Does Not Exist";
case 0xBBE8: "CM100 No Data Available";
case 0xBBE9: "CM100 Invalid CID Returned";
case 0xBBEA: "CM100 Invalid Card Exists";
case 0xBBEC: "CM100 Command Unsupported";
case 0xBBED: "CM100 Error In Command Process";
case 0xBBEE: "CM100 Invalid Command";
case 0X9031: "Unknown command";
case 0X9032: "Wrong parameter (such as the length of the command is incorrect)";
case 0X9038: "Wait (the command couldn’t be finished in BWT)";
case 0X9039: "Busy (a previously command has not been finished)";
case 0X903A: "Number of retries over limit";
case 0X9040: "Invalid Manufacturing system data";
case 0X9041: "Not authenticated";
case 0X9042: "Invalid Master DUKPT Key";
case 0X9043: "Invalid MAC Key";
case 0X9044: "Reserved for future use";
case 0X9045: "Reserved for future use";
case 0X9046: "Invalid DATA DUKPT Key";
case 0X9047: "Invalid PIN Pairing DUKPT Key";
case 0X9048: "Invalid DATA Pairing DUKPT Key";
case 0X9049: "No nonce generated";
case 0X9949: "No GUID available. Perform getVersion first.";
case 0X9950: "MAC Calculation unsuccessful. Check BDK value.";
case 0X904A: "Not ready";
case 0X904B: "Not MAC data";
case 0X9050: "Invalid Certificate";
case 0X9051: "Duplicate key detected";
case 0X9052: "AT checks failed";
case 0X9053: "TR34 checks failed";
case 0X9054: "TR31 checks failed";
case 0X9055: "MAC checks failed";
case 0X9056: "Firmware download failed";
case 0X9060: "Log is full";
case 0X9061: "Removal sensor unengaged";
case 0X9062: "Any hardware problems";
case 0X9070: "ICC communication timeout";
case 0X9071: "ICC data error (such check sum error)";
case 0X9072: "Smart Card not powered up";

RETURN_CODE IDTechSDK.IDT_SecureKey.device_getRKIStatus	(	bool	isProd,
		bool	isMultiKey,
		ref string	status,
		ref Dictionary< string, RKI_KEY_TYPE >	keys,
		string	ident = `""`
	)

Get RKI Status From Specified Server Polls the RKI server to validate device RKI eligiblity

Parameters

isProd	TRUE = poll production RKI server, FALSE = poll demo RKI server
isMultiKey	True = MultiKey, False = SingleKey
status	RKI status returned as a string
keys	Returns dictionary of available keys
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_readConfigurationToMemory	(	string	memo,
		Configs.InstallRules	rules,
		List< Configs.DeviceCommand >	cmds,
		string	ident = `""`,
		bool	isForeground = `false`
	)

Read Device Configuration To Memory Executes a ViVOconfig read of device settings and stores the results in memory

Once a ViVOconfig read starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:

RETURN_CODE_SDK_VIVOCONFIG_READ_CONFIG_SUCCESS = Read process completed successfully. Execute device_getConfigurationFromMemory to retrieve the configuration data

RETURN_CODE_SDK_VIVOCONFIG_READ_CONFIG_FAILED = Read process FAILED.

Parameters

memo	Optional: populates the memo field of the captured .json file
rules	Optional: populates the .json file with available install rules
cmds	Optional: populates the .json file with commands to execute
ident	Device ID to send command to. If not specified, current SDK default device will be used.
isForeground	If TRUE, will block program until update complete. Otherwise, FALSE performs update on background.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_RemoteKeyInjection	(	RKI_KEY_TYPE	type,
		string	keyName,
		string	ident = `""`,
		bool	performOnForeground = `false`
	)

Remote Key Injection Performs a remote key injection for the device

Parameters

type	Remote Key Injection Type
keyName	Name of key (optional)
ident	Device ID to send command to. If not specified, current SDK default device will be used.
performOnForeground	TRUE = block during process (default is false)

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendConfiguration	(	string	filename,
		VC_OPERATION_TYPE	type,
		bool	matchFW,
		string	ident = `""`,
		bool	isForeground = `false`
	)

Send Configuration Executes a ViVOconfig update or verify to a device

Once a ViVOconfig write or verify starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:

RETURN_CODE_SDK_VIVOCONFIG_VERIFY_SUCCESS = Verification process completed successfully. No differences found.
RETURN_CODE_SDK_VIVOCONFIG_VERIFY_SUCCESS_WITH_WARNING = Verification process completed with warnings.
RETURN_CODE_SDK_VIVOCONFIG_VERIFY_FAILED = Verification process FAILED
RETURN_CODE_SDK_VIVOCONFIG_WRITE_SUCCESS = Write process completed successfully.
RETURN_CODE_SDK_VIVOCONFIG_WRITE_SUCCESS_WITH_WARNING = Write process completed with warnings

RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED

Parameters

filename	The .json configuration file to update the device with NOTE: You can also use this parameter to pass the path of where the .json file is located at on local storage instead
filename	The name of the .json configuration file
type	VC_OPERATION_TYPE

VC_OPERATION_TYPE_WRITE = Write File To Device, Hash must validate
VC_OPERATION_TYPE_VERIFY = Verify Device With File
VC_OPERATION_TYPE_WRITE_IGNORE_HASH = Write File To Device, Ignore Hash

VC_OPERATION_TYPE_WRITE_FIX_HASH = Write File To Device, Fix Hash If Necessary

Parameters

matchFW	TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file
ident	Device ID to send command to. If not specified, current SDK default device will be used.
isForeground	If TRUE, will block program until update complete. Otherwise, FALSE performs update on background.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendConfigurationFromZip	(	byte[]	zip,
		string	filename,
		VC_OPERATION_TYPE	type,
		bool	matchFW,
		string	ident = `""`,
		bool	isForeground = `false`
	)

Send Configuration From Zip Executes a ViVOconfig update or verify to a device using files from a .zip archive

Once a ViVOconfig write or update starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:

RETURN_CODE_SDK_VIVOCONFIG_VERIFY_SUCCESS = Verification process completed successfully. No differences found.
RETURN_CODE_SDK_VIVOCONFIG_VERIFY_SUCCESS_WITH_WARNING = Verification process completed with warnings.
RETURN_CODE_SDK_VIVOCONFIG_VERIFY_FAILED = Verification process FAILED
RETURN_CODE_SDK_VIVOCONFIG_WRITE_SUCCESS = Write process completed successfully.
RETURN_CODE_SDK_VIVOCONFIG_WRITE_SUCCESS_WITH_WARNING = Write process completed with warnings

RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED

Parameters

zip	.Zip archive containing the .json configuration file and also any associated image assets NOTE: You can also use this parameter to pass the path of where the .zip file is located at on local storage instead
filename	The name of the .json configuration file
type	VC_OPERATION_TYPE

VC_OPERATION_TYPE_WRITE = Write File To Device, Hash must validate
VC_OPERATION_TYPE_VERIFY = Verify Device With File
VC_OPERATION_TYPE_WRITE_IGNORE_HASH = Write File To Device, Ignore Hash

VC_OPERATION_TYPE_WRITE_FIX_HASH = Write File To Device, Fix Hash If Necessary

Parameters

matchFW	TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file
ident	Device ID to send command to. If not specified, current SDK default device will be used.
isForeground	If TRUE, will block program until update complete. Otherwise, FALSE performs update on background.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendDataCommand	(	string	cmd,
		bool	calcLRC,
		ref byte[]	response,
		string	ident = `""`
	)

Send a data command to the device

Sends a command to the device.

Parameters

cmd	String representation of command to execute
calcLRC	If `TRUE`, this will wrap command with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}'
response	Response data
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendDataCommand_ext	(	string	cmd,
		bool	calcLRC,
		ref byte[]	response,
		int	timeout,
		bool	noResponse,
		string	ident = `""`
	)

Send a data command to the device - extended

Sends a command to the device.

Parameters

cmd	String representation of command to execute
calcLRC	If `TRUE`, this will wrap command as NGA with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}'
response	Response data
timeout	Timeout value waiting for response, in milliseconds (1000 = 1 second, string ident = "")
noResponse	if TRUE, this will not wait for a response and immediately return SUCCESS
calcITP	If `TRUE`, this will wrap command as ITP with start/end/lrc: '{STX} data {ETX}{CheckLRC}'
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendPAE	(	string	command,
		ref string	response,
		int	timeout,
		string	ident = `""`
	)

Send Payment Application Engine Command

Executes a PAE command

Parameters

command	ASCII command string, should start with "*PAE"
response	command response
timeout	timeout waiting for PAE response
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString( string ident = "")

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendVivoCommandP2	(	byte	command,
		byte	subCommand,
		byte[]	data,
		ref byte[]	response,
		string	ident = `""`
	)

Send Vivo Command Protocol 2

Sends a protocol 2 command to Vivo readers (IDG/NEO, string ident = "")

Parameters

command	Command
subCommand	Sub-Command
data	Data. May be null
response	Response
ip	Optional IP
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString( string ident = "")

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendVivoCommandP2_ext	(	byte	command,
		byte	subCommand,
		byte[]	data,
		ref byte[]	response,
		int	timeout,
		bool	noResponse,
		string	ident = `""`
	)

Send Vivo Command Protocol 2 Extended

Sends a protocol 2 command to Vivo readers (IDG/NEO, string ident = "")

Parameters

command	Command
subCommand	Sub-Command
data	Data. May be null
response	Response
timeout	Timeout, in milliseconds (3000 = 3 seconds, string ident = "")
noResponse	TRUE = don't wait for response, FALSE = wait for response defined by timeout
ip	Optional IP
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString( string ident = "")

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendVivoCommandP3	(	byte	command,
		byte	subCommand,
		byte[]	data,
		ref byte[]	response,
		string	ident = `""`
	)

Send Vivo Command Protocol 3

Sends a protocol 3 command to Vivo readers (IDG/NEO, string ident = "")

Parameters

command	Command
subCommand	Sub-Command
data	Data. May be null
response	Response
ip	Optional IP
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString( string ident = "")

RETURN_CODE IDTechSDK.IDT_SecureKey.device_sendVivoCommandP3_ext	(	byte	command,
		byte	subCommand,
		byte[]	data,
		ref byte[]	response,
		int	timeout,
		bool	noResponse,
		string	ident = `""`
	)

Send Vivo Command Protocol 3 Extended

Sends a protocol 3 command to Vivo readers (IDG/NEO, string ident = "")

Parameters

command	Command
subCommand	Sub-Command
data	Data. May be null
response	Response
timeout	Timeout, in milliseconds (3000 = 3 seconds, string ident = "")
noResponse	TRUE = don't wait for response, FALSE = wait for response defined by timeout
ip	Optional IP
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString( string ident = "")

RETURN_CODE IDTechSDK.IDT_SecureKey.device_setOutputType	(	bool	isSwipe,
		int	value,
		string	ident = `""`
	)

Set Captured Data Output Type

Parameters

isSwipe	TRUE = settings for Swipe, FALSE = settings for MSR (only applicable for Original/Enhanced formats, string ident = "") NOTE: IF XML is chosen, this parameter is ignored
value	0 : Original Format 1 : Enhanced Format 2 : XML Format
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_StartRKI	(	int	type,
		string	ident = `""`
	)

Start Remote Key Injection

Starts a remote key injection request with IDTech RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.

Parameters

type	0 = Symmetric RKI Demo Unit 1 = Symmetric RKI Production Unit 2 = PKI-RKI Demo Unit 3 = PKI-RKI Production Unit
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.device_updateFirmwareFromZip	(	byte[]	zipfile,
		string	ident = `""`,
		bool	isForeground = `false`
	)

Update Firmware From Zip

Performs one or more device firmware updates from firmware files passed as a compressed archive with a valid configuration file (.json format)

Parameters

zipfile	Zip file containing on or more firmware update files and a .json configuration file
ident	Device ID to send command to. If not specified, current SDK default device will be used.
isForeground	If TRUE, will block program until firmware update complete. Otherwise, FALSE performs FW update on background.

Returns: RETURN_CODE: Values can be parsed with errorCode.getErrorString(string ident = "")

static int IDTechSDK.IDT_SecureKey.getCommandTimeout ( string ident = "" )

static

Get Command Timeout

Gets the default timeout (in milliseconds) waiting for a blocking command response

Return values

time Time

static void IDTechSDK.IDT_SecureKey.lcd_retrieveMessage	(	DisplayMessages.DISPLAY_MESSAGE_LANGUAGE	lang,
		DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER	id,
		ref string	line1,
		ref string	line2
	)

static

Retrieve LCD Message

Returns the string value for a message ID returned for LCD messaging

Parameters

lang	Language.
id	Message ID
line1	Line 1 string value
line2	Line 2 string value
ident	Device ID to send command to. If not specified, current SDK default device will be used.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.msr_switchUSBInterfaceMode ( bool bIsUSBKeyboardMode )

Switch the USB interface mode between USB HID and USB KB mode.

For Non-SRED Augusta Only

Parameters

bIsUSBKeyboardMode

USB interface mode

true: Enter into USB Keyboard mode
false: Enter into USB HID mode

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

RETURN_CODE IDTechSDK.IDT_SecureKey.msr_switchUSBInterfaceMode	(	bool	bIsUSBKeyboardMode,
		ref string	ident
	)

Switch the USB interface mode between USB HID and USB KB mode.

For Non-SRED Augusta Only

Parameters

bIsUSBKeyboardMode	USB interface mode true: Enter into USB Keyboard mode false: Enter into USB HID mode
ident	Device ID to send command to.

Returns: RETURN_CODE: Values can be parsed with device_getResponseCodeString

static String IDTechSDK.IDT_SecureKey.SDK_Version ( )

static

SDK Version

All Devices

Returns the current version of SDK

Returns: Framework version

static void IDTechSDK.IDT_SecureKey.setCallback ( CallBack my_Callback )

static

Set Callback

Sets the class callback

Parameters

my_Callback The callback function to receive the response message from device. defined as follows. delegate void CallBack(IDT_DEVICE_Types sender, DeviceState state, byte[] data, IDTTransactionData card, EMV_Callback emvCallback, RETURN_CODE transactionResultCode, ident);

static void IDTechSDK.IDT_SecureKey.setCallback	(	IntPtr	my_Callback,
		SynchronizationContext	context
	)

static

Set Callback

Sets the class callback

Parameters

my_Callback	The callback function to receive the response message from device. defined as follows. public unsafe delegate void MFCCallBack(Parameters parameters, ident);
context	The context of the UI thread

static void IDTechSDK.IDT_SecureKey.setCommandTimeout	(	int	milliseconds,
		string	ident = `""`
	)

static

Set Command Timeout

Sets the default timeout (in milliseconds) waiting for a blocking command response

Parameters

milliseconds Time

Property Documentation

IDT_SecureKey IDTechSDK.IDT_SecureKey.SharedController

staticget

Singleton Instance

Establishes an singleton instance of IDT_SecureKey class.

Returns: Instance of IDT_SecureKey

The documentation for this class was generated from the following file:

/Users/randy/Repo/universal-sdk/IDTechSDK_STD/DeviceHeaders/IDT_SecureKey.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation