com.serialpundit.usb.internal

Class SerialComUSBJNIBridge

java.lang.Object

com.serialpundit.usb.internal.SerialComUSBJNIBridge

public final class SerialComUSBJNIBridge
extends Object

This class is an interface between java and native shared library. The native library is found in the root of 'sp-usb.jar' file. Library will be spusblnxx64.so etc.

Author:

Rishi Gupta

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String[]	findComPortFromUSBAttribute(int usbVidToMatch, int usbPidToMatch, String serialNumber)
String[]	findComPortFromUSBAttributes(int usbVidToMatch, int usbPidToMatch, String serialNumber)
String[]	getCDCUSBDevPowerInfo(String portNameVal)
String[]	getFirmwareRevisionNumber(int vid, int pid, String serialNumber)
int	getLatencyTimer(String comPort)
void	initNativeLib()
int	isUSBDevConnected(int vendorID, int productID, String serialNumber)
String[]	listUSBdevicesWithInfo(int vendorFilter)
String[]	listUSBHIDdevicesWithInfo(int vendorFilter)
static boolean	loadNativeLibrary(String directoryPath, String loadedLibName, com.serialpundit.core.SerialComSystemProperty serialComSystemProperty, int osType, int cpuArch, int abitype) Extract native library from jar in a 'directoryPath' directory, load and link it.
int	registerUSBHotPlugEventListener(ISerialComUSBHotPlugListener hotPlugListener, int filterVID, int filterPID, String serialNumber)
int	setLatencyTimer(String comPort, byte timerValue)
int	unregisterUSBHotPlugEventListener(int index)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComUSBJNIBridge

public SerialComUSBJNIBridge()

Allocates a new SerialComUSBJNIBridge object.

Method Detail

loadNativeLibrary

public static boolean loadNativeLibrary(String directoryPath,
                        String loadedLibName,
                        com.serialpundit.core.SerialComSystemProperty serialComSystemProperty,
                        int osType,
                        int cpuArch,
                        int abitype)
                                 throws com.serialpundit.core.SerialComException

Extract native library from jar in a 'directoryPath' directory, load and link it. Native library is found in the root of 'sp-usb.jar' file.

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.

abitype - binary application interface type to correctly link.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if java system properties can not be accessed or required files can not be accessed, if shared library is not found, it can not be loaded, linked and initialized etc.

findComPortFromUSBAttribute

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

initNativeLib

public void initNativeLib()

listUSBdevicesWithInfo

public String[] listUSBdevicesWithInfo(int vendorFilter)

getFirmwareRevisionNumber

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

registerUSBHotPlugEventListener

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

unregisterUSBHotPlugEventListener

public int unregisterUSBHotPlugEventListener(int index)

isUSBDevConnected

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

findComPortFromUSBAttributes

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

getCDCUSBDevPowerInfo

public String[] getCDCUSBDevPowerInfo(String portNameVal)

setLatencyTimer

public int setLatencyTimer(String comPort,
                  byte timerValue)

getLatencyTimer

public int getLatencyTimer(String comPort)

listUSBHIDdevicesWithInfo

public String[] listUSBHIDdevicesWithInfo(int vendorFilter)