com.embeddedunveiled.serial.vendor

Class SerialComVendorLib

java.lang.Object

com.embeddedunveiled.serial.vendor.SerialComVendorLib

Direct Known Subclasses:

SerialComFTDID2XX, SerialComMCHPSimpleIO, SerialComSLabsCP210xManufacturing, SerialComSLabsCP210xRuntime, SerialComSLabsUSBXpress

public class SerialComVendorLib
extends Object

Super class for all classes which implements vendor specific API to talk to their devices using the libraries provided by vendor. These libraries from vendor may be propriety or not.

Author:

Rishi Gupta

Field Summary

Fields

Modifier and Type	Field and Description
static int	VLIB_FTDI_D2XX The value indicating proprietary D2XX software interface from Future Technology Devices International Ltd.
static int	VLIB_MCHP_SIMPLEIO The value indicating 'SimpleIO' library from Microchip Technology Inc.
static int	VLIB_SLABS_CP210XMANUFACTURING The value indicating 'CP210xManufacturing' library from Silicon Laboratories, Inc.
static int	VLIB_SLABS_CP210XRUNTIME The value indicating 'CP210xRuntime' library from Silicon Laboratories, Inc.
static int	VLIB_SLABS_USBXPRESS The value indicating 'USBXpress' library from Silicon Laboratories, Inc.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
SerialComVendorLib	getVendorLibInstance(int vendorLibIdentifier, File libDirectory, String vlibName, int cpuArch, int osType, SerialComSystemProperty serialComSystemProperty) Gives an instance of the class which implements API defined by vendor in their propriety library.

Methods inherited from class java.lang.Object

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

Field Detail

VLIB_FTDI_D2XX

public static final int VLIB_FTDI_D2XX

The value indicating proprietary D2XX software interface from Future Technology Devices International Ltd.

See Also:

Constant Field Values

VLIB_MCHP_SIMPLEIO

public static final int VLIB_MCHP_SIMPLEIO

The value indicating 'SimpleIO' library from Microchip Technology Inc.

See Also:

Constant Field Values

VLIB_SLABS_CP210XRUNTIME

public static final int VLIB_SLABS_CP210XRUNTIME

The value indicating 'CP210xRuntime' library from Silicon Laboratories, Inc.

See Also:

Constant Field Values

VLIB_SLABS_CP210XMANUFACTURING

public static final int VLIB_SLABS_CP210XMANUFACTURING

The value indicating 'CP210xManufacturing' library from Silicon Laboratories, Inc.

See Also:

Constant Field Values

VLIB_SLABS_USBXPRESS

public static final int VLIB_SLABS_USBXPRESS

The value indicating 'USBXpress' library from Silicon Laboratories, Inc.

See Also:

Constant Field Values

Constructor Detail

SerialComVendorLib

public SerialComVendorLib()

Allocates a new SerialComVendorLib object.

Method Detail

getVendorLibInstance

public SerialComVendorLib getVendorLibInstance(int vendorLibIdentifier,
                                      File libDirectory,
                                      String vlibName,
                                      int cpuArch,
                                      int osType,
                                      SerialComSystemProperty serialComSystemProperty)
                                        throws UnsatisfiedLinkError,
                                               SerialComLoadException,
                                               SerialComUnexpectedException,
                                               SecurityException,
                                               FileNotFoundException

Gives an instance of the class which implements API defined by vendor in their propriety library.

Parameters:

vendorLibIdentifier - one of the constant VLIB_XXXX_XXXX in SerialComVendorLib class.

libDirectory - directory where vendor library is placed.

vlibName - full name of the vendor library (for ex. libftd2xx.so.1.1.12).

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.

Returns:

object of class on which vendor specific API calls can be made otherwise null.

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.

UnsatisfiedLinkError - if loading/linking shared library fails.

SerialComException - if an I/O error occurs.

SerialComLoadException - if the library can not be found, extracted or loaded if the mentioned library is not supported by vendor for operating system and cpu architecture combination.