![]() |
IDTech Windows SDK Guide
3.2.4.393
API reference for Visual Studio .Net
|
Public Member Functions | |
RETURN_CODE | device_getFirmwareVersion (ref string response, string ident="") |
RETURN_CODE | device_StartRKI (int type, string ident="") |
RETURN_CODE | device_updateDeviceFirmware (byte[] firmwareData, string ident="") |
RETURN_CODE | device_sendPAE (string command, ref string response, int timeout, string ident="") |
RETURN_CODE | device_sendDataCommand (string cmd, bool calcLRC, ref byte[] response, string ident="") |
RETURN_CODE | device_sendDataCommand_ext (string cmd, bool calcLRC, ref byte[] response, int timeout, bool noResponse, string ident="") |
RETURN_CODE | config_getModelNumber (ref string response, string ident="") |
RETURN_CODE | config_getSerialNumber (ref string response, string ident="") |
bool | config_setCmdTimeOutDuration (int newTimeOut, string ident="") |
RETURN_CODE | pin_getEncryptedPIN (int keyType, string PAN, string message, int timeout, bool isAES=false, string ident="") |
RETURN_CODE | pin_getManualPanEntry (bool csc, bool ADR, bool ZIP, string ident="") |
RETURN_CODE | pin_getFunctionKey (string ident="") |
RETURN_CODE | pin_sendBeep (int frequency, int duration, string ident="") |
RETURN_CODE | device_rebootDevice (string ident="") |
RETURN_CODE | pin_setKeypressCapture (bool showKeyValue, string ident="") |
RETURN_CODE | pin_cancelPINEntry (string ident="") |
RETURN_CODE | device_getKeyStatus (ref byte[] status, string ident="") |
RETURN_CODE | pin_promptForKeyInput (string message, byte[] signature, bool maskInput, int minLen, int maxLen, string ident="") |
RETURN_CODE | pin_promptForAmountInput (string message, byte[] signature, bool maskInput, int minLen, int maxLen, string ident="") |
RETURN_CODE | pin_promptForKeyInput (int messageID, int languageID, bool maskInput, int minLen, int maxLen) |
RETURN_CODE | pin_promptForAmountInput (int messageID, int languageID, int minLen, int maxLen) |
RETURN_CODE | device_setSleepModeTime (int time, string ident="") |
RETURN_CODE | device_startRKI (string ident="") |
RETURN_CODE | device_enterStopMode (string ident="") |
RETURN_CODE | device_setDateTime (string ident="") |
RETURN_CODE | device_getDateTime (ref byte[] dateTime, string ident="") |
RETURN_CODE | lcd_clearDisplay (int lineNumber, string ident="") |
RETURN_CODE | lcd_clearAllLines (string ident="") |
RETURN_CODE | lcd_savePrompt (int promptNumber, string prompt, string ident="") |
RETURN_CODE | lcd_displayPrompt (int promptNumber, int lineNumber, string ident="") |
RETURN_CODE | lcd_displayMessage (int lineNumber, string message, string ident="") |
RETURN_CODE | config_setEthernetMACAddress (byte[] address, string ident="") |
RETURN_CODE | config_getEthernetMACAddress (ref byte[] address, string ident="") |
RETURN_CODE | config_getNetworkConfiguration (ref bool isStatic, ref string address, ref string subnet, ref string gateway, ref string dns, string ident="") |
RETURN_CODE | config_setNetworkConfiguration (bool isStatic, string address, string subnet, string gateway, string dns, string ident="") |
RETURN_CODE | lcd_enableBacklight (bool enable, string ident="") |
RETURN_CODE | lcd_getBacklightStatus (ref bool enabled, string ident="") |
RETURN_CODE | config_setBaudRate (int baud, string ident="") |
RETURN_CODE | config_getBaudRate (ref int baud, string ident="") |
RETURN_CODE | device_getRKIStatus (bool isProd, bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | device_getAnyRKIStatus (bool isMultiKey, ref string status, ref Dictionary< string, RKI_KEY_TYPE > keys, string ident="") |
RETURN_CODE | device_updateFirmwareFromZip (byte[] zipfile, string ident="", bool isForeground=false) |
RETURN_CODE | device_sendConfigurationFromZip (byte[] zip, string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false) |
RETURN_CODE | device_sendConfiguration (string filename, VC_OPERATION_TYPE type, bool matchFW, string ident="", bool isForeground=false) |
RETURN_CODE | device_readConfigurationToMemory (string memo, Configs.InstallRules rules, List< Configs.DeviceCommand > cmds, string ident="", bool isForeground=false) |
RETURN_CODE | device_getConfigurationFromMemory (ref string json, string ident="") |
RETURN_CODE | device_RemoteKeyInjection (RKI_KEY_TYPE type, string keyName, string ident="", bool performOnForeground=false) |
Static Public Member Functions | |
static bool | useSerialPort (int port) |
static bool | useSerialPortLinux (string path) |
static bool | useSerialPortLinux (string path, int baud) |
static int | getCommandTimeout (string ident="") |
static void | setCommandTimeout (int milliseconds, string ident="") |
static bool | useSerialPort (int port, int baud, string ident="") |
static bool | closeSerialPort () |
static bool | closeUSB (string ident="") |
static void | initSC () |
static void | setCallback (CallBack my_Callback) |
static void | setCallback (IntPtr my_Callback, SynchronizationContext context) |
static String | SDK_Version () |
static void | lcd_retrieveMessage (DisplayMessages.DISPLAY_MESSAGE_LANGUAGE lang, DisplayMessages.DISPLAY_MESSAGE_IDENTIFIER id, ref string line1, ref string line2) |
Properties | |
static IDT_L100 | SharedController [get] |
|
static |
Close Serial Port Interface
Instructs SDK to close the Serial Port if connected to L100
|
static |
Close USB
Instructs SDK to close the USB if connected to L100
RETURN_CODE IDTechSDK.IDT_L100.config_getBaudRate | ( | ref int | baud, |
string | ident = "" |
||
) |
Get Baud Rate
Gets the buad rate for RS-232 communication.
baud |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_getEthernetMACAddress | ( | ref byte[] | address, |
string | ident = "" |
||
) |
Get Device Ethernet MAC Address
address | 6-byte MAC Address |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_getModelNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Model Number
response | Returns Model Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_getNetworkConfiguration | ( | ref bool | isStatic, |
ref string | address, | ||
ref string | subnet, | ||
ref string | gateway, | ||
ref string | dns, | ||
string | ident = "" |
||
) |
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" |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_getSerialNumber | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Serial Number
response | Returns Serial Number |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_setBaudRate | ( | int | baud, |
string | ident = "" |
||
) |
Set Baud Rate
Sets the buad rate for RS-232 communication.
baud |
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
bool IDTechSDK.IDT_L100.config_setCmdTimeOutDuration | ( | int | newTimeOut, |
string | ident = "" |
||
) |
Command Acknowledgement Timout
Sets the amount of seconds to wait for an {ACK} to a command before a timeout. Responses should normally be received under one second. Default is 3 seconds
newTimeOut | Timout value. Valid range 1 - 60 seconds |
RETURN_CODE IDTechSDK.IDT_L100.config_setEthernetMACAddress | ( | byte[] | address, |
string | ident = "" |
||
) |
Set Device Ethernet MAC Address
address | 6-byte MAC Address |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.config_setNetworkConfiguration | ( | bool | isStatic, |
string | address, | ||
string | subnet, | ||
string | gateway, | ||
string | dns, | ||
string | ident = "" |
||
) |
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" |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_enterStopMode | ( | string | ident = "" | ) |
Enter Stop Mode
Set device enter to stio mode. In stop mode, LCD display and backlight is off. Stop mode reduces power consumption to the lowest possible level. A unit in stop mode can only be woken up by a physical key press.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getAnyRKIStatus | ( | bool | isMultiKey, |
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status Polls the RKI servers to validate device RKI eligiblity. Note: if device type is known in advance (production or demo device), it is more efficient to use device_getRKIStatus instead
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns all available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getConfigurationFromMemory | ( | ref string | json, |
string | ident = "" |
||
) |
Read Device Configuration From Memory Retrieves the ViVOconfig configuration data from memory after a successful device_readConfigurationToMemory
json | Returns the .json file data that can be saved to disk |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getDateTime | ( | ref byte[] | dateTime, |
string | ident = "" |
||
) |
Get Date Time
Gets current system date and time of the device.
dateTime | The date time returned as follows:
|
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getFirmwareVersion | ( | ref string | response, |
string | ident = "" |
||
) |
Polls device for Firmware Version
response | Response returned of Firmware Version |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getKeyStatus | ( | ref byte[] | status, |
string | ident = "" |
||
) |
Get Key Status
Gets the status of loaded keys
status | byte 0: PIN DUKPT Key, 1 Exists, 0 None, 0xFF STOP byte 1: PIN Master Key, 1 Exists, 0 None byte 2: PIN Session Key, 1 Exists, 0 None byte 3: Account/MSR DUKPT Key, Does not support, always 0 byte 4: Account/ICC DUKPT Key, Does not support, always 0 byte 5: Admin DUKPT Key, 1 Exists, 0 None, 0xFF STOP |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_getRKIStatus | ( | bool | isProd, |
bool | isMultiKey, | ||
ref string | status, | ||
ref Dictionary< string, RKI_KEY_TYPE > | keys, | ||
string | ident = "" |
||
) |
Get RKI Status From Specified Server Polls the RKI server to validate device RKI eligiblity
isProd | TRUE = poll production RKI server, FALSE = poll demo RKI server |
isMultiKey | True = MultiKey, False = SingleKey |
status | RKI status returned as a string |
keys | Returns dictionary of available keys |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_readConfigurationToMemory | ( | string | memo, |
Configs.InstallRules | rules, | ||
List< Configs.DeviceCommand > | cmds, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Read Device Configuration To Memory Executes a ViVOconfig read of device settings and stores the results in memory
Once a ViVOconfig read starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_READ_CONFIG_FAILED = Read process FAILED.
memo | Optional: populates the memo field of the captured .json file |
rules | Optional: populates the .json file with available install rules |
cmds | Optional: populates the .json file with commands to execute |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_L100.device_rebootDevice | ( | string | ident = "" | ) |
Reboot Device
Executes a command to restart the device.
Resetting firmware.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_RemoteKeyInjection | ( | RKI_KEY_TYPE | type, |
string | keyName, | ||
string | ident = "" , |
||
bool | performOnForeground = false |
||
) |
Remote Key Injection Performs a remote key injection for the device
type | Remote Key Injection Type |
keyName | Name of key (optional) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
performOnForeground | TRUE = block during process (default is false) |
RETURN_CODE IDTechSDK.IDT_L100.device_sendConfiguration | ( | string | filename, |
VC_OPERATION_TYPE | type, | ||
bool | matchFW, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Send Configuration Executes a ViVOconfig update or verify to a device
Once a ViVOconfig write or verify starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED
filename | The .json configuration file to update the device with NOTE: You can also use this parameter to pass the path of where the .json file is located at on local storage instead |
filename | The name of the .json configuration file |
type | VC_OPERATION_TYPE |
matchFW | TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_L100.device_sendConfigurationFromZip | ( | byte[] | zip, |
string | filename, | ||
VC_OPERATION_TYPE | type, | ||
bool | matchFW, | ||
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Send Configuration From Zip Executes a ViVOconfig update or verify to a device using files from a .zip archive
Once a ViVOconfig write or update starts, all messages will be returned to the callback as DeviceState.ViVOconfig. The ViVOconfig operation is complete when the return code from a DeviceState.ViVOconfig message is one of the following values:
RETURN_CODE_SDK_VIVOCONFIG_WRITE_FAILED = Write process FAILED
zip | .Zip archive containing the .json configuration file and also any associated image assets NOTE: You can also use this parameter to pass the path of where the .zip file is located at on local storage instead |
filename | The name of the .json configuration file |
type | VC_OPERATION_TYPE |
matchFW | TRUE = Device FW must match file FW, FALSE = Don't validate device FW against file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until update complete. Otherwise, FALSE performs update on background. |
RETURN_CODE IDTechSDK.IDT_L100.device_sendDataCommand | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
string | ident = "" |
||
) |
Send a data command to the device
Sends a command to the device.
cmd | String representation of command to execute |
calcLRC | If TRUE , this will wrap command with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}' |
response | Response data |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_sendDataCommand_ext | ( | string | cmd, |
bool | calcLRC, | ||
ref byte[] | response, | ||
int | timeout, | ||
bool | noResponse, | ||
string | ident = "" |
||
) |
Send a data command to the device - extended
Sends a command to the device.
cmd | String representation of command to execute |
calcLRC | If TRUE , this will wrap command as NGA with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}' |
response | Response data |
timeout | Timeout value waiting for response, in milliseconds (1000 = 1 second) |
noResponse | if TRUE, this will not wait for a response and immediately return SUCCESS |
calcITP | If TRUE , this will wrap command as ITP with start/end/lrc: '{STX} data {ETX}{CheckLRC}' |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_sendPAE | ( | string | command, |
ref string | response, | ||
int | timeout, | ||
string | ident = "" |
||
) |
Send Payment Application Engine Command
Executes a PAE command
command | ASCII command string, should start with "*PAE" |
response | command response |
timeout | timeout waiting for PAE response |
ip | Optional IP address when connected via TCP/IP |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_setDateTime | ( | string | ident = "" | ) |
Set Date Time
Set current system date and time to the device.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_setSleepModeTime | ( | int | time, |
string | ident = "" |
||
) |
Set Sleep Mode Timer
Set device enter to sleep mode after the given time. In sleep mode, LCD display and backlight is off. Sleep mode reduces power consumption to the lowest possible level. A unit in Sleep mode can only be woken up by a physical key press.
time | Enter sleep time value, in second. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_StartRKI | ( | int | type, |
string | ident = "" |
||
) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers. Set/Get RKI url with IDT_Device.RKI_URL.
type | 0 = Symmetric RKI Demo Unit 1 = Symmetric RKI Production Unit 2 = PKI-RKI Demo Unit 3 = PKI-RKI Production Unit |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_startRKI | ( | string | ident = "" | ) |
Start Remote Key Injection
Starts a remote key injection request with IDTech RKI servers.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.device_updateDeviceFirmware | ( | byte[] | firmwareData, |
string | ident = "" |
||
) |
Update Firmware
Updates the firmware .
firmwareData | Signed binary data of a firmware file provided by IDTech |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
After you pass the firmwareData file, a new thread will start to execute the firmware download. You will receive status of the progress through callbacks to the IDTechSDK.Callback() delegate. The following parameters will be passed back:
Example code starting a firmware update
Example monitoring firmware update status / success
RETURN_CODE IDTechSDK.IDT_L100.device_updateFirmwareFromZip | ( | byte[] | zipfile, |
string | ident = "" , |
||
bool | isForeground = false |
||
) |
Update Firmware From Zip
Performs one or more device firmware updates from firmware files passed as a compressed archive with a valid configuration file (.json format)
zipfile | Zip file containing on or more firmware update files and a .json configuration file |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
isForeground | If TRUE, will block program until firmware update complete. Otherwise, FALSE performs FW update on background. |
|
static |
Get Command Timeout
Gets the default timeout (in milliseconds) waiting for a blocking command response
time | Time |
RETURN_CODE IDTechSDK.IDT_L100.lcd_clearAllLines | ( | string | ident = "" | ) |
Clear LCD Display
Clears all lines of the LCD Display.
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_clearDisplay | ( | int | lineNumber, |
string | ident = "" |
||
) |
Clear LCD Display Line
Clears the line number of the LCD Display.
lineNumber | Line number to clear (1-4) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_displayMessage | ( | int | lineNumber, |
string | message, | ||
string | ident = "" |
||
) |
Display Message on Line
Displays a message on a display line.
lineNumber | Line number to display message on (1-4) |
message | Message to display |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_displayPrompt | ( | int | promptNumber, |
int | lineNumber, | ||
string | ident = "" |
||
) |
Display Prompt on Line
Displays a message prompt from L100 memory.
promptNumber | Prompt number (0-9) |
lineNumber | Line number to display message prompt (1-4) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_enableBacklight | ( | bool | enable, |
string | ident = "" |
||
) |
Enable/Disable LCD Backlight
Turns on/off the LCD back lighting.
enable | TRUE = turn ON backlight, FALSE = turn OFF backlight |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_getBacklightStatus | ( | ref bool | enabled, |
string | ident = "" |
||
) |
Get Backlight Status
Returns the status of the LCD back lighting.
enabled | TRUE = Backlight is ON, FALSE = Backlight is OFF |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
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 |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.lcd_savePrompt | ( | int | promptNumber, |
string | prompt, | ||
string | ident = "" |
||
) |
Save Prompt
Saves a message prompt to L100 memory.
promptNumber | Prompt number (0-9) |
prompt | Prompt string (up to 20 characters) |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_cancelPINEntry | ( | string | ident = "" | ) |
Cancel PIN Entry
Cancel “Get Function Key” & “Get Encrypted PIN” & “Get Numeric” & “Get Amount”
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_getEncryptedPIN | ( | int | keyType, |
string | PAN, | ||
string | message, | ||
int | timeout, | ||
bool | isAES = false , |
||
string | ident = "" |
||
) |
Get Encrypted PIN
Requests PIN Entry
keyType |
|
PAN | Account Number |
message | Message to display = timeout |
isAES | set to TRUE if PEK is AES, not TDES |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_getFunctionKey | ( | string | ident = "" | ) |
Get Function Key
Captures a function key
Timeout hard wired 3 minutes
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_getManualPanEntry | ( | bool | csc, |
bool | ADR, | ||
bool | ZIP, | ||
string | ident = "" |
||
) |
Get Manual Pan Entry
prompt the user to manually enter a card PAN and Expiry Date (and optionally CSC) from the keypad and return it to the POS.
csc | Request CSS |
ADR | Request Address |
ZIP | Request Zip |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_promptForAmountInput | ( | string | message, |
byte[] | signature, | ||
bool | maskInput, | ||
int | minLen, | ||
int | maxLen, | ||
string | ident = "" |
||
) |
Prompt for Amount Input from Encrypted Message
Prompts for amount input using the secure message data
@param message Message @param signature Signature, 256 bytes @param maskInput Mask Input Entry @param minLen Minimum input length. Cannot be less than 1 @param maxLen Maximum input length. Cannot be greater than 15 Timeout is hardwired to 3 minutes
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_promptForAmountInput | ( | int | messageID, |
int | languageID, | ||
int | minLen, | ||
int | maxLen | ||
) |
Prompt for Amount Input
Prompts for amount input using the secure message according to the following table
Msg Id | English Prompt | Portuguese Prompt | Spanish Prompt | French Prompt |
---|---|---|---|---|
1 | ENTER | ENTER | INGRESE | ENTREZ |
2 | REENTER | RE-INTRODUZIR | REINGRESE | RE-ENTREZ |
3 | ENTER YOUR | INTRODUZIR O SEU | INGRESE SU | ENTREZ VOTRE |
4 | REENTER YOUR | RE-INTRODUZIR O SEU | REINGRESE SU | RE-ENTREZ VOTRE |
5 | PLEASE ENTER | POR FAVOR DIGITE | POR FAVOR INGRESE | SVP ENTREZ |
6 | PLEASE REENTER | POR FAVO REENTRAR | POR FAVO REINGRESE | SVP RE-ENTREZ |
7 | PO NUMBER | NÚMERO PO | NUMERO PO | No COMMANDE |
8 | DRIVER ID | LICENÇA | LICENCIA | ID CONDUCTEUR |
9 | ODOMETER | ODOMETER | ODOMETRO | ODOMETRE |
10 | ID NUMBER | NÚMERO ID | NUMERO ID | No IDENT |
11 | EQUIP CODE | EQUIP CODE | CODIGO EQUIP | CODE EQUIPEMENT |
12 | DRIVERS ID | DRIVER ID | ID CONDUCTOR | ID CONDUCTEUR |
13 | JOB NUMBER | EMP NÚMERO | NUMERO EMP | No TRAVAIL |
14 | WORK ORDER | TRABALHO ORDEM | ORDEN TRABAJO | FICHE TRAVAIL |
15 | VEHICLE ID | ID VEÍCULO | ID VEHICULO | ID VEHICULE |
16 | ENTER DRIVER | ENTER DRIVER | INGRESE CONDUCTOR | ENTR CONDUCTEUR |
17 | ENTER DEPT | ENTER DEPT | INGRESE DEPT | ENTR DEPARTEMNT |
18 | ENTER PHONE | ADICIONAR PHONE | INGRESE TELEFONO | ENTR No TELEPH |
19 | ENTER ROUTE | ROUTE ADD | INGRESE RUTA | ENTREZ ROUTE |
20 | ENTER FLEET | ENTER FROTA | INGRESE FLOTA | ENTREZ PARC AUTO |
21 | ENTER JOB ID | ENTER JOB ID | INGRESE ID TRABAJO | ENTR ID TRAVAIL |
22 | ROUTE NUMBER | NÚMERO PATH | RUTA NUMERO | No ROUTE |
23 | ENTER USER ID | ENTER USER ID | INGRESE ID USUARIO | ID UTILISATEUR |
24 | FLEET NUMBER | NÚMERO DE FROTA | FLOTA NUMERO | No PARC AUTO |
25 | ENTER PRODUCT | ADICIONAR PRODUTO | INGRESE PRODUCTO | ENTREZ PRODUIT |
26 | DRIVER NUMBER | NÚMERO DRIVER | CONDUCTOR NUMERO | No CONDUCTEUR |
27 | ENTER LICENSE | ENTER LICENÇA | INGRESE LICENCIA | ENTREZ PERMIS |
28 | ENTER FLEET NO | ENTER NRO FROTA | INGRESE NRO FLOTA | ENT No PARC AUTO |
29 | ENTER CAR WASH | WASH ENTER | INGRESE LAVADO | ENTREZ LAVE-AUTO |
30 | ENTER VEHICLE | ENTER VEÍCULO | INGRESE VEHICULO | ENTREZ VEHICULE |
31 | ENTER TRAILER | TRAILER ENTER | INGRESE TRAILER | ENTREZ REMORQUE |
32 | ENTER ODOMETER | ENTER ODOMETER | INGRESE ODOMETRO | ENTREZ ODOMETRE |
33 | DRIVER LICENSE | CARTEIRA DE MOTORISTA | LICENCIA CONDUCTOR | PERMIS CONDUIRE |
34 | ENTER CUSTOMER | ENTER CLIENTE | INGRESE CLIENTE | ENTREZ CLIENT |
35 | VEHICLE NUMBER | NÚMERO DO VEÍCULO | VEHICULO NUMERO | No VEHICULE |
36 | ENTER CUST DATA | ENTER CLIENTE INFO | INGRESE INFO CLIENTE | INFO CLIENT |
37 | REENTER DRIVID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENTR ID COND |
38 | ENTER USER DATA | ENTER INFO USUÁRIO | INGRESE INFO USUARIO | INFO UTILISATEUR |
39 | ENTER CUST CODE | ENTER CODE. CLIENTE | INGRESE COD. CLIENTE | ENTR CODE CLIENT |
40 | ENTER EMPLOYEE | ENTER FUNCIONÁRIO | INGRESE EMPLEADO | ENTREZ EMPLOYE |
41 | ENTER ID NUMBER | ENTER NÚMERO ID | INGRESE NUMERO ID | ENTREZ No ID |
42 | ENTER DRIVER ID | ENTER ID DRIVER | INGRESE ID CONDUCTOR | No CONDUCTEUR |
43 | ENTER FLEET PIN | ENTER PIN FROTA | INGRESE PIN DE FLOTA | NIP PARC AUTO |
44 | ODOMETER NUMBER | NÚMERO ODOMETER | ODOMETRO NUMERO | No ODOMETRE |
45 | ENTER DRIVER LIC | ENTER DRIVER LIC | INGRESE LIC CONDUCTOR | PERMIS CONDUIRE |
46 | ENTER TRAILER NO | NRO TRAILER ENTER | INGRESE NRO TRAILER | ENT No REMORQUE |
47 | REENTER VEHICLE | REENTRAR VEÍCULO | REINGRESE VEHICULO | RE-ENTR VEHICULE |
48 | ENTER VEHICLE ID | ENTER VEÍCULO ID | INGRESE ID VEHICULO | ENTR ID VEHICULE |
49 | ENTER BIRTH DATE | INSERIR DATA NAC | INGRESE FECHA NAC | ENT DT NAISSANCE |
50 | ENTER DOB MMDDYY | ENTER FDN MMDDYY | INGRESE FDN MMDDAA | NAISSANCE MMJJAA |
51 | ENTER FLEET DATA | ENTER FROTA INFO | INGRESE INFO DE FLOTA | INFO PARC AUTO |
52 | ENTER REFERENCE | ENTER REFERÊNCIA | INGRESE REFERENCIA | ENTREZ REFERENCE |
53 | ENTER AUTH NUMBR | ENTER NÚMERO AUT | INGRESE NUMERO AUT | No AUTORISATION |
54 | ENTER HUB NUMBER | ENTER HUB NRO | INGRESE NRO HUB | ENTREZ No NOYAU |
55 | ENTER HUBOMETER | MEDIDA PARA ENTRAR HUB | INGRESE MEDIDO DE HUB | COMPTEUR NOYAU |
56 | ENTER TRAILER ID | TRAILER ENTER ID | INGRESE ID TRAILER | ENT ID REMORQUE |
57 | ODOMETER READING | QUILOMETRAGEM | LECTURA ODOMETRO | LECTURE ODOMETRE |
58 | REENTER ODOMETER | REENTRAR ODOMETER | REINGRESE ODOMETRO | RE-ENT ODOMETRE |
59 | REENTER DRIV. ID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENT ID CONDUC |
60 | ENTER CUSTOMER ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
61 | ENTER CUST. ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
62 | ENTER ROUTE NUM | ENTER NUM ROUTE | INGRESE NUM RUTA | ENT No ROUTE |
63 | ENTER FLEET NUM | FROTA ENTER NUM | INGRESE NUM FLOTA | ENT No PARC AUTO |
64 | FLEET PIN | FROTA PIN | PIN DE FLOTA | NIP PARC AUTO |
65 | DRIVER # | DRIVER # | CONDUCTOR # | CONDUCTEUR |
66 | ENTER DRIVER # | ENTER DRIVER # | INGRESE CONDUCTOR # | ENT # CONDUCTEUR |
67 | VEHICLE # | VEÍCULO # | VEHICULO # | # VEHICULE |
68 | ENTER VEHICLE # | ENTER VEÍCULO # | INGRESE VEHICULO # | ENT # VEHICULE |
69 | JOB # | TRABALHO # | TRABAJO # | # TRAVAIL |
70 | ENTER JOB # | ENTER JOB # | INGRESE TRABAJO # | ENTREZ # TRAVAIL |
71 | DEPT NUMBER | NÚMERO DEPT | NUMERO DEPTO | No DEPARTEMENT |
72 | DEPARTMENT # | DEPARTAMENTO # | DEPARTAMENTO # | DEPARTEMENT |
73 | ENTER DEPT # | ENTER DEPT # | INGRESE DEPTO # | ENT# DEPARTEMENT |
74 | LICENSE NUMBER | NÚMERO DE LICENÇA | NUMERO LICENCIA | No PERMIS |
75 | LICENSE # | LICENÇA # | LICENCIA # | # PERMIS |
76 | ENTER LICENSE # | ENTER LICENÇA # | INGRESE LICENCIA # | ENTREZ # PERMIS |
77 | DATA | INFO | INFO | INFO |
78 | ENTER DATA | ENTER INFO | INGRESE INFO | ENTREZ INFO |
79 | CUSTOMER DATA | CLIENTE INFO | INFO CLIENTE | INFO CLIENT |
80 | ID # | ID # | ID # | # ID |
81 | ENTER ID # | ENTER ID # | INGRESE ID # | ENTREZ # ID |
82 | USER ID | USER ID | ID USUARIO | ID UTILISATEUR |
83 | ROUTE # | ROUTE # | RUTA # | # ROUTE |
84 | ENTER ROUTE # | ADD ROUTE # | INGRESE RUTA # | ENTREZ # ROUTE |
85 | ENTER CARD NUM | ENTER NÚMERO DE CARTÃO | INGRESE NUM TARJETA | ENTREZ NO CARTE |
86 | EXP DATE(YYMM) | VALIDADE VAL (AAMM) | FECHA EXP (AAMM) | DATE EXPIR(AAMM) |
87 | PHONE NUMBER | TELEFONE | NUMERO TELEFONO | NO TEL |
88 | CVV START DATE | CVV DATA DE INÍCIO | CVV FECHA INICIO | CVV DATE DE DEBUT |
89 | ISSUE NUMBER | NÚMERO DE EMISSÃO | NUMERO DE EMISION | NO DEMISSION |
90 | START DATE (MMYY) | DATA DE INÍCIO (AAMM) | FECHA INICIO (AAMM) | DATE DE DEBUT-AAMM |
@param messageID Message (1-90) @param languageID 0=English Prompt, 1=Portuguese Prompt, 2=Spanish Prompt, 3=French Prompt @param minLen Minimum input length. Cannot be less than 1 @param maxLen Maximum input length. Cannot be greater than 15 Timeout is hardwired to 3 minutes @return RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_L100.pin_promptForKeyInput | ( | string | message, |
byte[] | signature, | ||
bool | maskInput, | ||
int | minLen, | ||
int | maxLen, | ||
string | ident = "" |
||
) |
Prompt for Key Input from Encrypted Message
Prompts for a numeric key using the secure encrypted message data
message | Message |
signature | Signature, 256 bytes |
maskInput | TRUE = entry is masked with '*', FALSE = entry is displayed on keypad |
minLen | Minimum input length. Cannot be less than 1 |
maxLen | Maximum input length. Cannot be greater than 16 |
Integrators that desire to have custom messages for their application must submit the message request to IDTech with the following information (all fields required)
The following data can be used as test data
Timeout is hardwired to 3 minutes
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_promptForKeyInput | ( | int | messageID, |
int | languageID, | ||
bool | maskInput, | ||
int | minLen, | ||
int | maxLen | ||
) |
Prompt for Key Input
Prompts for a numeric key using the secure message according to the following table
Msg Id | English Prompt | Portuguese Prompt | Spanish Prompt | French Prompt |
---|---|---|---|---|
1 | ENTER | ENTER | INGRESE | ENTREZ |
2 | REENTER | RE-INTRODUZIR | REINGRESE | RE-ENTREZ |
3 | ENTER YOUR | INTRODUZIR O SEU | INGRESE SU | ENTREZ VOTRE |
4 | REENTER YOUR | RE-INTRODUZIR O SEU | REINGRESE SU | RE-ENTREZ VOTRE |
5 | PLEASE ENTER | POR FAVOR DIGITE | POR FAVOR INGRESE | SVP ENTREZ |
6 | PLEASE REENTER | POR FAVO REENTRAR | POR FAVO REINGRESE | SVP RE-ENTREZ |
7 | PO NUMBER | NÚMERO PO | NUMERO PO | No COMMANDE |
8 | DRIVER ID | LICENÇA | LICENCIA | ID CONDUCTEUR |
9 | ODOMETER | ODOMETER | ODOMETRO | ODOMETRE |
10 | ID NUMBER | NÚMERO ID | NUMERO ID | No IDENT |
11 | EQUIP CODE | EQUIP CODE | CODIGO EQUIP | CODE EQUIPEMENT |
12 | DRIVERS ID | DRIVER ID | ID CONDUCTOR | ID CONDUCTEUR |
13 | JOB NUMBER | EMP NÚMERO | NUMERO EMP | No TRAVAIL |
14 | WORK ORDER | TRABALHO ORDEM | ORDEN TRABAJO | FICHE TRAVAIL |
15 | VEHICLE ID | ID VEÍCULO | ID VEHICULO | ID VEHICULE |
16 | ENTER DRIVER | ENTER DRIVER | INGRESE CONDUCTOR | ENTR CONDUCTEUR |
17 | ENTER DEPT | ENTER DEPT | INGRESE DEPT | ENTR DEPARTEMNT |
18 | ENTER PHONE | ADICIONAR PHONE | INGRESE TELEFONO | ENTR No TELEPH |
19 | ENTER ROUTE | ROUTE ADD | INGRESE RUTA | ENTREZ ROUTE |
20 | ENTER FLEET | ENTER FROTA | INGRESE FLOTA | ENTREZ PARC AUTO |
21 | ENTER JOB ID | ENTER JOB ID | INGRESE ID TRABAJO | ENTR ID TRAVAIL |
22 | ROUTE NUMBER | NÚMERO PATH | RUTA NUMERO | No ROUTE |
23 | ENTER USER ID | ENTER USER ID | INGRESE ID USUARIO | ID UTILISATEUR |
24 | FLEET NUMBER | NÚMERO DE FROTA | FLOTA NUMERO | No PARC AUTO |
25 | ENTER PRODUCT | ADICIONAR PRODUTO | INGRESE PRODUCTO | ENTREZ PRODUIT |
26 | DRIVER NUMBER | NÚMERO DRIVER | CONDUCTOR NUMERO | No CONDUCTEUR |
27 | ENTER LICENSE | ENTER LICENÇA | INGRESE LICENCIA | ENTREZ PERMIS |
28 | ENTER FLEET NO | ENTER NRO FROTA | INGRESE NRO FLOTA | ENT No PARC AUTO |
29 | ENTER CAR WASH | WASH ENTER | INGRESE LAVADO | ENTREZ LAVE-AUTO |
30 | ENTER VEHICLE | ENTER VEÍCULO | INGRESE VEHICULO | ENTREZ VEHICULE |
31 | ENTER TRAILER | TRAILER ENTER | INGRESE TRAILER | ENTREZ REMORQUE |
32 | ENTER ODOMETER | ENTER ODOMETER | INGRESE ODOMETRO | ENTREZ ODOMETRE |
33 | DRIVER LICENSE | CARTEIRA DE MOTORISTA | LICENCIA CONDUCTOR | PERMIS CONDUIRE |
34 | ENTER CUSTOMER | ENTER CLIENTE | INGRESE CLIENTE | ENTREZ CLIENT |
35 | VEHICLE NUMBER | NÚMERO DO VEÍCULO | VEHICULO NUMERO | No VEHICULE |
36 | ENTER CUST DATA | ENTER CLIENTE INFO | INGRESE INFO CLIENTE | INFO CLIENT |
37 | REENTER DRIVID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENTR ID COND |
38 | ENTER USER DATA | ENTER INFO USUÁRIO | INGRESE INFO USUARIO | INFO UTILISATEUR |
39 | ENTER CUST CODE | ENTER CODE. CLIENTE | INGRESE COD. CLIENTE | ENTR CODE CLIENT |
40 | ENTER EMPLOYEE | ENTER FUNCIONÁRIO | INGRESE EMPLEADO | ENTREZ EMPLOYE |
41 | ENTER ID NUMBER | ENTER NÚMERO ID | INGRESE NUMERO ID | ENTREZ No ID |
42 | ENTER DRIVER ID | ENTER ID DRIVER | INGRESE ID CONDUCTOR | No CONDUCTEUR |
43 | ENTER FLEET PIN | ENTER PIN FROTA | INGRESE PIN DE FLOTA | NIP PARC AUTO |
44 | ODOMETER NUMBER | NÚMERO ODOMETER | ODOMETRO NUMERO | No ODOMETRE |
45 | ENTER DRIVER LIC | ENTER DRIVER LIC | INGRESE LIC CONDUCTOR | PERMIS CONDUIRE |
46 | ENTER TRAILER NO | NRO TRAILER ENTER | INGRESE NRO TRAILER | ENT No REMORQUE |
47 | REENTER VEHICLE | REENTRAR VEÍCULO | REINGRESE VEHICULO | RE-ENTR VEHICULE |
48 | ENTER VEHICLE ID | ENTER VEÍCULO ID | INGRESE ID VEHICULO | ENTR ID VEHICULE |
49 | ENTER BIRTH DATE | INSERIR DATA NAC | INGRESE FECHA NAC | ENT DT NAISSANCE |
50 | ENTER DOB MMDDYY | ENTER FDN MMDDYY | INGRESE FDN MMDDAA | NAISSANCE MMJJAA |
51 | ENTER FLEET DATA | ENTER FROTA INFO | INGRESE INFO DE FLOTA | INFO PARC AUTO |
52 | ENTER REFERENCE | ENTER REFERÊNCIA | INGRESE REFERENCIA | ENTREZ REFERENCE |
53 | ENTER AUTH NUMBR | ENTER NÚMERO AUT | INGRESE NUMERO AUT | No AUTORISATION |
54 | ENTER HUB NUMBER | ENTER HUB NRO | INGRESE NRO HUB | ENTREZ No NOYAU |
55 | ENTER HUBOMETER | MEDIDA PARA ENTRAR HUB | INGRESE MEDIDO DE HUB | COMPTEUR NOYAU |
56 | ENTER TRAILER ID | TRAILER ENTER ID | INGRESE ID TRAILER | ENT ID REMORQUE |
57 | ODOMETER READING | QUILOMETRAGEM | LECTURA ODOMETRO | LECTURE ODOMETRE |
58 | REENTER ODOMETER | REENTRAR ODOMETER | REINGRESE ODOMETRO | RE-ENT ODOMETRE |
59 | REENTER DRIV. ID | REENTRAR DRIVER ID | REINGRESE ID CHOFER | RE-ENT ID CONDUC |
60 | ENTER CUSTOMER ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
61 | ENTER CUST. ID | ENTER CLIENTE ID | INGRESE ID CLIENTE | ENTREZ ID CLIENT |
62 | ENTER ROUTE NUM | ENTER NUM ROUTE | INGRESE NUM RUTA | ENT No ROUTE |
63 | ENTER FLEET NUM | FROTA ENTER NUM | INGRESE NUM FLOTA | ENT No PARC AUTO |
64 | FLEET PIN | FROTA PIN | PIN DE FLOTA | NIP PARC AUTO |
65 | DRIVER # | DRIVER # | CONDUCTOR # | CONDUCTEUR |
66 | ENTER DRIVER # | ENTER DRIVER # | INGRESE CONDUCTOR # | ENT # CONDUCTEUR |
67 | VEHICLE # | VEÍCULO # | VEHICULO # | # VEHICULE |
68 | ENTER VEHICLE # | ENTER VEÍCULO # | INGRESE VEHICULO # | ENT # VEHICULE |
69 | JOB # | TRABALHO # | TRABAJO # | # TRAVAIL |
70 | ENTER JOB # | ENTER JOB # | INGRESE TRABAJO # | ENTREZ # TRAVAIL |
71 | DEPT NUMBER | NÚMERO DEPT | NUMERO DEPTO | No DEPARTEMENT |
72 | DEPARTMENT # | DEPARTAMENTO # | DEPARTAMENTO # | DEPARTEMENT |
73 | ENTER DEPT # | ENTER DEPT # | INGRESE DEPTO # | ENT# DEPARTEMENT |
74 | LICENSE NUMBER | NÚMERO DE LICENÇA | NUMERO LICENCIA | No PERMIS |
75 | LICENSE # | LICENÇA # | LICENCIA # | # PERMIS |
76 | ENTER LICENSE # | ENTER LICENÇA # | INGRESE LICENCIA # | ENTREZ # PERMIS |
77 | DATA | INFO | INFO | INFO |
78 | ENTER DATA | ENTER INFO | INGRESE INFO | ENTREZ INFO |
79 | CUSTOMER DATA | CLIENTE INFO | INFO CLIENTE | INFO CLIENT |
80 | ID # | ID # | ID # | # ID |
81 | ENTER ID # | ENTER ID # | INGRESE ID # | ENTREZ # ID |
82 | USER ID | USER ID | ID USUARIO | ID UTILISATEUR |
83 | ROUTE # | ROUTE # | RUTA # | # ROUTE |
84 | ENTER ROUTE # | ADD ROUTE # | INGRESE RUTA # | ENTREZ # ROUTE |
85 | ENTER CARD NUM | ENTER NÚMERO DE CARTÃO | INGRESE NUM TARJETA | ENTREZ NO CARTE |
86 | EXP DATE(YYMM) | VALIDADE VAL (AAMM) | FECHA EXP (AAMM) | DATE EXPIR(AAMM) |
87 | PHONE NUMBER | TELEFONE | NUMERO TELEFONO | NO TEL |
88 | CVV START DATE | CVV DATA DE INÍCIO | CVV FECHA INICIO | CVV DATE DE DEBUT |
89 | ISSUE NUMBER | NÚMERO DE EMISSÃO | NUMERO DE EMISION | NO DEMISSION |
90 | START DATE (MMYY) | DATA DE INÍCIO (AAMM) | FECHA INICIO (AAMM) | DATE DE DEBUT-AAMM |
@param messageID Message (1-90) @param languageID 0=English Prompt, 1=Portuguese Prompt, 2=Spanish Prompt, 3=French Prompt @param maskInput TRUE = entry is masked with '*', FALSE = entry is displayed on keypad @param minLen Minimum input length. Cannot be less than 1 @param maxLen Maximum input length. Cannot be greater than 16 Timeout is hardwired to 3 minutes @return RETURN_CODE: Values can be parsed with errorCode.getErrorString()
RETURN_CODE IDTechSDK.IDT_L100.pin_sendBeep | ( | int | frequency, |
int | duration, | ||
string | ident = "" |
||
) |
Send Beep
Executes a beep request.
frequency | Frequency, range 200-20000Hz |
duration | Duration, range 16-65535ms |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
RETURN_CODE IDTechSDK.IDT_L100.pin_setKeypressCapture | ( | bool | showKeyValue, |
string | ident = "" |
||
) |
Set Keypress Capture Mode
If TRUE, each keypress will be broadcast with its value 0-9, B, C, E. Function completes after timeout, C, or E are received If FALSE, each keypress will generate a generic keypress notification, with final results being returned after E is pressed, or C/timeout encountered before then.
showKeyValue | TRUE = broadcast each keypress value, FALSE = only broadcast a key was pressed, not it's value. |
ident | Device ID to send command to. If not specified, current SDK default device will be used. |
|
static |
SDK Version
Returns the current version of SDK
|
static |
Set Callback
Sets the class callback
|
static |
Set Callback
Sets the class callback
my_Callback | The callback function to receive the response message from device. defined as follows. public unsafe delegate void MFCCallBack(Parameters parameters, ident); |
context | The context of the UI thread |
|
static |
Set Command Timeout
Sets the default timeout (in milliseconds) waiting for a blocking command response
milliseconds | Time |
|
static |
Use Serial Port Interface
Instructs SDK to attempt to use the Serial Port for communication with L100 using default baud rate
port | Serial Port to use. Example COM1 = 1. |
|
static |
Use Serial Port Interface with baud rate L100
port | Serial Port to use. Example COM1 = 1. |
baud | Baud rate to override default. Example 115200; |
|
static |
Use Serial Port Interface on Linux
Instructs SDK to attempt to use the Serial Port for communication with BTMag using default baud rate on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
|
static |
Use Serial Port Interface on Linux with baud rate
Instructs SDK to attempt to use the Serial Port for communication with BTPay on Linux implementations
path | Path to use. Example /dev/ttyUSB* |
baud | Baud rate to override default. Example 115200; |
|
staticget |