com.embeddedunveiled.serial.internal

Class SerialComPortJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComPortJNIBridge

public final class SerialComPortJNIBridge
extends Object

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

Author:

Rishi Gupta

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	clearPortIOBuffers(long handle, boolean rxPortbuf, boolean txPortbuf)
int	closeComPort(long handle)
int	configureComPortControl(long handle, int flowctrl, byte xonCh, byte xoffCh, boolean ParFraError, boolean overFlowErr)
int	configureComPortData(long handle, int dataBits, int stopBits, int parity, int baudRateTranslated, int custBaudTranslated)
long	createBlockingIOContext()
int	destroyBlockingIOContext(long context)
int	destroyDataLooperThread(long handle)
int	destroyEventLooperThread(long handle)
String[]	findComPortFromUSBAttribute(int usbVidToMatch, int usbPidToMatch, String serialNumber)
String[]	findComPortFromUSBAttributes(int usbVidToMatch, int usbPidToMatch, String serialNumber)
String	findDriverServingComPort(String comPortName)
String	findIRQnumberForComPort(long handle)
int	fineTuneRead(long handle, int vmin, int vtime, int rit, int rttm, int rttc)
int[]	getByteCount(long handle)
String[]	getCDCUSBDevPowerInfo(String portNameVal)
int[]	getCurrentConfigurationU(long handle)
String[]	getCurrentConfigurationW(long handle)
String[]	getFirmwareRevisionNumber(int vid, int pid, String serialNumber)
int[]	getInterruptCount(long handle)
int	getLatencyTimer(String comPort)
int[]	getLinesStatus(long handle)
String	getNativeLibraryVersion()
int	initNativeLib()
long	ioctlExecuteOperation(long handle, long operationCode)
long	ioctlGetValue(long handle, long operationCode)
long	ioctlSetValue(long handle, long operationCode, long value)
long	ioctlSetValueCharArray(long handle, long operationCode, byte[] values)
long	ioctlSetValueIntArray(long handle, long operationCode, int[] values)
int	isUSBDevConnected(int vendorID, int productID, String serialNumber)
String[]	listAvailableComPorts()
String[]	listBTSPPDevNodesWithInfo()
String[]	listUSBdevicesWithInfo(int vendorFilter)
static boolean	loadNativeLibrary(String directoryPath, String loadedLibName, SerialComSystemProperty serialComSystemProperty, int osType, int cpuArch, int javaABIType) Extract native library from jar in a working directory, load and link it.
long	openComPort(String portName, boolean enableRead, boolean enableWrite, boolean exclusiveOwner)
int	pauseListeningEvents(long handle)
byte[]	readBytes(long handle, int byteCount)
byte[]	readBytesBlocking(long handle, int byteCount, long context)
int	readBytesDirect(long handle, ByteBuffer buffer, int offset, int length)
int	readBytesP(long handle, byte[] buffer, int offset, int length, long context)
int	registerUSBHotPlugEventListener(ISerialComUSBHotPlugListener hotPlugListener, int filterVID, int filterPID, String serialNumber)
int	rescanUSBDevicesHW()
int	resumeListeningEvents(long handle)
int	sendBreak(long handle, int duration)
int	setDTR(long handle, boolean enabled)
int	setLatencyTimer(String comPort, byte timerValue)
int	setRTS(long handle, boolean enabled)
int	setUpDataLooperThread(long handle, SerialComLooper looper)
int	setUpEventLooperThread(long handle, SerialComLooper looper)
int	unblockBlockingIOOperation(long context)
int	unregisterUSBHotPlugEventListener(int index)
int	writeBytes(long handle, byte[] buffer, int delay)
int	writeBytesDirect(long handle, ByteBuffer buffer, int offset, int length)
int	writeSingleByte(long handle, byte dataByte)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComPortJNIBridge

public SerialComPortJNIBridge()

Allocates a new SerialComPortJNIBridge object.

Method Detail

loadNativeLibrary

public static boolean loadNativeLibrary(String directoryPath,
                        String loadedLibName,
                        SerialComSystemProperty serialComSystemProperty,
                        int osType,
                        int cpuArch,
                        int javaABIType)
                                 throws SecurityException,
                                        SerialComUnexpectedException,
                                        SerialComLoadException,
                                        UnsatisfiedLinkError

Extract native library from jar in a working directory, load and link it. The 'lib-tty' folder in 'scm-x.x.x.jar' file is searched for the required native library for serial port communication.

Parameters:

directoryPath - null for default directory or user supplied directory path

loadedLibName - null for default name or user supplied name of loaded library

serialComSystemProperty - instance of SerialComSystemProperty to get required java properties

cpuArch - architecture of CPU this library is running on

osType - operating system this library is running on

javaABIType - binary application interface type to correctly link

Throws:

SecurityException - if java system properties can not be accessed

SerialComUnexpectedException - if java system property is null

SerialComLoadException - if any file system related issue occurs

UnsatisfiedLinkError - if loading/linking shared library fails

initNativeLib

public int initNativeLib()

getNativeLibraryVersion

public String getNativeLibraryVersion()

listAvailableComPorts

public String[] listAvailableComPorts()

setUpDataLooperThread

public int setUpDataLooperThread(long handle,
                        SerialComLooper looper)

setUpEventLooperThread

public int setUpEventLooperThread(long handle,
                         SerialComLooper looper)

destroyDataLooperThread

public int destroyDataLooperThread(long handle)

destroyEventLooperThread

public int destroyEventLooperThread(long handle)

pauseListeningEvents

public int pauseListeningEvents(long handle)

resumeListeningEvents

public int resumeListeningEvents(long handle)

openComPort

public long openComPort(String portName,
               boolean enableRead,
               boolean enableWrite,
               boolean exclusiveOwner)

closeComPort

public int closeComPort(long handle)

readBytes

public byte[] readBytes(long handle,
               int byteCount)

readBytesP

public int readBytesP(long handle,
             byte[] buffer,
             int offset,
             int length,
             long context)

readBytesBlocking

public byte[] readBytesBlocking(long handle,
                       int byteCount,
                       long context)

readBytesDirect

public int readBytesDirect(long handle,
                  ByteBuffer buffer,
                  int offset,
                  int length)

writeBytes

public int writeBytes(long handle,
             byte[] buffer,
             int delay)

writeBytesDirect

public int writeBytesDirect(long handle,
                   ByteBuffer buffer,
                   int offset,
                   int length)

writeSingleByte

public int writeSingleByte(long handle,
                  byte dataByte)

createBlockingIOContext

public long createBlockingIOContext()

unblockBlockingIOOperation

public int unblockBlockingIOOperation(long context)

destroyBlockingIOContext

public int destroyBlockingIOContext(long context)

setRTS

public int setRTS(long handle,
         boolean enabled)

setDTR

public int setDTR(long handle,
         boolean enabled)

getLinesStatus

public int[] getLinesStatus(long handle)

getInterruptCount

public int[] getInterruptCount(long handle)

findDriverServingComPort

public String findDriverServingComPort(String comPortName)

findIRQnumberForComPort

public String findIRQnumberForComPort(long handle)

sendBreak

public int sendBreak(long handle,
            int duration)

getByteCount

public int[] getByteCount(long handle)

clearPortIOBuffers

public int clearPortIOBuffers(long handle,
                     boolean rxPortbuf,
                     boolean txPortbuf)

registerUSBHotPlugEventListener

public int registerUSBHotPlugEventListener(ISerialComUSBHotPlugListener hotPlugListener,
                                  int filterVID,
                                  int filterPID,
                                  String serialNumber)

unregisterUSBHotPlugEventListener

public int unregisterUSBHotPlugEventListener(int index)

configureComPortData

public int configureComPortData(long handle,
                       int dataBits,
                       int stopBits,
                       int parity,
                       int baudRateTranslated,
                       int custBaudTranslated)

configureComPortControl

public int configureComPortControl(long handle,
                          int flowctrl,
                          byte xonCh,
                          byte xoffCh,
                          boolean ParFraError,
                          boolean overFlowErr)

getCurrentConfigurationU

public int[] getCurrentConfigurationU(long handle)

getCurrentConfigurationW

public String[] getCurrentConfigurationW(long handle)

fineTuneRead

public int fineTuneRead(long handle,
               int vmin,
               int vtime,
               int rit,
               int rttm,
               int rttc)

ioctlExecuteOperation

public long ioctlExecuteOperation(long handle,
                         long operationCode)

ioctlSetValue

public long ioctlSetValue(long handle,
                 long operationCode,
                 long value)

ioctlGetValue

public long ioctlGetValue(long handle,
                 long operationCode)

ioctlSetValueIntArray

public long ioctlSetValueIntArray(long handle,
                         long operationCode,
                         int[] values)

ioctlSetValueCharArray

public long ioctlSetValueCharArray(long handle,
                          long operationCode,
                          byte[] values)

listUSBdevicesWithInfo

public String[] listUSBdevicesWithInfo(int vendorFilter)

isUSBDevConnected

public int isUSBDevConnected(int vendorID,
                    int productID,
                    String serialNumber)

getCDCUSBDevPowerInfo

public String[] getCDCUSBDevPowerInfo(String portNameVal)

setLatencyTimer

public int setLatencyTimer(String comPort,
                  byte timerValue)

getLatencyTimer

public int getLatencyTimer(String comPort)

rescanUSBDevicesHW

public int rescanUSBDevicesHW()

getFirmwareRevisionNumber

public String[] getFirmwareRevisionNumber(int vid,
                                 int pid,
                                 String serialNumber)

findComPortFromUSBAttributes

public String[] findComPortFromUSBAttributes(int usbVidToMatch,
                                    int usbPidToMatch,
                                    String serialNumber)

findComPortFromUSBAttribute

public String[] findComPortFromUSBAttribute(int usbVidToMatch,
                                   int usbPidToMatch,
                                   String serialNumber)

listBTSPPDevNodesWithInfo

public String[] listBTSPPDevNodesWithInfo()