com.embeddedunveiled.serial.internal

Class SerialComMCHPSIOJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComMCHPSIOJNIBridge

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

Method Summary

Methods

Modifier and Type	Method and Description
int	clearPin(int pinNumber)
int	configureIO(short ioMap)
int	configureIoDefaultOutput(short ioMap, short ucDefValue)
int	configureMCP2200(byte ioMap, long baudRateParam, int rxLEDMode, int txLEDMode, boolean flow, boolean uload, boolean sspnd, boolean invert)
int	fnInvertUartPol(int onOff)
int	fnRxLED(int mode)
int	fnSetBaudRate(long baudRateParam)
int	fnSuspend(int onOff)
int	fnTxLED(int mode)
int	fnULoad(int onOff)
String	getDeviceInfo(int uiDeviceNumber)
int	getNumOfDevices()
int	getSelectedDevice()
String	getSelectedDeviceInfo()
int	hardwareFlowControl(int onOff)
int	initMCP2200(int vendorID, int productID)
int	isConnected()
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.
int	readEEPROM(int uiEEPAddress)
int	readPin(int pinNumber)
int	readPinValue(int pinNumber)
int	readPort()
int	readPortValue()
int	selectDevice(int uiDeviceNumber)
int	setPin(int pinNumber)
int	writeEEPROM(int uiEEPAddress, short ucValue)
int	writePort(int portValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComMCHPSIOJNIBridge

public SerialComMCHPSIOJNIBridge()

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

initMCP2200

public int initMCP2200(int vendorID,
              int productID)

isConnected

public int isConnected()

configureMCP2200

public int configureMCP2200(byte ioMap,
                   long baudRateParam,
                   int rxLEDMode,
                   int txLEDMode,
                   boolean flow,
                   boolean uload,
                   boolean sspnd,
                   boolean invert)

setPin

public int setPin(int pinNumber)

clearPin

public int clearPin(int pinNumber)

readPinValue

public int readPinValue(int pinNumber)

readPin

public int readPin(int pinNumber)

writePort

public int writePort(int portValue)

readPort

public int readPort()

readPortValue

public int readPortValue()

selectDevice

public int selectDevice(int uiDeviceNumber)

getSelectedDevice

public int getSelectedDevice()

getNumOfDevices

public int getNumOfDevices()

getDeviceInfo

public String getDeviceInfo(int uiDeviceNumber)

getSelectedDeviceInfo

public String getSelectedDeviceInfo()

readEEPROM

public int readEEPROM(int uiEEPAddress)

writeEEPROM

public int writeEEPROM(int uiEEPAddress,
              short ucValue)

fnRxLED

public int fnRxLED(int mode)

fnTxLED

public int fnTxLED(int mode)

hardwareFlowControl

public int hardwareFlowControl(int onOff)

fnULoad

public int fnULoad(int onOff)

fnSuspend

public int fnSuspend(int onOff)

fnInvertUartPol

public int fnInvertUartPol(int onOff)

fnSetBaudRate

public int fnSetBaudRate(long baudRateParam)

configureIO

public int configureIO(short ioMap)

configureIoDefaultOutput

public int configureIoDefaultOutput(short ioMap,
                           short ucDefValue)