![]() |
IDTech Windows SDK Guide
1.2.177.4
API reference for NEO2
|
Public Member Functions | |
bool | ip_connectToSocket (string IP, bool isSecure=false) |
void | ip_autoConnectToSocket () |
void | ip_monitorSocketConnectionStatus (bool enable, bool monitorConnect, int interval, int retryCount) |
RETURN_CODE | device_getBatteryVoltage (ref string voltage) |
RETURN_CODE | config_getSerialNumber (ref string response, string ip="") |
RETURN_CODE | device_terminalInfo (ref byte[] tlv) |
RETURN_CODE | config_setWhiteList (byte[] data, string ip="") |
RETURN_CODE | config_setTrackFormat (byte option, string ip="") |
RETURN_CODE | config_getTrackFormat (ref byte option, string ip="") |
RETURN_CODE | config_setMasking (byte prePAN, byte postPAN, byte asciiMask, byte hexMask, bool maskExp, string ip="") |
RETURN_CODE | config_getMasking (ref byte prePAN, ref byte postPAN, ref byte asciiMask, ref byte hexMask, ref bool maskExp, string ip="") |
RETURN_CODE | config_getWhiteList (ref Dictionary< string, string > data, string ip="") |
RETURN_CODE | config_getWiFiMACAddress (ref byte[] address, string ip="") |
RETURN_CODE | config_getBLEMACAddress (ref byte[] address, string ip="") |
RETURN_CODE | config_getEthernetMACAddress (ref byte[] address, string ip="") |
RETURN_CODE | config_getNetworkConfiguration (ref bool isStatic, ref string address, ref string subnet, ref string gateway, ref string dns) |
RETURN_CODE | device_getDeviceTime (ref DateTime time, string ip="") |
RETURN_CODE | config_setBluetoothParameters (string name, string oldPW, string newPW) |
RETURN_CODE | config_setSwipeandDone (byte swipeVal, byte doneVal, byte delay) |
RETURN_CODE | config_getSwipeandDone (ref byte swipeVal, ref byte doneVal, ref byte delay) |
RETURN_CODE | device_disBlueLED () |
RETURN_CODE | device_enaBlueLED (byte[] dataCmd) |
RETURN_CODE | device_onYellowLED () |
RETURN_CODE | device_offYellowLED () |
RETURN_CODE | device_buzzerOnOff () |
RETURN_CODE | device_getLightSensorVal (ref UInt16 lightVal, string ip="") |
RETURN_CODE | device_setSelfCheckTime (byte hour, byte minutes, string ip="") |
RETURN_CODE | device_logRead (DeviceLogCallback callback, string ip="") |
RETURN_CODE | device_logClear (string ip="") |
RETURN_CODE | device_logEnable (bool enable, string ip="") |
RETURN_CODE | device_extendedErrorCondition (bool enable, string ip="") |
RETURN_CODE | device_getSelfCheckTime (ref byte hour, ref byte minutes, string ip="") |
RETURN_CODE | config_setNetworkConfiguration (bool isStatic, string address, string subnet, string gateway, string dns) |
RETURN_CODE | config_setWifiConfig (string mode, string ssid, string password, string ip, string netMask, string gateway) |
RETURN_CODE | config_getWifiConfig (ref byte mode, ref string ssid, ref string password, ref string ip, ref string netMask, ref string gateway) |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ip="") |
RETURN_CODE | device_getBootloaderVersion (ref string response, string ip="") |
RETURN_CODE | config_setWirelessWorkMode (string mode) |
RETURN_CODE | config_getWirelessWorkMode (ref byte mode) |
RETURN_CODE | device_getRT1050FirmwareVersion (ref string response, string ip="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ip="") |
RETURN_CODE | device_setTransArmorEncryption (byte[] cert) |
RETURN_CODE | device_getTransArmorID (ref string TID) |
RETURN_CODE | device_setTransArmorID (string TID) |
RETURN_CODE | device_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | device_rebootDevice (string ip="") |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ip="") |
RETURN_CODE | device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | msr_setMSRTrack (int val, string ip) |
RETURN_CODE | msr_getMSRTrack (ref int val, string ip) |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ip="") |
RETURN_CODE | msr_startMSRSwipe (int timeout, string ip, SwipeCallback swipeCallback, TimeoutCallback timeoutCallback, FailureCallback failureCallback) |
RETURN_CODE | msr_cancelMSRSwipe (string ip="") |
RETURN_CODE | emv_cancelTransaction () |
RETURN_CODE | ctls_cancelTransaction (string ip="") |
RETURN_CODE | emv_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false) |
RETURN_CODE | emv_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false) |
RETURN_CODE | emv_authenticateTransaction (byte[] updatedTLV) |
RETURN_CODE | ctls_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false) |
RETURN_CODE | ctls_activateTransaction (int timeout, byte[] tags, bool forceOnline, bool isFastEMV=false) |
RETURN_CODE | ctls_updateBalance (byte statusCode, byte[] authCode, byte[] date, byte[] time) |
RETURN_CODE | device_startTransaction (double amount, double amtOther, int exponent, int type, int timeout, byte[] tags, bool isFastEMV=false, string ip="") |
RETURN_CODE | device_activateTransaction (int timeout, byte[] tags, bool isFastEMV=false) |
RETURN_CODE | emv_completeTransaction (bool commError, byte[] authCode, byte[] iad, byte[] tlvScripts, byte[] tlv) |
RETURN_CODE | emv_callbackResponseLCD (EMV_LCD_DISPLAY_MODE type, byte selection) |
RETURN_CODE | emv_callbackResponsePIN (EMV_PIN_MODE type, byte[] KSN, byte[] PIN) |
RETURN_CODE | emv_callbackResponseMSR (byte[] MSR) |
RETURN_CODE | emv_getEMVKernelCheckValue (ref string response) |
RETURN_CODE | emv_getEMVConfigurationCheckValue (ref string response) |
RETURN_CODE | emv_getEMVKernelVersion (ref string response) |
RETURN_CODE | emv_retrieveTransactionResult (byte[] tags, ref IDTTransactionData tlv) |
RETURN_CODE | emv_removeApplicationData (byte[] AID) |
RETURN_CODE | ctls_removeApplicationData (byte[] AID) |
RETURN_CODE | emv_removeAllApplicationData () |
RETURN_CODE | emv_removeCAPK (byte[] capk) |
RETURN_CODE | ctls_removeCAPK (byte[] capk) |
RETURN_CODE | emv_removeAllCAPK () |
RETURN_CODE | ctls_removeAllCAPK () |
RETURN_CODE | emv_removeCRL (byte[] crlList) |
RETURN_CODE | emv_removeAllCRL () |
RETURN_CODE | emv_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
RETURN_CODE | ctls_retrieveApplicationData (byte[] AID, ref byte[] tlv) |
RETURN_CODE | emv_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | ctls_retrieveAIDList (ref byte[][] response) |
RETURN_CODE | emv_retrieveCAPK (byte[] capk, ref byte[] key) |
RETURN_CODE | ctls_retrieveCAPK (byte[] capk, ref byte[] key) |
RETURN_CODE | emv_retrieveCAPKList (ref byte[] keys) |
RETURN_CODE | ctls_retrieveCAPKList (ref byte[] keys) |
RETURN_CODE | emv_retrieveCRLList (ref byte[] list) |
RETURN_CODE | ctls_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | device_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | emv_retrieveTerminalData (ref byte[] tlv) |
RETURN_CODE | emv_removeTerminalData () |
RETURN_CODE | emv_setApplicationData (byte[] name, byte[] tlv) |
RETURN_CODE | emv_setApplicationData (byte[] tlv) |
RETURN_CODE | ctls_setApplicationData (byte[] tlv) |
RETURN_CODE | ctls_setDefaultConfiguration () |
RETURN_CODE | ctls_setConfigurationGroup (byte[] tlv) |
RETURN_CODE | emv_setCAPK (byte[] key) |
RETURN_CODE | ctls_setCAPK (byte[] key) |
RETURN_CODE | emv_setCRL (byte[] list) |
RETURN_CODE | emv_setTerminalData (byte[] tlv) |
RETURN_CODE | ctls_setTerminalData (byte[] tlv) |
RETURN_CODE | device_setTerminalData (byte[] tlv) |
RETURN_CODE | device_sendVivoCommandP3 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP3_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | device_sendVivoCommandP4 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP4_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | emv_setTerminalMajorConfiguration (int configuration) |
RETURN_CODE | emv_getTerminalMajorConfiguration (ref int configuration) |
RETURN_CODE | device_lowPowerMode (bool stopMode, bool wakeOnTrans) |
RETURN_CODE | device_pingDevice (string ip="") |
RETURN_CODE | device_buzzer () |
RETURN_CODE | device_cancelTransaction () |
RETURN_CODE | device_resetTransaction () |
RETURN_CODE | device_controlLED (byte indexLED, byte control, string ip="") |
RETURN_CODE | device_getProductType (ref byte[] type) |
RETURN_CODE | device_getProcessorType (ref byte[] type) |
RETURN_CODE | getHardwareInfor (ref string ascii) |
RETURN_CODE | getUIDofMCU (ref string uid) |
RETURN_CODE | getModuleVer (ref string moduleVer) |
RETURN_CODE | getUsbBootLoader (ref string bootLoader) |
RETURN_CODE | getRemoteKeyInjectionTO (ref int timeout) |
RETURN_CODE | getCashTranRiskPara (ref byte[] tlv) |
RETURN_CODE | getDrlReaderRiskPara (byte index, ref byte[] tlv) |
RETURN_CODE | getMsrSecurePar (bool b0, bool b1, bool b2, bool b3, ref byte[] tlv) |
RETURN_CODE | getWhiteList (ref byte[] list) |
RETURN_CODE | emv_resetConfigurationGroup (int group) |
RETURN_CODE | device_getMerchantRecord (int index, ref byte[] record) |
RETURN_CODE | device_resetConfigurationGroup (int group) |
RETURN_CODE | ctls_resetConfigurationGroup (int group) |
RETURN_CODE | device_controlUserInterface (byte[] values) |
RETURN_CODE | device_sendVivoCommandP2 (byte command, byte subCommand, byte[] data, ref byte[] response, string ip="") |
RETURN_CODE | device_sendVivoCommandP2_ext (byte command, byte subCommand, byte[] data, ref byte[] response, int timeout, bool noResponse, string ip="") |
RETURN_CODE | device_SymmetricRKI (int type, string ip="") |
RETURN_CODE | ctls_getConfigurationGroup (int group, ref byte[] tlv) |
RETURN_CODE | ctls_removeConfigurationGroup (int group) |
RETURN_CODE | ctls_getAllConfigurationGroups (ref byte[][] response) |
RETURN_CODE | device_setBurstMode (byte mode) |
RETURN_CODE | device_setPollMode (byte mode) |
RETURN_CODE | device_setMerchantRecord (int index, bool enabled, string merchantID, string merchantURL) |
RETURN_CODE | device_startRKI (bool isTest, string ip="") |
RETURN_CODE | device_updateFirmwareType (string path, FIRMWARE_TYPE type, FirmwareUpdateCallback callback, string ip) |
RETURN_CODE | device_updateFirmwareIP (string path, int type, FirmwareUpdateCallback callback, string ip) |
RETURN_CODE | icc_getICCReaderStatus (ref byte status) |
RETURN_CODE | icc_powerOffICC () |
RETURN_CODE | icc_powerOnICC (ref byte[] ATR, byte interfaces) |
RETURN_CODE | icc_exchangeAPDU (string c_APDU, ref byte[] response) |
RETURN_CODE | lcd_displayMessage (int lineNumber, string message) |
RETURN_CODE | lcd_clearAllLines () |
RETURN_CODE | lcd_showScreen (string screenName, string ip="") |
RETURN_CODE | lcd_createScreen (string screenName, ref UInt16 screenID, string ip="") |
RETURN_CODE | lcd_cloneScreen (string screenName, string cloneName, ref UInt16 cloneID, string ip="") |
RETURN_CODE | lcd_destroyScreen (string screenName, string ip="") |
RETURN_CODE | lcd_getActiveScreen (ref string screenName, string ip="") |
RETURN_CODE | lcd_getButtonEvent (ref UInt16 screenID, ref UInt16 objectID, ref string screenName, ref string objectName, ref bool isLongPress, string ip="") |
RETURN_CODE | lcd_addButton (string screenName, string buttonName, byte type, byte alignment, UInt16 xCord, UInt16 yCord, string label, ref lcdItem returnItem, buttonCallback callback, string ip="") |
RETURN_CODE | lcd_addEthernet (string screenName, string objectName, byte alignment, UInt16 xCord, UInt16 yCord, ref lcdItem returnItem, string ip) |
RETURN_CODE | lcd_addLED (string screenName, string objectName, byte alignment, UInt16 xCord, UInt16 yCord, ref lcdItem returnItem, byte[] LED, string ip="") |
RETURN_CODE | lcd_addImage (string screenName, string objectName, byte alignment, UInt16 xCord, UInt16 yCord, string filename, ref lcdItem returnItem, string ip="") |
void | lcd_setButtonCallback (string screenName, string buttonName, buttonCallback callback, string ip) |
void | lcd_setPinInputCallback (SwipeCallback callback, string ip="") |
RETURN_CODE | device_enterStandbyMode (string ip="") |
void | lcd_setPinSwipeCallback (SwipeCallback callback, string ip="") |
void | lcd_setPinFailureCallback (FailureCallback callback, string ip="") |
void | lcd_setPinTimeoutCallback (TimeoutCallback callback, string ip="") |
void | lcd_setPinCancelPromptCallback (CancelPromptCallback callback, string ip="") |
RETURN_CODE | lcd_addText (string screenName, string objectName, byte alignment, UInt16 xCord, UInt16 yCord, UInt16 width, UInt16 height, byte fontID, byte[] color, string label, ref lcdItem returnItem, string ip="") |
RETURN_CODE | lcd_updateLabel (string screenName, string objectName, string label, string ip="") |
RETURN_CODE | lcd_updateColor (string screenName, string objectName, byte[] color, string ip="") |
RETURN_CODE | lcd_updatePosition (string screenName, string objectName, byte alignment, UInt16 new_xCord, UInt16 new_yCord, string ip="") |
RETURN_CODE | lcd_removeItem (string screenName, string objectName, string ip="") |
RETURN_CODE | lcd_storeScreenInfo (string ip="") |
RETURN_CODE | lcd_loadScreenInfo (string ip="") |
RETURN_CODE | lcd_clearScreenInfo (string ip="") |
RETURN_CODE | lcd_getAllScreens (ref byte screenNumbers, ref Dictionary< UInt16, string > returnScreens, string ip="") |
RETURN_CODE | lcd_getAllObjects (string screenName, ref byte objectNumbers, ref Dictionary< UInt16, string > returnObjects, string ip="") |
RETURN_CODE | lcd_queryScreenbyName (string screenName, ref byte result, string ip="") |
RETURN_CODE | lcd_queryObjectbyName (string objectName, ref byte objectNumbers, ref List< string > returnItems, string ip="") |
RETURN_CODE | lcd_queryScreenbyID (UInt16 screenID, ref byte result, ref string screenName, string ip="") |
RETURN_CODE | lcd_queryObjectbyID (UInt16 objectID, ref byte objectNumbers, ref List< string > returnItems, string ip="") |
RETURN_CODE | lcd_setBacklight (byte backlightVal, string ip="") |
RETURN_CODE | device_enablePassThrough (bool enablePassThrough) |
RETURN_CODE | device_enableL100PassThrough (bool enablePassThrough) |
string | device_getResponseCodeString (RETURN_CODE eCode) |
RETURN_CODE | device_getTransactionResults (ref IDTTransactionData results) |
RETURN_CODE | pin_getFunctionKey (int timeout, string ip="") |
RETURN_CODE | pin_getFunctionKey (int timeout, string ip, SwipeCallback inputCallback, FailureCallback failureCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_capturePin (int timeout, int type, string PAN, int minPIN, int maxPIN, string message, string ip="") |
RETURN_CODE | pin_capturePin (int timeout, int type, string PAN, int minPIN, int maxPIN, string message, string ip, SwipeCallback inputCallback, FailureCallback failureCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_sendBeep (string ip="") |
RETURN_CODE | pin_getPanEntry (bool csc, bool expDate, bool ADR, bool ZIP, bool mod10, UInt16 timeout, bool encPANOnly=false, string ip="") |
RETURN_CODE | pin_getPanEntry (bool csc, bool expDate, bool ADR, bool ZIP, bool mod10, UInt16 timeout, bool encPANOnly, string ip, SwipeCallback swipeCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_promptForInput (int messageID, short timeout, string ip=null) |
RETURN_CODE | pin_promptForInput (int messageID, short timeout, string ip, SwipeCallback inputCallback, SwipeCallback swipeCallback, FailureCallback failureCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_promptForNumericKeyWithSwipe (short timeout, byte function, int minLen, int maxLen, string line1, string line2, byte[] signature, string ip="") |
RETURN_CODE | pin_promptForNumericKeyWithSwipe (short timeout, byte function, int minLen, int maxLen, string line1, string line2, byte[] signature, string ip, SwipeCallback inputCallback, SwipeCallback swipeCallback, FailureCallback failureCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_promptForAmount (int timeout, int minLen, int maxLen, string message, byte[] signature, string ip="") |
RETURN_CODE | pin_promptForAmount (int timeout, int minLen, int maxLen, string message, byte[] signature, string ip, SwipeCallback inputCallback, FailureCallback failureCallback, TimeoutCallback timeoutCallback, CancelPromptCallback cancelPromptCallback) |
RETURN_CODE | pin_cancelPINEntry (string ip="") |
void | device_listenForNotifications (bool enable, string ip="") |
RETURN_CODE | device_deleteDirectory (string filename, string ip="") |
RETURN_CODE | device_listDirectory (string directoryName, bool recursive, bool onSD, ref string directory, string ip="") |
RETURN_CODE | device_transferFile (string fileName, byte[] file, string ip="") |
RETURN_CODE | device_deleteFile (string filename, string ip="") |
RETURN_CODE | felica_authentication (byte[] key, string ip="") |
RETURN_CODE | felica_readWithMac (int numBlocks, byte[] blockList, ref byte[] blocks, string ip="") |
RETURN_CODE | felica_writeWithMac (int blockNumber, byte[] data, string ip="") |
RETURN_CODE | felica_read (byte[] serviceCode, int numBlocks, byte[] blockList, ref byte[] blocks, string ip="") |
RETURN_CODE | felica_write (byte[] serviceCode, int blockCount, byte[] blockList, byte[] data, ref byte[] statusFlag, string ip="") |
RETURN_CODE | ctls_nfcCommand (byte[] nfcCmdPkt, ref byte[] response, string ip="") |
RETURN_CODE | felica_requestService (byte[] nodeCode, ref byte[] response, string ip="") |
RETURN_CODE | lcd_startScreenSaver (string name, string ip="") |
RETURN_CODE | lcd_playAudio (string name, int type, string ip="") |
RETURN_CODE | lcd_stopAudio (string ip="") |
RETURN_CODE | lcd_startScanQR (ushort timeout, string ip="") |
RETURN_CODE | lcd_stopScanQR (string ip="") |
RETURN_CODE | lcd_startCameraCapture (ushort timeout, string ip="") |
RETURN_CODE | lcd_stopCameraCapture (string ip="") |
Static Public Member Functions | |
static bool | useSerialPort (int port) |
static bool | useSerialPort (int port, int baud) |
static int | getCommandTimeout () |
static void | setCommandTimeout (int milliseconds) |
static void | hasUI (bool val) |
static bool | ip_switchToSocket (string IP) |
static bool | closeSocket (string IP) |
static List< string > | ip_getSocketList () |
static string | getlastErrorString (string ip="") |
static bool | ip_isConnected (string ip, int attempts=1, bool isSecure=false) |
static bool | useUSB () |
static void | setCallback (CallBack my_Callback) |
static void | setLongPressCallback (longPressCallback callback, string ip="") |
static void | setCallbackIP (CallBackIP my_Callback, string ip="") |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static void | emv_autoAuthenticate (bool authenticate) |
static void | emv_autoAuthenticate (bool authenticate, byte[] tags) |
static void | emv_allowFallback (bool allow) |
static RETURN_CODE | device_updateFirmwareType (FIRMWARE_TYPE type, byte[] firmwareData, string ip="") |
static RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData) |
static RETURN_CODE | device_wakeDevice (string macAddress="", string ipAddress="") |
static RETURN_CODE | lcd_clearDisplay () |
static void | lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2) |
Static Public Attributes | |
static bool | bypassUSBCheck = false |
Properties | |
static IDT_NEO2 | SharedController [get] |
Class for VP6300 reader
|
static |
Close Socket
Instructs SDK to attempt to use close existing TCP/IP socket used for communication with IDT_NEO2
IP | Valid established IP address of the existing device. Must match original IP string exactly. Example: Connect to device as 192.168.1.155:50#Device_1. You must use that whole string, not just 192.168.1.155, or 192.168.1.155:50. |
success | TRUE = socket closed, FALSE = socket not found |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getBLEMACAddress | ( | ref byte[] | address, |
string | ip = "" |
||
) |
Get Device BLE MAC Address
address | 6-byte MAC Address |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getEthernetMACAddress | ( | ref byte[] | address, |
string | ip = "" |
||
) |
Get Device Ethernet MAC Address
address | 6-byte MAC Address |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getMasking | ( | ref byte | prePAN, |
ref byte | postPAN, | ||
ref byte | asciiMask, | ||
ref byte | hexMask, | ||
ref bool | maskExp, | ||
string | ip = "" |
||
) |
Get Masking
prePAN | the number of pre-PAN characters to display in the clear. Valid values 0-6. Default 4. |
postPAN | the number of post-PAN characters to display in the clear. Valid values 0-6. Default 4. |
asciiMask | Mask character for ASCII output masked data. Valid values 0x20-0x7E. Default 0x2A (*) param hexMask Mask character for compressed numeric masked data. Valid values are 0x0A = 0x0F. Default 0x0C param maskExp TRUE = mask expiration data, FALSE = display expiration date in the clear. |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getNetworkConfiguration | ( | ref bool | isStatic, |
ref string | address, | ||
ref string | subnet, | ||
ref string | gateway, | ||
ref string | dns | ||
) |
Get Device Network Configuration
isStatic | TRUE = Static IP, FALSE = DHCP |
address | Device IP Address as string. Example "192.168.1.15" |
subnet | Device Subnet as string. Example "255.255.255.0" |
gateway | Device Gateway address as a string. Example "8.8.8.8" |
dns | Device DNS address as string. Example "192.168.1.22" |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getSerialNumber | ( | ref string | response, |
string | ip = "" |
||
) |
Polls device for Serial Number
response | Returns Serial Number |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getSwipeandDone | ( | ref byte | swipeVal, |
ref byte | doneVal, | ||
ref byte | delay | ||
) |
Get Swipe Button and Done Button Configuration
Read the button configuration from the ViVOpay Vendi reader.
swipe | Value of Swipe Button. The value set to 01h, the Swipe Card switch is enabled. If value is set to 00h the Swipe Card switch is disabled. |
done | Value of Done Button. If value is set to 01h, the Done switch is enabled. If value is set to 00h, the DONE switch is disabled. |
delay | The Delay is an unsigned delay value in seconds. This should probably not be set to values larger than 30 seconds |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getTrackFormat | ( | ref byte | option, |
string | ip = "" |
||
) |
Get Track Format
option | Format Options
|
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getWhiteList | ( | ref Dictionary< string, string > | data, |
string | ip = "" |
||
) |
Get White List
data | The white list data returned as Dictionary. Key = start bin range, Value = end bin range. When no range, Value = empty string. |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getWifiConfig | ( | ref byte | mode, |
ref string | ssid, | ||
ref string | password, | ||
ref string | ip, | ||
ref string | netMask, | ||
ref string | gateway | ||
) |
Get Wifi Configuration
Return all the network configurations.
RETURN_CODE IDTechSDK.IDT_NEO2.config_getWiFiMACAddress | ( | ref byte[] | address, |
string | ip = "" |
||
) |
Get Device WiFi MAC Address
address | 6-byte MAC Address |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_getWirelessWorkMode | ( | ref byte | mode | ) |
Get Wireless Work Mode
Return Wireless Work Mode.
RETURN_CODE IDTechSDK.IDT_NEO2.config_setBluetoothParameters | ( | string | name, |
string | oldPW, | ||
string | newPW | ||
) |
Set BluetoothParameters
Sets the name and password for the BLE module.
Sending null to all three parameters resets the default password to 123456
name | Device name, 1-25 characters |
oldPW | Old password, as a six character string, example "123456" |
newPW | New password, as a six character string, example "654321" |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setMasking | ( | byte | prePAN, |
byte | postPAN, | ||
byte | asciiMask, | ||
byte | hexMask, | ||
bool | maskExp, | ||
string | ip = "" |
||
) |
Set Masking
prePAN | the number of pre-PAN characters to display in the clear. Valid values 0-6. Default 4. |
postPAN | the number of post-PAN characters to display in the clear. Valid values 0-6. Default 4. |
asciiMask | Mask character for ASCII output masked data. Valid values 0x20-0x7E. Default 0x2A (*) param hexMask Mask character for compressed numeric masked data. Valid values are 0x0A = 0x0F. Default 0x0C param maskExp TRUE = mask expiration data, FALSE = display expiration date in the clear. |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setNetworkConfiguration | ( | bool | isStatic, |
string | address, | ||
string | subnet, | ||
string | gateway, | ||
string | dns | ||
) |
Set Device Network Configuration
isStatic | TRUE = Static IP, FALSE = DHCP |
address | Device IP Address as string. Example "192.168.1.15" |
subnet | Device Subnet as string. Example "255.255.255.0" |
gateway | Device Gateway address as a string. Example "8.8.8.8" |
dns | Device DNS address as string. Example "192.168.1.22" |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setSwipeandDone | ( | byte | swipeVal, |
byte | doneVal, | ||
byte | delay | ||
) |
Set Swipe Button and Done Button Configuration
Configure the buttons on the ViVOpay Vendi reader. Both the SWIPE and DONE buttons can be independently disabled with this command. This command also sets the TAP disable time for when the SWIPE button is pressed. When the SWIPE button is enabled, the contactless reader is turned off for the programmed delay time so that a false read does not occur when the user wishes to swipe a dual contactless/MagStripe card.
swipe | Value of Swipe Button. The value set to 01h, the Swipe Card switch is enabled. If value is set to 00h the Swipe Card switch is disabled. |
done | Value of Done Button. If value is set to 01h, the Done switch is enabled. If value is set to 00h, the DONE switch is disabled. |
delay | The Delay is an unsigned delay value in seconds. This should probably not be set to values larger than 30 seconds |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setTrackFormat | ( | byte | option, |
string | ip = "" |
||
) |
Set Track Format
option | Format Options
|
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setWhiteList | ( | byte[] | data, |
string | ip = "" |
||
) |
Set White List
data | The signed white list data |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setWifiConfig | ( | string | mode, |
string | ssid, | ||
string | password, | ||
string | ip, | ||
string | netMask, | ||
string | gateway | ||
) |
Set Wifi Configuration
Set wifi configuration. Configuration will be saved in flash.
mode | WiFi work mode 30h – Set NULL Mode, WiFi RF will be disabled 31h - Set Station Mode Default) 32h – Set SoftAP Mode 33h – Set SoftAP+Station Mode(Default) |
ssid | SSID of the target AP as string. |
password | Password of the target AP as string. |
ip | Device IP Address as string. |
netMask | Device Subnet as string. |
gateway | Device Gateway address as a string. |
RETURN_CODE IDTechSDK.IDT_NEO2.config_setWirelessWorkMode | ( | string | mode | ) |
Set Wireless Work Mode
Set wireless work mode(Wi-Fi/BLE). Configuration will be saved in flash.
mode | Wireless work mode 30h – Set Wi-Fi TCP Server Mode 31h - Set Wi-Fi SSL Server Mode 32h – Set BLE Server Mode |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false |
||
) |
Start a CTLS Transaction Request
Authorizes the CTLS transaction for an CTLS card
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 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable |
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 |
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_NEO2.ctls_cancelTransaction | ( | string | ip = "" | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_getAllConfigurationGroups | ( | ref byte | response[][] | ) |
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS
response | array of CTLS groups as TLV bytes |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_getConfigurationGroup | ( | int | group, |
ref byte[] | tlv | ||
) |
Get Configuration Group
Retrieves the Configuration for the specified Group. Group 0 = terminal settings.
group | Configuration Group |
tlv | return data |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_nfcCommand | ( | byte[] | nfcCmdPkt, |
ref byte[] | response, | ||
string | ip = "" |
||
) |
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 |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for CTLS
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_removeApplicationData | ( | byte[] | AID | ) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_removeCAPK | ( | byte[] | capk | ) |
Remove Certificate Authority Public Key
Removes the CAPK for CTLS as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_removeConfigurationGroup | ( | int | group | ) |
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_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_resetConfigurationGroup | ( | int | group | ) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS.
response | array of TLV data objects: DFEE2D (group name) followed by 9F06 (AID), and DFEE4F (Interface 01 = CTLS, 02 = CONTACT) |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key | ||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPKfor 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:
|
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_retrieveCAPKList | ( | ref byte[] | keys | ) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_retrieveTerminalData | ( | ref byte[] | tlv | ) |
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_getConfiguraitonGroup(0).
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_setApplicationData | ( | byte[] | tlv | ) |
Set Application Data by AID
Sets the Application Data as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (DFEE2D). Group 0 = System, all other Groups = User The second tag of the TLV data must be the AID (9F06) If tag DFEE4F is included, it must have a value of 0x01 to be a CTLS AID |
Example valid TLV, for Group #2, AID a0000000045010: "dfee2d01029f0607a0000000045010dfee4b0101dfee2e0110dfee4c0101dfee4f0101
Tags:
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_setCAPK | ( | byte[] | key | ) |
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:
|
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_setConfigurationGroup | ( | byte[] | tlv | ) |
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 (DFEE2D). A second tag must exist |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_setDefaultConfiguration | ( | ) |
Set Default Configuration Group
Resets the device to default CTLS configuration group settings
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_setTerminalData | ( | byte[] | tlv | ) |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The terminal global data is group 0. 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_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.ctls_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false |
||
) |
Start a CTLS Transaction Request
Authorizes the CTLS transaction for an CTLS card
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) |
exponent | Number of characters after decimile point |
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. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable |
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 |
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_NEO2.ctls_updateBalance | ( | byte | statusCode, |
byte[] | authCode, | ||
byte[] | date, | ||
byte[] | time | ||
) |
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). |
RETURN_CODE IDTechSDK.IDT_NEO2.device_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | isFastEMV = false |
||
) |
Start a Transaction Request
Authorizes the transaction CTLS, MSR or Contact EMV
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 |
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_NEO2.device_buzzer | ( | ) |
Buzzer Device
Buzzer the reader. If success can hear one beep. Otherwise, returns timeout.
RETURN_CODE IDTechSDK.IDT_NEO2.device_buzzerOnOff | ( | ) |
Buzzer On/Off
Cause the buzzer to beep once.
RETURN_CODE IDTechSDK.IDT_NEO2.device_cancelTransaction | ( | ) |
Cancel Transaction
Cancels the currently executing device transaction.
RETURN_CODE IDTechSDK.IDT_NEO2.device_controlLED | ( | byte | indexLED, |
byte | control, | ||
string | ip = "" |
||
) |
Control LED
Control the reader. If connected, returns success. Otherwise, returns timeout.
indexLED | description as follows: 00h: LED 0 (Power LED) 01h: LED 1 02h: LED 2 03h: LED 3 10h: Single Tri-Color LED (Unipay III used) FFh: All 4 LEDs + Single Tri-Color LED Where the LEDs are numbered 0, 1, 2, 3 counting from the left. Note: If you are using pass-through mode to control the Power LED (LED 0), it is your responsibility to make sure that it behaves correctly. |
control | description as follows: 00h: LED Off (LED 0~4 + Tri-Color LED) 01h: LED On (LED 0~4) 02h: Green Color (Tri-Color LED) 03h: Red Color (Tri-Color LED) 04h: Amber Color(Tri-Color LED) |
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.device_controlUserInterface | ( | byte[] | values | ) |
Control User Interface
Controls the User Interface: Display, Beep, LED
values | Four bytes to control the user interface Byte[0] = LCD Message Messages 00-07 are normally controlled by the reader.
|
RETURN_CODE IDTechSDK.IDT_NEO2.device_deleteDirectory | ( | string | filename, |
string | ip = "" |
||
) |
Delete Directory
This command deletes an empty directory.
filename | Complete path and file name of the directory you want to delete. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_deleteFile | ( | string | filename, |
string | ip = "" |
||
) |
Delete File
This command deletes a file or group of files.
filename | Complete path and file name of the file you want to delete. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_disBlueLED | ( | ) |
Disable Blue LED Sequence
Stop the blue LEDs on the ViVOpay Vendi reader from flashing in left to right sequence and turn the LEDs off, and contactless function is disable at the same time.
RETURN_CODE IDTechSDK.IDT_NEO2.device_enableL100PassThrough | ( | bool | enablePassThrough | ) |
Enable L100 Pass Through
Enables Pass Through Mode for direct communication to L100 hook up to NEO II device
enablePassThrough | true = pass through ON, false = pass through OFF |
RETURN_CODE IDTechSDK.IDT_NEO2.device_enablePassThrough | ( | bool | enablePassThrough | ) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.device_enaBlueLED | ( | byte[] | dataCmd | ) |
Control the blue LED behavior on the Vendi reader.
Control the blue LED behavior on the Vendi reader.
dataCmd | LED control. Minumum 4 bytes. Maximum 25 bytes. First byte is cycle. Next three bytes are sequence. Then sequence can repeat up to 8 times (24 bytes total for sequence) Byte 0 = Cycles (0 = Cycle once 1 = Repeat) Byte 1 = LED State Bitmap Bit - Description 8 = Left blue LED, 0 = off, 1 = on 7 = Center Blue LED, 0 = off, 1 = on 6 = Right Blue LED0 = off, 1 = on 5 = Yellow LED, 0 = off, 1 = on 4 = Reserved for future use 3 = Reserved for future use 2 = Reserved for future use 1 = Reserved for future use Byte2~3 = Duration (Given in multiples of 10 millisecond) If cycle equals 1, more pairs would be after Byte 3. |
RETURN_CODE IDTechSDK.IDT_NEO2.device_enterStandbyMode | ( | string | ip = "" | ) |
Enter Standby Mode
Puts unit into low power stand by mode
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_extendedErrorCondition | ( | bool | enable, |
string | ip = "" |
||
) |
Enable/disable Extended Error Condition
Enables/disables extended error condition for commands 02-40, 61-xx, 62-xx, 83-41 when error is 0xD0A or 0xD0B String can be retrieved with getLastErrorString
enable | TRUE = enable log, FALSE = disable log |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getBatteryVoltage | ( | ref string | voltage | ) |
Polls device for Battery Voltage
voltage | Returns Battery Voltage string representing millivolts. |
RETURN_CODE |
|
RETURN_CODE IDTechSDK.IDT_NEO2.device_getBootloaderVersion | ( | ref string | response, |
string | ip = "" |
||
) |
Polls device for Bootloader Version
response | Response returned of Bootloader Version |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getDeviceTime | ( | ref DateTime | time, |
string | ip = "" |
||
) |
Get Device Time
time | Device Time |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getFirmwareVersion | ( | ref string | response, |
string | ip = "" |
||
) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getLightSensorVal | ( | ref UInt16 | lightVal, |
string | ip = "" |
||
) |
Get Light Sensor Value
lightVal | Value of the light sensor |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getMerchantRecord | ( | int | index, |
ref byte[] | record | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getProcessorType | ( | ref byte[] | type | ) |
Get Processor Type Returns a processor type TLV
type | processor type RETURN_CODE: Values can be parsed with errorCode.getErrorString() |
45 00 | ARM7/ LPC21xx 4D 00 | ARM Cortex-M4/ K21 Family 4E 00 | ARM Cortex-M4/ K81 Family
RETURN_CODE IDTechSDK.IDT_NEO2.device_getProductType | ( | ref byte[] | type | ) |
Get Product Type Returns a "product type" value in a proprietary TLV
type | product type RETURN_CODE: Values can be parsed with errorCode.getErrorString() |
42 37 00 | ViVOpay 5000 43 33 00 | ViVOpay 4500 43 35 00 | ViVOpay Vend 43 36 00 | Vendi (NEO) 43 37 00 | ViVOpay Kiosk1 (ATM1) 43 38 00 | Kiosk2 43 39 00 | Kiosk3 (NEO) 55 31 00 | UniPay 1.5 (NEO) 55 33 00 | UniPay III (NEO) 55 33 31 | VP3300, VP3300 OEM (NEO) (iBase/Cake same code) 55 33 32 | VP3300E(NEO) 55 33 33 | VP3300C(NEO) 55 33 34 | BTPay Mini (NEO) (UniPayIII + BLE) 56 31 00 | VP3600 56 32 00 | VP5200 56 33 00 | VP5300 56 34 00 | VP6300 56 35 00 | VP6800 56 36 00 | VP8300 56 37 00 | VP8310 56 38 00 | VP8800 56 39 00 | VP8810 56 40 00 | VP9000 44 30 00 | QX120 44 31 00 | Mx8Series 44 32 00 | NETs 44 33 00 | Magtek 44 35 00 | ICP
string IDTechSDK.IDT_NEO2.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_NEO2.device_getRT1050FirmwareVersion | ( | ref string | response, |
string | ip = "" |
||
) |
Get RT1050 Firmware Version
response | Response returned of Firmware Version |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getSelfCheckTime | ( | ref byte | hour, |
ref byte | minutes, | ||
string | ip = "" |
||
) |
Get Self-Check Time
Gest the specific time for 24hrs self-check in Coordinated Universal Time
Hours,00-23h | |
Minutes | 00-59h |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getTransactionResults | ( | ref IDTTransactionData | results | ) |
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
results | The transaction results |
RETURN_CODE IDTechSDK.IDT_NEO2.device_getTransArmorID | ( | ref string | TID | ) |
Get TransArmor ID
TID | TransArmor ID |
RETURN_CODE IDTechSDK.IDT_NEO2.device_listDirectory | ( | string | directoryName, |
bool | recursive, | ||
bool | onSD, | ||
ref string | directory, | ||
string | ip = "" |
||
) |
List Directory
This command retrieves a directory listing of user accessible files from the reader.
directoryName | Directory Name. If null, root directory is listed |
recursive | Included sub-directories |
onSD | TRUE = use flash storage |
directory | The returned directory information |
ip | Optional: IP address to execute command on (for IP connected devices) |
void IDTechSDK.IDT_NEO2.device_listenForNotifications | ( | bool | enable, |
string | ip = "" |
||
) |
Listen for Notifications
Instructs SDK to listen for unsolicited data
enable | TRUE = Listen, FALSE = Don't Listen |
RETURN_CODE IDTechSDK.IDT_NEO2.device_logClear | ( | string | ip = "" | ) |
Clear Log
Instructs device to delete all log data
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_logEnable | ( | bool | enable, |
string | ip = "" |
||
) |
Enable Log
Instructs device to enable log
enable | TRUE = enable log, FALSE = disable log |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_logRead | ( | DeviceLogCallback | callback, |
string | ip = "" |
||
) |
Read Log
Instructs device to output all log data
callback | DeviceLogCallback that will receive all log entries. If null, will be sent to MessageCallback, DeviceState.LogEvent |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_lowPowerMode | ( | bool | stopMode, |
bool | wakeOnTrans | ||
) |
Enter Low Power Mode
Puts terminal in sleep mor stop mode, with the option to wak on swipe/tap
stopMode | TRUE = Stop Mode (POR required), FALSE = Sleep Mode (resume from last instruction) |
wakeOnTrans | TRUE = Swipe/Tap will wake from low power, FALSE = will not wake on power from swipe/tap |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.device_offYellowLED | ( | ) |
Turn Off Yellow LED
Turn off the ViVOpay Vendi reader yellow LED. This LED is located below the three blue LEDs.
RETURN_CODE IDTechSDK.IDT_NEO2.device_onYellowLED | ( | ) |
Turn On Yellow LED
Turn On the ViVOpay Vendi reader yellow LED. This LED is located below the three blue LEDs.
RETURN_CODE IDTechSDK.IDT_NEO2.device_pingDevice | ( | string | ip = "" | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
ip | Optional: The callback function will only be applicable to the provided IP. |
RETURN_CODE IDTechSDK.IDT_NEO2.device_rebootDevice | ( | string | ip = "" | ) |
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_NEO2.device_resetConfigurationGroup | ( | int | group | ) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.device_resetTransaction | ( | ) |
Reset Transaction
Abruptly terminates the currently executing device transaction. Does not produce any further transaction data or notifications after executing.
RETURN_CODE IDTechSDK.IDT_NEO2.device_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CTLS/CONTACT.
response | array of 2-tag TLV data objects: DFEE2D (group name) followed by 9F06 (AID) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_retrieveTerminalData | ( | ref byte[] | tlv | ) |
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_getConfiguraitonGroup(0).
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
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 |
ip | Optional IP parameter |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendDataCommand_ext | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
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}' |
ip | Optional IP parameter |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendPAE | ( | string | command, |
ref string | response, | ||
int | timeout, | ||
string | ip = "" |
||
) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP2 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 2
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP2_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 2 Extended
Sends a protocol 2 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP3 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 3
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP3_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 3 Extended
Sends a protocol 3 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP4 | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 4
Sends a protocol 4 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_sendVivoCommandP4_ext | ( | byte | command, |
byte | subCommand, | ||
byte[] | data, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ip = "" |
||
) |
Send Vivo Command Protocol 4 Extended
Sends a protocol 4 command to Vivo readers (IDG/NEO)
command | Command |
subCommand | Sub-Command |
data | Data. May be null |
response | Response |
timeout | Timeout, in milliseconds (3000 = 3 seconds) |
noResponse | TRUE = don't wait for response, FALSE = wait for response defined by timeout |
ip | Optional IP |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setBurstMode | ( | byte | mode | ) |
Send Burst Mode
Sets the burst mode forthe device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setMerchantRecord | ( | int | index, |
bool | enabled, | ||
string | merchantID, | ||
string | merchantURL | ||
) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setPollMode | ( | byte | mode | ) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setSelfCheckTime | ( | byte | hour, |
byte | minutes, | ||
string | ip = "" |
||
) |
Set Self-Check Time
Set a specific time for 24hrs self-check in Coordinated Universal Time
Hours | 00-23h |
Minutes | 00-59h |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setTerminalData | ( | byte[] | tlv | ) |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The terminal global data is group 0. 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_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setTransArmorEncryption | ( | byte[] | cert | ) |
Set TransArmor Encryption
cert | Certificate in PEM format |
RETURN_CODE IDTechSDK.IDT_NEO2.device_setTransArmorID | ( | string | TID | ) |
Set TransArmor ID
TID | TransArmor ID |
RETURN_CODE IDTechSDK.IDT_NEO2.device_startRKI | ( | bool | isTest, |
string | ip = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
isTest | TRUE = Demo Device, FALSE = Production Device |
ip | Optional IP address |
RETURN_CODE IDTechSDK.IDT_NEO2.device_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | isFastEMV = false , |
||
string | ip = "" |
||
) |
Start a Transaction Request
Authorizes the transaction CTLS, MSR or Contact EMV
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) |
exponent | Number of characters after decimile point |
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 |
ip | Optional IP parameter |
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_NEO2.device_SymmetricRKI | ( | int | type, |
string | ip = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech Symmetric RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.
type | 0 = Type A Demo 1 = Type A Production 2 = Type B Demo 3 = Type B Production |
ip | Optional IP address |
RETURN_CODE IDTechSDK.IDT_NEO2.device_terminalInfo | ( | ref byte[] | tlv | ) |
Retrieve Terminal Info
tlv | TLV Tags assigned as follows:
|
RETURN_CODE IDTechSDK.IDT_NEO2.device_transferFile | ( | string | fileName, |
byte[] | file, | ||
string | ip = "" |
||
) |
Transfer File
This command transfers a data file to the reader.
fileName | Filename. The data for this command is a ASCII string with the complete path and file name you want to create. You do not need to specify the root directory. Indicate subdirectories with a forward slash (/). |
file | The data file. |
ip | Optional: IP address to execute command on (for IP connected devices) |
|
static |
Update K81 Firmware
Updates the firmware .
firmwareData | Signed binary data of a firmware file provided by IDTech |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
RETURN_CODE IDTechSDK.IDT_NEO2.device_updateFirmwareIP | ( | string | path, |
int | type, | ||
FirmwareUpdateCallback | callback, | ||
string | ip | ||
) |
Update Firmware
Updates the firmware over IP .
path | Local filepath to the signed binary data of a firmware file provided by IDTech |
type | 0 = K81, 1 = 1050 |
callback | Callback to receive the status updates |
After you pass the filename file, a new thread will start to execute the firmware download. You will receive status of the progress through callback to the IDTechSDK.FirmwareUpdateCallback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
|
static |
Update App Firmware
Updates the firmware
type | FIRMWARE_TYPE. It can be Bootloader A, Bootloader B, 1050, K81, or Kernels 0-11. |
firmwareData | Signed binary data of a firmware file provided by IDTech |
ip | Optional ip address of device |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
RETURN_CODE IDTechSDK.IDT_NEO2.device_updateFirmwareType | ( | string | path, |
FIRMWARE_TYPE | type, | ||
FirmwareUpdateCallback | callback, | ||
string | ip | ||
) |
Update Firmware
Updates the firmware over IP .
path | Local filepath to the signed binary data of a firmware file provided by IDTech |
type | FIRMWARE_TYPE |
callback | Callback to receive the status updates |
After you pass the filename file, a new thread will start to execute the firmware download. You will receive status of the progress through callback to the IDTechSDK.FirmwareUpdateCallback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
|
static |
Wake Device From Standby Mode
If an IP connected device, the device can be located by it's MAC Address, or IP Address (if the SDK has previously established a connection to that device) When a IP device is first connected, the MacAddress and IP Address are stored in a look up table. Only one of the two parameter are required for Wake on WAN. If IP address is provided, it will take priority over Mac Address.
macAddress | Optional: Mac Address of IP connected device to wake |
ipAddress | Optional: IP Address of IP connected device to wake |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_activateTransaction | ( | int | timeout, |
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
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 |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
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 |
|
static |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_authenticateTransaction | ( | byte[] | updatedTLV | ) |
Authenticate EMV Transaction Request
Authenticates the EMV transaction for an ICC card. Execute this after receiving response with result code 0x10 to emv_startTransaction
The tags will be returned in the callback routine.
@param updatedTLV TLV stream that can be used to update the following values: - 9F02: Amount - 9F03: Other amount - 9C: Transaction type - 5F57: Account type In addition tag DFEE1A can be sent to specify tag list to include in results. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 @return RETURN_CODE: Values can be parsed with device_getResponseCodeString
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
|
static |
Enables authenticate for EMV transactions. If a startEMVTranaction results in code 0x0010 (start transaction success), then emv_authenticateEMVTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
tags | Tags to pass during authentication stage; |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_callbackResponseLCD | ( | EMV_LCD_DISPLAY_MODE | type, |
byte | selection | ||
) |
Callback Response LCD Display
Provides menu selection responses to the kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_TYPE.EMV_CALLBACK_TYPE_LCD, and lcd_displayMode = EMV_LCD_DISPLAY_MODE_MENU, EMV_LCD_DISPLAY_MODE_PROMPT, or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT
type | If Cancel key pressed during menu selection, then value is EMV_LCD_DISPLAY_MODE_CANCEL. Otherwise, value can be EMV_LCD_DISPLAY_MODE_MENU, EMV_LCD_DISPLAY_MODE_PROMPT, or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT |
selection | If type = EMV_LCD_DISPLAY_MODE_MENU or EMV_LCD_DISPLAY_MODE_LANGUAGE_SELECT, provide the selection ID line number. Otherwise, if type = EMV_LCD_DISPLAY_MODE_PROMPT supply either 0x43 ('C') for Cancel, or 0x45 ('E') for Enter/accept |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_callbackResponseMSR | ( | byte[] | MSR | ) |
Callback Response MSR Entry
Provides MSR information to kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_MSR
MSR | Swiped track data |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_callbackResponsePIN | ( | EMV_PIN_MODE | type, |
byte[] | KSN, | ||
byte[] | PIN | ||
) |
Callback Response PIN Entry
Provides (or cancels) PIN entry information to kernel after a callback was received with DeviceState.EMVCallback, and callbackType = EMV_CALLBACK_TYPE_PINPAD
type | If Cancel key pressed during PIN entry, then value is EMV_PIN_MODE_CANCEL. Otherwise, value can be EMV_PIN_MODE_ONLINE_DUKPT, EMV_PIN_MODE_ONLINE_MKSK, or EMV_PIN_MODE_OFFLINE |
KSN | If enciphered PIN, this is either the PIN DUKPT Key (EMV_PIN_MODE_ONLINE_DUKPT) or PIN Session Key (EMV_PIN_MODE_ONLINE_MKSK), or PIN Pairing DUKPT key (EMV_PIN_MODE_OFFLINE) |
PIN | If encipherd PIN, this is encrypted PIN block. If device does not implement pairing function, this is plaintext PIN |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_cancelTransaction | ( | ) |
Cancel Transaction
Cancels the currently executing EMV or CTLS transaction.
RETURN_CODE IDTechSDK.IDT_NEO2.emv_completeTransaction | ( | bool | commError, |
byte[] | authCode, | ||
byte[] | iad, | ||
byte[] | tlvScripts, | ||
byte[] | tlv | ||
) |
Complete EMV Transaction Request
Completes the EMV transaction for an ICC card when online authorization request is received from emv_authenticateTransaction
The tags will be returned in the callback routine.
commError | Communication error with host. Set to TRUE if host was unreachable, or FALSE if host response received. If Communication error, authCode, iad, tlvScripts can be null. |
authCode | Authorization code from host. Two bytes. Example 0x3030. (Tag value 8A). Required |
iad | Issuer Authentication Data, if any. Example 0x11223344556677883030 (tag value 91). |
tlvScripts | 71/72 scripts, if any |
tlv | Additional TVL data to return with transaction results (if any) |
NOTE: There are three possible outcomes for Authorization Code: Approval, Refer To Bank, Decline. The kernel maps these three outcomes to valid authorization response codes using tag DFEE1B through 8 bytes: {2 bytes Approval Code}{2 bytes Referral Code}{2 bytes Decline Code}{2 bytes RFU} If your gateway uses "00" for Approval, "01" for Referral, and "05" for Decline, then DFEE1B 08 3030 3031 3035 0000 If you use an authorization code value that that is not defined in DFEE1B, the kernel will use the DECLINE value of DFEE1B by default.
RETURN_CODE IDTechSDK.IDT_NEO2.emv_getEMVConfigurationCheckValue | ( | ref string | response | ) |
Polls device for EMV Configuration Check Value
response | Response returned of Check Value of Configuration |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_getEMVKernelCheckValue | ( | ref string | response | ) |
Polls device for EMV Kernel Check Value
response | Response returned of Check Value of Kernel |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_getEMVKernelVersion | ( | ref string | response | ) |
Polls device for EMV Kernel Version
response | Response returned of Kernel Version |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_getTerminalMajorConfiguration | ( | ref int | configuration | ) |
Get Terminal Major Configuration
Gets the Terminal Data Major Configuration setting
configuration | The configuration that is set (1-5) |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data for EMV Kernel
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK for EMV Kernel
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeAllCRL | ( | ) |
Remove All Certificate Revocation List Entries
Removes all CRLEntry entries
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeApplicationData | ( | byte[] | AID | ) |
Remove Application Data by AID
Removes the Application Data for EMV Kernel as specified by the AID name passed as a parameter
AID | Name of ApplicationID Must be between 5 and 16 bytes |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeCAPK | ( | byte[] | capk | ) |
Remove Certificate Authority Public Key
Removes the CAPK for EMV Kernel as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeCRL | ( | byte[] | crlList | ) |
Remove Certificate Revocation List Entries
Removes CRLEntries as specified by the RID and Index and serial number passed as 9 bytes
crlList | containing the list of CRL to remove: [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_removeTerminalData | ( | ) |
Remove Terminal Data
Removes the Terminal Data
RETURN_CODE IDTechSDK.IDT_NEO2.emv_resetConfigurationGroup | ( | int | group | ) |
Reset Configuration Group
This command allows resetting a dataset to its default configuration. If the file exists, it will be overwritten. If not, it will be created.
group | Configuration Group |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_VP8800::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveAIDList | ( | ref byte | response[][] | ) |
Retrieve AID list
Returns all the AID names and their assigned groups installed on the terminal for CONTACT.
response | array of 2-tag TLV data objects: DFEE2D (group name) followed by 9F06 (AID) |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveApplicationData | ( | byte[] | AID, |
ref byte[] | tlv | ||
) |
Retrieve Application Data by AID
Retrieves the Application Data for EMV Kernel 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 |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveCAPK | ( | byte[] | capk, |
ref byte[] | key | ||
) |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for EMV Kernel 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:
|
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveCAPKList | ( | ref byte[] | keys | ) |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal for EMV Kernel.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveCRLList | ( | ref byte[] | list | ) |
Retrieve the Certificate Revocation List
Returns the CRL entries on the terminal.
list | [CRL1][CRL2]...[CRLn], each CRL 9 bytes where CRL = 5 bytes RID + 1 byte index + 3 bytes serial number |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveTerminalData | ( | ref byte[] | tlv | ) |
Retrieve Terminal Data
Retrieves the Terminal Data for EMV Kernel.
tlv | Response returned as a TLV |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_retrieveTransactionResult | ( | byte[] | tags, |
ref IDTTransactionData | tlv | ||
) |
Retrieve Transaction Results
Retrieves specified EMV tags from the currently executing transaction.
tags | Tags to be retrieved. Example 0x9F028A will retrieve tags 9F02 and 8A |
tlv | All requested tags returned as unencrypted, encrypted and masked TLV data in IDDTransactionData object |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setApplicationData | ( | byte[] | name, |
byte[] | tlv | ||
) |
Set Application Data by AID
Sets the Application Data as specified by TLV data
tlv | Application data in TLV format |
Tags:
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setApplicationData | ( | byte[] | tlv | ) |
Set Application Data by AID
Sets the Application Data as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (DFEE2D). The second tag of the TLV data must be the AID (9F06) Tag DFEE4F must be included, and it must have a value of 0x02 to be and EMV AID |
Example valid TLV, for Group #8, AID a0000000045010: "dfee2d01089f0607a0000000045010dfee4b0101dfee2e0110dfee4c0101dfee4f0103
Tags:
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setCAPK | ( | byte[] | key | ) |
Set Certificate Authority Public Key
Sets the CAPK for EMV Kernel 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:
|
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setCRL | ( | byte[] | list | ) |
Set Certificate Revocation List
Sets the CRL
list | CRL Entries containing the RID, Index, and serial numbers to set [CRL1][CRL2]...[CRLn] where each [CRL] is 9 bytes: [5 bytes RID][1 byte CAPK Index][3 bytes serial number] |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setTerminalData | ( | byte[] | tlv | ) |
Set Terminal Data
Sets the Terminal Data for EMV Kernel
tlv | TerminalData configuration data |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_setTerminalMajorConfiguration | ( | int | configuration | ) |
Set Terminal Major Configuration
Sets the Terminal Data Major Configuration setting
configuration | The configuration to set (1-5) |
RETURN_CODE | Return codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with IDT_NEO2::device_getResponseCodeString:() |
RETURN_CODE IDTechSDK.IDT_NEO2.emv_startTransaction | ( | double | amount, |
double | amtOther, | ||
int | exponent, | ||
int | type, | ||
int | timeout, | ||
byte[] | tags, | ||
bool | forceOnline, | ||
bool | isFastEMV = false |
||
) |
Start EMV Transaction Request
Authorizes the EMV transaction for an ICC card
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) |
exponent | Number of characters after decimile point |
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. |
forceOnline | TRUE = do not allow offline approval, FALSE = allow ICC to approve offline if terminal capable Note: To request tags to be included in default response, use tag DFEE1A, and specify tag list. Example four tags 9F02, 9F36, 95, 9F37 to be included in response = DFEE1A079F029F369f9F37 |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_authentication | ( | byte[] | key, |
string | ip = "" |
||
) |
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 |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_read | ( | byte[] | serviceCode, |
int | numBlocks, | ||
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ip = "" |
||
) |
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. |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_readWithMac | ( | int | numBlocks, |
byte[] | blockList, | ||
ref byte[] | blocks, | ||
string | ip = "" |
||
) |
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. |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_requestService | ( | byte[] | nodeCode, |
ref byte[] | response, | ||
string | ip = "" |
||
) |
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 |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_write | ( | byte[] | serviceCode, |
int | blockCount, | ||
byte[] | blockList, | ||
byte[] | data, | ||
ref byte[] | statusFlag, | ||
string | ip = "" |
||
) |
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 |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.felica_writeWithMac | ( | int | blockNumber, |
byte[] | data, | ||
string | ip = "" |
||
) |
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. |
ip | IP Address of target device (optional) |
RETURN_CODE IDTechSDK.IDT_NEO2.getCashTranRiskPara | ( | ref byte[] | tlv | ) |
Get Cash Transaction Reader Risk Parameters Returns the TTQ and reader risk parameters that will be used for cash transactions, if enabled.
tlv | TLV Data Objects |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
RETURN_CODE IDTechSDK.IDT_NEO2.getDrlReaderRiskPara | ( | byte | index, |
ref byte[] | tlv | ||
) |
Get DRL Reader Risk Parameters Get the Index, Application Program ID, and reader risk parameters for the DRL settings.
index | DRL index (01-04) |
tlv | TLV Data Objects |
RETURN_CODE IDTechSDK.IDT_NEO2.getHardwareInfor | ( | ref string | ascii | ) |
Get Hardware Information
ascii | the ascii charactor RETURN_CODE: Values can be parsed with errorCode.getErrorString() |
HW,VPVendi<CR><LF>K21F Rev9 | Vendi HW,VP3300 Audio Jack<CR><LF>K21F Rev9 | Unipay III HW,VPUnipay1.5<CR><LF>K21F Rev9 | Unipay 1.5 HW,VPUniPay1.5TTK<CR><LF>K21F Rev9 | UniPay 1.5 TTK HW,VP3300 USB<CR><LF>K21F Rev9 | VP3300 USB, VP3300 USB OEM (iBase/Cake same code) HW,VP3300 USB-E<CR><LF>K21F Rev9 | VP3300 USB-E HW,VP3300 USB-C<CR><LF>K21F Rev9 | VP3300 USB-C HW,VPVP3300 Bluetooth<CR><LF>K21F Rev9 | VP3300 Bluetooth HW,.VP6300<CR><LF>K81F.Rev4 | VP6300
|
static |
Last Error String
Returns the last firmware reported error string to RETURN_CODE_P2_FAILED and RETURN_CODE_P2_COMMAND_NOT_ALLOWED if error reporting is enabled
ip | IP address of device |
string | Last Error String Message |
RETURN_CODE IDTechSDK.IDT_NEO2.getModuleVer | ( | ref string | moduleVer | ) |
Get Module Version Information Get the 16 byte UID of MCU
uid | string UID |
RETURN_CODE IDTechSDK.IDT_NEO2.getMsrSecurePar | ( | bool | b0, |
bool | b1, | ||
bool | b2, | ||
bool | b3, | ||
ref byte[] | tlv | ||
) |
Get MSR Secure Parameters get parameters from flash setting
b0,b1,b2,b3 | Encryption Option Bit 0: T1 force encrypt Bit 1: T2 force encrypt Bit 2: T3 force encrypt Bit 3: T3 force encrypt when card type is 80 |
tlv | MSR Secure Parameters TVL objects |
RETURN_CODE IDTechSDK.IDT_NEO2.getRemoteKeyInjectionTO | ( | ref int | timeout | ) |
Get Remote Key Injection Timeout
timeout | Timeout is in seconds, value scope is [120, 3600] |
RETURN_CODE IDTechSDK.IDT_NEO2.getUIDofMCU | ( | ref string | uid | ) |
Get UID of MCU
moduleVer | module version information |
RETURN_CODE IDTechSDK.IDT_NEO2.getUsbBootLoader | ( | ref string | bootLoader | ) |
Get USB Boot Loader Version Get the version of the USB Boot Loader
bootLoader | USB boot loader information |
RETURN_CODE IDTechSDK.IDT_NEO2.getWhiteList | ( | ref byte[] | list | ) |
Get White List Retrieve the White List
list | the white list |
RETURN_CODE IDTechSDK.IDT_NEO2.icc_exchangeAPDU | ( | string | c_APDU, |
ref byte[] | response | ||
) |
Exchange APDU
Sends an APDU packet to the ICC. If successful, response is returned in APDUResult class instance in response parameter.
c_APDU | APDU data packet |
response | Unencrypted/encrypted parsed APDU response |
RETURN_CODE IDTechSDK.IDT_NEO2.icc_getICCReaderStatus | ( | ref byte | status | ) |
Get Reader Status
Returns the reader status
status | Pointer that will return with the ICCReaderStatus results. bit 0: 0 = ICC Power Not Ready, 1 = ICC Powered bit 1: 0 = Card not seated, 1 = card seated |
RETURN_CODE IDTechSDK.IDT_NEO2.icc_powerOffICC | ( | ) |
Power Off ICC
Powers down the ICC
If Success, empty If Failure, ASCII encoded data of error string
RETURN_CODE IDTechSDK.IDT_NEO2.icc_powerOnICC | ( | ref byte[] | ATR, |
byte | interfaces | ||
) |
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
interfaces | For NEO2 devices allowed interfaces for which to get the ATR. 0x20h = retrieve last ATR received from PICC 0x21h = SAM1 (SRED version only) 0x22h = SAM2 (SRED version only) For other devices interfaces euquals to 0s |
void IDTechSDK.IDT_NEO2.ip_autoConnectToSocket | ( | ) |
Auto Connect To Socket
Instructs SDK to attempt to attempt to connect to all the IP addresses as specified in NEO2_Devices.xml. The NEO2_Devices.xml must be located in the same root directory as IDTechSDK.dll. It is used to specify NEO2 devices for USB connectivity and IP connectivity. It is made up of DEVICE entries example as follows:
Multiple device connections can be defined by a single Device entry, if those devices will use consecutive IP addresses, or multiple device connections can be defined by multiple Device entries, each with unique IP.
Every IP connection attempt is reported to a callback as connection successful, or connection could not be established
bool IDTechSDK.IDT_NEO2.ip_connectToSocket | ( | string | IP, |
bool | isSecure = false |
||
) |
Connect to Socket
Instructs SDK to attempt to use TCP/IP for communication with IDT_NEO2
IP | Valid IP address, with optional port and label. Examples
|
isSecure | TRUE = Use TLS 1.2 |
success | TRUE = device found, FALSE = device not found |
NOTE: If the device is found, it will automatically become the currently selected SDK device unless there is another currently connected IP device the SDK is using. If you would like to change between multiple IP connected devices, use ip_switchToSocket instead
|
static |
Get IP Socket List
Returns a list of all the established socket connections with the SDK. Each entry is the original full IP address specified.
list | Socket Connections |
|
static |
Is IP Connected
Validates if IP channel is open and device responsive. If the channel is open and device not responsive, this will close the channel.
IP | address to check |
attempts | Number of connection attempts to try before returning result |
isSecure | TRUE = TLS 1.2 connection |
status |
|
void IDTechSDK.IDT_NEO2.ip_monitorSocketConnectionStatus | ( | bool | enable, |
bool | monitorConnect, | ||
int | interval, | ||
int | retryCount | ||
) |
Monitor Socket Connection Status
Instructs SDK to monitor currently connected devices for network disconnect, and also to automatically re-connect when plugged back into the network. Disconnect monitors is done by pinging the SDK connected stream list on an interval, and if ping unsuccessful, that device stream is closed and removed from SDK device list, followed by a notification of the device disconnect.
If the option to monitor connection, then the NEO2_Devices.xml must contain the auto-connect information for the SDK to run on the specified interval.
enable | TRUE = enable polling for device disconnect and optional connect, at specified interval and retryCount |
monitorConnect | If TRUE, an auto-connect attempt will be made at the specified interval |
interval | Interval, in seconds, to monitor IP. Minimum value 5 seconds |
retryCount | Number of retries trying to communicate before determining device not available and issue disconnect notification. |
|
static |
Switch to Socket
Instructs SDK to direct communication to the specified device (the device must have already established a connection through auto-connent or ip_connecToSocket)
IP | Valid established IP address of the existing device. Must match original IP string exactly. Example: Connect to device as 192.168.1.155:50#Device_1. You must use that whole string, not just 192.168.1.155, or 192.168.1.155:50. |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_addButton | ( | string | screenName, |
string | buttonName, | ||
byte | type, | ||
byte | alignment, | ||
UInt16 | xCord, | ||
UInt16 | yCord, | ||
string | label, | ||
ref lcdItem | returnItem, | ||
buttonCallback | callback, | ||
string | ip = "" |
||
) |
Add Button
Adds a button to a selected screen. Must execute lcd_createScreen first to establish a screen to draw on.
screenName | Screen name that will be the target of add button |
buttonName | Button name that will be the target of add button |
type | Button Type
|
alignment | Position for Button
|
xCord | x-coordinate for Button, range 0-271 |
yCord | y-coordinate for Button, range 0-479 |
label | Label to show on the button. Required for Large/Medium buttons. Not used for Invisible buttons. |
returnItem | The item includes screen ID, object ID, top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-left y-coordinate, which are all assigned to the created button |
callback | buttonCallback to receive button presses. Passing NULL will return button presses to main messageCallback. |
ip | Optional: IP address to execute command on (for IP connected devices) |
NOTE ON BUTTON PRESS EVENTS: A button press consists of uInt16 specifying the screen, and uInt16 specifying the button ID If buttonCallback is used, it will have the follow signature:
public delegate void buttonCallback(IDT_DEVICE_Types sender, UInt16 screenID, UInt16 itemID, string IP);
If buttonCallback is NULL, then the button presses will be passed to the messageCallback, with DeviceState.ButtonEvent, and data = data[0], data[1] = uInt16 screenID, and data[2], data[3] = uint16 buttonID
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_addEthernet | ( | string | screenName, |
string | objectName, | ||
byte | alignment, | ||
UInt16 | xCord, | ||
UInt16 | yCord, | ||
ref lcdItem | returnItem, | ||
string | ip | ||
) |
Add Ethernet Settings
Adds an Ethernet settings to a selected screen. Must execute lcd_createScreen first to establish a screen to draw on.
screenName | Screen name that will be the target of add widget |
objectName | Object name that will be the target of add widget |
alignment | Position for widget
|
xCord | x-coordinate for widget, range 0-271 |
yCord | y-coordinate for widget, range 0-479 |
returnItem | The item includes screen ID, object ID, top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-left y-coordinate, which are all assigned to the created widget |
ip | Optional: IP address to execute command on (for IP connected devices) |
Item | Maximum can be created for each screen |
---|---|
Text Area | 20 |
Large Button | 8 |
Medium Button | 16 |
Invisible Button | 16 |
Numeric Entry | 1 |
Ethernet Setting | 1 |
Led widget | 1 |
image | 20 |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_addImage | ( | string | screenName, |
string | objectName, | ||
byte | alignment, | ||
UInt16 | xCord, | ||
UInt16 | yCord, | ||
string | filename, | ||
ref lcdItem | returnItem, | ||
string | ip = "" |
||
) |
Add Image
Adds a image to a selected screen. Must execute lcd_createScreen first to establish a screen to draw on.
screenName | Screen name that will be the target of add image |
objectName | Object name that will be the target of add image |
alignment | Position for Image
|
xCord | x-coordinate for Image, range 0-271 |
yCord | y-coordinate for Image, range 0-479 |
filename | Filename of the image. Must be available in device memory. |
returnItem | The item includes screen ID, object ID, top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-left y-coordinate, which are all assigned to the created image |
ip | Optional: IP address to execute command on (for IP connected devices) |
Item | Maximum can be created for each screen |
---|---|
Text Area | 20 |
Large Button | 8 |
Medium Button | 16 |
Invisible Button | 16 |
Numeric Entry | 1 |
Ethernet Setting | 1 |
Led widget | 1 |
image | 20 |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_addLED | ( | string | screenName, |
string | objectName, | ||
byte | alignment, | ||
UInt16 | xCord, | ||
UInt16 | yCord, | ||
ref lcdItem | returnItem, | ||
byte[] | LED, | ||
string | ip = "" |
||
) |
Add LED
Adds a LED widget to a selected screen. Must execute lcd_createScreen first to establish a screen to draw on.
screenName | Screen name that will be the target of add LED |
objectName | Object name that will be the target of add LED |
alignment | Position for LED
|
xCord | x-coordinate for LED, range 0-271 |
yCord | y-coordinate for LED, range 0-479 |
returnItem | The item includes screen ID, object ID, top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-left y-coordinate, which are all assigned to the created widget |
LED | Must be 4 bytes, LED 0 = byte 0, LED 1 = byte 1, LED 2 = byte 2, LED 3 = byte 3
|
ip | Optional: IP address to execute command on (for IP connected devices) |
Item | Maximum can be created for each screen |
---|---|
Text Area | 20 |
Large Button | 8 |
Medium Button | 16 |
Invisible Button | 16 |
Numeric Entry | 1 |
Ethernet Setting | 1 |
Led widget | 1 |
image | 20 |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_addText | ( | string | screenName, |
string | objectName, | ||
byte | alignment, | ||
UInt16 | xCord, | ||
UInt16 | yCord, | ||
UInt16 | width, | ||
UInt16 | height, | ||
byte | fontID, | ||
byte[] | color, | ||
string | label, | ||
ref lcdItem | returnItem, | ||
string | ip = "" |
||
) |
Add text
Adds a text component to a selected screen. Must execute lcd_createScreen first to establish a screen to draw on.
screenName | Screen name that will be the target of add text |
objectName | Object name that will be the target of add text |
alignment | Position for Text
|
xCord | x-coordinate for Text, range 0-271 |
yCord | y-coordinate for Text, range 0-479 |
width | Width of text area |
height | Height of text area |
fontID | Font ID |
color | Four bytes for color, example, Blue = 0xFF000000, Black = 0x00000000
|
label | Label to show on the text |
returnItem | The item includes screen ID, object ID, top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-left y-coordinate, which are all assigned to the created text area |
ip | Optional: IP address to execute command on (for IP connected devices) |
Font ID | Typography Name | Font | Size |
---|---|---|---|
0 | RoundBold_12 | RoundBold.ttf | 12 |
1 | RoundBold_18 | RoundBold.ttf | 18 |
2 | RoundBold_24 | RoundBold.ttf | 24 |
3 | RoundBold_36 | RoundBold.ttf | 36 |
4 | RoundBold_48 | RoundBold.ttf | 48 |
5 | RoundBold_60 | RoundBold.ttf | 60 |
6 | RoundBold_72 | RoundBold.ttf | 72 |
7 | RoundCondensedBold_12 | RoundCondensedBold.ttf | 12 |
8 | RoundCondensedBold_18 | RoundCondensedBold.ttf | 18 |
9 | RoundCondensedBold_24 | RoundCondensedBold.ttf | 24 |
10 | RoundCondensedBold_36 | RoundCondensedBold.ttf | 36 |
11 | RoundCondensedBold_48 | RoundCondensedBold.ttf | 48 |
12 | RoundCondensedBold_60 | RoundCondensedBold.ttf | 60 |
13 | RoundCondensedBold_72 | RoundCondensedBold.ttf | 72 |
14 | RoundCondensedMedium_12 | RoundCondensedMedium_0.ttf | 12 |
15 | RoundCondensedMedium_18 | RoundCondensedMedium_0.ttf | 18 |
16 | RoundCondensedMedium_24 | RoundCondensedMedium_0.ttf | 24 |
17 | RoundCondensedMedium_36 | RoundCondensedMedium_0.ttf | 36 |
18 | RoundCondensedMedium_48 | RoundCondensedMedium_0.ttf | 48 |
19 | RoundCondensedMedium_60 | RoundCondensedMedium_0.ttf | 60 |
20 | RoundCondensedMedium_72 | RoundCondensedMedium_0.ttf | 72 |
21 | RoundCondensedSemibold_12 | RoundCondensedSemibold.ttf | 12 |
22 | RoundCondensedSemibold_18 | RoundCondensedSemibold.ttf | 18 |
23 | RoundCondensedSemibold_24 | RoundCondensedSemibold.ttf | 24 |
24 | RoundCondensedSemibold_36 | RoundCondensedSemibold.ttf | 36 |
25 | RoundCondensedSemibold_48 | RoundCondensedSemibold.ttf | 48 |
26 | RoundCondensedSemibold_60 | RoundCondensedSemibold.ttf | 60 |
27 | RoundCondensedSemibold_72 | RoundCondensedSemibold.ttf | 72 |
28 | RoundMedium_12 | RoundMedium.ttf | 12 |
29 | RoundMedium_18 | RoundMedium.ttf | 18 |
30 | RoundMedium_24 | RoundMedium.ttf | 24 |
31 | RoundMedium_36 | RoundMedium.ttf | 36 |
32 | RoundMedium_48 | RoundMedium.ttf | 48 |
33 | RoundMedium_60 | RoundMedium.ttf | 60 |
34 | RoundMedium_72 | RoundMedium.ttf | 72 |
35 | RoundSemibold_12 | RoundSemibold.ttf | 12 |
36 | RoundSemibold_18 | RoundSemibold.ttf | 18 |
37 | RoundSemibold_24 | RoundSemibold.ttf | 24 |
38 | RoundSemibold_36 | RoundSemibold.ttf | 36 |
39 | RoundSemibold_48 | RoundSemibold.ttf | 48 |
40 | RoundSemibold_60 | RoundSemibold.ttf | 60 |
41 | RoundSemibold_72 | RoundSemibold.ttf | 72 |
Item | Maximum can be created for each screen |
---|---|
Text Area | 20 |
Large Button | 8 |
Medium Button | 16 |
Invisible Button | 16 |
Numeric Entry | 1 |
Ethernet Setting | 1 |
Led widget | 1 |
image | 20 |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_clearAllLines | ( | ) |
Clear LCD Display
Clears all lines of the LCD Display.
|
static |
Clear Display
Command to clear the display screen on the reader.It returns the display to the currently defined background color and terminates all events
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_clearScreenInfo | ( | string | ip = "" | ) |
Clear Screen Info
Clear all current screen information in RAM and flash. And then show'power-on screen'
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_cloneScreen | ( | string | screenName, |
string | cloneName, | ||
ref UInt16 | cloneID, | ||
string | ip = "" |
||
) |
Clone Screen
Clones an existing screen.
screenID | Screen number to clone. |
cloneID | Screen ID of the cloned screen |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_createScreen | ( | string | screenName, |
ref UInt16 | screenID, | ||
string | ip = "" |
||
) |
Create Screen
Creates a new screen.
screenName | Screen name to use. |
screenID | Screen ID that was created. |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_destroyScreen | ( | string | screenName, |
string | ip = "" |
||
) |
Destroy Screen
Destroys a previously created inactive screen. The screen cannot be active
screenName | Screen name to destroy. The screen number is assigned with lcd_createScreen. |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_displayMessage | ( | int | lineNumber, |
string | message | ||
) |
Display Message on Line
Displays a message on a display line. 16 characters per line. You can display up to 32 characters for line 1, and it will flow to line 2, or you can display up to 16 characters on just line 2
lineNumber | Line number to display message on (1 or 2) |
message | Message to display |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_getActiveScreen | ( | ref string | screenName, |
string | ip = "" |
||
) |
Get Active Screen
Returns the active screen ID.
screenName | Screen name this is active. |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_getAllObjects | ( | string | screenName, |
ref byte | objectNumbers, | ||
ref Dictionary< UInt16, string > | returnObjects, | ||
string | ip = "" |
||
) |
Get All Objects on Screen
Get all created objects' name on certain screen
objectNumbers | Number of created objects |
returnObjects | Dictionary all created objects -key ID of a created screen -value Name of a created screen |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_getAllScreens | ( | ref byte | screenNumbers, |
ref Dictionary< UInt16, string > | returnScreens, | ||
string | ip = "" |
||
) |
Get All Screens
Get all created screens' name
screenNumbers | Number of created screens |
returnScreens | Dictionary all created screens -key ID of a created screen -value Name of a created screen |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_getButtonEvent | ( | ref UInt16 | screenID, |
ref UInt16 | objectID, | ||
ref string | screenName, | ||
ref string | objectName, | ||
ref bool | isLongPress, | ||
string | ip = "" |
||
) |
Get Button Event
Reports back the ID of the button that encountered a click event after the last Get Button Event.
screenID | Screen ID of the last clicked button |
objectID | Button ID of the last clicked button |
screenName | Screen Name of the last clicked button |
objectName | Button Name of the last clicked button |
isLongPress | TRUE = Long Press, FALSE = Short Press |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_loadScreenInfo | ( | string | ip = "" | ) |
Load Screen Info
Load all current screen information from RAM to flash
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_playAudio | ( | string | name, |
int | type, | ||
string | ip = "" |
||
) |
Play Audio
This command plays an audio file loaded from the inserted SD card. The VP6800 supports 16bit PCM format .WAV files.
name | Name of file on SD Card |
type | 0 = Flash, 1 = SD Card |
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_queryObjectbyID | ( | UInt16 | objectID, |
ref byte | objectNumbers, | ||
ref List< string > | returnItems, | ||
string | ip = "" |
||
) |
Queery Object by ID
Check if the given object exists or not. If exists, return all screen names which contains the object of the given object ID
objectID | ID of the checked object |
objectNumber | Number of the checked object |
returnItems | screens containing the item |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_queryObjectbyName | ( | string | objectName, |
ref byte | objectNumbers, | ||
ref List< string > | returnItems, | ||
string | ip = "" |
||
) |
Queery Object by Name
Check if the given object exists or not. If exists, return all screen names which contains the object of the given object name
objectName | Name of the checked object |
objectNumber | Number of the checked object |
returnItems | List of all the screens that contain the object |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_queryScreenbyID | ( | UInt16 | screenID, |
ref byte | result, | ||
ref string | screenName, | ||
string | ip = "" |
||
) |
Queery Screen by ID
Check if the given screen exists or not
screenID | ID of the checked screen |
result | the checking result |
screenName | Name of the checked screen |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_queryScreenbyName | ( | string | screenName, |
ref byte | result, | ||
string | ip = "" |
||
) |
Queery Screen by Name
Check if the given screen exists or not
screenName | Name of the checked screen |
result | the checking result |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_removeItem | ( | string | screenName, |
string | objectName, | ||
string | ip = "" |
||
) |
Removed Item
Removes a component.
screenName | Screen name where to remove the target from. |
objectName | Identifier of the component |
ip | Optional: IP address to execute command on (for IP connected devices) |
|
static |
Retrieve LCD Message
Returns the string value for a message ID returned for LCD messaging
lang | Language. |
id | Message ID |
line1 | Line 1 string value |
line2 | Line 2 string value |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_setBacklight | ( | byte | backlightVal, |
string | ip = "" |
||
) |
Set Backlight
Set backlight percentage. If the percent >100, it will be rejected. If percent < 10, backlight percent will be set to 10
backlightVal | Backlight percent value to be sat |
ip | Optional: IP address to execute command on (for IP connected devices) |
void IDTechSDK.IDT_NEO2.lcd_setButtonCallback | ( | string | screenName, |
string | buttonName, | ||
buttonCallback | callback, | ||
string | ip | ||
) |
Set Button Callback
Sets the callback for a button.
screenName | Screen name where the button is located |
buttonName | Object name of the button |
callback | buttonCallback to receive button presses. Passing NULL will return button presses to main messageCallback. |
ip | Optional: IP address to execute command on (for IP connected devices) |
NOTE ON BUTTON PRESS EVENTS: A button press consists of uInt16 specifying the screen, and uInt16 specifying the button ID If buttonnCallback is used, it will have the follow signature:
public delegate void buttonCallback(IDT_DEVICE_Types sender, UInt16 screenID, UInt16 itemID, string IP);
If buttonCallback is NULL, then the button presses will be passed to the messageCallback, with DeviceState.ButtonEvent, and data = data[0], data[1] = uInt16 screenID, and data[2], data[3] = uint16 buttonID
void IDTechSDK.IDT_NEO2.lcd_setPinCancelPromptCallback | ( | CancelPromptCallback | callback, |
string | ip = "" |
||
) |
Set Pin Cancel Prompt Callback
Sets the callback for the PIN Cancel Prompt Callback.
callback | CancelPromptCallback |
ip | Optional: IP address to execute command on (for IP connected devices) |
Callback will have the follow signature:
public delegate void CancelPromptCallback(string ipAddress);
void IDTechSDK.IDT_NEO2.lcd_setPinFailureCallback | ( | FailureCallback | callback, |
string | ip = "" |
||
) |
Set Pin Failure Callback
Sets the callback for the PIN Failure Callback.
callback | FailureCallback |
ip | Optional: IP address to execute command on (for IP connected devices) |
Callback will have the follow signature:
public delegate void FailureCallback(string ipAddress, RETURN_CODE errorCode);
void IDTechSDK.IDT_NEO2.lcd_setPinInputCallback | ( | SwipeCallback | callback, |
string | ip = "" |
||
) |
Set Pin Input Callback
Sets the callback for the PIN Input Callback.
callback | SwipeCallback |
ip | Optional: IP address to execute command on (for IP connected devices) |
Callback will have the follow signature:
public delegate void SwipeCallback(string ipAddress, string input);
void IDTechSDK.IDT_NEO2.lcd_setPinSwipeCallback | ( | SwipeCallback | callback, |
string | ip = "" |
||
) |
Set Pin Swipe Callback
Sets the callback for the PIN Swipe Callback.
callback | SwipeCallback |
ip | Optional: IP address to execute command on (for IP connected devices) |
Callback will have the follow signature:
public delegate void InputCallback(string ipAddress, IDTTransactionData input);
void IDTechSDK.IDT_NEO2.lcd_setPinTimeoutCallback | ( | TimeoutCallback | callback, |
string | ip = "" |
||
) |
Set Pin Timeout Callback
Sets the callback for the PIN Timeout Callback.
callback | TimeoutCallback |
ip | Optional: IP address to execute command on (for IP connected devices) |
Callback will have the follow signature:
public delegate void TimeoutCallback(string ipAddress);
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_showScreen | ( | string | screenName, |
string | ip = "" |
||
) |
Show Screen
Displays and makes active a previously created screen.
screenName | Screen to display. The screen name is defined with lcd_createScreen. |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_startCameraCapture | ( | ushort | timeout, |
string | ip = "" |
||
) |
Start Camera Capture
When the camera is turned on, a “take a picture” button appears on the display. If the button is pressed, the device takes a picture, which is stored in SD card and displayed on-screen for five seconds. The device stores a maximum of 20 pictures. Upon reaching capacity, the 21st picture replaces the 1st.
ip | timeout Timeout value. Minimum is 30 seconds (values under 30 seconds will default to 30 seconds) |
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_startScanQR | ( | ushort | timeout, |
string | ip = "" |
||
) |
Start QR Scanning
This command will enable the camera and attempt to scan a QR code. The data will be returned to the MessageCallback, with DeviceState.CameraEventData
ip | timeout Timeout value. Minimum is 30 seconds (values under 30 seconds will default to 30 seconds) |
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_startScreenSaver | ( | string | name, |
string | ip = "" |
||
) |
Start Screen Saver
The command starts the screen saver, which is disabled when the touchpad is touched, the customize screen is shown, or a transaction is started. The device reads the video from the inserted SD Card; the video format must be MJPEG with a maximum frame width of 480px and maximum frame height of 272px. Note that the video displays rotated +90 degrees.
name | Name of file on SD Card |
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_stopAudio | ( | string | ip = "" | ) |
Stop Audio
This command stop playing audio started with lcd_playAudio.
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_stopCameraCapture | ( | string | ip = "" | ) |
Stop Camera Capture
This command will stop the camera that started with lcd_startCameraCapture
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_stopScanQR | ( | string | ip = "" | ) |
Stop QR Scanning
This command will stop QR scanning that started with lcd_startScanQR
ip | Optional IP Address |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_storeScreenInfo | ( | string | ip = "" | ) |
Store Screen Info
Store all current screen information from RAM to flash
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_updateColor | ( | string | screenName, |
string | objectName, | ||
byte[] | color, | ||
string | ip = "" |
||
) |
Update Color
Updates the component color, or updates the LED colors if specifying LCD component
screenName | Screen name that will be the target of update color |
objecName | Identifier of the component |
color | Non LCD Widget: Four bytes for color, example, Blue = 0xFF000000, Black = 0x00000000
|
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_updateLabel | ( | string | screenName, |
string | objectName, | ||
string | label, | ||
string | ip = "" |
||
) |
Update Label
Updates the component label.
screenName | Screen name that will be the target of update label |
objectName | Identifier of the component |
label | Label to show on the component |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.lcd_updatePosition | ( | string | screenName, |
string | objectName, | ||
byte | alignment, | ||
UInt16 | new_xCord, | ||
UInt16 | new_yCord, | ||
string | ip = "" |
||
) |
Update Position
Updates the component position.
screenName | Screen Name that will be the target of update position |
objectName | Identifier of the component |
alignment | Alignment for the target
|
new_xCord | x-coordinate for Text, range 0-271 |
new_yCord | y-coordinate for Text, range 0-479 |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.msr_cancelMSRSwipe | ( | string | ip = "" | ) |
Disable MSR Swipe Cancels MSR swipe request.
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.msr_getMSRTrack | ( | ref int | val, |
string | ip | ||
) |
Gets the MSR tracks setting.
val | Track Value:
|
ip | Optional IP parameter |
RETURN_CODE IDTechSDK.IDT_NEO2.msr_setMSRTrack | ( | int | val, |
string | ip | ||
) |
Sets the MSR tracks to recognize. When "Any Track" is selected (0 - default value), an error condition will be returned if no tracks are read When specific tracks are selected (1 - 7), if any of the requested tracks are missing, it will return error.
val | Track Value:
|
ip | Optional IP parameter |
RETURN_CODE IDTechSDK.IDT_NEO2.msr_startMSRSwipe | ( | int | timeout, |
string | ip = "" |
||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur.
timeout | Swipe Timeout Value |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.msr_startMSRSwipe | ( | int | timeout, |
string | ip, | ||
SwipeCallback | swipeCallback, | ||
TimeoutCallback | timeoutCallback, | ||
FailureCallback | failureCallback | ||
) |
Enable MSR Swipe
Enables MSR, waiting for swipe to occur.
timeout | Swipe Timeout Value |
ip | IP address to execute command on (for IP connected devices) |
swipeCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData transactionData) |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_cancelPINEntry | ( | string | ip = "" | ) |
Cancel PIN Entry
Cancel “Get Function Key” & “Get Encrypted PIN” & “Get Numeric” & “Get Amount”
RETURN_CODE IDTechSDK.IDT_NEO2.pin_capturePin | ( | int | timeout, |
int | type, | ||
string | PAN, | ||
int | minPIN, | ||
int | maxPIN, | ||
string | message, | ||
string | ip = "" |
||
) |
Capture PIN
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
type | PAN and Key Type
|
PAN | Personal Account Number (if internal, value is 0) |
minPIN | Minimum PIN Length |
maxPIN | Maximum PIN Length |
message | LCD Message |
ip | Optional: IP address to execute command on (for IP connected devices) Results returned to MessageCallback. If successful PIN capture, data is returned as DeviceState.TransactionData, with IDTTransactionData cData.pin_pinblock and cData.pin_KSN. If timeout, returns DeviceState.PINTimeout If error, returns DeviceState.PINFail with one of the following values in data[0]:
|
RETURN_CODE IDTechSDK.IDT_NEO2.pin_capturePin | ( | int | timeout, |
int | type, | ||
string | PAN, | ||
int | minPIN, | ||
int | maxPIN, | ||
string | message, | ||
string | ip, | ||
SwipeCallback | inputCallback, | ||
FailureCallback | failureCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Capture PIN
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
type | PAN and Key Type
|
PAN | Personal Account Number (if internal, value is 0) |
minPIN | Minimum PIN Length |
maxPIN | Maximum PIN Length |
message | LCD Message |
ip | IP address to execute command on (for IP connected devices) Results returned to MessageCallback. If successful PIN capture, data is returned as DeviceState.TransactionData, with IDTTransactionData cData.pin_pinblock and cData.pin_KSN. If timeout, returns DeviceState.PINTimeout If error, returns DeviceState.PINFail with one of the following values in data[0]:
|
inputCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData input); |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_getFunctionKey | ( | int | timeout, |
string | ip = "" |
||
) |
Get Function Key
Results returned to MessageCallback. If successful function key capture, data is returned as DeviceState.FunctionKey, with data being the ASCII value of the key that was pressed.
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_getFunctionKey | ( | int | timeout, |
string | ip, | ||
SwipeCallback | inputCallback, | ||
FailureCallback | failureCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Get Function Key
Results returned to MessageCallback. If successful function key capture, data is returned as DeviceState.FunctionKey, with data being the ASCII value of the key that was pressed.
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
ip | IP address to execute command on (for IP connected devices) |
inputCallback | Redirects the input from main callback to InputCallback(string ipAddress, IDTTranasctionData input); |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_getPanEntry | ( | bool | csc, |
bool | expDate, | ||
bool | ADR, | ||
bool | ZIP, | ||
bool | mod10, | ||
UInt16 | timeout, | ||
bool | encPANOnly = false , |
||
string | ip = "" |
||
) |
Get Pan
prompt the user to manually enter a card PAN and Expiry Date (and optionally CSC) from the keypad and return it to the POS.
timeout | Number of seconds that the reader waits for the data entry session to complete, stored as a big-endian number. 0 = no timeout |
csc | Request CSS |
expDate | Request Expiration Date |
ADR | Request Address |
ZIP | Request Zip |
mod10 | Validate entered PAN passes MOD-10 checking before accepting |
encPANOnly | Output only encrypted PAN |
ip | Optional: IP address to execute command on (for IP connected devices) |
swipeCallback | Optional: Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData transactionData) |
timeoutCallback | Optional: Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Optional: Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_getPanEntry | ( | bool | csc, |
bool | expDate, | ||
bool | ADR, | ||
bool | ZIP, | ||
bool | mod10, | ||
UInt16 | timeout, | ||
bool | encPANOnly, | ||
string | ip, | ||
SwipeCallback | swipeCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Get Pan
prompt the user to manually enter a card PAN and Expiry Date (and optionally CSC) from the keypad and return it to the POS.
timeout | Number of seconds that the reader waits for the data entry session to complete, stored as a big-endian number. 0 = no timeout |
csc | Request CSS |
expDate | Request Expiration Date |
ADR | Request Address |
ZIP | Request Zip |
mod10 | Validate entered PAN passes MOD-10 checking before accepting |
encPANOnly | Output only encrypted PAN |
ip | IP address to execute command on (for IP connected devices) |
swipeCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData transactionData) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForAmount | ( | int | timeout, |
int | minLen, | ||
int | maxLen, | ||
string | message, | ||
byte[] | signature, | ||
string | ip = "" |
||
) |
Capture Amount
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
minLen | Minimum input Length |
maxLen | Maximum input Length |
message | LCD Message |
signature | Display message signed by Numeric Private Key using RSAPSS algorithm:
|
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForAmount | ( | int | timeout, |
int | minLen, | ||
int | maxLen, | ||
string | message, | ||
byte[] | signature, | ||
string | ip, | ||
SwipeCallback | inputCallback, | ||
FailureCallback | failureCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Capture Amount
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
minLen | Minimum input Length |
maxLen | Maximum input Length |
message | LCD Message |
signature | Display message signed by Numeric Private Key using RSAPSS algorithm:
|
ip | IP address to execute command on (for IP connected devices) |
inputCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData input); |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForInput | ( | int | messageID, |
short | timeout, | ||
string | ip = null |
||
) |
Capture Numeric Input From Message ID
messageID | Message ID
|
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForInput | ( | int | messageID, |
short | timeout, | ||
string | ip, | ||
SwipeCallback | inputCallback, | ||
SwipeCallback | swipeCallback, | ||
FailureCallback | failureCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Capture Numeric Input From Message ID
messageID | Message ID
|
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
ip | IP address to execute command on (for IP connected devices) |
inputCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData input); |
swipeCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData transactionData) |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress) |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForNumericKeyWithSwipe | ( | short | timeout, |
byte | function, | ||
int | minLen, | ||
int | maxLen, | ||
string | line1, | ||
string | line2, | ||
byte[] | signature, | ||
string | ip = "" |
||
) |
Capture Numeric Input
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
function |
|
minLen | Minimum input Length |
maxLen | Maximum input Length |
line1 | Line 1 of LCD Message - 16 chars max |
line2 | Line 2 of LCD Message - 16 chars max |
signature | Display message signed by Numeric Private Key using RSAPSS algorithm:
|
ip | Optional: IP address to execute command on (for IP connected devices) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_promptForNumericKeyWithSwipe | ( | short | timeout, |
byte | function, | ||
int | minLen, | ||
int | maxLen, | ||
string | line1, | ||
string | line2, | ||
byte[] | signature, | ||
string | ip, | ||
SwipeCallback | inputCallback, | ||
SwipeCallback | swipeCallback, | ||
FailureCallback | failureCallback, | ||
TimeoutCallback | timeoutCallback, | ||
CancelPromptCallback | cancelPromptCallback | ||
) |
Capture Numeric Input
timeout | Timeout, in seconds. Value of 0 will use system timeout, if any |
function |
|
minLen | Minimum input Length |
maxLen | Maximum input Length |
line1 | Line 1 of LCD Message - 16 chars max |
line2 | Line 2 of LCD Message - 16 chars max |
signature | Display message signed by Numeric Private Key using RSAPSS algorithm:
|
ip | : IP address to execute command on (for IP connected devices) |
inputCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData input); |
swipeCallback | Redirects the input from main callback to SwipeCallback(string ipAddress, IDTTransactionData transactionData) |
failureCallback | Redirects the input from main callback to FailureCallback(string ipAddress, RETURN_CODE errorCode) |
timeoutCallback | Redirects the input from main callback to TimeoutCallback(string ipAddress)p |
cancelPromptCallback | Redirects the input from main callback to CancelPromptCallback(string ipAddress) |
RETURN_CODE IDTechSDK.IDT_NEO2.pin_sendBeep | ( | string | ip = "" | ) |
Send Beep
Executes a beep request.
ip | Optional: IP address to execute command on (for IP connected devices) |
|
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); |
context | The context of the UI thread |
|
static |
Set Callback with IP
Sets the class callback that also reports back IP device information (for network connected devices)
my_Callback | The callback function to receive the response message from device. defined as follows. public delegate void CallBackIP(IDT_DEVICE_Types sender, DeviceState state, byte[] data, IDTTransactionData card, EMV_Callback emvCallback, RETURN_CODE transactionResultCode, string IP); |
ip | Optional: The callback function will only be applicable to the provided IP. |
|
static |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
milliseconds | Time |
|
static |
Set Longpress Callback
Sets the class callback that also reports back IP device information (for network connected devices)
callback | The callback function to receive the response message from device. defined as follows. Location 0 = top left, Location 1 = top right. public delegate void longPressCallback(IDT_DEVICE_Types sender, UInt16 screenID, byte location, string IP); |
ip | Optional: The callback function will only be applicable to the provided IP. |
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with IDT_NEO2 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 IDT_NEO2
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
|
static |
Use USB Interface
Instructs SDK to attempt to use USB for communication with IDT_NEO2
success | Returns TRUE if connection successful, otherwise returens false |
|
staticget |