IDTech Android SDK Guide  1.00.142
API reference for UniMag
com.idtechproducts.device.IDT_UniMag Class Reference

Public Member Functions

 IDT_UniMag (OnReceiverListener callback, Context context)
 
boolean device_setDeviceType (ReaderInfo.DEVICE_TYPE deviceType)
 
void registerListen ()
 
void unregisterListen ()
 
void release ()
 
String config_getSDKVersion ()
 
String config_getXMLVersionInfo ()
 
String phone_getInfoManufacture ()
 
String phone_getInfoModel ()
 
void log_setVerboseLoggingEnable (boolean enable)
 
void log_setSaveLogEnable (boolean enable)
 
int log_deleteLogs ()
 
void config_setXMLFileNameWithPath (String path)
 
boolean config_loadingConfigurationXMLFile (boolean updateAutomatically)
 
boolean device_connectWithProfile (StructConfigParameters profile)
 
boolean device_isConnected ()
 
int msr_startMSRSwipe ()
 
void msr_cancelMSRSwipe ()
 
boolean msr_isSwipeCardRunning ()
 
int autoConfig_start (String strXMLFilename)
 
void autoConfig_stop ()
 
int device_enableTDES (ResDataStruct respData)
 
int device_enableAES (ResDataStruct respData)
 
int device_calibrateReader (ResDataStruct respData)
 
int device_getFirmwareVersion (StringBuilder version)
 
int device_ReviewAudioJackSetting (ResDataStruct respData)
 
int device_sendDataCommand (String cmd, boolean calcLRC, String data, ResDataStruct respData)
 
int config_getSerialNumber (StringBuilder serialNumber)
 
int device_getKSN (ResDataStruct ksn)
 
int device_enableErrorNotification (ResDataStruct respData, boolean enable)
 
int device_enableExpDate (ResDataStruct respData, boolean enable)
 
int device_enableForceEncryption (ResDataStruct respData, boolean enable)
 
String device_getResponseCodeString (int errorCode)
 

Member Function Documentation

◆ autoConfig_start()

int com.idtechproducts.device.IDT_UniMag.autoConfig_start ( String  strXMLFilename)

start Auto Config to search the profile.

Parameters
strXMLFilenameInput the customized XML file as the templates to search the profile.
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ config_getSerialNumber()

int com.idtechproducts.device.IDT_UniMag.config_getSerialNumber ( StringBuilder  serialNumber)

Get the serial number of device.

Parameters
serialNumberreturns Serial Number string.
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ device_enableTDES()

int com.idtechproducts.device.IDT_UniMag.device_enableTDES ( ResDataStruct  respData)

enable TDES encryption.

Parameters
respDataresponse data from reader
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ device_getFirmwareVersion()

int com.idtechproducts.device.IDT_UniMag.device_getFirmwareVersion ( StringBuilder  version)

DEVICE INFO API Get the firmware version of device.

Parameters
versionfor version string.
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ device_getKSN()

int com.idtechproducts.device.IDT_UniMag.device_getKSN ( ResDataStruct  ksn)

Get the Account DUKPT Key KSN of device.

Parameters
10-byteKSN
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ device_isConnected()

boolean com.idtechproducts.device.IDT_UniMag.device_isConnected ( )

get the status if the device connected.

Returns
true: connected, false: disconnected

◆ device_ReviewAudioJackSetting()

int com.idtechproducts.device.IDT_UniMag.device_ReviewAudioJackSetting ( ResDataStruct  respData)

Retrieves Audio Jack setting.

Parameters
responseresponse[0]: baud rate of the device connected.
response[1]: level option of the device output signals.
response[2]: the number of prefix "55", and end with "66".
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ device_sendDataCommand()

int com.idtechproducts.device.IDT_UniMag.device_sendDataCommand ( String  cmd,
boolean  calcLRC,
String  data,
ResDataStruct  respData 
)

Send a direct command to device

Sends a command represented by the provide string to the device.

Parameters
cmdNSData representation of command to execute
calcLRCIf TRUE, this will wrap command with start/length/lrc/sum/end: '{STX}{Len_Low}{Len_High} data {CheckLRC} {CheckSUM} {ETX}'
dataIgnored. Not applicable for use with Augusta's NGA protocol
responseReturns response ResDataStruct.respData
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ msr_cancelMSRSwipe()

void com.idtechproducts.device.IDT_UniMag.msr_cancelMSRSwipe ( )

Disable MSR swipe card.

Cancels MSR swipe request.

Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

◆ msr_startMSRSwipe()

int com.idtechproducts.device.IDT_UniMag.msr_startMSRSwipe ( )

Enable MSR swipe card. Returns encrypted MSR data or function key value by call back function. The function swipeMSRData in interface OnReceiverListener will be called if swiping card data received.

See also
OnReceiverListener
Returns
success or error code. Values can be parsed with device_getResponseCodeString
See also
ErrorCode

The documentation for this class was generated from the following file: