![]() |
IDTech Windows SDK Guide
1.1.178.0 / NuGet 2.0.1.13
API reference for SREDKey2
|
Public Member Functions | |
RETURN_CODE | device_getOutputType (ref int response) |
RETURN_CODE | device_setOutputType (int value) |
RETURN_CODE | config_getModelNumber (ref string response) |
RETURN_CODE | device_sendVivoCommandP3 (byte command, byte subCommand, byte[] data, ref byte[] response) |
RETURN_CODE | device_sendVivoCommandP3_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse) |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response) |
RETURN_CODE | device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse) |
RETURN_CODE | config_getSerialNumber (ref string response) |
RETURN_CODE | device_getFirmwareVersion (ref string response) |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
RETURN_CODE | device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse) |
RETURN_CODE | msr_disable () |
RETURN_CODE | msr_enable () |
IDTechSDK.RETURN_CODE | device_setLanguage (int val) |
RETURN_CODE | msr_getSwipeEncryption (ref byte encryption) |
RETURN_CODE | device_getTransArmorID (ref string TID) |
RETURN_CODE | device_setTransArmorID (string TID) |
RETURN_CODE | device_enableAdminKey (bool enable) |
RETURN_CODE | msr_setExpirationMask (bool mask) |
RETURN_CODE | msr_getExpirationMask (ref byte value) |
RETURN_CODE | msr_setClearPANID (byte val) |
RETURN_CODE | msr_getClearPANID (ref byte value) |
RETURN_CODE | msr_getSwipeMaskOption (ref byte option) |
RETURN_CODE | msr_setSwipeMaskOption (bool track1, bool track2, bool track3) |
RETURN_CODE | msr_setSwipeForcedEncryptionOption (bool track1, bool track2, bool track3, bool track3card0) |
RETURN_CODE | msr_getSwipeForcedEncryptionOption (ref byte option) |
RETURN_CODE | msr_getFunctionStatus (ref bool enabled, ref bool isBufferMode, ref bool withNotification) |
RETURN_CODE | device_rebootDevice () |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | device_sendVivoCommandP3 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP3_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | device_sendVivoCommandP4 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP4_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | config_getStatusKeySlots (ref byte[] keyslots) |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData) |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode) |
RETURN_CODE | device_startRKI () |
void | setRKIDelay (int setFeatureDelay, int getFeatureDelay) |
void | getRKIDelay (ref int setFeatureDelay, ref int getFeatureDelay) |
Static Public Member Functions | |
static int | getCommandTimeout () |
static void | setCommandTimeout (int milliseconds) |
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 ip="") |
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 | ) |
Polls device for Model Number
response | Returns Model Number |
RETURN_CODE IDTechSDK.IDT_SREDKey2.config_getSerialNumber | ( | ref string | response | ) |
Polls device for Serial Number
response | Returns Serial Number |
RETURN_CODE IDTechSDK.IDT_SREDKey2.config_getStatusKeySlots | ( | ref byte[] | keyslots | ) |
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 |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_enableAdminKey | ( | bool | enable | ) |
Enable Admin Key
enable | TRUE = enable, FALSE = disable |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_getFirmwareVersion | ( | ref string | response | ) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_getOutputType | ( | ref int | response | ) |
Get Captured Data Output Type
response |
|
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_getTransArmorID | ( | ref string | TID | ) |
Get TransArmor ID
TID | TransArmor ID |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_rebootDevice | ( | ) |
Reboot Device
Executes a command to restart the device.
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendDataCommand_ext | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse | ||
) |
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) |
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}' |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP2 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response | ||
) |
Send Vivo Command Protocol 2
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP2 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 2
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP2_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse | ||
) |
Send Vivo Command Protocol 2 Extended
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP2_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 2 Extended
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP3 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response | ||
) |
Send Vivo Command Protocol 3
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP3 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 3
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP3_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse | ||
) |
Send Vivo Command Protocol 3 Extended
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP3_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 3 Extended
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP4 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 4
Sends a protocol 4 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_sendVivoCommandP4_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 4 Extended
Sends a protocol 4 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
IDTechSDK.RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setLanguage | ( | int | val | ) |
Set Device Language.
val | Language: 0 = English, 1 = Japanese |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setOutputType | ( | int | value | ) |
Set Captured Data Output Type
value |
|
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_setTransArmorID | ( | string | TID | ) |
Set TransArmor ID
TID | TransArmor ID |
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_startRKI | ( | ) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
RETURN_CODE IDTechSDK.IDT_SREDKey2.device_updateDeviceFirmware | ( | byte[] | firmwareData | ) |
Update K81 Firmware
Updates the firmware .
firmwareData | Signed binary data of a firmware file provided by IDTech |
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 |
Update App Firmware
Updates the firmware
type | FIRMWARE_TYPE. It can be Bootloader A, Bootloader B, 1050, K81, or Kernels 0-11. |
firmwareData | Signed binary data of a firmware file provided by IDTech |
ip | Optional ip address of device |
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 |
void IDTechSDK.IDT_SREDKey2.getRKIDelay | ( | ref int | setFeatureDelay, |
ref int | getFeatureDelay | ||
) |
Get Remote Key Injection Delay
Returns the timing parameters when executing 90-03 command.
setFeatureDelay | Time, in milliseconds, that will be inserted before SetFeatureReport is executed for 90-03 command |
getFeatureDelay | Time, in milliseconds, that will be inserted before GetFeatureReport in response to a 90-03 command |
|
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 |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_disable | ( | ) |
Disable MSR function.
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_enable | ( | ) |
Disable MSR function.
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getClearPANID | ( | ref byte | value | ) |
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': |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getExpirationMask | ( | ref byte | value | ) |
Get Expiration Masking
Get the flag that determines if to mask the expiration date
value | '0' = masked, '1' = not-masked |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getFunctionStatus | ( | ref bool | enabled, |
ref bool | isBufferMode, | ||
ref bool | withNotification | ||
) |
Get MSR Function status Get MSR Function status about enable/disable and with or without seated notification
enabled |
|
isBufferMode |
|
withNotification |
|
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getSwipeEncryption | ( | ref byte | encryption | ) |
Get Swipe Data Encryption
For Non-SRED Augusta Only
Returns the encryption used for swipe data
encryption | 1 = TDES, 2 = AES, 0 = NONE |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getSwipeForcedEncryptionOption | ( | ref byte | option | ) |
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
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_getSwipeMaskOption | ( | ref byte | option | ) |
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
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_setClearPANID | ( | byte | val | ) |
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. |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_setExpirationMask | ( | bool | mask | ) |
Set Expiration Masking
Sets the flag to mask the expiration date
mask | TRUE = mask expiration |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_setSwipeForcedEncryptionOption | ( | bool | track1, |
bool | track2, | ||
bool | track3, | ||
bool | track3card0 | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_SREDKey2.msr_setSwipeMaskOption | ( | bool | track1, |
bool | track2, | ||
bool | track3 | ||
) |
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 |
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
|
|
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); |
|
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); |
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 |
void IDTechSDK.IDT_SREDKey2.setRKIDelay | ( | int | setFeatureDelay, |
int | getFeatureDelay | ||
) |
Set Remote Key Injection Delay
During Remote Key Injection, it may be necessary to adjust the timing parameters when executing 90-03 command.
setFeatureDelay | Time, in milliseconds, that will be inserted before SetFeatureReport is executed for 90-03 command |
getFeatureDelay | Time, in milliseconds, that will be inserted before GetFeatureReport in response to a 90-03 command |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_SREDKey2 class.