|
RETURN_CODE | device_getFirmwareVersion (ref string response) |
|
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ip="") |
|
RETURN_CODE | device_getVersion (byte version, ref string response) |
|
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response) |
|
RETURN_CODE | device_sendBeep (int time) |
|
RETURN_CODE | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool isFastEMV=false) |
|
RETURN_CODE | device_setDateTime () |
|
RETURN_CODE | ctls_cancelTransaction () |
|
RETURN_CODE | ctls_enableL2Application (bool enable) |
|
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_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) |
|
Class for IDT_CM100 ICC reader
RETURN_CODE IDTechSDK.IDT_CM100.ctls_cancelTransaction |
( |
| ) |
|
Cancel CTLS Transaction
Cancels the currently executing CTLS transaction.
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.ctls_enableL2Application |
( |
bool |
enable | ) |
|
Enable L2 Application
Enables or disables the L2 Application. Disable when L1 functionality is needed
@param enable TRUE = application enabled, FALSE = application disabled
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.ctls_startTransaction |
( |
double |
amount, |
|
|
double |
amtOther, |
|
|
int |
exponent, |
|
|
int |
type, |
|
|
int |
timeout, |
|
|
byte[] |
tags, |
|
|
bool |
isFastEMV = false |
|
) |
| |
Start EMV Transaction Request
Authorizes the CTLS transaction for a CTLS card
The tags will be returned in the callback routine.
- Parameters
-
amount | Transaction amount value (tag value 9F02) |
amtOther | Other amount value, if any (tag value 9F03) |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 If tags 9F02 (amount),9F03 (other amount), or 9C (transaction type) are included, they will take priority over these values supplied as individual parameters to this method. |
isFastEMV | If TRUE, it will populate the IDTTransactionData.fastEMV with ASCII data similar to IDTech FastEMV KB output, after performing an auto-authenticate and auto-complete with ResultCode = Could Not Contact Host |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.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
- Parameters
-
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. |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE
RETURN_CODE IDTechSDK.IDT_CM100.device_getConfigurationFromMemory |
( |
ref string |
json, |
|
|
string |
ident = "" |
|
) |
| |
Read Device Configuration From Memory Retrieves the ViVOconfig configuration data from memory after a successful device_readConfigurationToMemory
- Parameters
-
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. |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE
RETURN_CODE IDTechSDK.IDT_CM100.device_getFirmwareVersion |
( |
ref string |
response | ) |
|
Polls device for Firmware Version
- Parameters
-
response | Response returned of Firmware Version |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.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
- Parameters
-
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. |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE
RETURN_CODE IDTechSDK.IDT_CM100.device_getVersion |
( |
byte |
version, |
|
|
ref string |
response |
|
) |
| |
Get Version
- Parameters
-
version | The version to return:
- 0x01 = READER
- 0x91 = L1
- 0xA1 = PAYPASS
- 0xB1 = VISA
- 0xC1 = AMEX
- 0xD1 = DISCOVER
|
response | Response returned of Firmware Version |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.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 IDTechSDK.IDT_CM100.device_RemoteKeyInjection |
( |
RKI_KEY_TYPE |
type, |
|
|
string |
keyName, |
|
|
string |
ident = "" , |
|
|
bool |
performOnForeground = false |
|
) |
| |
Remote Key Injection Performs a remote key injection for the device
- Parameters
-
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) |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString(). When no data is available, return code = RETURN_CODE_NO_DATA_AVAILABLE
RETURN_CODE IDTechSDK.IDT_CM100.device_sendBeep |
( |
int |
time | ) |
|
Beep Device
- Parameters
-
Time | to beep in .1 second increments. Example: 16 = 1.6 seconds |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.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 IDTechSDK.IDT_CM100.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 IDTechSDK.IDT_CM100.device_sendDataCommand |
( |
string |
cmd, |
|
|
bool |
calcLRC, |
|
|
ref byte[] |
response |
|
) |
| |
Send a NSData object to device
Sends a command represented by the provide NSData object to the device through the accessory protocol.
- Parameters
-
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 |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.device_sendPAE |
( |
string |
command, |
|
|
ref string |
response, |
|
|
int |
timeout, |
|
|
string |
ip = "" |
|
) |
| |
Send Payment Application Engine Command
Executes a PAE command
- Parameters
-
command | ASCII command string, should start with "*PAE" |
response | command response |
timeout | timeout waiting for PAE response |
ip | Optional IP address when connected via TCP/IP |
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_CM100.device_setDateTime |
( |
| ) |
|
Set DateTime
Sets the CM100 date/time to the current date/time of the host operating system
- Returns
- RETURN_CODE: Values can be parsed with errorCode.getErrorString()
static int IDTechSDK.IDT_CM100.getCommandTimeout |
( |
| ) |
|
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
- Return values
-
static String IDTechSDK.IDT_CM100.SDK_Version |
( |
| ) |
|
|
static |
SDK Version
Returns the current version of SDK
- Returns
- Framework version
static void IDTechSDK.IDT_CM100.setCallback |
( |
CallBack |
my_Callback | ) |
|
|
static |
Set Callback
Sets the class callback
static void IDTechSDK.IDT_CM100.setCallback |
( |
IntPtr |
my_Callback, |
|
|
SynchronizationContext |
context |
|
) |
| |
|
static |
Set Callback
Sets the class callback
- Parameters
-
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 void IDTechSDK.IDT_CM100.setCommandTimeout |
( |
int |
milliseconds | ) |
|
|
static |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
- Parameters
-
IDT_CM100 IDTechSDK.IDT_CM100.SharedController |
|
staticget |
Singleton Instance
Establishes an singleton instance of IDT_CM100 class.
- Returns
- Instance of IDT_CM100
The documentation for this class was generated from the following file:
- /Users/randy/Repo/universal-sdk/IDTechSDK_STD/DeviceHeaders/IDT_CM100.cs