com.embeddedunveiled.serial.internal

Class SerialComCP210xManufacturingJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComCP210xManufacturingJNIBridge

public final class SerialComCP210xManufacturingJNIBridge
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
SerialComCP210xManufacturingJNIBridge() Allocates a new SerialComCP210xManufacturingJNIBridge object.

Method Summary

Methods

Modifier and Type	Method and Description
int	close(long handle)
int	createHexFile(long handle, String fileName)
int[]	getBaudRateConfig(long handle)
String	getDeviceInterfaceString(long handle, byte bInterfaceNumber)
String	getDeviceManufacturerString(long handle)
byte[]	getDeviceMode(long handle)
int	getDevicePid(long handle)
String	getDeviceProductString(long handle)
String	getDeviceSerialNumber(long handle)
int	getDeviceVersion(long handle)
int	getDeviceVid(long handle)
int[]	getDualPortConfig(long handle)
int	getFlushBufferConfig(long handle)
int	getLockValue(long handle)
int	getMaxPower(long handle)
int	getNumDevices()
String	getPartNumber(long handle)
int[]	getPortConfig(long handle)
String	getProductString(int index, int flag)
int[]	getQuadPortConfig(long handle)
int	getSelfPower(long handle)
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)
int	reset(long handle)
int	setBaudRateConfig(long handle, int baudGen, int timer0Reload, int prescalar, int baudrate)
int	setDeviceMode(long handle, byte bDeviceModeECI, byte bDeviceModeSCI)
int	setDeviceVersion(long handle, int version)
int	setDualPortConfig(long handle, int mode, int resetLatch, int suspendLatch, int enhancedFxnECI, int enhancedFxnSCI, int enhancedFxnDevice)
int	setFlushBufferConfig(long handle, int flag)
int	setInterfaceString(long handle, byte bInterfaceNumber, String interfaceString)
int	setLockValue(long handle)
int	setMaxPower(long handle, byte maxPower)
int	setPid(long handle, int pid)
int	setPortConfig(long handle, int mode, int resetLatch, int suspendLatch, int enhancedFxn)
int	setProductString(long handle, String product)
int	setQuadPortConfig(long handle, int[] resetLatch, int[] suspendLatch, byte[] config)
int	setSelfPower(long handle, boolean selfPower)
int	setSerialNumber(long handle, String serialNumber)
int	setVid(long handle, int vid)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComCP210xManufacturingJNIBridge

public SerialComCP210xManufacturingJNIBridge()

Allocates a new SerialComCP210xManufacturingJNIBridge 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

getNumDevices

public int getNumDevices()

reset

public int reset(long handle)

createHexFile

public int createHexFile(long handle,
                String fileName)

getPartNumber

public String getPartNumber(long handle)

getDeviceManufacturerString

public String getDeviceManufacturerString(long handle)

open

public long open(int index)

close

public int close(long handle)

setProductString

public int setProductString(long handle,
                   String product)

getProductString

public String getProductString(int index,
                      int flag)

getDeviceProductString

public String getDeviceProductString(long handle)

setVid

public int setVid(long handle,
         int vid)

getDeviceVid

public int getDeviceVid(long handle)

setPid

public int setPid(long handle,
         int pid)

getDevicePid

public int getDevicePid(long handle)

setSerialNumber

public int setSerialNumber(long handle,
                  String serialNumber)

getDeviceSerialNumber

public String getDeviceSerialNumber(long handle)

setInterfaceString

public int setInterfaceString(long handle,
                     byte bInterfaceNumber,
                     String interfaceString)

getDeviceInterfaceString

public String getDeviceInterfaceString(long handle,
                              byte bInterfaceNumber)

setSelfPower

public int setSelfPower(long handle,
               boolean selfPower)

getSelfPower

public int getSelfPower(long handle)

setMaxPower

public int setMaxPower(long handle,
              byte maxPower)

getMaxPower

public int getMaxPower(long handle)

setFlushBufferConfig

public int setFlushBufferConfig(long handle,
                       int flag)

getFlushBufferConfig

public int getFlushBufferConfig(long handle)

setDeviceMode

public int setDeviceMode(long handle,
                byte bDeviceModeECI,
                byte bDeviceModeSCI)

getDeviceMode

public byte[] getDeviceMode(long handle)

setDeviceVersion

public int setDeviceVersion(long handle,
                   int version)

getDeviceVersion

public int getDeviceVersion(long handle)

setBaudRateConfig

public int setBaudRateConfig(long handle,
                    int baudGen,
                    int timer0Reload,
                    int prescalar,
                    int baudrate)

getBaudRateConfig

public int[] getBaudRateConfig(long handle)

setPortConfig

public int setPortConfig(long handle,
                int mode,
                int resetLatch,
                int suspendLatch,
                int enhancedFxn)

getPortConfig

public int[] getPortConfig(long handle)

setDualPortConfig

public int setDualPortConfig(long handle,
                    int mode,
                    int resetLatch,
                    int suspendLatch,
                    int enhancedFxnECI,
                    int enhancedFxnSCI,
                    int enhancedFxnDevice)

getDualPortConfig

public int[] getDualPortConfig(long handle)

setQuadPortConfig

public int setQuadPortConfig(long handle,
                    int[] resetLatch,
                    int[] suspendLatch,
                    byte[] config)

getQuadPortConfig

public int[] getQuadPortConfig(long handle)

setLockValue

public int setLockValue(long handle)

getLockValue

public int getLockValue(long handle)