com.embeddedunveiled.serial.internal

Class SerialComHIDJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComHIDJNIBridge

public final class SerialComHIDJNIBridge
extends Object

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

Author:

Rishi Gupta

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	closeHidDeviceR(long handle)
long	createBlockingHIDIOContextR()
int	destroyBlockingIOContextR(long context)
String	findDriverServingHIDDeviceR(String hidDeviceNode)
int	flushInputReportQueueR(long handle)
int	getFeatureReportR(long handle, byte reportId, byte[] report, int length)
String	getIndexedStringR(long handle, int index)
String	getManufacturerStringR(long handle)
byte[]	getPhysicalDescriptorR(long handle)
String	getProductStringR(long handle)
byte[]	getReportDescriptorR(long handle)
String	getSerialNumberStringR(long handle)
int	initNativeLib()
String[]	listHIDdevicesWithInfoR()
String[]	listUSBHIDdevicesWithInfo(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	openHidDeviceByPathR(String pathNameVal, boolean shared)
long	openHidDeviceByUSBAttributes(int usbVidToMatch, int usbPidToMatch, String serialNum, int locationID, int usbBusNumber, int usbDevNumber)
long	openHidDeviceR(String pathNameVal, boolean shared, int osType)
int	readInputReportR(long handle, byte[] reportBuffer, int length, long context)
int	readInputReportWithTimeoutR(long handle, byte[] reportBuffer, int length, int timeoutValue)
int	readPlatformSpecificInputReportR(long handle, byte reportId, byte[] reportBuffer, int length)
int	sendFeatureReportR(long handle, byte reportId, byte[] report, int length)
int	unblockBlockingHIDIOOperationR(long context)
int	writeOutputReportR(long handle, byte reportId, byte[] report, int length)
int	writePlatformSpecificOutputReportR(long handle, byte reportId, byte[] reportBuffer, int length)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComHIDJNIBridge

public SerialComHIDJNIBridge()

Allocates a new SerialComHIDJNIBridge 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-hid' folder in 'scm-x.x.x.jar' file is searched for the required native library for communication with HID device.

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()

listUSBHIDdevicesWithInfo

public String[] listUSBHIDdevicesWithInfo(int vendorFilter)

openHidDeviceByUSBAttributes

public long openHidDeviceByUSBAttributes(int usbVidToMatch,
                                int usbPidToMatch,
                                String serialNum,
                                int locationID,
                                int usbBusNumber,
                                int usbDevNumber)

openHidDeviceR

public long openHidDeviceR(String pathNameVal,
                  boolean shared,
                  int osType)

openHidDeviceByPathR

public long openHidDeviceByPathR(String pathNameVal,
                        boolean shared)

closeHidDeviceR

public int closeHidDeviceR(long handle)

createBlockingHIDIOContextR

public long createBlockingHIDIOContextR()

unblockBlockingHIDIOOperationR

public int unblockBlockingHIDIOOperationR(long context)

destroyBlockingIOContextR

public int destroyBlockingIOContextR(long context)

writeOutputReportR

public int writeOutputReportR(long handle,
                     byte reportId,
                     byte[] report,
                     int length)

readInputReportR

public int readInputReportR(long handle,
                   byte[] reportBuffer,
                   int length,
                   long context)

readInputReportWithTimeoutR

public int readInputReportWithTimeoutR(long handle,
                              byte[] reportBuffer,
                              int length,
                              int timeoutValue)

readPlatformSpecificInputReportR

public int readPlatformSpecificInputReportR(long handle,
                                   byte reportId,
                                   byte[] reportBuffer,
                                   int length)

writePlatformSpecificOutputReportR

public int writePlatformSpecificOutputReportR(long handle,
                                     byte reportId,
                                     byte[] reportBuffer,
                                     int length)

sendFeatureReportR

public int sendFeatureReportR(long handle,
                     byte reportId,
                     byte[] report,
                     int length)

getFeatureReportR

public int getFeatureReportR(long handle,
                    byte reportId,
                    byte[] report,
                    int length)

listHIDdevicesWithInfoR

public String[] listHIDdevicesWithInfoR()

getManufacturerStringR

public String getManufacturerStringR(long handle)

getProductStringR

public String getProductStringR(long handle)

getSerialNumberStringR

public String getSerialNumberStringR(long handle)

getIndexedStringR

public String getIndexedStringR(long handle,
                       int index)

findDriverServingHIDDeviceR

public String findDriverServingHIDDeviceR(String hidDeviceNode)

flushInputReportQueueR

public int flushInputReportQueueR(long handle)

getReportDescriptorR

public byte[] getReportDescriptorR(long handle)

getPhysicalDescriptorR

public byte[] getPhysicalDescriptorR(long handle)