![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
bool | config_setCmdTimeOutDuration (int newTimeOut, string ident="") |
RETURN_CODE | config_setLEDController (bool firmwareControlMSRLED, bool firmwareControlICCLED=false, string ident="") |
RETURN_CODE | config_getLEDController (ref bool firmwareControlMSRLED, ref bool firmwareControlICCLED, string ident="") |
RETURN_CODE | device_controlLED_ICC (int controlMode, int interval, string ident="") |
RETURN_CODE | device_controlBeep (int index, int frequency, int duration, string ident="") |
RETURN_CODE | device_controlLED (byte indexLED, byte control, int intervalOn=500, int intervalOff=500, string ident="") |
RETURN_CODE | config_setEncryptionControl (bool msr, bool icc, string ident="") |
RETURN_CODE | config_getEncryptionControl (ref bool msr, ref bool icc, string ident="") |
RETURN_CODE | device_getKeyStatus (ref byte[] status, string ident="") |
RETURN_CODE | device_setDateTime (string ident="") |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ident="") |
RETURN_CODE | device_controlLED_MSR (byte control, int intervalOn=500, int intervalOff=500, string ident="") |
RETURN_CODE | msr_captureMode (bool isBufferMode, bool withNotification=false, string ident="") |
RETURN_CODE | msr_disable (string ident="") |
RETURN_CODE | msr_getFunctionStatus (ref bool enabled, ref bool isBufferMode, ref bool withNotification, string ident="") |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode) |
RETURN_CODE | msr_switchUSBInterfaceMode (bool bIsUSBKeyboardMode, ref 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_RetrieveWhiteList (ref byte[] value, string ident="") |
RETURN_CODE | msr_getSetting (byte setting, ref byte value, string ident="") |
RETURN_CODE | msr_getSettings (byte setting, ref byte[] value, string ident="") |
RETURN_CODE | msr_setSetting (byte setting, byte value, string ident="") |
RETURN_CODE | msr_setSettings (byte setting, byte[] value, 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_setSwipeMaskOption (bool track1, bool track2, bool track3, string ident="") |
RETURN_CODE | msr_setWhiteList (byte[] value, byte[] MAC, string ident="") |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ident="") |
RETURN_CODE | msr_cancelMSRSwipe (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 bool | useSerialPort (int port) |
static bool | useSerialPort (int port, int baud) |
static bool | useSerialPortLinux (string path) |
static bool | useSerialPortLinux (string path, int baud) |
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_BTMag | SharedController [get] |
RETURN_CODE IDTechSDK.IDT_BTMag.config_getEncryptionControl | ( | ref bool | msr, |
ref bool | icc, | ||
string | ident = "" |
||
) |
Get Encryption Control
Get Encryption Control to switch status between MSR and ICC/EMV function. Following Encryption status supported:
msr |
|
icc |
|
RETURN_CODE IDTechSDK.IDT_BTMag.config_getLEDController | ( | ref bool | firmwareControlMSRLED, |
ref bool | firmwareControlICCLED, | ||
string | ident = "" |
||
) |
Get the LED Controller Status Get the MSR / ICC LED controlled status by software or firmware
firmwareControlMSRLED |
|
firmwareControlICCLED |
|
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.config_setEncryptionControl | ( | bool | msr, |
bool | icc, | ||
string | ident = "" |
||
) |
Set Encryption Control
Set Encryption Control to switch status between MSR and ICC/EMV function. Following Encryption status supported:
msr |
|
icc |
|
RETURN_CODE IDTechSDK.IDT_BTMag.config_setLEDController | ( | bool | firmwareControlMSRLED, |
bool | firmwareControlICCLED = false , |
||
string | ident = "" |
||
) |
Set the LED Controller Set the MSR / ICC LED controlled by software or firmware NOTE: The ICC LED always controlled by software.
firmwareControlMSRLED |
|
firmwareControlICCLED |
|
RETURN_CODE IDTechSDK.IDT_BTMag.device_controlBeep | ( | int | index, |
int | frequency, | ||
int | duration, | ||
string | ident = "" |
||
) |
Control Beep
Controls the Beeper
index | For Augusta, must be set to 1 (only one beeper) |
frequency | Frequency, range 1000-20000 (suggest minimum 3000) |
duration | Duration, in milliseconds (range 1 - 65525) |
RETURN_CODE IDTechSDK.IDT_BTMag.device_controlLED | ( | byte | indexLED, |
byte | control, | ||
int | intervalOn = 500 , |
||
int | intervalOff = 500 , |
||
string | ident = "" |
||
) |
Control MSR LED
Controls the LED for the MSR
indexLED | For Augusta, must be set to 1 (MSR LED) |
control | LED Status:
|
intervalOn | Blink interval ON, in ms (Range 200 - 2000) |
intervalOff | Blink interval OFF, in ms (Range 200 - 2000) |
RETURN_CODE IDTechSDK.IDT_BTMag.device_controlLED_ICC | ( | int | controlMode, |
int | interval, | ||
string | ident = "" |
||
) |
Control ICC LED
Controls the LED for the ICC card slot
controlMode | 0 = off, 1 = solid, 2 = blink |
interval | Blink interval, in ms (500 = 500 ms) |
RETURN_CODE IDTechSDK.IDT_BTMag.device_controlLED_MSR | ( | byte | control, |
int | intervalOn = 500 , |
||
int | intervalOff = 500 , |
||
string | ident = "" |
||
) |
Control the MSR LED
Controls the MSR / ICC LED This API not recommended to control ICC LED
control |
|
intervalOn | Blink interval on time last, in ms (500 = 500 ms, valid from 200 to 2000) |
intervalOff | Blink interval off time last, in ms (500 = 500 ms, valid from 200 to 2000) |
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.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_BTMag.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. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.device_getKeyStatus | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Get Key Status
Gets the status of loaded keys
status | when the newFormat is false, data format as follows. byte 0: PIN DUKPT Key, Does not support, always 0 byte 1: PIN Master Key, Does not support, always 0 byte 2: PIN Session Key, Does not support, always 0 byte 3: Account/MSR DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 4: Account/ICC DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 5: Admin DUKPT Key, 1 Exists, 0 None, 0xFF STOP |
when the newFormat is true, data format as follows. [Block Length] [KeyStatusBlock1] [KeyStatusBlock2] …[KeyStatusBlockN] Where: [Block Length] is 2 bytes, format is Len_L Len_H, is KeyStatusBlock Number [KeyStatusBlockX> is 4 bytes, format is [Key Index and Key Name] [key slot] [key status]: [Key Index and Key Name] is 1 byte. Please refer to following table 0x14 LCL-KEK to Encrypt Other Keys 0x02 Data encryption Key to Encrypt ICC/MSR 0x05 MAC DUKPT Key for Host-Device – MAC Verification 0x05 MTK DUKPT Key for TTK Self-Test 0x0C RKI-KEK for Remote Key Injection [key slot] is 2 bytes. Range is 0 – 9999 the MTK DUKPT Key slot is 16, the others are all 0 [key status] is 1 byte. 0 – Not Exist 1 – Exist 0xFF – (Stop. Only Valid for DUKPT Key)
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
string IDTechSDK.IDT_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.device_setDateTime | ( | string | ident = "" | ) |
Set Date Time
Set current system date and time to the device.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.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
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
time | Time |
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.msr_captureMode | ( | bool | isBufferMode, |
bool | withNotification = false , |
||
string | ident = "" |
||
) |
Set MSR Capture Mode.
For Non-SRED Augusta Only
Switch between Auto mode and Buffer mode. Auto mode only available on KB interface
isBufferMode |
|
withNotification |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.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_BTMag.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_BTMag.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_BTMag.msr_getSetting | ( | byte | setting, |
ref byte | value, | ||
string | ident = "" |
||
) |
Get Single MSR Setting value
Returns the encryption used for sweip 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_BTMag.msr_getSettings | ( | byte | setting, |
ref byte[] | value, | ||
string | ident = "" |
||
) |
Get Multi MSR Setting value
Returns the encryption used for sweip 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_BTMag.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_BTMag.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_BTMag.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_BTMag.msr_RetrieveWhiteList | ( | ref byte[] | value, |
string | ident = "" |
||
) |
Retrieve MSR White List
For Non-SRED Augusta Only
value | is the white list data which is ASN.1 Block format |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.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_BTMag.msr_setSetting | ( | byte | setting, |
byte | value, | ||
string | ident = "" |
||
) |
Set Single 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_BTMag.msr_setSettings | ( | byte | setting, |
byte[] | value, | ||
string | ident = "" |
||
) |
Set Multi 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_BTMag.msr_setSwipeEncryption | ( | byte | encryption, |
string | ident = "" |
||
) |
Set Swipe Data Encryption
For Non-SRED Augusta Only
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_BTMag.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_BTMag.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_BTMag.msr_setWhiteList | ( | byte[] | value, |
byte[] | MAC, | ||
string | ident = "" |
||
) |
Set MSR White List
For Non-SRED Augusta Only
value | the white list data which is ASN.1 Block format |
MAC | Message Authenticate Code. For non-PCI, use null |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.msr_startMSRSwipe | ( | int | timeout, |
string | ident = "" |
||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur. Allows track selection. Returns IDTMSRData instance to deviceDelegate::swipeMSRData:()
timeout | Swipe Timeout Value |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_BTMag.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_BTMag.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); |
|
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with BTMag using default baud rate
port | Serial Port to use. Example COM1 = 1. |
|
static |
Use Serial Port Interface with baud rate
Instructs SDK to attempt to use the Serial Port for communication with BTPay
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
|
static |
Use Serial Port Interface on Linux
Instructs SDK to attempt to use the Serial Port for communication with BTMag using default baud rate on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
|
static |
Use Serial Port Interface on Linux with baud rate
Instructs SDK to attempt to use the Serial Port for communication with BTPay on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
baud | Baud rate to override default. Example 115200; |
|
staticget |