![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_getBootloaderVersion (ref string response, string ident="") |
RETURN_CODE | config_getModelNumber (ref string response, string ident="") |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
bool | config_setCmdTimeOutDuration (int newTimeOut, string ident="") |
RETURN_CODE | device_getBatteryVoltage (ref string voltage, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ident="") |
RETURN_CODE | device_startRKI (string ident="") |
RETURN_CODE | icc_exchangeAPDU (string c_APDU, ref byte[] response, string ident="") |
RETURN_CODE | icc_getAPDU_KSN (ref byte[] ksn, string ident="") |
RETURN_CODE | icc_getICCReaderStatus (ref byte status, string ident="") |
RETURN_CODE | icc_getKeyFormatForICCDUKPT (ref byte format, string ident="") |
RETURN_CODE | icc_getKeyTypeForICCDUKPT (ref byte type, string ident="") |
RETURN_CODE | icc_powerOffICC (string ident="") |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR, string ident="") |
RETURN_CODE | icc_setKeyFormatForICCDUKPT (byte encryption, string ident="") |
RETURN_CODE | icc_setKeyTypeForICCDUKPT (byte encryption, string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (string ident="") |
RETURN_CODE | msr_getClearPANID (ref byte value, string ident="") |
RETURN_CODE | msr_getExpirationMask (ref byte value, string ident="") |
RETURN_CODE | msr_getSwipeEncryption (ref byte encryption, string ident="") |
RETURN_CODE | msr_getSwipeForcedEncryptionOption (ref byte option, string ident="") |
RETURN_CODE | msr_getSwipeMaskOption (ref byte option, string ident="") |
RETURN_CODE | msr_setClearPANID (byte val, string ident="") |
RETURN_CODE | msr_setExpirationMask (bool mask, string ident="") |
RETURN_CODE | msr_setSwipeEncryption (byte encryption, string ident="") |
RETURN_CODE | msr_setSwipeForcedEncryptionOption (bool track1, bool track2, bool track3, bool track3card0, string ident="") |
RETURN_CODE | msr_setSetting (byte setting, byte value, string ident="") |
RETURN_CODE | msr_getSetting (byte setting, ref byte value, string ident="") |
RETURN_CODE | msr_setSwipeMaskOption (bool track1, bool track2, bool track3, string ident="") |
RETURN_CODE | msr_startMSRSwipe (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 () |
Properties | |
static IDT_UniPay | SharedController [get] |
Class for UniPay MSR/ICC reader
RETURN_CODE IDTechSDK.IDT_UniPay.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_UniPay.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. |
bool IDTechSDK.IDT_UniPay.config_setCmdTimeOutDuration | ( | int | newTimeOut, |
string | ident = "" |
||
) |
Command Acknowledgement Timout
Sets the amount of seconds to wait for an {ACK} to a command before a timeout. Responses should normally be received under one second. Default is 3 seconds
newTimeOut | Timout value. Valid range 1 - 60 seconds |
RETURN_CODE IDTechSDK.IDT_UniPay.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_UniPay.device_getBatteryVoltage | ( | ref string | voltage, |
string | ident = "" |
||
) |
Polls device for Battery Voltage
voltage | Returns Battery Voltage as 4-chararacter string * 100. Example: "0186" = 1.86v. "1172" = 11.72v. |
RETURN_CODE |
|
RETURN_CODE IDTechSDK.IDT_UniPay.device_getBootloaderVersion | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Bootloader Version
Puts device in bootloader mode so it can return bootloader version. Remains in bootloader mode until timeout of 30 seconds is reached. During this time, only command that may be executed is device_getFirmwareVersion, which will return bootloader version
response | Response returned of Bootloader Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.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_UniPay.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_UniPay.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_UniPay.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_UniPay.device_rebootDevice | ( | string | ident = "" | ) |
Reboot Device
Executes a command to restart the device.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.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_UniPay.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_UniPay.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_UniPay.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send a NSData object to device
Sends a command represented by the provide NSData object to the device through the accessory protocol.
cmd | NSData 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_UniPay.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_UniPay.device_startRKI | ( | string | ident = "" | ) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.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 |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_exchangeAPDU | ( | string | c_APDU, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
Exchange APDU
Sends an APDU packet to the ICC. If successful, response is returned in APDUResult class instance in response parameter.
c_APDU | APDU data packet |
response | Unencrypted/encrypted parsed APDU response |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getAPDU_KSN | ( | ref byte[] | ksn, |
string | ident = "" |
||
) |
Get APDU KSN
Retrieves the KSN used in ICC Encypted APDU usage
ksn | Returns the encrypted APDU packet KSN |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getICCReaderStatus | ( | ref byte | status, |
string | ident = "" |
||
) |
Get Reader Status
Returns the reader status
status | Pointer that will return with the ICCReaderStatus results. bit 0: 0 = ICC Power Not Ready, 1 = ICC Powered bit 1: 0 = Card not seated, 1 = card seated |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getKeyFormatForICCDUKPT | ( | ref byte | format, |
string | ident = "" |
||
) |
Get Key Format For ICC DUKPT
Specifies how data will be encrypted with Data Key or PIN key (if DUKPT key loaded, string ident = "")
format | Response returned from method:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_getKeyTypeForICCDUKPT | ( | ref byte | type, |
string | ident = "" |
||
) |
Get Key Type for ICC DUKPT
Specifies the key type used for ICC DUKPT encryption
type | Response returned from method:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_powerOffICC | ( | string | ident = "" | ) |
Power Off ICC
Powers down the ICC
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_UniPay.icc_powerOnICC | ( | ref byte[] | ATR, |
string | ident = "" |
||
) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_setKeyFormatForICCDUKPT | ( | byte | encryption, |
string | ident = "" |
||
) |
Set Key Format for ICC DUKPT
Sets how data will be encrypted, with either TDES or AES (if DUKPT key loaded, string ident = "")
encryption | Encryption Type
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.icc_setKeyTypeForICCDUKPT | ( | byte | encryption, |
string | ident = "" |
||
) |
Set Key Type for ICC DUKPT Key
Sets which key the data will be encrypted with, with either Data Key or PIN key (if DUKPT key loaded, string ident = "")
encryption | Encryption Type
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_cancelMSRSwipe | ( | string | ident = "" | ) |
Disable MSR Swipe Cancels MSR swipe request.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getClearPANID | ( | ref byte | value, |
string | ident = "" |
||
) |
Get Clear PAN Digits
Returns the number of digits that begin the PAN that will be in the clear
value | Number of digits in clear. Values are char '0' - '6': |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getExpirationMask | ( | ref byte | value, |
string | ident = "" |
||
) |
Get Expiration Masking
Get the flag that determines if to mask the expiration date
value | '0' = masked, '1' = not-masked |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSetting | ( | byte | setting, |
ref byte | value, | ||
string | ident = "" |
||
) |
Get MSR Setting value
Returns the encryption used for swipe data
setting | MSR Setting to retrieve |
value | MSR Setting value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeEncryption | ( | ref byte | encryption, |
string | ident = "" |
||
) |
Get Swipe Data Encryption
Returns the encryption used for sweip data
encryption | 1 = TDES, 2 = AES, 0 = NONE |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeForcedEncryptionOption | ( | ref byte | option, |
string | ident = "" |
||
) |
Get Swipe Data Encryption
Gets the swipe force encryption options
option | Byte using lower four bits as flags. 0 = Force Encryption Off, 1 = Force Encryption On bit0 = Track 1 bit1 = Track 2 bit2 = Track 3 bit4 = Track 3 Card Option 0 |
Example: Response 0x03 = Track1/Track2 Forced Encryption, Track3/Track3-0 no Forced Encryption
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_getSwipeMaskOption | ( | ref byte | option, |
string | ident = "" |
||
) |
Get Swipe Mask Option
Gets the swipe mask/clear data sending option
option | Byte using lower three bits as flags. 0 = Mask Option Off, 1 = Mask Option On bit0 = Track 1 bit1 = Track 2 bit2 = Track 3 |
Example: Response 0x03 = Track1/Track2 Masked Option ON, Track3 Masked Option Off
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setClearPANID | ( | byte | val, |
string | ident = "" |
||
) |
Set Clear PAN Digits
Sets the amount of digits shown in the clear (not masked) at the beginning of the returned PAN value
val | Number of digits to show in clear. Range 0-6. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setExpirationMask | ( | bool | mask, |
string | ident = "" |
||
) |
Set Expiration Masking
Sets the flag to mask the expiration date
mask | TRUE = mask expiration |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSetting | ( | byte | setting, |
byte | value, | ||
string | ident = "" |
||
) |
Set MSR Setting value
setting | MSR Setting to set |
value | MSR Setting value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeEncryption | ( | byte | encryption, |
string | ident = "" |
||
) |
Set Swipe Data Encryption
Sets the swipe encryption method
encryption | 1 = TDES, 2 = AES |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeForcedEncryptionOption | ( | bool | track1, |
bool | track2, | ||
bool | track3, | ||
bool | track3card0, | ||
string | ident = "" |
||
) |
Set Swipe Force Encryption
Sets the swipe force encryption options
track1 | Force encrypt track 1 |
track2 | Force encrypt track 2 |
track3 | Force encrypt track 3 |
track3card0 | Force encrypt track 3 when card type is 0 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_setSwipeMaskOption | ( | bool | track1, |
bool | track2, | ||
bool | track3, | ||
string | ident = "" |
||
) |
Set Swipe Mask Option
Sets the swipe mask/clear data sending option
track1 | Mask track 1 allowed |
track2 | Mask track 2 allowed |
track3 | Mask track 3 allowed |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_UniPay.msr_startMSRSwipe | ( | int | timeout, |
string | ident = "" |
||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur.
timeout | Swipe Timeout Value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
SDK Version
Returns the current version of SDK
|
static |
Set Callback
Sets the class callback
|
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_UniPay class.