![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
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] |
Class for SecureKey MSR reder
RETURN_CODE IDTechSDK.IDT_SecureKey.config_getModelNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Model Number
response | Returns Model Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SecureKey.config_getSerialNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Serial Number
response | Returns Serial Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
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.
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. |
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
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. |
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
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. |
RETURN_CODE IDTechSDK.IDT_SecureKey.device_getFirmwareVersion | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SecureKey.device_getOutputType | ( | bool | isSwipe, |
ref int | response, | ||
string | ident = "" |
||
) |
Get Captured Data Output Type
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 |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
string IDTechSDK.IDT_SecureKey.device_getResponseCodeString | ( | RETURN_CODE | eCode | ) |
Get the description of response result.
eCode | the response result. |
the | string for description of response result |
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
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. |
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_FAILED = Read process FAILED.
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. |
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
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) |
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_WRITE_FAILED = Write process FAILED
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 |
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. |
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_WRITE_FAILED = Write process FAILED
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 |
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. |
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.
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. |
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.
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. |
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
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. |
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 = "")
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. |
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 = "")
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. |
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 = "")
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. |
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 = "")
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. |
RETURN_CODE IDTechSDK.IDT_SecureKey.device_setOutputType | ( | bool | isSwipe, |
int | value, | ||
string | ident = "" |
||
) |
Set Captured Data Output Type
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 |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
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.
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. |
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)
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. |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
|
static |
Retrieve LCD Message
Returns the string value for a message ID returned for LCD messaging
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. |
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
bIsUSBKeyboardMode | USB interface mode
|
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
bIsUSBKeyboardMode | USB interface mode
|
ident | Device ID to send command to. |
|
static |
SDK Version
Returns the current version of SDK
|
static |
Set Callback
Sets the class callback
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 |
Set Callback
Sets the class callback
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 |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
milliseconds | Time |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_SecureKey class.