![]() |
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 | config_setBaudRate (int baud, string ident="") |
RETURN_CODE | device_retrieveAIDList (ref byte[][] response, string ident="") |
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 | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_getMerchantRecord (int index, ref byte[] record, string ident="") |
RETURN_CODE | device_getTransactionResults (ref IDTTransactionData results, string ident="") |
RETURN_CODE | device_pingDevice (string ident="") |
RETURN_CODE | device_controlUserInterface (byte[] values, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | device_controlLED (byte indexLED, byte control, string ident="") |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response, string ident="") |
RETURN_CODE | device_cancelTransaction (string ident="") |
RETURN_CODE | device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ident="") |
RETURN_CODE | ctls_retrieveAIDList (ref byte[][] response, string ident="") |
RETURN_CODE | ctls_getAllConfigurationGroups (ref byte[][] response, string ident="") |
RETURN_CODE | ctls_retrieveApplicationData (byte[] AID, ref byte[] tlv, string ident="") |
RETURN_CODE | ctls_removeApplicationData (byte[] AID, string ident="") |
RETURN_CODE | ctls_setApplicationData (byte[] tlv, string ident="") |
RETURN_CODE | ctls_setDefaultConfiguration (string ident="") |
RETURN_CODE | ctls_setConfigurationGroup (byte[] tlv, string ident="") |
RETURN_CODE | ctls_retrieveTerminalData (ref byte[] tlv, string ident="") |
RETURN_CODE | ctls_setTerminalData (byte[] tlv, string ident="") |
RETURN_CODE | ctls_trySetTerminalData (byte[] tlv, ref byte[] rejectedTLV, ref byte[] convertedTLV, string ident="") |
RETURN_CODE | ctls_getConfigurationGroup (int group, ref byte[] tlv, string ident="") |
RETURN_CODE | ctls_removeConfigurationGroup (int group, string ident="") |
RETURN_CODE | ctls_setCAPK (byte[] key, string ident="") |
RETURN_CODE | ctls_retrieveCAPK (byte[] capk, ref byte[] key, string ident="") |
RETURN_CODE | ctls_removeCAPK (byte[] capk, string ident="") |
RETURN_CODE | ctls_removeAllCAPK (string ident="") |
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys, string ident="") |
RETURN_CODE | device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool isFastEMV=false, string ident="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, bool isFastEMV=false, string ident="") |
RETURN_CODE | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool isFastEMV=false, string ident="") |
RETURN_CODE | ctls_updateBalance (byte statusCode, byte[] authCode, byte[] date, byte[] time, string ident="") |
RETURN_CODE | ctls_activateTransaction (int timeout, byte[] tags, bool isFastEMV=false, string ident="") |
RETURN_CODE | ctls_cancelTransaction (string ident="") |
RETURN_CODE | device_setBurstMode (byte mode, string ident="") |
RETURN_CODE | device_setMerchantRecord (int index, bool enabled, string merchantID, string merchantURL, string ident="") |
RETURN_CODE | device_pollForToken (byte seconds, ref byte card, ref byte[] serialNumber, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | device_setPollMode (byte mode, string ident="") |
RETURN_CODE | device_startRKI (string ident="") |
RETURN_CODE | device_StartRKI (int type, string ident="") |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, string ident="") |
RETURN_CODE | device_enablePassThrough (bool enablePassThrough, string ident="") |
RETURN_CODE | felica_authentication (byte[] key, string ident="") |
RETURN_CODE | felica_SendCommand (byte[] command, ref byte[] response, string ident="") |
RETURN_CODE | felica_readWithMac (int numBlocks, byte[] blockList, ref byte[] blocks, string ident="") |
RETURN_CODE | felica_writeWithMac (int blockNumber, byte[] data, string ident="") |
RETURN_CODE | felica_read (byte[] serviceCode, int numBlocks, byte[] blockList, ref byte[] blocks, string ident="") |
RETURN_CODE | felica_write (byte[] serviceCode, int blockCount, byte[] blockList, byte[] data, ref byte[] statusFlag, string ident="") |
RETURN_CODE | ctls_nfcCommand (byte[] nfcCmdPkt, ref byte[] response, string ident="") |
RETURN_CODE | felica_requestService (byte[] nodeCode, ref byte[] response, 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) |
RETURN_CODE | config_setDEKVariantType (byte type, string ident="") |
RETURN_CODE | config_getDEKVariantType (ref byte type, string ident="") |
RETURN_CODE | config_setDUKPTEncryptionType (byte type, string ident="") |
RETURN_CODE | config_getDUKPTEncryptionType (ref byte type, string ident="") |
RETURN_CODE | config_getDUKPT_KSN (ref byte[] ksn, string ident="") |
RETURN_CODE | config_getSalt_KCV (ref byte[] kcv, string ident="") |
RETURN_CODE | config_checkDUKPTKey (byte keyindex, ref byte[] val, string ident="") |
RETURN_CODE | config_setDUKPT_DEK_Attribution_TDES (byte keyslot, byte outputMode, byte variant, string ident="") |
RETURN_CODE | config_setDUKPT_DEK_Attribution_AES (byte keyslot, byte workingKey, byte keyUsage, string ident="") |
RETURN_CODE | config_getDUKPT_DEK_Attribution (byte keyslot, ref byte mode, ref byte outputMode_workingKey, ref byte variant_keyUsage, string ident="") |
RETURN_CODE | config_setKeyslot_PEK_DEK (bool isPEK, byte keyslot, string ident="") |
RETURN_CODE | config_getKeyslot_PEK_DEK (ref byte keyslotPEK, ref byte keyslotDEK, string ident="") |
RETURN_CODE | config_setRKLKeys (short keyNumber, byte[] tr31, byte[] nonce, byte[] hmac, ref byte[] kv, ref byte[] nonce_device, ref byte[] hmac_device, string ident="") |
Static Public Member Functions | |
static bool | useSerialPort (int port) |
static bool | useSerialPortLinux (string path) |
static bool | useSerialPortLinux (string path, int baud) |
static int | getCommandTimeout (string ident="") |
static void | setCommandTimeout (int milliseconds, string ident="") |
static bool | useSerialPort (int port, int baud, string ident="") |
static void | initSC () |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
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_KioskIII | SharedController [get] |
Class for KioskIII and KioskIV ICC reader
RETURN_CODE IDTechSDK.IDT_KioskIII.config_checkDUKPTKey | ( | byte | keyindex, |
ref byte[] | val, | ||
string | ident = "" |
||
) |
Check DUKPT Key
This command checks whether a valid DUKPT key is stored at the specified slot and if a valid key is found then some basic information related to the type of key is returned. The actual Key data is never returned. This command can be used to check whether a key is already present before injecting a key in a KeyIndex to prevent overwriting an existing DUKPT key.
keyindex | Data Encryption Key Index (usually 5) |
val |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getDEKVariantType | ( | ref byte | type, |
string | ident = "" |
||
) |
Get Data Encryption Key Variant Type
Returns the Data Encryption Key Type
type |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getDUKPT_DEK_Attribution | ( | byte | keyslot, |
ref byte | mode, | ||
ref byte | outputMode_workingKey, | ||
ref byte | variant_keyUsage, | ||
string | ident = "" |
||
) |
Get DUKPT DEK Attribution based on KeySlot
Command settings can only be changed for each key one time.
keyslot | Key Slot |
mode |
|
outputMode_workingKey | Output Mode is when TDES, Working Key is when AES
|
variant_keyUsage | Variant is when TDES, Key Usage is when AES
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getDUKPT_KSN | ( | ref byte[] | ksn, |
string | ident = "" |
||
) |
Get DUKPT Key Serial Number (KSN)
Host can use this command to retrieve the KSN of the DUKPT key.
ksn | Key Serial Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getDUKPTEncryptionType | ( | ref byte | type, |
string | ident = "" |
||
) |
Get DUKPT Key Encryption Type
Returns DUKPT Key Encryption Type.
type |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getKeyslot_PEK_DEK | ( | ref byte | keyslotPEK, |
ref byte | keyslotDEK, | ||
string | ident = "" |
||
) |
Get KeySlot for DUKPT PEK and DUKPT DEK
• Returns the KeySlot for PEK and DEK (when exists).
keyslotPEK | PEK KeySlot (0-9). Value of 255 (0xff) = does not exist |
keyslotDEK | DEK KeySlot (0-9). Value of 255 (0xff) = does not exist |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_getSalt_KCV | ( | ref byte[] | kcv, |
string | ident = "" |
||
) |
Get Salt KCV
Host can use this command to retrieve the Salt KCV.
kcv | KCV |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.config_setBaudRate | ( | int | baud, |
string | ident = "" |
||
) |
Set Baud Rate
Sets the buad rate for RS-232 communication.
baud |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setDEKVariantType | ( | byte | type, |
string | ident = "" |
||
) |
Set Data Encryption Key Variant Type
This command exists to specify the key variant type of Data encryption Key (Slot = 0), and MUST be used before the initial loading of the Data encryption Key into the device. The key variant type CANNOT be changed once the Data encryption Key is present. It must remain either Data Variant or PIN Variant.
type |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setDUKPT_DEK_Attribution_AES | ( | byte | keyslot, |
byte | workingKey, | ||
byte | keyUsage, | ||
string | ident = "" |
||
) |
Set DUKPT DEK Attribution based on KeySlot AES
Command settings can only be changed for each key one time.
keyslot | Key Slot |
workingKey |
|
keyUsage |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setDUKPT_DEK_Attribution_TDES | ( | byte | keyslot, |
byte | outputMode, | ||
byte | variant, | ||
string | ident = "" |
||
) |
Set DUKPT DEK Attribution based on KeySlot TDES
Command settings can only be changed for each key one time. However switching the Output mode (TDES and TransArmor TDES) is always valid.
keyslot | Key Slot |
outputMode |
|
variant |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setDUKPTEncryptionType | ( | byte | type, |
string | ident = "" |
||
) |
Set DUKPT Key Encryption Type
This command exists to specify the encryption type of Data encryption Key(Slot = 0), and MUST be used before the initial loading of the Data encryption Key into the device. The encryption type CANNOT be changed once the Data encryption Key is present. It must remain either TDES or AES.
type |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setKeyslot_PEK_DEK | ( | bool | isPEK, |
byte | keyslot, | ||
string | ident = "" |
||
) |
Set KeySlot for DUKPT PEK and DUKPT DEK
• Selects one of the available PEKs for use in subsequent PIN encryption operations. • Selects one of the available DEKs for use in subsequent Data encryption operations.
isPEK | TRUE = Set PEK, FALSE = Set DEK |
keyslot | The KeySlot number specifies the key this command will select |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.config_setRKLKeys | ( | short | keyNumber, |
byte[] | tr31, | ||
byte[] | nonce, | ||
byte[] | hmac, | ||
ref byte[] | kv, | ||
ref byte[] | nonce_device, | ||
ref byte[] | hmac_device, | ||
string | ident = "" |
||
) |
Set RKL Keys
• Sets the RKL Keys.
keyNumber | Number of keys remaining to load |
tr31 | ASN.1 structure of encrypted key(s) |
nonce | Nonce generated by RKMS to generate an HMAC used for auth. |
hmac | HMAC-SHA256 generated from RKMS. |
kv | ASN.1 Key Verification Structure returned from device. |
nonce_device | Nonce generated by the device to generate a MAC used for auth. |
hmac_device | HMAC-SHA256 generated from device terminal. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start CTLS Transaction Request
Authorizes the CTLS transaction
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required) 9F26 = four bytes = ApplePay Terminal Capabilities Information (required)
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_cancelTransaction | ( | string | ident = "" | ) |
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_getAllConfigurationGroups | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS
response | array of CTLS groups as TLV bytes |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_getConfigurationGroup | ( | int | group, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Get Configuration Group
Retrieves the Configuration for the specified Group.
group | Configuration Group |
tlv | return data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_nfcCommand | ( | byte[] | nfcCmdPkt, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
NFC Command
This command uses nfcCmdPkt[0] in command data field to implement different functions. This command should be used in Pass-Through mode and command with “Poll for a NFC Tag” data should be used first. Command with other data can only be used once the “Poll for a NFC Tag” command has indicated that a NFC tag is present.
nfcCmdPkt | System Code
|
response | Response as explained in FeliCA Lite-S User's Manual |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeAllCAPK | ( | string | ident = "" | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for CTLS
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeApplicationData | ( | byte[] | AID, |
string | ident = "" |
||
) |
Remove Application Data by AID
Removes the Application Data for CTLS as specified by the AID name passed as a parameter
AID | Name of ApplicationID Must be between 5 and 16 bytes |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeCAPK | ( | byte[] | capk, |
string | ident = "" |
||
) |
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_removeConfigurationGroup | ( | int | group, |
string | ident = "" |
||
) |
Remove Configuration Group
Removes the Configuration as specified by the Group. Must not by group 0
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS.
response | array of 2-tag TLV data objects: FFE4 (group name) followed by 9F06 (AID) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv, | ||
string | ident = "" |
||
) |
Retrieve Application Data by AID
Retrieves the CTLS Application Data as specified by the AID name passed as a parameter.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
tlv | The TLV elements of the requested AID |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key, | ||
string | ident = "" |
||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for CTLS as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
key | Response returned as a CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveCAPKList | ( | ref byte[] | keys, |
string | ident = "" |
||
) |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal for CTLS.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_retrieveTerminalData | ( | ref byte[] | tlv, |
string | ident = "" |
||
) |
Retrieve Terminal Data
Retrieves the Terminal Data for CTLS. This is configuration group 0 (Tag FFEE - > FFEE0100). The terminal data can also be retrieved by ctls_getConfigurationGroup(0).
tlv | Response returned as a TLV |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setApplicationData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Application Data by AID
Sets the Application Data for CTLS as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (FFE4). The second tag of the TLV data must be the AID (9F06) |
Example valid TLV, for Group #2, AID a0000000035010: "ffe401029f0607a0000000051010ffe10101ffe50110ffe30114ffe20106"
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setCAPK | ( | byte[] | key, |
string | ident = "" |
||
) |
Set Certificate Authority Public Key
Sets the CAPK for CTLS as specified by the CAKey structure
key | CAKey format: [5 bytes RID][1 byte Index][1 byte Hash Algorithm][1 byte Encryption Algorithm][20 bytes HashValue][4 bytes Public Key Exponent][2 bytes Modulus Length][Variable bytes Modulus] Where:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setConfigurationGroup | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Configuration Group
Sets the Configuration Group for CTLS as specified by the TLV data
tlv | Configuration Group Data in TLV format The first tag of the TLV data must be the group number (FFE4). A second tag must exist |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setDefaultConfiguration | ( | string | ident = "" | ) |
Set Default Configuration Group
Resets the device to default CTLS configuration group settings
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_setTerminalData | ( | byte[] | tlv, |
string | ident = "" |
||
) |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The first TLV must be Configuration Group Number (Tag FFE4). The terminal global data is group 0, so the first TLV would be FFE40100. Other groups can be defined using this method (1 or greater), and those can be retrieved with emv_getConfigurationGroup(int group), and deleted with emv_removeConfigurationGroup(int group). You cannot delete group 0.
tlv | TerminalData configuration data |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start CTLS Transaction Request
The tags will be returned in the callback routine.
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required) 9F26 = four bytes = ApplePay Terminal Capabilities Information (required)
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_trySetTerminalData | ( | byte[] | tlv, |
ref byte[] | rejectedTLV, | ||
ref byte[] | convertedTLV, | ||
string | ident = "" |
||
) |
Try to Set CTLS Terminal Data
Atempts to set the CTLS Terminal Data. Use this functions to attempt to set the terminal data to the device. This function will allow the cross-device tag compatible writing of IDTech Legacy/New tag definitions
tlv | TerminalData TLV Data |
rejectedTLV | Contains the tags (if any) that were rejected by the firmware |
convertedTLV | Contains the tags (if any) that were converted and accepted by the firmware |
ident | Optional identifier |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_BTPay::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_KioskIII.ctls_updateBalance | ( | byte | statusCode, |
byte[] | authCode, | ||
byte[] | date, | ||
byte[] | time, | ||
string | ident = "" |
||
) |
Update Balance
This command is the authorization response sent by the issuer to the terminal including the Authorization Status (OK or NOT OK).
This command is also being used in some implementations (i.e. EMEA) to communicate the results of Issuer Authentication to the reader in order to display the correct LCD messages. With this command, the POS passes the authorization result (OK/NOT OK), and possibly the Authorization Code (Auth_Code)/Date/Time to the terminal.
statusCode | 00: OK, 01: NOT OK, 02: (ARC response 89 for Interac) |
authCode | Authorization code from host. Six bytes. Optional |
date | Transaction date. If null, uses current terminal date. 3 bytes compressed numeric YYMMDD (tag value 9A). |
time | Transaction time. If null, uses current terminal time. 3 bytes compressed numeric HHMMSS (tag value 9F21). |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start CTLS Transaction Request
Authorizes the CTLS transaction
The tags will be returned in the callback routine.
timeout | Timeout value in seconds. |
tags | The tags to be included in the request. Passed as TLV Data. Example, tag 9F02 with amount 0x000000000100 would be 0x9F0206000000000100 |
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required) 9F26 = four bytes = ApplePay Terminal Capabilities Information (required)
RETURN_CODE IDTechSDK.IDT_KioskIII.device_cancelTransaction | ( | string | ident = "" | ) |
Cancel Transaction
Cancels the currently executing device transaction.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_controlLED | ( | byte | indexLED, |
byte | control, | ||
string | ident = "" |
||
) |
Control LED
Controls the LED for the reader. This command will only operate in pass-through mode
indexLED | For LED
|
control | LED Status:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_controlUserInterface | ( | byte[] | values, |
string | ident = "" |
||
) |
Control User Interface
Controls the User Interface: Display, Beep, LED
@param values Four bytes to control the user interface Byte[0] = LCD Message Messages 00-07 are normally controlled by the reader. - 00h: Idle Message (Welcome) - 01h: Present card (Please Present Card) - 02h: Time Out or Transaction cancel (No Card) - 03h: Transaction between reader and card is in the middle (Processing...) - 04h: Transaction Pass (Thank You) - 05h: Transaction Fail (Fail) - 06h: Amount (Amount $ 0.00 Tap Card) - 07h: Balance or Offline Available funds (Balance $ 0.00) Messages 08-0B are controlled by the terminal - 08h: Insert or Swipe card (Use Chip & PIN) - 09h: Try Again(Tap Again) - 0Ah: Tells the customer to present only one card (Present 1 card only) - 0Bh: Tells the customer to wait for authentication/authorization (Wait) - FFh: indicates the command is setting the LED/Buzzer only. Byte[1] = Beep Indicator - 00h: No beep - 01h: Single beep - 02h: Double beep - 03h: Three short beeps - 04h: Four short beeps - 05h: One long beep of 200 ms - 06h: One long beep of 400 ms - 07h: One long beep of 600 ms - 08h: One long beep of 800 ms Byte[2] = LED Number - 00h: LED 0 (Power LED) 01h: LED 1 - 02h: LED 2 - 03h: LED 3 - FFh: All LEDs Byte[3] = LED Status - 00h: LED Off - 01h: LED On
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_enablePassThrough | ( | bool | enablePassThrough, |
string | ident = "" |
||
) |
Enable Pass Through
Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).
enablePassThrough | true = pass through ON, false = pass through OFF |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.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_KioskIII.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_KioskIII.device_getMerchantRecord | ( | int | index, |
ref byte[] | record, | ||
string | ident = "" |
||
) |
Get Merchant Record Gets the merchant record for ApplePay VAS
index | Merchant Record index, valid values 1-6 |
record | Data returned containing 99 bytes: Byte 0 = Merchand Index Byte 1 = Merchant Enabled (1 = enabled) Byte 2 - 33 = Merchant Protocol Hash-256 value Byte 34 = Length of Merchant URL Bytes 35 - 99 = URL |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.device_getTransactionResults | ( | ref IDTTransactionData | results, |
string | ident = "" |
||
) |
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
results | The transaction results |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_pingDevice | ( | string | ident = "" | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_pollForToken | ( | byte | seconds, |
ref byte | card, | ||
ref byte[] | serialNumber, | ||
string | ident = "" |
||
) |
Poll for Token
Once Pass-Through Mode is started, ViVOpay will not poll for any cards until the “Poll for Token” command is received. This command tells ViVOpay to start polling for a Type A or Type B PICC until a PICC is detected or a timeout occurs.
This command automatically turns the RF Antenna on.
If a PICC is detected within the specified time limit, ViVOpay activates it and responds back to the terminal with card related data such as the Serial Number. If no PICC is detected within the specified time limit, ViVOpay stops polling and responds back indicating that no card was found. No card related data is returned in this case
timeout | Timeout, in seconds to wait for card to be detected |
card | Card Type:
|
serialNumber | Serial Number or the UID of the PICC |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.device_rebootDevice | ( | string | ident = "" | ) |
Reboot Device
Performs a reboot of the device
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.device_retrieveAIDList | ( | ref byte | response[][], |
string | ident = "" |
||
) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS/CONTACT.
response | array of TLV data objects: FFE4 (group name) followed by 9F06 (AID), and DFEE4F (Interface 01 = CTLS, 02 = CONTACT) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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_KioskIII.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_KioskIII.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_KioskIII.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) |
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_KioskIII.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 |
ip | Optional IP address when connected via TCP/IP |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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)
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_KioskIII.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)
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_setBurstMode | ( | byte | mode, |
string | ident = "" |
||
) |
Send Burst Mode
Sets the burst mode forthe device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_setMerchantRecord | ( | int | index, |
bool | enabled, | ||
string | merchantID, | ||
string | merchantURL, | ||
string | ident = "" |
||
) |
Set Merchant Record Sets the merchant record for ApplePay VAS
index | Merchant Record index, valid values 1-6 |
enabled | Merchant Enabled/Valid flag |
merchantID | Merchant unique identifer registered with Apple. Example com.idtechproducts.applePay |
merchantURL | Merchant URL, when applicable |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.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
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_KioskIII.device_startRKI | ( | string | ident = "" | ) |
Start Legacy Remote Key Injection
Starts a remote key injection request with IDTech RKI Legacy servers.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_StartRKI | ( | int | type, |
string | ident = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.
type | 0 = Symmetric RKI Demo Unit 1 = Symmetric RKI Production Unit 2 = PKI-RKI Demo Unit 3 = PKI-RKI Production Unit |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ident = "" |
||
) |
Start CTLS Transaction Request
The tags will be returned in the callback routine.
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
NOTE ON APPLEPAY VAS: To enable ApplePay VAS, first a merchant record must be defined in one of the six available index positions (1-6) using device_setMerchantRecord, then container tag FFEE06 must be sent as part of the additional tags parameter of ctls_startTransaction. Tag FFEE06 must contain tag 9F26 and 9F22, and can optionanally contain tags 9F2B and DFO1. Example FFEE06189F220201009F2604000000009F2B050100000000DF010101 9F22 = two bytes = ApplePay Terminal Applicaiton Version Number. Hard defined as 0100 for now. (required) 9F26 = four bytes = ApplePay Terminal Capabilities Information (required)
RETURN_CODE IDTechSDK.IDT_KioskIII.device_updateDeviceFirmware | ( | byte[] | firmwareData, |
string | ident = "" |
||
) |
Update 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_KioskIII.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. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_authentication | ( | byte[] | key, |
string | ident = "" |
||
) |
FeliCa Authentication
Provides a key to be used in a follow up FeliCa Read with MAC (3 blocks max) or Write with MAC (1 block max). This command must be executed before each Read w/MAC or Write w/MAC command
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
key | 16 byte key used for MAC generation of Read or Write with MAC |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_read | ( | byte[] | serviceCode, |
int | numBlocks, | ||
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ident = "" |
||
) |
FeliCa Read
Reads up to 4 blocks.
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
serviceCode | Service Code List. Each service code in Service Code List = 2 bytes of data |
numBlocks | Number of blocks |
blockList | Blocks to read. Maximum 4 block requests |
blocks | Blocks read. Each block 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_readWithMac | ( | int | numBlocks, |
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ident = "" |
||
) |
FeliCa Read with MAC Generation
Reads up to 3 blocks with MAC Generation. FeliCa Authentication must be performed first
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
numBlocks | Number of blocks |
blockList | Block to read. Each block in blockList Maximum 3 block requests |
blocks | Blocks read. Each block 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_requestService | ( | byte[] | nodeCode, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
FeliCa Request Service
Perform functions a Felica Request Service
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
nodeCode | Node Code |
response | Response as explained in FeliCA Lite-S User's Manual |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_SendCommand | ( | byte[] | command, |
ref byte[] | response, | ||
string | ident = "" |
||
) |
FeliCa Send Command
Send a Felica Command
command | Command data from settlement center to be sent to felica card |
response | Response data from felica card. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_write | ( | byte[] | serviceCode, |
int | blockCount, | ||
byte[] | blockList, | ||
byte[] | data, | ||
ref byte[] | statusFlag, | ||
string | ident = "" |
||
) |
FeliCa Write
Writes a block
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
serviceCode | Service Code list. Each service code must be be 2 bytes |
blockCount | Block Count |
blockList | Block list. |
data | Block to write. Must be 16 bytes. |
statusFlag | Status flag response as explained in FeliCA Lite-S User's Manual, Section 4.5 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_KioskIII.felica_writeWithMac | ( | int | blockNumber, |
byte[] | data, | ||
string | ident = "" |
||
) |
FeliCa Write with MAC Generation
Writes a block with MAC Generation. FeliCa Authentication must be performed first
NOTE: The reader must be in Pass Through Mode for FeliCa commands to work.
blockNumber | Number of block |
data | Block to write. Must be 16 bytes. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
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 |
|
static |
SDK Version
Returns the current version of SDK
|
static |
Set Callback
Sets the class callback
|
static |
Set Callback
Sets the class callback
my_Callback | The callback function to receive the response message from device. defined as follows. public unsafe delegate void MFCCallBack(Parameters parameters, ident); |
context | The context of the UI thread |
|
static |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
milliseconds | Time |
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with Kiosk III/IV 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 Kiosk III/IV
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 |
Singleton Instance
Establishes an singleton instance of IDT_KioskIII class.