com.serialpundit.hid

Class SerialComHID

java.lang.Object

com.serialpundit.hid.SerialComHID

Direct Known Subclasses:

SerialComRawHID

public class SerialComHID
extends Object

The SerialPundit provides two set of APIs for communicating with a HID device; raw mode API and parsed mode API. In raw mode, input reports received and output reports sent are not parsed. In parsed mode, input reports received and output reports sent are parsed.

In Windows, system supplied HID minidriver and HID class drivers provide most of the functionality and required support for HID-compliant devices. However we may have to write our own HID minidriver if it is difficult to make desired changes to HID-compliant device firmware or if we need to make a non-HID compliant device into a HID device without updating the firmware.

Note that a driver can override the descriptors and reports from a HID device.

The SerialComRawHID class extends this class.

Author:

Rishi Gupta

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXP_UNBLOCK_HIDIO The exception message indicating that a blocked read method has been unblocked and made to return to caller explicitly (irrespective there was data to read or not).
static int	HID_BLUETOOTH The value indicating instance of SerialComBluetoothHID class (HID over Bluetooth).
static int	HID_GENERIC The value indicating instance of SerialComHID class (HID transport neutral).
static int	HID_I2C The value indicating instance of SerialComI2CHID class (HID over I2C).
static int	HID_USB The value indicating instance of SerialComUSBHID class (HID over USB).
static int	MODE_PARSED The value indicating instance of SerialComParsedHID class.
static int	MODE_RAW The value indicating instance of SerialComRawHID class.

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MODE_RAW

public static final int MODE_RAW

The value indicating instance of SerialComRawHID class. Integer constant with value 0x01.

See Also:

Constant Field Values

MODE_PARSED

public static final int MODE_PARSED

The value indicating instance of SerialComParsedHID class. Integer constant with value 0x02.

See Also:

Constant Field Values

HID_GENERIC

public static final int HID_GENERIC

The value indicating instance of SerialComHID class (HID transport neutral). Integer constant with value 0x03.

See Also:

Constant Field Values

HID_USB

public static final int HID_USB

The value indicating instance of SerialComUSBHID class (HID over USB). Integer constant with value 0x04.

See Also:

Constant Field Values

HID_BLUETOOTH

public static final int HID_BLUETOOTH

The value indicating instance of SerialComBluetoothHID class (HID over Bluetooth). Integer constant with value 0x05.

See Also:

Constant Field Values

HID_I2C

public static final int HID_I2C

The value indicating instance of SerialComI2CHID class (HID over I2C). Integer constant with value 0x06.

See Also:

Constant Field Values

EXP_UNBLOCK_HIDIO

public static final String EXP_UNBLOCK_HIDIO

The exception message indicating that a blocked read method has been unblocked and made to return to caller explicitly (irrespective there was data to read or not).

See Also:

Constant Field Values

Constructor Detail

SerialComHID

public SerialComHID()

Allocates a new SerialComHID object.