com.serialpundit.usb

Class SerialComUSBHIDdevice

java.lang.Object

com.serialpundit.usb.SerialComUSBHIDdevice

public final class SerialComUSBHIDdevice
extends Object

Represents a USB HID device with information about it.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComUSBHIDdevice(String transport, String deviceNode, String idVendor, String idProduct, String serial, String product, String manufacturer, String location) Allocate and construct a new SerialComUSBHIDdevice object with given details.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDeviceInfo() Prints information about this device on console.
String	getDeviceNode() Returns device node representing this device in system.
String	getLocation() Retrieves the location of the USB device in system.
String	getManufacturerString() Retrieves the manufacturer string of the USB device.
int	getProductID() Retrieves the product id of the USB device.
String	getProductString() Retrieves the product string of the USB device.
String	getSerialNumber() Retrieves the serial number string of the USB device.
String	getTransportType() Returns USB or Bluetooth i.e.
int	getVendorID() Retrieves the vendor id of the USB device.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComUSBHIDdevice

public SerialComUSBHIDdevice(String transport,
                     String deviceNode,
                     String idVendor,
                     String idProduct,
                     String serial,
                     String product,
                     String manufacturer,
                     String location)

Allocate and construct a new SerialComUSBHIDdevice object with given details.

Parameters:

transport - communication medium USB or Bluetooth this devices uses.

deviceNode - identifier that can be used to open this device.

idVendor - USB-IF unique vendor id of this device.

idProduct - USB product id of this device.

serial - serial number of this device.

product - product identifier/description of this device.

manufacturer - company manufacturing of this device.

location - location in device tree created dynamically.

Throws:

SerialComException - if the object can not be constructed.

Method Detail

getTransportType

public String getTransportType()

Returns USB or Bluetooth i.e. transport this device uses.

Returns:

USB or Bluetooth string whichever is applicable for this device.

getDeviceNode

public String getDeviceNode()

Returns device node representing this device in system.

In MAC os x, there is no device file for HID devices like '/dev/xxx'. Devices are identified by their usage or other properties. Therefore to maintain consistency, we create device node string with various properties separated by underscore : Transport_USB-VID_USB-PID_USB-serialnumber_LocationID

Returns:

string device node.

getVendorID

public int getVendorID()

Retrieves the vendor id of the USB device.

Returns:

vendor id of the USB device or -1 if location ID is not applicable for this platform.

Throws:

NumberFormatException - if the USB vendor id hex string can not be converted into numerical representation.

getProductID

public int getProductID()

Retrieves the product id of the USB device.

Returns:

product id of the USB device or -1 if location ID is not applicable for this platform.

Throws:

NumberFormatException - if the USB product id hex string can not be converted into numerical representation.

getSerialNumber

public String getSerialNumber()

Retrieves the serial number string of the USB device.

Returns:

serial number string of the USB device.

getProductString

public String getProductString()

Retrieves the product string of the USB device.

Returns:

serial number string of the USB device.

getManufacturerString

public String getManufacturerString()

Retrieves the manufacturer string of the USB device.

Returns:

serial number string of the USB device.

getLocation

public String getLocation()

Retrieves the location of the USB device in system.

Returns:

location information about this device.

dumpDeviceInfo

public void dumpDeviceInfo()

Prints information about this device on console.