![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | msr_resetTerminalData (string ident="") |
RETURN_CODE | msr_cancelTransaction (string ident="") |
RETURN_CODE | msr_setConfiguration (byte[] config, string ident="") |
RETURN_CODE | msr_getConfiguration (ref byte[] config, string ident="") |
RETURN_CODE | msr_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | msr_getTerminalData (byte[] tag, ref byte[] tlv, string ident="") |
RETURN_CODE | msr_startKeyedTransaction (int timeout, bool ZIP, bool CSC, bool ADR, bool Mod10Check, string ident="") |
RETURN_CODE | msr_startSwipeTransaction (int timeout, byte[] tlv, string ident="") |
RETURN_CODE | device_setTransArmorEncryption (byte[] cert, string ident="") |
RETURN_CODE | device_setPollMode (byte mode, 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_updateDeviceFromManifest (string filepath, string ident="", bool isForeground=false) |
RETURN_CODE | device_certificateType (ref int type, 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_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 | msr_disable (string ident="") |
RETURN_CODE | msr_enable (string ident="") |
IDTechSDK.RETURN_CODE | device_setLanguage (int val, string ident="") |
RETURN_CODE | msr_getSwipeEncryption (ref byte encryption, string ident="") |
RETURN_CODE | device_getTransArmorID (ref string TID, string ident="") |
RETURN_CODE | device_setTransArmorID (string TID, string ident="") |
RETURN_CODE | device_enableAdminKey (bool enable, string ident="") |
RETURN_CODE | msr_setExpirationMask (bool mask, string ident="") |
RETURN_CODE | msr_getExpirationMask (ref byte value, string ident="") |
RETURN_CODE | msr_setClearPANID (byte val, string ident="") |
RETURN_CODE | msr_getClearPANID (ref byte value, string ident="") |
RETURN_CODE | msr_getSwipeMaskOption (ref byte option, string ident="") |
RETURN_CODE | msr_setSwipeMaskOption (bool track1, bool track2, bool track3, string ident="") |
RETURN_CODE | msr_setSwipeForcedEncryptionOption (bool track1, bool track2, bool track3, bool track3card0, string ident="") |
RETURN_CODE | msr_getSwipeForcedEncryptionOption (ref byte option, string ident="") |
RETURN_CODE | msr_getFunctionStatus (ref bool enabled, ref bool isBufferMode, ref bool withNotification, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | device_sendVivoCommandP4 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="") |
RETURN_CODE | device_sendVivoCommandP4_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ident="") |
RETURN_CODE | config_getStatusKeySlots (ref byte[] keyslots, string ident="") |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, string ident="") |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode) |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode, ref string ident) |
RETURN_CODE | device_startRKI (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 RETURN_CODE | device_updateFirmwareType (FIRMWARE_TYPE type, byte[] firmwareData, string ident="", UInt32 address=0, bool performOnForeground=false, int manifestScriptsCount=0, int processedScriptCount=0, string DT_PRJ_filename="") |
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_SREDKey2 | SharedController [get] |
Class for SREDKey2 MSR reder
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.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_SREDKey2.config_getStatusKeySlots | ( | ref byte[] | keyslots, |
string | ident = "" |
||
) |
Get status of the key slots
There are 10 keyslots for PIN Key at Index 1, slot #0-9 There are 10 keyslots for DATA Key at Index 2, slots #0-9 There is a keyslot for MAC Key at Index 5, slot 0 There is a keyslot for Key Encryption Key at Index 14, slot 0
This routine will return all the key slots values as one continuous byte[] of 4-byte key slot info.
keySlots | Key slot data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_certificateType | ( | ref int | type, |
string | ident = "" |
||
) |
Device Certificate Type
Returns the device certificate type
type | 0 = Unknown, 1 = Demo, 2 = Production |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_enableAdminKey | ( | bool | enable, |
string | ident = "" |
||
) |
Enable Admin Key
enable | TRUE = enable, FALSE = disable |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.device_getTransArmorID | ( | ref string | TID, |
string | ident = "" |
||
) |
Get TransArmor ID
TID | TransArmor ID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP4 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 4
Sends a protocol 4 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_SREDKey2.device_sendVivoCommandP4_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ident = "" |
||
) |
Send Vivo Command Protocol 4 Extended
Sends a protocol 4 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. |
IDTechSDK.RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setLanguage | ( | int | val, |
string | ident = "" |
||
) |
Set Device Language.
val | Language: 0 = English, 1 = Japanese |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.device_setPollMode | ( | byte | mode, |
string | ident = "" |
||
) |
Send Poll Mode
Sets the poll mode forthe device. Auto Poll keeps reader active, Poll On Demand only polls when requested by terminal. Valid only in HID Mode.
mode | 0 = Auto Poll, 1 = Poll On Demand |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setTransArmorEncryption | ( | byte[] | cert, |
string | ident = "" |
||
) |
Set TransArmor Encryption
cert | Certificate in PEM format or DER format. PEM format must be string data (converted to binary) starting with "---". DER format is binary data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setTransArmorID | ( | string | TID, |
string | ident = "" |
||
) |
Set TransArmor ID
TID | TransArmor ID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.device_updateDeviceFirmware | ( | byte[] | firmwareData, |
string | ident = "" |
||
) |
Update K81 Firmware
Updates the firmware .
firmwareData | Signed binary data of a firmware file provided by IDTech |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_updateDeviceFromManifest | ( | string | filepath, |
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Update Device From Manifest
Initiates a device update using a manifest file.
filepath | File path of the manifest file. It must be a valid .json manifest file, and must be located in the same folder as all the needed firmware update assets |
ip | Optional Device Identifier |
isForeground | Optional. If TRUE, function blocks until complete, other if FALSE, runs on background thread |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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 |
Update App Firmware
Updates the firmware
type | FIRMWARE_TYPE.
|
firmwareData | Signed binary data of a firmware file provided by IDTech |
ip | Optional ip address of device |
address | Required for ADF_SDK and ADF_APP. Start address |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
|
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_SREDKey2.msr_cancelTransaction | ( | string | ident = "" | ) |
Cancel MSR Transaction
Valid only in HID Mode
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_disable | ( | string | ident = "" | ) |
Disable MSR function.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_enable | ( | string | ident = "" | ) |
Disable MSR function.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.msr_getConfiguration | ( | ref byte[] | config, |
string | ident = "" |
||
) |
Set MSR Configuration
Gets msr configuration data.
config | Configuration data to get |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.msr_getFunctionStatus | ( | ref bool | enabled, |
ref bool | isBufferMode, | ||
ref bool | withNotification, | ||
string | ident = "" |
||
) |
Get MSR Function status Get MSR Function status about enable/disable and with or without seated notification
enabled |
|
isBufferMode |
|
withNotification |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getSwipeEncryption | ( | ref byte | encryption, |
string | ident = "" |
||
) |
Get Swipe Data Encryption
For Non-SRED Augusta Only
Returns the encryption used for swipe 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_SREDKey2.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_SREDKey2.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_SREDKey2.msr_getTerminalData | ( | byte[] | tag, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Get MSR Terminal Data
Gets msr terminal data.
tag | Tag value to retrieve (example new byte[]{0xDF, 0xEC, 0x09} to retrieve value for tag DFEC09 |
tlv | Configuration data to read in TLV format |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_resetTerminalData | ( | string | ident = "" | ) |
Reset MSR Terminal Data
Resets msr terminal data to defaults.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.msr_setConfiguration | ( | byte[] | config, |
string | ident = "" |
||
) |
Set MSR Configuration
Sets msr configuration data.
config | Configuration data to send |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.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_SREDKey2.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_SREDKey2.msr_setTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set MSR Terminal Data
Sets msr terminal data.
tlv | Configuration data to set in TLV format |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_startKeyedTransaction | ( | int | timeout, |
bool | ZIP, | ||
bool | CSC, | ||
bool | ADR, | ||
bool | Mod10Check, | ||
string | ident = "" |
||
) |
Start Swipe Transaction
Enables keypad, awaiting card number input. Valid only when device is in HID mode, and poll on demand mode Will prompt for PAN and Expiration Date.
@param timeout Swipe Timeout Value (0 - 255 seconds) @ZIP Also Request ZIP @CSC Also Request CSC @ADR Also Request Address @Mod10Check Verify PAN passes validation
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_startSwipeTransaction | ( | int | timeout, |
byte[] | tlv, | ||
string | ident = "" |
||
) |
Start Swipe Transaction
Enables MSR, waiting for swipe to occur. Valid only when device is in HID mode, poll on demand mode, and MSR Function ID 0x1A = 0x31.
@param timeout Swipe Timeout Value (0 - 255 seconds) @tlv TLV configuration settings to override existing device tlv configuration settings
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.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_SREDKey2.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_SREDKey2 class.