com.embeddedunveiled.serial.internal.SerialComPortJNIBridge Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
* Author : Rishi Gupta
*
* This file is part of 'serial communication manager' library.
* Copyright (C) <2014-2016>
*
* This 'serial communication manager' is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* The 'serial communication manager' is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with 'serial communication manager'. If not, see 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.
*
* In Linux/Windows/Solaris it is possible to run 32 bit JVM on 64 bit OS, while perhaps in mac os x
* JVM must match with underlying OS architecture. Whether 32 or 64 bit scm-dll/so file is to be loaded,
* is decided by arch of JVM this process is running on. This library included both 32 and 64 bit dll/so
* and therefore 32 bit application using this library with 32 JVM can be run on a 64 bit OS system.
*
* @author Rishi Gupta
*/
public final class SerialComPortJNIBridge {
private static final Comparator comparator = new Comparator() {
@Override
public int compare(final String valueA, final String valueB) {
if(valueA.equalsIgnoreCase(valueB)){
return valueA.compareTo(valueB);
}
int al = valueA.length();
int bl = valueB.length();
int minLength = (al <= bl) ? al : bl;
int shiftA = 0;
int shiftB = 0;
for(int i = 0; i < minLength; i++){
char charA = valueA.charAt(i - shiftA);
char charB = valueB.charAt(i - shiftB);
if(charA != charB){
if(Character.isDigit(charA) && Character.isDigit(charB)){
int[] resultsA = {-1, (i - shiftA)};
String numVal = "";
for(int x = (i - shiftA); x < al; x++){
resultsA[1] = x;
char c = valueA.charAt(x);
if(Character.isDigit(c)){
numVal += c;
}else {
break;
}
}
try {
resultsA[0] = Integer.valueOf(numVal);
} catch (Exception e) {
//Do nothing
}
int[] resultsB = {-1, (i - shiftB)};
numVal = "";
for(int x = (i - shiftB); x < bl; x++){
resultsB[1] = x;
char c = valueB.charAt(x);
if(Character.isDigit(c)){
numVal += c;
}else {
break;
}
}
try {
resultsB[0] = Integer.valueOf(numVal);
} catch (Exception e) {
//Do nothing
}
if(resultsA[0] != resultsB[0]){
return resultsA[0] - resultsB[0];
}
if(al < bl){
i = resultsA[1];
shiftB = resultsA[1] - resultsB[1];
}else {
i = resultsB[1];
shiftA = resultsB[1] - resultsA[1];
}
}else {
if(Character.toLowerCase(charA) - Character.toLowerCase(charB) != 0){
return Character.toLowerCase(charA) - Character.toLowerCase(charB);
}
}
}
}
return valueA.compareToIgnoreCase(valueB);
}
};
/**
* Allocates a new SerialComPortJNIBridge object.
*/
public SerialComPortJNIBridge() {
}
/**
* 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.
*
* @param directoryPath null for default directory or user supplied directory path
* @param loadedLibName null for default name or user supplied name of loaded library
* @param serialComSystemProperty instance of SerialComSystemProperty to get required java properties
* @param cpuArch architecture of CPU this library is running on
* @param osType operating system this library is running on
* @param javaABIType binary application interface type to correctly link
* @throws SecurityException if java system properties can not be accessed
* @throws SerialComUnexpectedException if java system property is null
* @throws SerialComLoadException if any file system related issue occurs
* @throws UnsatisfiedLinkError if loading/linking shared library fails
*/
public static boolean loadNativeLibrary(String directoryPath, String loadedLibName, SerialComSystemProperty serialComSystemProperty,
int osType, int cpuArch, int javaABIType) throws SerialComUnexpectedException, SerialComLoadException {
String javaTmpDir = null;
String userHomeDir = null;
String fileSeparator = null;
File baseDir = null;
File workingDir = null;
boolean isTmpDir = false;
boolean isUserHomeDir = false;
String libToExtractFromJar = null;
File libFile = null;
String libExtension = null;
InputStream input = null;
FileOutputStream output = null;
fileSeparator = serialComSystemProperty.getfileSeparator();
if(fileSeparator == null) {
throw new SerialComUnexpectedException("The file.separator java system property is null in the system !");
}
/* Prepare directory in which native shared library will be extracted from jar */
if(directoryPath == null) {
// user did not supplied any directory path so try tmp and user home
javaTmpDir = serialComSystemProperty.getJavaIOTmpDir();
if(javaTmpDir == null) {
throw new SerialComUnexpectedException("The java.io.tmpdir java system property is null in the system !");
}
baseDir = new File(javaTmpDir);
if(baseDir.exists() && baseDir.isDirectory() && baseDir.canWrite()) {
isTmpDir = true;
// temp directory will be used
}else {
// access to temp directory failed, let us try access to user's home directory
userHomeDir = serialComSystemProperty.getUserHome();
if(userHomeDir == null) {
throw new SerialComUnexpectedException("The user.home java system property is null in the system !");
}
baseDir = new File(userHomeDir);
if(!baseDir.exists()) {
throw new SerialComLoadException("User home directory does not exist. Also unable to access tmp/temp directory !");
}
if(!baseDir.isDirectory()) {
throw new SerialComLoadException("User home directory is not a directory. Also unable to access tmp/temp directory !");
}
if(!baseDir.canWrite()) {
throw new SerialComLoadException("User home directory is not writeable (permissions ??). Also unable to access tmp/temp directory !");
}
isUserHomeDir = true;
}
// for tmp or user home create unique directory inside them for our use only
workingDir = new File(baseDir.toString() + fileSeparator + "scm_tuartx1");
if(!workingDir.exists()) {
if(!workingDir.mkdir()) {
if(isTmpDir == true) {
throw new SerialComLoadException("Can not create scm_tuartx1 unique directory in temp directory !");
}else if(isUserHomeDir == true) {
throw new SerialComLoadException("Can not create scm_tuartx1 unique directory in user home directory !");
}else {
}
}
}
}else {
// user specified directory, so try it
baseDir = new File(directoryPath);
if(!baseDir.exists()) {
throw new SerialComLoadException("Given " + directoryPath + " directory does not exist !");
}
if(!baseDir.isDirectory()) {
throw new SerialComLoadException("Given " + directoryPath + " is not a directory !");
}
if(!baseDir.canWrite()) {
throw new SerialComLoadException("Given " + directoryPath + " directory is not writeable !");
}
// for user specified directory base itself will be working directory
workingDir = baseDir;
}
/* Find the native library that will be extracted based on arch and os type */
if(cpuArch == SerialComManager.ARCH_AMD64) {
switch(osType) {
case SerialComManager.OS_WINDOWS:
libToExtractFromJar = "windows_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.dll";
libExtension = ".dll";
break;
case SerialComManager.OS_LINUX:
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.so";
libExtension = ".so";
break;
case SerialComManager.OS_MAC_OS_X:
libToExtractFromJar = "mac_" + SerialComManager.JAVA_LIB_VERSION + "_x86_64.dylib";
libExtension = ".dylib";
break;
default :
}
}else if(cpuArch == SerialComManager.ARCH_X86) {
switch(osType) {
case SerialComManager.OS_WINDOWS:
libToExtractFromJar = "windows_" + SerialComManager.JAVA_LIB_VERSION + "_x86.dll";
libExtension = ".dll";
break;
case SerialComManager.OS_LINUX:
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_x86.so";
libExtension = ".so";
break;
case SerialComManager.OS_MAC_OS_X:
libToExtractFromJar = "mac_" + SerialComManager.JAVA_LIB_VERSION + "_x86.dylib";
libExtension = ".dylib";
break;
default :
}
}else if(cpuArch == SerialComManager.ARCH_ARMV7) {
if(osType == SerialComManager.OS_LINUX) {
libExtension = ".so";
if(javaABIType == SerialComManager.ABI_ARMHF) {
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_armv7hf.so";
}else if(javaABIType == SerialComManager.ABI_ARMEL) {
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_armv7el.so";
}else {
}
}
}else if(cpuArch == SerialComManager.ARCH_ARMV6) {
if(osType == SerialComManager.OS_LINUX) {
libExtension = ".so";
if(javaABIType == SerialComManager.ABI_ARMHF) {
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_armv6hf.so";
}else if(javaABIType == SerialComManager.ABI_ARMEL) {
libToExtractFromJar = "linux_" + SerialComManager.JAVA_LIB_VERSION + "_armv6el.so";
}else {
}
}
}else {
throw new SerialComLoadException("This architecture is unknown to this library. Please contact us !");
}
/* Extract shared library from jar into working directory */
try {
if(loadedLibName == null) {
libFile = new File(workingDir.getAbsolutePath() + fileSeparator + libToExtractFromJar);
}else {
libFile = new File(workingDir.getAbsolutePath() + fileSeparator + loadedLibName.trim() + libExtension);
}
input = SerialComPortJNIBridge.class.getResourceAsStream("/lib-tty/" + libToExtractFromJar);
output = new FileOutputStream(libFile);
if(input != null) {
int read;
byte[] buffer = new byte[4096];
while((read = input.read(buffer)) != -1){
output.write(buffer, 0, read);
}
output.flush();
output.close();
output = null;
if((libFile != null) && libFile.exists() && libFile.isFile()) {
// congratulations successfully extracted
}else {
throw new SerialComLoadException("Can not extract native shared library " + libToExtractFromJar + " from scm-x.x.x.jar file !");
}
}else {
throw new SerialComLoadException("Can not get shared library " + libToExtractFromJar + " resource as stream from scm-x.x.x.jar file using class loader !");
}
} catch (Exception e) {
throw (SerialComLoadException) new SerialComLoadException(libFile.toString()).initCause(e);
} finally {
try {
if(output != null) {
output.close();
}
} catch (Exception e) {
// ignore
}
try {
if(input != null) {
input.close();
}
} catch (Exception e) {
// ignore
}
}
/* Try loading the dynamic shared library from the local file system finally */
try {
System.load(libFile.toString());
} catch (Exception e) {
throw (UnsatisfiedLinkError) new UnsatisfiedLinkError("Could not load " + libFile.toString() + " native library !").initCause(e);
}
return true;
}
public native int initNativeLib();
public native String getNativeLibraryVersion();
public native String[] listAvailableComPorts();
public native int setUpDataLooperThread(long handle, SerialComLooper looper);
public native int setUpEventLooperThread(long handle, SerialComLooper looper);
public native int destroyDataLooperThread(long handle);
public native int destroyEventLooperThread(long handle);
public native int pauseListeningEvents(long handle);
public native int resumeListeningEvents(long handle);
// Open-close-read-write
public native long openComPort(String portName, boolean enableRead, boolean enableWrite, boolean exclusiveOwner);
public native int closeComPort(long handle);
public native byte[] readBytes(long handle, int byteCount);
public native int readBytesP(long handle, byte[] buffer, int offset, int length, long context);
public native byte[] readBytesBlocking(long handle, int byteCount, long context);
public native int readBytesDirect(long handle, ByteBuffer buffer, int offset, int length);
public native int writeBytes(long handle, byte[] buffer, int delay);
public native int writeBytesDirect(long handle, ByteBuffer buffer, int offset, int length);
public native int writeSingleByte(long handle, byte dataByte);
public native long createBlockingIOContext();
public native int unblockBlockingIOOperation(long context);
public native int destroyBlockingIOContext(long context);
// Modem control, buffer
public native int setRTS(long handle, boolean enabled);
public native int setDTR(long handle, boolean enabled);
public native int[] getLinesStatus(long handle);
public native int[] getInterruptCount(long handle);
public native String findDriverServingComPort(String comPortName);
public native String findIRQnumberForComPort(long handle);
public native int sendBreak(long handle, int duration);
public native int[] getByteCount(long handle);
public native int clearPortIOBuffers(long handle, boolean rxPortbuf, boolean txPortbuf);
// Hot-plug
public native int registerUSBHotPlugEventListener(ISerialComUSBHotPlugListener hotPlugListener, int filterVID, int filterPID, String serialNumber);
public native int unregisterUSBHotPlugEventListener(int index);
// Configuration
public native int configureComPortData(long handle, int dataBits, int stopBits, int parity, int baudRateTranslated, int custBaudTranslated);
public native int configureComPortControl(long handle, int flowctrl, byte xonCh, byte xoffCh, boolean ParFraError, boolean overFlowErr);
public native int[] getCurrentConfigurationU(long handle);
public native String[] getCurrentConfigurationW(long handle);
public native int fineTuneRead(long handle, int vmin, int vtime, int rit, int rttm, int rttc);
// IOCTL
public native long ioctlExecuteOperation(long handle, long operationCode);
public native long ioctlSetValue(long handle, long operationCode, long value);
public native long ioctlGetValue(long handle, long operationCode);
public native long ioctlSetValueIntArray(long handle, long operationCode, int[] values);
public native long ioctlSetValueCharArray(long handle, long operationCode, byte[] values);
// USB
public native String[] listUSBdevicesWithInfo(int vendorFilter);
public native int isUSBDevConnected(int vendorID, int productID, String serialNumber);
public native String[] getCDCUSBDevPowerInfo(String portNameVal);
public native int setLatencyTimer(String comPort, byte timerValue);
public native int getLatencyTimer(String comPort);
public native int rescanUSBDevicesHW();
public native String[] getFirmwareRevisionNumber(int vid, int pid, String serialNumber);
public native String[] findComPortFromUSBAttributes(int usbVidToMatch, int usbPidToMatch, String serialNumber);
public String[] findComPortFromUSBAttribute(int usbVidToMatch, int usbPidToMatch, String serialNumber) {
String[] ports = findComPortFromUSBAttributes(usbVidToMatch, usbPidToMatch, serialNumber);
if(ports != null) {
if(ports.length < 2) {
return ports;
}else {
ArrayList portsFound = new ArrayList();
for(String portName : ports){
portsFound.add(portName);
}
Collections.sort(portsFound, comparator);
return portsFound.toArray(new String[portsFound.size()]);
}
}
return null;
}
// Bluetooth
public native String[] listBTSPPDevNodesWithInfo();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy