C D E F G H I L M O R S U W

C

closeHidDeviceR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

closeHidDeviceR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Closes a HID device.

com.serialpundit.hid - package com.serialpundit.hid

Encapsulates behavior and environment involving use of a HID protocols and standards.

com.serialpundit.hid.internal - package com.serialpundit.hid.internal

For internal use.

createBlockingHIDIOContextR() - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

createBlockingHIDIOContextR() - Method in class com.serialpundit.hid.SerialComRawHID

Prepares a context that should be passed to readInputReportR, unblockBlockingHIDIOOperationR and destroyBlockingIOContextR methods.

D

destroyBlockingIOContextR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

destroyBlockingIOContextR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Destroys the context that was created by a call to createBlockingHIDIOContextR method for blocking I/O operations uses.

dumpDeviceInfo() - Method in class com.serialpundit.hid.SerialComHIDdevice

Prints information about this device on console.

E

EXP_UNBLOCK_HIDIO - Static variable in class com.serialpundit.hid.SerialComHID

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).

F

findDriverServingHIDDeviceR(String) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

findDriverServingHIDDeviceR(String) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the name of the driver who is driving the given HID device.

flushInputReportQueueR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

flushInputReportQueueR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Deletes all the input reports from input report buffer maintained by operating system.

formatReportToHexR(byte[], String) - Method in class com.serialpundit.hid.SerialComRawHID

Converts report read from HID device to hexadecimal string.

G

getDeviceNode() - Method in class com.serialpundit.hid.SerialComHIDdevice

Returns device node representing this device in system.

getFeatureReportR(long, byte, byte[], int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getFeatureReportR(long, byte, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Read a feature report to the HID device.

getIndexedStringR(long, int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getIndexedStringR(long, int) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the string at the given index of string descriptor from HID device.

getInputReportListener() - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Gives input report listener associated with given HID device handle.

getInputReportListenerStateInstance() - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Gives worker thread's state instance associated with this input report listener.

getListenerContext() - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Gives the context associated with this input report listener.

getLocation() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the location of the USB device in system.

getManufacturerString() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the manufacturer string of the USB device.

getManufacturerStringR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getManufacturerStringR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the manufacturer of the HID device.

getPhysicalDescriptorR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getPhysicalDescriptorR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the physical descriptor for the given HID device.

getProductID() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the product id of the USB device.

getProductString() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the product string of the USB device.

getProductStringR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getProductStringR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the product name of the HID device.

getReportDescriptorR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getReportDescriptorR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the report descriptor as supplied by device itself.

getSerialNumber() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the serial number string of the USB device.

getSerialNumberStringR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

getSerialNumberStringR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Gives the serial number of the HID device.

getTransportType() - Method in class com.serialpundit.hid.SerialComHIDdevice

Returns USB or Bluetooth i.e.

getVendorID() - Method in class com.serialpundit.hid.SerialComHIDdevice

Retrieves the vendor id of the USB device.

H

HID_BLUETOOTH - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComBluetoothHID class (HID over Bluetooth).

HID_GENERIC - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComHID class (HID transport neutral).

HID_I2C - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComI2CHID class (HID over I2C).

HID_USB - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComUSBHID class (HID over USB).

HIDdevHandleInfo - Class in com.serialpundit.hid.internal

Encapsulates the information like HID device handle and listeners associated with this handle etc.

HIDdevHandleInfo(IHIDInputReportListener) - Constructor for class com.serialpundit.hid.internal.HIDdevHandleInfo

Allocates and create new HIDdevHandleInfo object with given details.

I

IHIDInputReportListener - Interface in com.serialpundit.hid

The interface IHIDInputReportListener should be implemented by class who wish to receive input reports from HID device whenever an input report is received by host computer.

initNativeLib() - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

InputReportListenerState - Class in com.serialpundit.hid.internal

Acts as a medium between threads to indicate whether input report reader worker thread should exit or not.

InputReportListenerState() - Constructor for class com.serialpundit.hid.internal.InputReportListenerState

Allocates a new InputReportListenerState with state as false.

L

listHIDdevicesWithInfoR() - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

listHIDdevicesWithInfoR() - Method in class com.serialpundit.hid.SerialComRawHID

Find all the device instances claiming to be HID device.

loadNativeLibrary(String, String, SerialComSystemProperty, int, int, int) - Static method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

Extract native library from jar in a working directory, load and link it.

M

MODE_PARSED - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComParsedHID class.

MODE_RAW - Static variable in class com.serialpundit.hid.SerialComHID

The value indicating instance of SerialComRawHID class.

O

onNewInputReportAvailable(int, byte[]) - Method in interface com.serialpundit.hid.IHIDInputReportListener

This method gets called whenever an input report is received by host computer.

onNewInputReportAvailableError(Exception) - Method in interface com.serialpundit.hid.IHIDInputReportListener

If any exception occurs while worker thread was waiting for new input report or while reading it, worker thread calls this method passing the error information.

openHidDeviceByPathR(String, boolean) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

openHidDeviceR(String, boolean, int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

openHidDeviceR(String, boolean) - Method in class com.serialpundit.hid.SerialComRawHID

Opens a HID device for communication using its path name.

R

readInputReportR(long, byte[], int, long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

readInputReportR(long, byte[], long) - Method in class com.serialpundit.hid.SerialComRawHID

Reads input report from the given HID device.

readInputReportWithTimeoutR(long, byte[], int, int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

readInputReportWithTimeoutR(long, byte[], int) - Method in class com.serialpundit.hid.SerialComRawHID

Try to read input report from HID device within the given timeout limit.

readPlatformSpecificInputReportR(long, byte, byte[], int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

readPlatformSpecificInputReportR(long, byte, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Read input report from given HID device and handles inconsistencies in reports internally using facilities provided by operating system.

registerInputReportListener(long, IHIDInputReportListener, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Registers a listener which will be invoked whenever an input report is available to read.

S

sendFeatureReportR(long, byte, byte[], int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

sendFeatureReportR(long, byte, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Send a feature report to the HID device.

SerialComHID - Class in com.serialpundit.hid

The SerialPundit provides two set of APIs for communicating with a HID device; raw mode API and parsed mode API.

SerialComHID() - Constructor for class com.serialpundit.hid.SerialComHID

Allocates a new SerialComHID object.

SerialComHIDdevice - Class in com.serialpundit.hid

Represents a HID device with information about it.

SerialComHIDdevice(String, String, String, String, String, String, String, String) - Constructor for class com.serialpundit.hid.SerialComHIDdevice

Construct and allocates a new SerialComHIDdevice object with given details.

SerialComHIDJNIBridge - Class in com.serialpundit.hid.internal

This class is an interface between java and native shared library.

SerialComHIDJNIBridge() - Constructor for class com.serialpundit.hid.internal.SerialComHIDJNIBridge

Allocates a new SerialComHIDJNIBridge object.

SerialComRawHID - Class in com.serialpundit.hid

Contains APIs to communicate with a HID class device in raw mode.

SerialComRawHID(String, String) - Constructor for class com.serialpundit.hid.SerialComRawHID

Construct and allocates a new SerialComRawHID object with given details and load/link native libraries if required.

setInputReportListener(IHIDInputReportListener) - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Set the input report listener who will get input reports for given handle.

setInputReportListenerState(boolean) - Method in class com.serialpundit.hid.internal.InputReportListenerState

Sets the state of input report listener worker thread to the given state.

setInputReportListenerStateInstance(InputReportListenerState) - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Set the state of worker thread's state instance associated with this input report listener.

setListenerContext(long) - Method in class com.serialpundit.hid.internal.HIDdevHandleInfo

Set the context associated with this input report listener.

shouldInputReportListenerExit() - Method in class com.serialpundit.hid.internal.InputReportListenerState

Tells whether worker thread should continue to listen for input report availability or not.

U

unblockBlockingHIDIOOperationR(long) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

unblockBlockingHIDIOOperationR(long) - Method in class com.serialpundit.hid.SerialComRawHID

Unblocks any blocked operation if it exist.

unregisterInputReportListener(IHIDInputReportListener) - Method in class com.serialpundit.hid.SerialComRawHID

This unregisters listener and terminates worker thread which was delivering input reports.

W

writeOutputReportR(long, byte, byte[], int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

writeOutputReportR(long, byte, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Sends the given output report to the HID device.

writePlatformSpecificOutputReportR(long, byte, byte[], int) - Method in class com.serialpundit.hid.internal.SerialComHIDJNIBridge

writePlatformSpecificOutputReportR(long, byte, byte[]) - Method in class com.serialpundit.hid.SerialComRawHID

Sends an output report to given HID device and handles inconsistencies in reports internally using facilities provided by operating system.

C D E F G H I L M O R S U W