com.embeddedunveiled.serial.vendor

Class SerialComMCHPSimpleIO

java.lang.Object

com.embeddedunveiled.serial.vendor.SerialComVendorLib

com.embeddedunveiled.serial.vendor.SerialComMCHPSimpleIO

public final class SerialComMCHPSimpleIO
extends SerialComVendorLib

Microchip Technology Inc provides a shared library known as 'SimpleIO' for communicating with their USB-UART devices. More information can be found here : http://www.microchip.com/wwwproducts/devices.aspx?dDocName=en546923

[0] The data types used in java layer may be bigger in size than the native layer. For example; if native function returns 16 bit signed integer, than java method will return 32 bit integer. This is done to make sure that no data loss occur. This library take care of sign and their applicability internally.

[1] Developers are requested to check with vendor library documentation if a particular function is supported for desired platform or not and also how does a particular API will behave. Also consider paying attention to valid values and range when passing arguments to a method.

SCM version 1.0.4 is linked to 1.4.0 version of SimpleIO library (SimpleIO-UM.dll).

Author:

Rishi Gupta

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLINKFAST Constant representing fast rate of blinking LED.
static int	BLINKSLOW Constant representing slow rate of blinking LED.
static int	OFF Constant representing off state.
static int	ON Constant representing on state.
static int	TOGGLE Constant representing toggling in operational state.

Fields inherited from class com.embeddedunveiled.serial.vendor.SerialComVendorLib

VLIB_FTDI_D2XX, VLIB_MCHP_SIMPLEIO, VLIB_SLABS_CP210XMANUFACTURING, VLIB_SLABS_CP210XRUNTIME, VLIB_SLABS_USBXPRESS

Constructor Summary

Constructors

Constructor and Description
SerialComMCHPSimpleIO(File libDirectory, String vlibName, int cpuArch, int osType, SerialComSystemProperty serialComSystemProperty) Allocates a new SerialComMCHPSimpleIO object and extract and load shared libraries as required.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearPin(int pinNumber) Executes ClearPin function of 'SimpleIO-xxxx' library.
boolean	configureIO(short ioMap) Executes ConfigureIO function of 'SimpleIO-xxxx' library.
boolean	configureIoDefaultOutput(short ioMap, short ucDefValue) Executes ConfigureIoDefaultOutput function of 'SimpleIO-xxxx' library.
boolean	configureMCP2200(byte ioMap, long baudRateParam, int rxLEDMode, int txLEDMode, boolean flow, boolean uload, boolean sspnd, boolean invert) Executes ConfigureMCP2200 function of 'SimpleIO-xxxx' library.
boolean	fnInvertUartPol(int onOff) Executes fnInvertUartPol function of 'SimpleIO-xxxx' library.
boolean	fnRxLED(int mode) Executes fnRxLED function of 'SimpleIO-xxxx' library.
boolean	fnSetBaudRate(long baudRateParam) Executes fnSetBaudRate function of 'SimpleIO-xxxx' library.
boolean	fnSuspend(int onOff) Executes fnSuspend function of 'SimpleIO-xxxx' library.
boolean	fnTxLED(int mode) Executes fnTxLED function of 'SimpleIO-xxxx' library.
boolean	fnULoad(int onOff) Executes fnULoad function of 'SimpleIO-xxxx' library.
String	getDeviceInfo(int uiDeviceNumber) Executes GetDeviceInfo function of 'SimpleIO-xxxx' library.
int	getNumOfDevices() Executes GetNoOfDevices function of 'SimpleIO-xxxx' library.
int	getSelectedDevice() Executes GetSelectedDevice function of 'SimpleIO-xxxx' library.
String	getSelectedDeviceInfo() Executes GetSelectedDeviceInfo function of 'SimpleIO-xxxx' library.
boolean	hardwareFlowControl(int onOff) Executes fnHardwareFlowControl function of 'SimpleIO-xxxx' library.
boolean	initMCP2200(int vendorID, int productID) Executes InitMCP2200 function of 'SimpleIO-xxxx' library.
boolean	isConnected() Executes IsConnected function of 'SimpleIO-xxxx' library.
int	readEEPROM(int uiEEPAddress) Executes ReadEEPROM function of 'SimpleIO-xxxx' library.
int	readPin(int pinNumber) Executes ReadPin function of 'SimpleIO-xxxx' library.
int	readPinValue(int pinNumber) Executes ReadPinValue function of 'SimpleIO-xxxx' library.
int	readPort() Executes ReadPort function of 'SimpleIO-xxxx' library.
int	readPortValue() Executes ReadPortValue function of 'SimpleIO-xxxx' library.
boolean	selectDevice(int uiDeviceNumber) Executes SelectDevice function of 'SimpleIO-xxxx' library.
boolean	setPin(int pinNumber) Executes SetPin function of 'SimpleIO-xxxx' library.
boolean	writeEEPROM(int uiEEPAddress, short ucValue) Executes WriteEEPROM function of 'SimpleIO-xxxx' library.
boolean	writePort(int portValue) Executes WritePort function of 'SimpleIO-xxxx' library.

Methods inherited from class com.embeddedunveiled.serial.vendor.SerialComVendorLib

getVendorLibInstance

Methods inherited from class java.lang.Object

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

Field Detail

OFF

public static final int OFF

Constant representing off state.

See Also:

Constant Field Values

ON

public static final int ON

Constant representing on state.

See Also:

Constant Field Values

TOGGLE

public static final int TOGGLE

Constant representing toggling in operational state.

See Also:

Constant Field Values

BLINKSLOW

public static final int BLINKSLOW

Constant representing slow rate of blinking LED.

See Also:

Constant Field Values

BLINKFAST

public static final int BLINKFAST

Constant representing fast rate of blinking LED.

See Also:

Constant Field Values

Constructor Detail

SerialComMCHPSimpleIO

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

Allocates a new SerialComMCHPSimpleIO object and extract and load shared libraries as required.

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.

SerialComException - if initializing native library fails.

Method Detail

initMCP2200

public boolean initMCP2200(int vendorID,
                  int productID)
                    throws SerialComException

Executes InitMCP2200 function of 'SimpleIO-xxxx' library.

Configures the Simple IO class for a specific Vendor and product ID.

Parameters:

vendorID - USB vendor ID as Assigned by USB IF (www.usb.org).

productID - USB product ID of this device belongs to.

Returns:

true if the requested operation executed successfully.

Throws:

SerialComException - if an I/O error occurs.

IllegalArgumentException - if vendorID or productID is negative or invalid number.

isConnected

public boolean isConnected()
                    throws SerialComException

Executes IsConnected function of 'SimpleIO-xxxx' library.

Checks with the OS to see if the current VID/PID device is connected.

Returns:

true if the device is connected to host otherwise false.

Throws:

SerialComException - if an I/O error occurs.

configureMCP2200

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

Executes ConfigureMCP2200 function of 'SimpleIO-xxxx' library.

Configures the device. Sets the default GPIO designation, baud rate, TX/RX Led modes, flow control.

The argument rxLEDMode and txLEDMode can be one of these constants OFF, ON, TOGGLE, BLINKSLOW, BLINKFAST defined in SerialComMCHPSimpleIO class.

Parameters:

ioMap - A byte which represents the input/output state of the pins (each bit may be either a 1 for input, and 0 for output).

baudRateParam - the default communication baud rate.

rxLEDMode - defines the behavior of the RX Led.

txLEDMode - defines the behavior of the TX Led.

flow - establishes the default flow control method (false - no HW flow control, true - RTS/CTS flow control).

uload - enables/disables the GP1 pin as a USB configuration status indicator.

sspnd - enables/disables the GP0 pin as a USB suspend status pin.

invert - enables/disables the UART lines states: (1) Normal – Tx/Rx idle high; CTS/RTS active low, (2) Inverted – Tx/Rx idle low; CTS/RTS active high.

Returns:

true if the device is configured as given.

Throws:

SerialComException - if an I/O error occurs.

setPin

public boolean setPin(int pinNumber)
               throws SerialComException

Executes SetPin function of 'SimpleIO-xxxx' library.

Sets the specified pin to logic '1'.

Parameters:

pinNumber - number of the pin which need to be set to logic 1.

Returns:

true if the requested operation executed successfully.

Throws:

SerialComException - if an I/O error occurs.

clearPin

public boolean clearPin(int pinNumber)
                 throws SerialComException

Executes ClearPin function of 'SimpleIO-xxxx' library.

Sets the specified pin to logic '0'.

Parameters:

pinNumber - number of the pin which need to be set to logic 0.

Returns:

true if the requested operation executed successfully.

Throws:

SerialComException - if an I/O error occurs.

readPinValue

public int readPinValue(int pinNumber)
                 throws SerialComException

Executes ReadPinValue function of 'SimpleIO-xxxx' library.

Reads the specified pin's value/state.

Parameters:

pinNumber - number of the pin whose value is to be read.

Returns:

value which will be 0 or 1 depending upon pin's state.

Throws:

SerialComException - if an I/O error occurs.

readPin

public int readPin(int pinNumber)
            throws SerialComException

Executes ReadPin function of 'SimpleIO-xxxx' library.

Reads the specified pin's value/state.

Parameters:

pinNumber - number of the pin whose value is to be read.

Returns:

value which will be 0 or 1 depending upon pin's state.

Throws:

SerialComException - if an I/O error occurs.

writePort

public boolean writePort(int portValue)
                  throws SerialComException

Executes WritePort function of 'SimpleIO-xxxx' library.

Writes the given value to the GPIO port.

Parameters:

portValue - byte value to set on the port.

Returns:

true if the requested operation executed successfully.

Throws:

SerialComException - if an I/O error occurs.

readPort

public int readPort()
             throws SerialComException

Executes ReadPort function of 'SimpleIO-xxxx' library.

Reads the GPIO port as digital input.

Returns:

port value read.

Throws:

SerialComException - if an I/O error occurs.

readPortValue

public int readPortValue()
                  throws SerialComException

Executes ReadPortValue function of 'SimpleIO-xxxx' library.

Reads the GPIO port as digital input.

Returns:

port value read.

Throws:

SerialComException - if an I/O error occurs.

selectDevice

public boolean selectDevice(int uiDeviceNumber)
                     throws SerialComException

Executes SelectDevice function of 'SimpleIO-xxxx' library.

Selects one of the active devices in the system.

Parameters:

uiDeviceNumber - the ID of the device to select (can have a value between 0 to (number of devices - 1).

Returns:

true if the requested device gets selected successfully.

Throws:

SerialComException - if an I/O error occurs.

getSelectedDevice

public int getSelectedDevice()
                      throws SerialComException

Executes GetSelectedDevice function of 'SimpleIO-xxxx' library.

Gets the currently selected device from one of the active devices in the system.

Returns:

ID of the current selected device.

Throws:

SerialComException - if an I/O error occurs.

getNumOfDevices

public int getNumOfDevices()
                    throws SerialComException

Executes GetNoOfDevices function of 'SimpleIO-xxxx' library.

Find the number of available devices present in the system.

Returns:

the number of HID devices with the given (as parameters of InitMCP2200() function) VID/PID.

Throws:

SerialComException - if an I/O error occurs.

getDeviceInfo

public String getDeviceInfo(int uiDeviceNumber)
                     throws SerialComException

Executes GetDeviceInfo function of 'SimpleIO-xxxx' library.

Find the pathname for one of the connected devices.

Parameters:

uiDeviceNumber - device number about whom information is to be fetched.

Returns:

a string containing the pathname of the given device id.

Throws:

SerialComException - if an I/O error occurs.

getSelectedDeviceInfo

public String getSelectedDeviceInfo()
                             throws SerialComException

Executes GetSelectedDeviceInfo function of 'SimpleIO-xxxx' library.

Find the pathname for currently selected device.

Returns:

a string containing the pathname of the selected device.

Throws:

SerialComException - if an I/O error occurs.

readEEPROM

public int readEEPROM(int uiEEPAddress)
               throws SerialComException

Executes ReadEEPROM function of 'SimpleIO-xxxx' library.

Reads a byte from the EEPROM at the given address.

Parameters:

uiEEPAddress - EEPROM address from where to read value.

Returns:

value at given address.

Throws:

SerialComException - if an I/O error occurs.

writeEEPROM

public boolean writeEEPROM(int uiEEPAddress,
                  short ucValue)
                    throws SerialComException

Executes WriteEEPROM function of 'SimpleIO-xxxx' library.

Reads a byte value to the given EEPROM address.

Parameters:

uiEEPAddress - EEPROM address to write at.

ucValue - value to write at given address.

Returns:

true of value gets written successfully at given address.

Throws:

SerialComException - if an I/O error occurs.

fnRxLED

public boolean fnRxLED(int mode)
                throws SerialComException

Executes fnRxLED function of 'SimpleIO-xxxx' library.

Configures the Rx LED mode. Rx LED configuration will be stored in NVRAM.

The argument mode can be one of these constants OFF, ON, TOGGLE, BLINKSLOW, BLINKFAST defined in SerialComMCHPSimpleIO class.

Parameters:

mode - mode as described above.

Returns:

true if the mode is set successfully.

Throws:

SerialComException - if an I/O error occurs.

fnTxLED

public boolean fnTxLED(int mode)
                throws SerialComException

Executes fnTxLED function of 'SimpleIO-xxxx' library.

Configures the Tx LED mode. Tx LED configuration will be stored in NVRAM.

The argument mode can be one of these constants OFF, ON, TOGGLE, BLINKSLOW, BLINKFAST defined in SerialComMCHPSimpleIO class.

Parameters:

mode - mode as described above.

Returns:

true if the mode is set successfully.

Throws:

SerialComException - if an I/O error occurs.

hardwareFlowControl

public boolean hardwareFlowControl(int onOff)
                            throws SerialComException

Executes fnHardwareFlowControl function of 'SimpleIO-xxxx' library.

Sets the flow control to HW flow control (RTS/CTS) or No flow control.

Parameters:

onOff - if 1 hardware flow control will be set. if 0 no flow control will be set.

Returns:

true if the flow control gets successfully.

Throws:

SerialComException - if an I/O error occurs.

fnULoad

public boolean fnULoad(int onOff)
                throws SerialComException

Executes fnULoad function of 'SimpleIO-xxxx' library.

Configures the GP1 pin of the MCP2200 to show the status of the USB configuration.

Parameters:

onOff - if 1 GP1 will reflect the USB configuration status, if 0 GP1 will not reflect the USB configuration status (can be used as GPIO).

Returns:

true if GP1 gets configured successfully.

Throws:

SerialComException - if an I/O error occurs.

fnSuspend

public boolean fnSuspend(int onOff)
                  throws SerialComException

Executes fnSuspend function of 'SimpleIO-xxxx' library.

Configures the MCP2200 to invert the UART polarity or not.

Parameters:

onOff - if 1 GP0 will reflect the USB Suspend/Resume states, if 0 GP0 will not reflect the USB Suspend/Resume states (can be used as GPIO).

Returns:

true if GP0 gets configured successfully.

Throws:

SerialComException - if an I/O error occurs.

fnInvertUartPol

public boolean fnInvertUartPol(int onOff)
                        throws SerialComException

Executes fnInvertUartPol function of 'SimpleIO-xxxx' library.

Configures the MCP2200 to invert the UART polarity or not.

Parameters:

onOff - if 1 invert the UART polarity, if 0 leave the polarity as default.

Returns:

true if polarity gets configured successfully.

Throws:

SerialComException - if an I/O error occurs.

fnSetBaudRate

public boolean fnSetBaudRate(long baudRateParam)
                      throws SerialComException

Executes fnSetBaudRate function of 'SimpleIO-xxxx' library.

Sets the desired baudrate and it will store it into device's NVRAM.

Parameters:

baudRateParam - baud rate value to set.

Returns:

true if baud rate gets set successfully.

Throws:

SerialComException - if an I/O error occurs.

configureIO

public boolean configureIO(short ioMap)
                    throws SerialComException

Executes ConfigureIO function of 'SimpleIO-xxxx' library.

Configures the GPIO pins for Digital Input, Digital Output.

Parameters:

ioMap - a byte which represents a bitmap of the GPIO configuration. A bit set to '1' will be a digital input, a bit set to '0' will be a digital output.

Returns:

true if GPIO gets configured successfully.

Throws:

SerialComException - if an I/O error occurs.

configureIoDefaultOutput

public boolean configureIoDefaultOutput(short ioMap,
                               short ucDefValue)
                                 throws SerialComException

Executes ConfigureIoDefaultOutput function of 'SimpleIO-xxxx' library.

Configures the IO pins for Digital Input, Digital Output and also the default output latch value.

Parameters:

ioMap - a byte which represents a bitmap of the GPIO configuration. A bit set to '1' will be a digital input, a bit set to '0' will be a digital output.

ucDefValue - the default value that will be loaded to the output latch (effect only on the pins configured as outputs).

Returns:

true if GPIO gets configured successfully.

Throws:

SerialComException - if an I/O error occurs.