![]() |
IDTech Universal SDK
1.0.35.038
API reference for C++
|
VP3300 COM API. More...
#include "IDTDef.h"
Go to the source code of this file.
Macros | |
#define | IN |
#define | OUT |
#define | IN_OUT |
Typedefs | |
typedef void(* | pMessageHotplug) (int, int) |
typedef void(* | pSendDataLog) (BYTE *, int) |
typedef void(* | pReadDataLog) (BYTE *, int) |
typedef void(* | pEMV_callBack) (int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int) |
typedef void(* | pMSR_callBack) (int, IDTMSRData) |
typedef void(* | pMSR_callBackp) (int, IDTMSRData *) |
typedef void(* | pPIN_callBack) (int, IDTPINData *) |
typedef void(* | pCMR_callBack) (int, IDTCMRData *) |
typedef void(* | pCSFS_callBack) (BYTE status) |
typedef void(* | pRKI_callBack) (int, char *) |
typedef void(* | ftpComm_callBack) (int, int, int) |
typedef void(* | httpComm_callBack) (BYTE *, int) |
typedef void(* | v4Comm_callBack) (BYTE, BYTE, BYTE *, int) |
typedef void(* | pWP_callBack) (char *, int, int) |
typedef void(* | pWN_callBack) (char *, int, int) |
Functions | |
void | registerHotplugCallBk (pMessageHotplug pMsgHotplug) |
void | registerLogCallBk (pSendDataLog pFSend, pReadDataLog pFRead) |
void | device_registerRKICallBk (pRKI_callBack pRKIf) |
void | emv_registerCallBk (pEMV_callBack pEMVf) |
void | msr_registerCallBk (pMSR_callBack pMSRf) |
void | msr_registerCallBkp (pMSR_callBackp pMSRf) |
void | ctls_registerCallBk (pMSR_callBack pCTLSf) |
void | ctls_registerCallBkp (pMSR_callBackp pCTLSf) |
void | pin_registerCallBk (pPIN_callBack pPINf) |
void | device_registerCameraCallBk (pCMR_callBack pCMRf) |
void | device_registerCardStatusFrontSwitchCallBk (pCSFS_callBack pCSFSf) |
void | comm_registerHTTPCallback (httpComm_callBack cBack) |
void | comm_registerV4Callback (v4Comm_callBack cBack) |
char * | SDK_Version () |
int | setAbsoluteLibraryPath (const char *absoluteLibraryPath) |
int | device_init () |
int | rs232_device_init (int deviceType, int port_number, int brate) |
int | device_setCurrentDevice (int deviceType) |
int | device_isAttached (int deviceType) |
int | device_close () |
void | device_getIDGStatusCodeString (IN int returnCode, OUT char *despcrition) |
int | device_isConnected () |
int | device_getFirmwareVersion (OUT char *firmwareVersion) |
int | device_getFirmwareVersion_Len (OUT char *firmwareVersion, IN_OUT int *firmwareVersionLen) |
int | device_pingDevice () |
int | device_controlUserInterface (IN BYTE *values) |
int | device_getCurrentDeviceType () |
int | device_SendDataCommandNEO (IN int cmd, IN int subCmd, IN BYTE *data, IN int dataLen, OUT BYTE *response, IN_OUT int *respLen) |
int | device_enablePassThrough (int enablePassThrough) |
int | device_setBurstMode (IN BYTE mode) |
int | device_setPollMode (IN BYTE mode) |
int | device_setMerchantRecord (int index, int enabled, char *merchantID, char *merchantURL) |
int | device_pollForToken (IN int timeout, OUT BYTE *respData, IN_OUT int *respDataLen) |
int | device_getMerchantRecord (IN int index, OUT BYTE *record) |
int | device_getMerchantRecord_Len (IN int index, OUT BYTE *record, IN_OUT int *recordLen) |
int | device_getTransactionResults (IDTMSRData *cardData) |
int | device_startTransaction (IN double amount, IN double amtOther, IN int type, IN const int _timeout, IN BYTE *tags, IN int tagsLen) |
void | device_setTransactionExponent (int exponent) |
int | device_activateTransaction (IN const int _timeout, IN BYTE *tags, IN int tagsLen) |
int | device_cancelTransaction () |
int | device_getRTCDateTime (IN BYTE *dateTime, IN_OUT int *dateTimeLen) |
int | device_setRTCDateTime (IN BYTE *dateTime, IN int dateTimeLen) |
int | device_startRKI (IN const char *caPath, IN int isProduction) |
void | device_setRKI_URL (IN char *rkiURL, IN int rkiURLLen) |
int | device_getSDKWaitTime () |
void | device_setSDKWaitTime (int waitTime) |
int | device_getThreadStackSize () |
void | device_setThreadStackSize (int threadSize) |
int | config_getSerialNumber (OUT char *sNumber) |
int | config_getSerialNumber_Len (OUT char *sNumber, IN_OUT int *sNumberLen) |
int | ctls_startTransaction (IN double amount, IN double amtOther, IN int type, IN const int _timeout, IN BYTE *tags, IN int tagsLen) |
int | ctls_activateTransaction (IN const int _timeout, IN BYTE *tags, IN int tagsLen) |
int | ctls_cancelTransaction () |
int | ctls_retrieveApplicationData (IN BYTE *AID, IN int AIDLen, OUT BYTE *tlv, IN_OUT int *tlvLen) |
int | ctls_setApplicationData (IN BYTE *tlv, IN int tlvLen) |
int | ctls_removeApplicationData (IN BYTE *AID, IN int AIDLen) |
int | ctls_removeAllApplicationData () |
int | ctls_retrieveAIDList (OUT BYTE *AIDList, IN_OUT int *AIDListLen) |
int | ctls_retrieveTerminalData (OUT BYTE *tlv, IN_OUT int *tlvLen) |
int | ctls_setTerminalData (IN BYTE *tlv, IN int tlvLen) |
int | ctls_retrieveCAPK (IN BYTE *capk, IN int capkLen, OUT BYTE *key, IN_OUT int *keyLen) |
int | ctls_setCAPK (IN BYTE *capk, IN int capkLen) |
int | ctls_removeCAPK (IN BYTE *capk, IN int capkLen) |
int | ctls_removeAllCAPK () |
int | ctls_retrieveCAPKList (OUT BYTE *keys, IN_OUT int *keysLen) |
int | ctls_setConfigurationGroup (IN BYTE *tlv, IN int tlvLen) |
int | ctls_getConfigurationGroup (IN int group, OUT BYTE *tlv, OUT int *tlvLen) |
int | ctls_getAllConfigurationGroups (OUT BYTE *tlv, IN_OUT int *tlvLen) |
int | ctls_removeConfigurationGroup (int group) |
void | emv_allowFallback (IN int allow) |
void | emv_setAutoAuthenticateTransaction (IN int authenticate) |
void | emv_setAutoCompleteTransaction (IN int complete) |
int | emv_getAutoAuthenticateTransaction () |
int | emv_getAutoCompleteTransaction () |
void | emv_setTransactionParameters (IN double amount, IN double amtOther, IN int type, IN int timeout, IN BYTE *tags, IN int tagsLen) |
int | emv_startTransaction (IN double amount, IN double amtOther, IN int exponent, IN int type, IN int timeout, IN BYTE *tags, IN int tagsLen, IN int forceOnline) |
int | emv_activateTransaction (IN int timeout, IN BYTE *tags, IN int tagsLen, IN int forceOnline) |
int | emv_authenticateTransaction (IN BYTE *updatedTLV, IN int updatedTLVLen) |
int | emv_authenticateTransactionWithTimeout (IN int timeout, IN BYTE *updatedTLV, IN int updatedTLVLen) |
int | emv_completeTransaction (IN int commError, IN BYTE *authCode, IN int authCodeLen, IN BYTE *iad, IN int iadLen, IN BYTE *tlvScripts, IN int tlvScriptsLen, IN BYTE *tlv, IN int tlvLen) |
int | emv_cancelTransaction () |
int | emv_retrieveApplicationData (IN BYTE *AID, IN int AIDLen, OUT BYTE *tlv, IN_OUT int *tlvLen) |
int | emv_setApplicationData (IN BYTE *name, IN int nameLen, IN BYTE *tlv, IN int tlvLen) |
int | emv_setApplicationDataTLV (IN BYTE *tlv, IN int tlvLen) |
int | emv_removeApplicationData (IN BYTE *AID, IN int AIDLen) |
int | emv_removeAllApplicationData () |
int | emv_retrieveAIDList (OUT BYTE *AIDList, IN_OUT int *AIDListLen) |
int | emv_retrieveTerminalData (OUT BYTE *tlv, IN_OUT int *tlvLen) |
int | emv_setTerminalData (IN BYTE *tlv, IN int tlvLen) |
int | emv_setTerminalMajorConfiguration (IN int configuration) |
int | emv_retrieveCAPK (IN BYTE *capk, IN int capkLen, OUT BYTE *key, IN_OUT int *keyLen) |
int | emv_setCAPK (IN BYTE *capk, IN int capkLen) |
int | emv_removeCAPK (IN BYTE *capk, IN int capkLen) |
int | emv_removeAllCAPK () |
int | emv_retrieveCAPKList (OUT BYTE *keys, IN_OUT int *keysLen) |
int | emv_retrieveCRL (OUT BYTE *list, IN_OUT int *lssLen) |
int | emv_setCRL (IN BYTE *list, IN int lsLen) |
int | emv_removeCRL (IN BYTE *list, IN int lsLen) |
int | emv_removeAllCRL () |
int | icc_getICCReaderStatus (OUT BYTE *status) |
int | icc_powerOnICC (OUT BYTE *ATR, IN_OUT int *inLen) |
int | icc_powerOffICC () |
int | icc_exchangeAPDU (IN BYTE *c_APDU, IN int cLen, OUT BYTE *reData, IN_OUT int *reLen) |
int | msr_cancelMSRSwipe () |
int | msr_startMSRSwipe (IN int _timeout) |
int | executeTransaction (WorldPayData *data, pWP_callBack wpCallback, int requestOnly) |
int | forwardTransaction (IN pWP_callBack wpCallback, IN char *forwardID, IN int forwardIDLen, IN char *password, IN int passwordLen, IN int bypassProcessing) |
int | cancelWorldPay () |
int | executeTransaction_WorldNet (WorldNetData *data, pWN_callBack wnCallback, int requestOnly) |
int | forwardTransaction_WorldNet (IN char *apiKey, IN int apiKeyLen, IN pWN_callBack wnCallback, IN char *forwardID, IN int forwardIDLen, IN char *password, IN int passwordLen, IN int bypassProcessing) |
int | cancelWorldNet () |
void | parseMSRData (IN BYTE *resData, IN int resLen, IN_OUT IDTMSRData *cardData) |
VP3300 COM API.
VP3300 COM Global API methods.
#define IN |
INPUT parameter.
#define IN_OUT |
INPUT / OUTPUT PARAMETER.
#define OUT |
OUTPUT parameter.
typedef void(* ftpComm_callBack) (int, int, int) |
Define the comm callback function to get FTP file transfer status
It should be passed as a parameter in a FTP request, Signature (int, int, int) = response code, current block, total blocks RESPONSE CODES: 100 = FILE DOWNLOAD STARTED 101 = FILE BLOCK XX OF XX RECEIVED 102 = FILE DOWNLOAD COMPLETED 103 = FILE DOWNLOAD TERMINATED PREMATURELY
typedef void(* httpComm_callBack) (BYTE *, int) |
Define the comm callback function to get the async url data
It should be registered using the comm_registerHTTPCallback
typedef void(* pCMR_callBack) (int, IDTCMRData *) |
Define the camera callback function to get the image data
It should be registered using the device_registerCameraCallBk,
typedef void(* pCSFS_callBack) (BYTE status) |
Define the card status and front switch callback function to get card and front switch status
It should be registered using the device_registerCardStatusFrontSwitchCallBk,
typedef void(* pEMV_callBack) (int, int, BYTE *, int, IDTTransactionData *, EMV_Callback *, int) |
Define the EMV callback function to get the transaction message/data/result.
It should be registered using the emv_registerCallBk,
typedef void(* pMessageHotplug) (int, int) |
Define the USB hot-plug callback function to monitor the info when plug in/out the reader.
It should be registered using the registerHotplugCallBk, The first integer parameter is device type, and the second integer parameter is either 0: Device Plugged Out or 1: Device Plugged In
typedef void(* pMSR_callBack) (int, IDTMSRData) |
Define the MSR callback function to get the MSR card data
It should be registered using the msr_registerCallBk, this callback function is for backward compatibility
typedef void(* pMSR_callBackp) (int, IDTMSRData *) |
Define the MSR callback function to get pointer to the MSR card data
It should be registered using the msr_registerCallBk, this callback function is recommended instead of pMSR_callBack
typedef void(* pPIN_callBack) (int, IDTPINData *) |
Define the PINPad callback function to get the input PIN Pad data
It should be registered using the pin_registerCallBk,
typedef void(* pReadDataLog) (BYTE *, int) |
Define the read response callback function to monitor the reading response from the reader.
It should be registered using the registerLogCallBk,
typedef void(* pRKI_callBack) (int, char *) |
Define the RKI callback function to get the status of the RKI
It should be registered using the device_registerRKICallBk,
typedef void(* pSendDataLog) (BYTE *, int) |
Define the send command callback function to monitor the sending command into the reader.
It should be registered using the registerLogCallBk,
typedef void(* pWN_callBack) (char *, int, int) |
Define the Worldnet callback function to get the transaction message/data/result.
typedef void(* pWP_callBack) (char *, int, int) |
Define the Worldpay callback function to get the transaction message/data/result.
typedef void(* v4Comm_callBack) (BYTE, BYTE, BYTE *, int) |
Define the comm callback function to receive the V4 Protocol packets received by the device from an external source (IP/USB/RS-232) It should be registered using the comm_registerV4Callback, Data callback will contain command, sub-command, and data from V4 packet
int cancelWorldNet | ( | ) |
Cancels WorldNet transaction.
int cancelWorldPay | ( | ) |
Cancels WorldPay transaction.
void comm_registerHTTPCallback | ( | httpComm_callBack | cBack | ) |
Register Comm HTTP Async Callback
cBack | - HTTP Comm callback |
void comm_registerV4Callback | ( | v4Comm_callBack | cBack | ) |
Register External V4 Protocol commands Callback
cBack | - V4 Protocol Comm callback |
int config_getSerialNumber | ( | OUT char * | sNumber | ) |
DEPRECATED : please use config_getSerialNumber_Len(OUT char* sNumber, IN_OUT int *sNumberLen)
Polls device for Serial Number
sNumber | Returns Serial Number; needs to have at least 64 bytes of memory |
Polls device for Serial Number
sNumber | Returns Serial Number |
sNumberLen | Length of Serial Number |
Start CTLS Transaction Request
Authorizes the CTLS 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 stream. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 |
tagsLen | The length of tags data buffer. |
>>>>>IMPORTANT: parameters for amount and amtOther MUST BE PASSED AS A DOUBLE VALUE WITH DECIMAL POINT. Example, do not pass 1, but instead pass 1.0 or 1.00. Otherwise, results will be unpredictable
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)
int ctls_cancelTransaction | ( | ) |
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
Retrieve All Configuration Groups
Returns all the Configuration Groups installed on the terminal for CTLS
tlv | The TLV elements data |
tlvLen | the length of tlv data buffer. |
Get Configuration Group
Retrieves the Configuration for the specified Group.
group | Configuration Group |
tlv | return data |
tlvLen | the length of tlv data buffer |
void ctls_registerCallBk | ( | pMSR_callBack | pCTLSf | ) |
To register the ctls callback function to get the MSR card data. (Pass NULL to disable the callback.)
void ctls_registerCallBkp | ( | pMSR_callBackp | pCTLSf | ) |
To register the ctls callback function to get the MSR card data pointer. (Pass NULL to disable the callback.)
int ctls_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data
int ctls_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK
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 |
AIDLen | the length of AID data buffer |
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
capkLen | the length of capk data buffer |
int 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 | Values can be parsed with device_getIDGStatusCodeString() |
Retrieve AID list
Returns all the AID names installed on the terminal for CTLS. .
AIDList | array of AID name byte arrays |
AIDListLen | the length of AIDList array buffer |
int ctls_retrieveApplicationData | ( | IN BYTE * | AID, |
IN int | AIDLen, | ||
OUT BYTE * | tlv, | ||
IN_OUT int * | tlvLen | ||
) |
Retrieve Application Data by AID
Retrieves the Application Data as specified by the AID name passed as a parameter.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
AIDLen | the length of AID data buffer. |
tlv | The TLV elements of the requested AID |
tlvLen | the length of tlv data buffer. |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for CTLS as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
capkLen | the length of capk data buffer |
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:
|
keyLen | the length of key data buffer |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
keysLen | the length of keys data buffer |
Retrieve Terminal Data
Retrieves the Terminal Data for CTLS. This is configuration group 0 (Tag FFEE - > FFEE0100). The terminal data can also be retrieved by ctls_getConfigurationGroup(0).
tlv | Response returned as a TLV |
tlvLen | the length of tlv data buffer |
Set Application Data by AID
Sets the Application Data for CTLS as specified by TLV data
tlv | Application data in TLV format The first tag of the TLV data must be the group number (FFE4). The second tag of the TLV data must be the AID (9F06) |
Example valid TLV, for Group #2, AID a0000000035010: "ffe401029f0607a0000000051010ffe10101ffe50110ffe30114ffe20106"
tlvLen | the length of tlv data buffer |
Set Certificate Authority Public Key
Sets the CAPK as specified by the CAKey structure
capk | 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:
|
capkLen | the length of capk data buffer |
Set Configuration Group
Sets the Configuration Group for CTLS as specified by the TLV data
tlv | Configuration Group Data in TLV format The first tag of the TLV data must be the group number (FFE4). A second tag must exist |
tlvLen | the length of tlv data buffer |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The first TLV must be Configuration Group Number (Tag FFE4). The terminal global data is group 0, so the first TLV would be FFE40100. Other groups can be defined using this method (1 or greater), and those can be retrieved with ctls_getConfigurationGroup(int group), and deleted with ctls_removeConfigurationGroup(int group). You cannot delete group 0.
tlv | TerminalData configuration file |
tlvLen | the length of tlv data buffer |
RETURN_CODE | Values can be parsed with device_getIDGStatusCodeString() |
int ctls_startTransaction | ( | IN double | amount, |
IN double | amtOther, | ||
IN int | type, | ||
IN const int | _timeout, | ||
IN BYTE * | tags, | ||
IN int | tagsLen | ||
) |
Start CTLS Transaction Request
Authorizes the CTLS transaction for an ICC card
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02) - SEE IMPORTANT NOTE BELOW |
amtOther | Other amount value, if any (tag value 9F03) - SEE IMPORTANT NOTE BELOW |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV stream. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 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. |
tagsLen | The length of tags data buffer. |
>>>>>IMPORTANT: parameters for amount and amtOther MUST BE PASSED AS A DOUBLE VALUE WITH DECIMAL POINT. Example, do not pass 1, but instead pass 1.0 or 1.00. Otherwise, results will be unpredictable
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)
Start Transaction Request
Authorizes the transaction for an MSR/CTLS/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 a TLV. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 Be sure to include 9F02 (amount)and9C (transaction type). |
tagsLen | The length of tags data buffer. |
>>>>>IMPORTANT: parameters for amount and amtOther MUST BE PASSED AS A DOUBLE VALUE WITH DECIMAL POINT. Example, do not pass 1, but instead pass 1.0 or 1.00. Otherwise, results will be unpredictable
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 device_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)
int device_cancelTransaction | ( | ) |
Disable Transaction Cancel Transaction request.
int device_close | ( | ) |
Close the device
int device_controlUserInterface | ( | IN 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.
|
int device_enablePassThrough | ( | int | enablePassThrough | ) |
Enable Pass Through
Enables Pass Through Mode for direct communication with L1 interface (power on icc, send apdu, etc).
enablePassThrough | 1 = pass through ON, 0 = pass through OFF |
int device_getCurrentDeviceType | ( | ) |
Get current active device type
int device_getFirmwareVersion | ( | OUT char * | firmwareVersion | ) |
DEPRECATED : please use device_getFirmwareVersion_Len(OUT char* firmwareVersion, IN_OUT int *firmwareVersionLen)
Polls device for Firmware Version
firmwareVersion | Response returned of Firmware Version; needs to have at least 128 bytes of memory |
Polls device for Firmware Version
firmwareVersion | Response returned of Firmware Version |
firmwareVersionLen | Length of Firmware Version |
Review the return code description.
returnCode | the response result. |
description |
the | string for description of response result |
DEPRECATED : please use device_getMerchantRecord_Len(IN int index, OUT BYTE * record, IN_OUT int *recordLen)
Get Merchant Record
Gets the merchant record for the device.
index | Merchant Record index, valid values 1-6 |
record; | needs to have at least 99 bytes of memory response data from reader. Merchant Record Index: 1 byte enabled: 1 byte Merchant ID: 32 bytes Length of Merchant URL: 1 byte Merchant URL: 64 bytes |
Get Merchant Record
Gets the merchant record for the device.
index | Merchant Record index, valid values 1-6 |
record | response data from reader. Merchant Record Index: 1 byte enabled: 1 byte Merchant ID: 32 bytes Length of Merchant URL: 1 byte Merchant URL: 64 bytes |
recordLen | Length of record |
get RTC date and time of the device
dateTime | <dateTime data>=""> is: 6 byte data for YYMMDDHHMMSS in hex. For example 0x171003102547 stands for 2017 Oct 3rd 10:25:47 |
dateTimeLen | return 6 bytes if successful |
int device_getSDKWaitTime | ( | ) |
Get SDK Wait Time
Get the SDK wait time for transactions
int device_getThreadStackSize | ( | ) |
Get Thread Stack Size
Get the stack size setting for newly created threads
int device_getTransactionResults | ( | IDTMSRData * | cardData | ) |
Get Transaction Results Gets the transaction results when the reader is functioning in "Auto Poll" mode
cardData | The transaction results |
int device_init | ( | ) |
Initial the device by USB
It will detect the device and trying connect.
The connect status can be checked by device_isConnected().
Note: after the function returns success, the function device_setCurrentDevice() has to be called to set the device type.
int device_isAttached | ( | int | deviceType | ) |
Check if the device is attached to the USB port The function device_init() must be called before this function.
deviceType,the | device type of the USB device |
int device_isConnected | ( | ) |
Check the device conntected status
int device_pingDevice | ( | ) |
Ping Device
Pings the reader. If connected, returns success. Otherwise, returns timeout.
Poll for Token
Polls for a PICC
timeout | timeout in milliseconds, must be multiple of 10 milliseconds. 30, 120, 630, or 1150 for example. |
respData | Response data will be stored in respData. 1 byte of card type, and the Serial Number (or the UID) of the PICC if available. |
respDataLen | Length of systemCode. |
void device_registerCameraCallBk | ( | pCMR_callBack | pCMRf | ) |
To register the camera callback function to get the image data. (Pass NULL to disable the callback.)
void device_registerCardStatusFrontSwitchCallBk | ( | pCSFS_callBack | pCSFSf | ) |
To register the card status and front switch callback function to get status. (Pass NULL to disable the callback.)
void device_registerRKICallBk | ( | pRKI_callBack | pRKIf | ) |
To register the RKI callback function to get the RKI status. (Pass NULL to disable the callback.)
int device_SendDataCommandNEO | ( | IN int | cmd, |
IN int | subCmd, | ||
IN BYTE * | data, | ||
IN int | dataLen, | ||
OUT BYTE * | response, | ||
IN_OUT int * | respLen | ||
) |
Send a Command to device
Sends a command to the device .
cmd | buffer of command to execute. |
cmdLen,the | length of the buffer cmd. |
data | buffer of IDG command data. |
dataLen,the | length of the buffer data. |
response | Response data |
respLen,the | length of Response data |
Sends a command to the NEO device .
cmd | command to execute. |
subCmd,sub | command to execute. |
data | buffer of NEO command data. |
dataLen,the | length of the buffer data. |
response | Response data |
respLen,the | length of Response data |
int device_setBurstMode | ( | IN BYTE | mode | ) |
Send Burst Mode
Sets the burst mode for the device.
mode | 0 = OFF, 1 = Always On, 2 = Auto Exit |
int device_setCurrentDevice | ( | int | deviceType | ) |
Sets the current device to talk to
The connect status can be checked by device_isConnected().
deviceType | Device to connect to enum DEVICE_TYPE { IDT_DEVICE_UNKNOWN=0, IDT_DEVICE_AUGUSTA_HID, IDT_DEVICE_AUGUSTA_KB, IDT_DEVICE_AUGUSTA_S_HID, IDT_DEVICE_AUGUSTA_S_KB, IDT_DEVICE_AUGUSTA_S_TTK_HID, IDT_DEVICE_SPECTRUM_PRO, IDT_DEVICE_MINISMART_II, IDT_DEVICE_L80, IDT_DEVICE_L100, IDT_DEVICE_UNIPAY, IDT_DEVICE_UNIPAY_I_V, IDT_DEVICE_VP3300_AJ, IDT_DEVICE_KIOSK_III, IDT_DEVICE_KIOSK_III_S, IDT_DEVICE_PIP_READER, IDT_DEVICE_VENDI, IDT_DEVICE_VP3300_USB, IDT_DEVICE_UNIPAY_I_V_TTK, IDT_DEVICE_VP3300_BT, IDT_DEVICE_VP8800, IDT_DEVICE_SREDKEY2_HID, IDT_DEVICE_SREDKEY2_KB, IDT_DEVICE_NEO2, IDT_DEVICE_MINISMART_II_COM = IDT_DEVICE_NEO2+5, IDT_DEVICE_SPECTRUM_PRO_COM, IDT_DEVICE_KIOSK_III_COM, IDT_DEVICE_KIOSK_III_S_COM, IDT_DEVICE_PIP_READER_COM, IDT_DEVICE_VP3300_COM, IDT_DEVICE_NEO2_COM, IDT_DEVICE_MAX_DEVICES = IDT_DEVICE_NEO2_COM+5 }; |
int device_setMerchantRecord | ( | int | index, |
int | enabled, | ||
char * | merchantID, | ||
char * | 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 |
int device_setPollMode | ( | IN BYTE | mode | ) |
Set 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 |
Set the URL for RKI
rkiURL | The URL for RKI (less than 100 characters). Pass NULL to reset to default URL |
rkiURLLen | The length of rkiURL. Pass 0 to reset to default URL |
set RTC date and time of the device
dateTime | <dateTime data>=""> is: 6 byte data for YYMMDDHHMMSS in hex. For example 0x171003102547 stands for 2017 Oct 3rd 10:25:47 |
dateTimeLen | should be always 6 bytes |
void device_setSDKWaitTime | ( | int | waitTime | ) |
Set SDK Wait Time
Set the SDK wait time for transactions
waitTime | The SDK wait time for transaction in seconds. The Maximum is 2147483 seconds. |
void device_setThreadStackSize | ( | int | threadSize | ) |
Set Thread Stack Size
Set the stack size setting for newly created threads
void device_setTransactionExponent | ( | int | exponent | ) |
Sets the transaction exponent to be used with device_startTransaction. Default value is 2
exponent,The | exponent to use when calling device_startTransaction |
Start remote key injection.
caPath | The path to ca-certificates.crt It should be NULL, because the file is not used anymore. |
isProduction | 1: The reader is a production unit, 0: The reader is not a production unit |
int device_startTransaction | ( | IN double | amount, |
IN double | amtOther, | ||
IN int | type, | ||
IN const int | _timeout, | ||
IN BYTE * | tags, | ||
IN int | tagsLen | ||
) |
Start device Transaction Request
Authorizes the transaction for an MSR/CTLS/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) |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as TLV. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 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. 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 = DFEE1A079F029F36959F37 |
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 | Tags to be included in the request. Passed as a TLV stream. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 |
tagsLen | Length of tags |
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 = DFEE1A079F029F36959F37 |
void emv_allowFallback | ( | IN int | allow | ) |
Allow fallback for EMV transactions. Default is TRUE
allow | TRUE = allow fallback, FALSE = don't allow fallback |
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.
updatedTLV | TLV stream that can be used to update the following values:
|
updatedTLVLen |
int emv_authenticateTransactionWithTimeout | ( | IN int | timeout, |
IN BYTE * | updatedTLV, | ||
IN int | updatedTLVLen | ||
) |
Authenticate EMV Transaction Request with Timeout
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.
timeout | Timeout value in seconds. |
updatedTLV | TLV stream that can be used to update the following values:
|
updatedTLVLen |
int emv_cancelTransaction | ( | ) |
Cancel EMV Transaction
Cancels the currently executing EMV transaction.
int emv_completeTransaction | ( | IN int | commError, |
IN BYTE * | authCode, | ||
IN int | authCodeLen, | ||
IN BYTE * | iad, | ||
IN int | iadLen, | ||
IN BYTE * | tlvScripts, | ||
IN int | tlvScriptsLen, | ||
IN BYTE * | tlv, | ||
IN int | tlvLen | ||
) |
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(1) if host was unreachable, or FALSE(0) 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 |
authCodeLen | the length of authCode |
iad | Issuer Authentication Data, if any. Example 0x11223344556677883030 (tag value 91). |
iadLen | the length of iadLen |
tlvScripts | 71/72 scripts, if any |
tlvScriptsLen | the length of tlvScriptsLen |
tlv | Additional TLV data to return with transaction results (if any) |
tlvLen | the length of tlv |
int emv_getAutoAuthenticateTransaction | ( | ) |
Gets auto authenticate value for EMV transactions.
int emv_getAutoCompleteTransaction | ( | ) |
Gets auto complete value for EMV transactions.
void emv_registerCallBk | ( | pEMV_callBack | pEMVf | ) |
To register the emv callback function to get the EMV processing response. (Pass NULL to disable the callback.)
int emv_removeAllApplicationData | ( | ) |
Remove All Application Data
Removes all the Application Data
int emv_removeAllCAPK | ( | ) |
Remove All Certificate Authority Public Key
Removes all the CAPK
int emv_removeAllCRL | ( | ) |
Remove All Certificate Revocation List Entries
Removes all CRLEntry entries
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 |
AIDLen | the length of AID data buffer |
Remove Certificate Authority Public Key
Removes the CAPK as specified by the RID/Index
capk | 6 byte CAPK = 5 bytes RID + 1 byte INDEX |
capkLen | the length of capk data buffer |
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 |
lssLen | the length of list data buffer |
Retrieve AID list
Returns all the AID names installed on the terminal for CTLS. .
AIDList | array of AID name byte arrays |
AIDListLen | the length of AIDList array buffer |
int emv_retrieveApplicationData | ( | IN BYTE * | AID, |
IN int | AIDLen, | ||
OUT BYTE * | tlv, | ||
IN_OUT int * | tlvLen | ||
) |
Retrieve Application Data by AID
Retrieves the Application Data as specified by the AID name passed as a parameter.
AID | Name of ApplicationID. Must be between 5 and 16 bytes |
AIDLen | the length of AID data buffer. |
tlv | The TLV elements of the requested AID |
tlvLen | the length of tlv data buffer. |
Retrieve Certificate Authority Public Key
Retrieves the CAPK for CTLS as specified by the RID/Index passed as a parameter.
capk | 6 bytes CAPK = 5 bytes RID + 1 byte Index |
capkLen | the length of capk data buffer |
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:
|
keyLen | the length of key data buffer |
Retrieve the Certificate Authority Public Key list
Returns all the CAPK RID and Index installed on the terminal.
keys | [key1][key2]...[keyn], each key 6 bytes where key = 5 bytes RID + 1 byte index |
keysLen | the length of keys data buffer |
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 |
lssLen | the length of list data buffer |
Retrieve Terminal Data
Retrieves the Terminal Data for CTLS. This is configuration group 0 (Tag FFEE - > FFEE0100). The terminal data can also be retrieved by ctls_getConfigurationGroup(0).
tlv | Response returned as a TLV |
tlvLen | the length of tlv data buffer |
Set Application Data by AID
Sets the Application Data as specified by the application name and TLV data
name | Application name, 10-32 ASCII hex characters representing 5-16 bytes Example "a0000000031010" |
nameLen | the length of name data buffer of Application name, |
tlv | Application data in TLV format |
tlvLen | the length of tlv data buffer |
Set Application Data by TLV
Sets the Application Data as specified by the 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) Example valid TLV, for Group #2, AID a0000000035010: "dfee2d01029f0607a0000000051010ffe10101ffe50110ffe30114ffe20106" |
tlvLen | the length of tlv data buffer |
void emv_setAutoAuthenticateTransaction | ( | IN int | authenticate | ) |
Enables authenticate for EMV transactions. If a emv_startTranaction results in code 0x0010 (start transaction success), then emv_authenticateTransaction can automatically execute if parameter is set to TRUE
authenticate | TRUE = auto authenticate, FALSE = manually authenticate |
void emv_setAutoCompleteTransaction | ( | IN int | complete | ) |
Enables complete for EMV transactions. If a emv_authenticateTranaction results in code 0x0004 (go online), then emv_completeTransaction can automatically execute if parameter is set to TRUE
complete | TRUE = auto complete, FALSE = manually complete |
Set Certificate Authority Public Key
Sets the CAPK as specified by the CAKey structure
capk | 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:
|
capkLen | the length of capk data buffer |
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] |
lsLen | the length of list data buffer |
Set Terminal Data
Sets the Terminal Data for CTLS as specified by the TLV. The first TLV must be Configuration Group Number (Tag FFE4). The terminal global data is group 0, so the first TLV would be FFE40100. Other groups can be defined using this method (1 or greater), and those can be retrieved with emv_getConfigurationGroup(int group), and deleted with emv_removeConfigurationGroup(int group). You cannot delete group 0.
tlv | TerminalData configuration file |
tlvLen | the length of tlv data buffer |
RETURN_CODE | Values can be parsed with device_getIDGStatusCodeString() |
int emv_setTerminalMajorConfiguration | ( | IN int | configuration | ) |
Sets the terminal major configuration in ICS .
configuration | A configuration value, range 1-23
|
void emv_setTransactionParameters | ( | IN double | amount, |
IN double | amtOther, | ||
IN int | type, | ||
IN int | timeout, | ||
IN BYTE * | tags, | ||
IN int | tagsLen | ||
) |
Set EMV Transaction Parameters
Set the parameters to be used on EMV transactions for an ICC card when Auto Poll is on
The tags will be returned in the callback routine.
amount | Transaction amount value (tag value 9F02) |
amtOther | Other amount value, if any (tag value 9F03) |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request (Maximum Length = 500 bytes). Passed as a string. Example, tag 9F0C with amount 0x000000000100 would be "9F0C06000000000100" 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. 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 = DFEE1A079F029F36959F37 |
tagsLen | the length of tags |
int emv_startTransaction | ( | IN double | amount, |
IN double | amtOther, | ||
IN int | exponent, | ||
IN int | type, | ||
IN int | timeout, | ||
IN BYTE * | tags, | ||
IN int | tagsLen, | ||
IN int | forceOnline | ||
) |
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) - SEE IMPORTANT NOTE BELOW |
amtOther | Other amount value, if any (tag value 9F03) - SEE IMPORTANT NOTE BELOW |
exponent | Number of characters after decimal point |
type | Transaction type (tag value 9C). |
timeout | Timeout value in seconds. |
tags | Any other tags to be included in the request. Passed as a TLV stream. Example, tag 9F0C with amount 0x000000000100 would be 0x9F0C06000000000100 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. |
tagsLen | Length of tags |
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 = DFEE1A079F029F36959F37 |
int executeTransaction | ( | WorldPayData * | data, |
pWP_callBack | wpCallback, | ||
int | requestOnly | ||
) |
executeTransaction Requests 3 sets of public keys: encrypting Keys, signing/validating keys, signing/validating 3rd party apps
data | WorldPay data object |
wpCallback | WorldPay callback |
requestOnly |
|
int executeTransaction_WorldNet | ( | WorldNetData * | data, |
pWN_callBack | wnCallback, | ||
int | requestOnly | ||
) |
executeTransaction_WorldNet Requests 3 sets of public keys: encrypting Keys, signing/validating keys, signing/validating 3rd party apps
data | WorldNet data object |
wnCallback | WorldNet callback |
requestOnly |
|
int forwardTransaction | ( | IN pWP_callBack | wpCallback, |
IN char * | forwardID, | ||
IN int | forwardIDLen, | ||
IN char * | password, | ||
IN int | passwordLen, | ||
IN int | bypassProcessing | ||
) |
forwardTransaction Send the saved data to WorldPay and complete the transaction.
wpCallback | WPCallback is the callback to send the results. Should the the same as executeTransaction callback. |
forwardID | = ID, which could be either unique ID or Memo. |
forwardIDLen | The length of forwardID. |
password | = password. If null/blank, no password. |
passwordLen | The length of passwordLen. |
bypassProcess | = true means read the file from disk, but don't send to WorldPay, then delete the transaction as if you did send to WorldPay. The purpose of this is to allow them to delete transactions from the storage without sending to WorldPay. |
int forwardTransaction_WorldNet | ( | IN char * | apiKey, |
IN int | apiKeyLen, | ||
IN pWN_callBack | wnCallback, | ||
IN char * | forwardID, | ||
IN int | forwardIDLen, | ||
IN char * | password, | ||
IN int | passwordLen, | ||
IN int | bypassProcessing | ||
) |
forwardTransaction_WorldNet Send the saved data to WorldNet and complete the transaction.
wnCallback | WNCallback is the callback to send the results. Should be the same as executeTransaction_WorldNet callback. |
forwardID | = ID, which could be either unique ID or Memo. |
forwardIDLen | The length of forwardID. |
password | = password. If null/blank, no password. |
passwordLen | The length of passwordLen. |
bypassProcess | = true means read the file from disk, but don't send to WorldPay, then delete the transaction as if you did send to WorldPay. The purpose of this is to allow them to delete transactions from the storage without sending to WorldPay. |
Exchange APDU with plain text For Non-SRED Augusta Only
Sends an APDU packet to the ICC. If successful, response is the APDU data in response parameter.
c_APDU | APDU data packet |
cLen | APDU data packet length |
reData | Unencrypted APDU response |
reLen | Unencrypted APDU response data length |
int icc_getICCReaderStatus | ( | OUT 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 |
int icc_powerOffICC | ( | ) |
Power Off ICC
Powers down the ICC
If Success, empty If Failure, ASCII encoded data of error string
Power On ICC
Power up the currently selected microprocessor card in the ICC reader
ATR,the | ATR data response when succeeded power on ICC, |
inLen,the | length of ATR data |
int msr_cancelMSRSwipe | ( | ) |
Disable MSR Swipe Cancels MSR swipe request.
void msr_registerCallBk | ( | pMSR_callBack | pMSRf | ) |
To register the msr callback function to get the MSR card data. (Pass NULL to disable the callback.)
void msr_registerCallBkp | ( | pMSR_callBackp | pMSRf | ) |
To register the msr callback function to get the MSR card data pointer. (Pass NULL to disable the callback.)
int msr_startMSRSwipe | ( | IN int | _timeout | ) |
Start MSR Swipe Enables MSR, waiting for swipe to occur. Allows track selection. Returns IDTMSRData instance to deviceDelegate::swipeMSRData:()
timeout | Swipe Timeout Value |
Parser the MSR data from the buffer into IDTMSTData structure
resData | MSR card data buffer |
resLen | the length of resData |
cardData | the parser result with IDTMSTData structure |
void pin_registerCallBk | ( | pPIN_callBack | pPINf | ) |
To register the pin callback function to get the PINPad data. (Pass NULL to disable the callback.)
void registerHotplugCallBk | ( | pMessageHotplug | pMsgHotplug | ) |
To register the USB HID hot-plug callback function which implemented in the application to monitor the hotplug message from the SDK.
void registerLogCallBk | ( | pSendDataLog | pFSend, |
pReadDataLog | pFRead | ||
) |
To register the log callback function which implemented in the application to monitor sending/reading data between application and reader.
int rs232_device_init | ( | int | deviceType, |
int | port_number, | ||
int | brate | ||
) |
Initial the device by RS232
It will try to connect to the device with provided deviceType, port_number, and brate.
deviceType | Device to connect to |
port_number | Port number of the device |
| 0 | ttyS0 | COM1 | | 1 | ttyS1 | COM2 | | 2 | ttyS2 | COM3 | | 3 | ttyS3 | COM4 | | 4 | ttyS4 | COM5 | | 5 | ttyS5 | COM6 | | 6 | ttyS6 | COM7 | | 7 | ttyS7 | COM8 | | 8 | ttyS8 | COM9 | | 9 | ttyS9 | COM10 | | 10 | ttyS10 | COM11 | | 11 | ttyS11 | COM12 | | 12 | ttyS12 | COM13 | | 13 | ttyS13 | COM14 | | 14 | ttyS14 | COM15 | | 15 | ttyS15 | COM16 | | 16 | ttyUSB0 | n.a. | | 17 | ttyUSB1 | n.a. | | 18 | ttyUSB2 | n.a. | | 19 | ttyUSB3 | n.a. | | 20 | ttyUSB4 | n.a. | | 21 | ttyUSB5 | n.a. | | 22 | ttyAMA0 | n.a. | | 23 | ttyAMA1 | n.a. | | 24 | ttyACM0 | n.a. | | 25 | ttyACM1 | n.a. | | 26 | rfcomm0 | n.a. | | 27 | rfcomm1 | n.a. | | 28 | ircomm0 | n.a. | | 29 | ircomm1 | n.a. | | 30 | cuau0 | n.a. | | 31 | cuau1 | n.a. | | 32 | cuau2 | n.a. | | 33 | cuau3 | n.a. | | 34 | cuaU0 | n.a. | | 35 | cuaU1 | n.a. | | 36 | cuaU2 | n.a. | | 37 | cuaU3 | n.a. |
brate | Bitrate of the device |
char* SDK_Version | ( | ) |
To Get SDK version
int setAbsoluteLibraryPath | ( | const char * | absoluteLibraryPath | ) |
Set the path to use when searching for ID TECH's libraries. If this is not set, the libraries will be searched for with the system's default procedures.
absoluteLibraryPath | The absolute path to ID TECH's libraries. |