com.embeddedunveiled.serial.internal

Class SerialComFTDID2XXJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComFTDID2XXJNIBridge

public final class SerialComFTDID2XXJNIBridge
extends Object

This class is an interface between java and native shared library. The native library is found in 'lib-vendor' folder in 'scm-x.x.x.jar' file.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComFTDID2XXJNIBridge() Allocates a new SerialComFTDID2XXJNIBridge object.

Method Summary

Methods

Modifier and Type	Method and Description
int	clearDTR(long handle)
int	clearRTS(long handle)
int	close(long handle)
int	createDeviceInfoList()
int	cyclePort(long handle)
int	eeProgram(long handle, String manufacturer, String manufacturerID, String description, String serialNumber, int[] values)
int	eeProgramEx(long handle, String manufacturer, String manufacturerID, String description, String serialNumber, int[] values)
int	eepromProgram(long handle, int devType, int[] dataToBeWritten, String manufacturer, String manufacturerID, String description, String serialNumber)
int[]	eepromRead(long handle, int deviceType, char[] manufacturer, char[] manufacturerID, char[] description, char[] serialNumber)
int[]	eeRead(long handle, int version, char[] manufacturer, char[] manufacturerID, char[] description, char[] serialNumber)
int	eeUAread(long handle, byte[] buffer, int length)
int	eeUAsize(long handle)
int	eeUAwrite(long handle, byte[] buffer, int length)
int	eraseEE(long handle)
int	getBitMode(long handle)
long	getComPortNumber(long handle)
String[]	getDeviceInfo(long handle)
String[]	getDeviceInfoDetail(int index)
String[]	getDeviceInfoList(int numOfDevices)
long	getDriverVersion(long handle)
int	getLatencyTimer(long handle)
long	getLibraryVersion()
int	getModemStatus(long handle)
int	getQueueStatus(long handle)
long[]	getStatus(long handle)
int[]	getVidPid()
String[]	listDevices(int pvArg1, int dwFlags)
static boolean	loadNativeLibrary(File libDirectory, String vlibName, int cpuArch, int osType, SerialComSystemProperty serialComSystemProperty) Extract native library from jar in a working directory, load and link it.
long	open(int index)
long	openEx(String serialOrDescription, long locationId, int dwFlags)
int	purge(long handle, boolean purgeTxBuffer, boolean purgeRxBuffer)
int	read(long handle, byte[] buffer, int numOfBytesToRead)
int	readEE(long handle, int offset)
int	reload(int vid, int pid)
int	rescan()
int	resetDevice(long handle)
int	resetPort(long handle)
int	restartInTask(long handle)
int	setBaudRate(long handle, int baudRate)
int	setBitMode(long handle, int mask, int mode)
int	setBreakOff(long handle)
int	setBreakOn(long handle)
int	setChars(long handle, byte evch, byte even, byte erch, byte eren)
int	setDataCharacteristics(long handle, int dataBits, int stopBits, int parity)
int	setDeadmanTimeout(long handle, int count)
int	setDivisor(long handle, int divisor)
int	setDTR(long handle)
int	setEventNotificationAndWait(long handle, int eventMask)
int	setFlowControl(long handle, int flctrl, byte xonch, byte xoffch)
int	setLatencyTimer(long handle, int value)
int	setResetPipeRetryCount(long handle, int count)
int	setRTS(long handle)
int	setTimeouts(long handle, long readTimeOut, long writeTimeOut)
int	setUSBParameters(long handle, int inTransferSize, int outTransferSize)
int	setVidPid(int vid, int pid)
int	stopInTask(long handle)
int	w32ClearCommBreak(long handle)
int[]	w32ClearCommError(long handle)
int	w32CloseHandle(long handle)
long	w32CreateFile(String serialNum, String description, long location, int dwAttrsAndFlags, int dwAccess, boolean overLapped)
int	w32EscapeCommFunction(long handle, short function)
int	w32GetCommMask(long handle)
int	w32GetCommModemStatus(long handle)
int[]	w32GetCommState(long handle)
int[]	w32GetCommTimeouts(long handle)
String	w32GetLastError(long handle)
int	w32GetOverlappedResult(long handle, boolean wait)
int	w32PurgeComm(long handle, int event)
int	w32ReadFile(long handle, byte[] buffer, int numOfBytesToRead)
int	w32SetCommBreak(long handle)
int	w32SetCommMask(long handle, int flag)
int	w32SetCommState(long handle, int[] dcb)
int	w32SetCommTimeouts(long handle, int readIntervalTimeout, int readTotalTimeoutMultiplier, int readTotalTimeoutConstant, int writeTotalTimeoutMultiplier, int writeTotalTimeoutConstant)
int	w32SetupComm(long handle, int readBufSize, int writeBufSize)
int	w32WaitCommEvent(long handle, int event)
int	w32WriteFile(long handle, byte[] buffer, int numOfBytesToWrite)
int	write(long handle, byte[] buffer, int numOfBytesToWrite)
int	writeEE(long handle, int offset, int valueToWrite)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialComFTDID2XXJNIBridge

public SerialComFTDID2XXJNIBridge()

Allocates a new SerialComFTDID2XXJNIBridge object.

Method Detail

loadNativeLibrary

public static boolean loadNativeLibrary(File libDirectory,
                        String vlibName,
                        int cpuArch,
                        int osType,
                        SerialComSystemProperty serialComSystemProperty)
                                 throws UnsatisfiedLinkError,
                                        SerialComLoadException,
                                        SerialComUnexpectedException,
                                        SecurityException,
                                        FileNotFoundException

Extract native library from jar in a working directory, load and link it. The 'lib-vendor' folder in 'scm-x.x.x.jar' file is searched for the required native library for vendor specific communication. It also load vendor's native shared library.

Parameters:

libDirectory - directory in which native library will be extracted and vendor library will be found

vlibName - name of vendor library to load and link

cpuArch - architecture of CPU this library is running on

osType - operating system this library is running on

serialComSystemProperty - instance of SerialComSystemProperty to get required java properties

Throws:

SerialComUnexpectedException - if a critical java system property is null in system

SecurityException - if any java system property can not be accessed

FileNotFoundException - if the vendor library file is not found

SerialComLoadException - if any file system related issue occurs

UnsatisfiedLinkError - if loading/linking shared library fails

setVidPid

public int setVidPid(int vid,
            int pid)

getVidPid

public int[] getVidPid()

createDeviceInfoList

public int createDeviceInfoList()

getDeviceInfoList

public String[] getDeviceInfoList(int numOfDevices)

getDeviceInfoDetail

public String[] getDeviceInfoDetail(int index)

listDevices

public String[] listDevices(int pvArg1,
                   int dwFlags)

open

public long open(int index)

openEx

public long openEx(String serialOrDescription,
          long locationId,
          int dwFlags)

close

public int close(long handle)

read

public int read(long handle,
       byte[] buffer,
       int numOfBytesToRead)

write

public int write(long handle,
        byte[] buffer,
        int numOfBytesToWrite)

setBaudRate

public int setBaudRate(long handle,
              int baudRate)

setDivisor

public int setDivisor(long handle,
             int divisor)

setDataCharacteristics

public int setDataCharacteristics(long handle,
                         int dataBits,
                         int stopBits,
                         int parity)

setTimeouts

public int setTimeouts(long handle,
              long readTimeOut,
              long writeTimeOut)

setFlowControl

public int setFlowControl(long handle,
                 int flctrl,
                 byte xonch,
                 byte xoffch)

setDTR

public int setDTR(long handle)

clearDTR

public int clearDTR(long handle)

setRTS

public int setRTS(long handle)

clearRTS

public int clearRTS(long handle)

getModemStatus

public int getModemStatus(long handle)

getQueueStatus

public int getQueueStatus(long handle)

getDeviceInfo

public String[] getDeviceInfo(long handle)

getDriverVersion

public long getDriverVersion(long handle)

getLibraryVersion

public long getLibraryVersion()

getComPortNumber

public long getComPortNumber(long handle)

getStatus

public long[] getStatus(long handle)

setEventNotificationAndWait

public int setEventNotificationAndWait(long handle,
                              int eventMask)

setChars

public int setChars(long handle,
           byte evch,
           byte even,
           byte erch,
           byte eren)

setBreakOn

public int setBreakOn(long handle)

setBreakOff

public int setBreakOff(long handle)

purge

public int purge(long handle,
        boolean purgeTxBuffer,
        boolean purgeRxBuffer)

resetDevice

public int resetDevice(long handle)

resetPort

public int resetPort(long handle)

cyclePort

public int cyclePort(long handle)

rescan

public int rescan()

reload

public int reload(int vid,
         int pid)

setResetPipeRetryCount

public int setResetPipeRetryCount(long handle,
                         int count)

stopInTask

public int stopInTask(long handle)

restartInTask

public int restartInTask(long handle)

setDeadmanTimeout

public int setDeadmanTimeout(long handle,
                    int count)

readEE

public int readEE(long handle,
         int offset)

writeEE

public int writeEE(long handle,
          int offset,
          int valueToWrite)

eraseEE

public int eraseEE(long handle)

eeRead

public int[] eeRead(long handle,
           int version,
           char[] manufacturer,
           char[] manufacturerID,
           char[] description,
           char[] serialNumber)

eeProgram

public int eeProgram(long handle,
            String manufacturer,
            String manufacturerID,
            String description,
            String serialNumber,
            int[] values)

eeProgramEx

public int eeProgramEx(long handle,
              String manufacturer,
              String manufacturerID,
              String description,
              String serialNumber,
              int[] values)

eeUAsize

public int eeUAsize(long handle)

eeUAread

public int eeUAread(long handle,
           byte[] buffer,
           int length)

eeUAwrite

public int eeUAwrite(long handle,
            byte[] buffer,
            int length)

eepromRead

public int[] eepromRead(long handle,
               int deviceType,
               char[] manufacturer,
               char[] manufacturerID,
               char[] description,
               char[] serialNumber)

eepromProgram

public int eepromProgram(long handle,
                int devType,
                int[] dataToBeWritten,
                String manufacturer,
                String manufacturerID,
                String description,
                String serialNumber)

setLatencyTimer

public int setLatencyTimer(long handle,
                  int value)

getLatencyTimer

public int getLatencyTimer(long handle)

setBitMode

public int setBitMode(long handle,
             int mask,
             int mode)

getBitMode

public int getBitMode(long handle)

setUSBParameters

public int setUSBParameters(long handle,
                   int inTransferSize,
                   int outTransferSize)

w32CreateFile

public long w32CreateFile(String serialNum,
                 String description,
                 long location,
                 int dwAttrsAndFlags,
                 int dwAccess,
                 boolean overLapped)

w32CloseHandle

public int w32CloseHandle(long handle)

w32ReadFile

public int w32ReadFile(long handle,
              byte[] buffer,
              int numOfBytesToRead)

w32WriteFile

public int w32WriteFile(long handle,
               byte[] buffer,
               int numOfBytesToWrite)

w32GetOverlappedResult

public int w32GetOverlappedResult(long handle,
                         boolean wait)

w32EscapeCommFunction

public int w32EscapeCommFunction(long handle,
                        short function)

w32GetCommModemStatus

public int w32GetCommModemStatus(long handle)

w32SetupComm

public int w32SetupComm(long handle,
               int readBufSize,
               int writeBufSize)

w32SetCommState

public int w32SetCommState(long handle,
                  int[] dcb)

w32GetCommState

public int[] w32GetCommState(long handle)

w32SetCommTimeouts

public int w32SetCommTimeouts(long handle,
                     int readIntervalTimeout,
                     int readTotalTimeoutMultiplier,
                     int readTotalTimeoutConstant,
                     int writeTotalTimeoutMultiplier,
                     int writeTotalTimeoutConstant)

w32GetCommTimeouts

public int[] w32GetCommTimeouts(long handle)

w32SetCommBreak

public int w32SetCommBreak(long handle)

w32ClearCommBreak

public int w32ClearCommBreak(long handle)

w32SetCommMask

public int w32SetCommMask(long handle,
                 int flag)

w32GetCommMask

public int w32GetCommMask(long handle)

w32WaitCommEvent

public int w32WaitCommEvent(long handle,
                   int event)

w32PurgeComm

public int w32PurgeComm(long handle,
               int event)

w32GetLastError

public String w32GetLastError(long handle)

w32ClearCommError

public int[] w32ClearCommError(long handle)