org.hid4java

Class HidServices

java.lang.Object

org.hid4java.HidServices

public class HidServices
extends Object

JNA bridge class to provide the following to USB HID:

• Access to the signal11/hidapi via JNA

Requires the hidapi to be present on the classpath or the system library search path.

Since:

0.0.1

Constructor Summary

Constructors

Constructor and Description
HidServices() Initialise and start scanning for USB devices at 500ms interval.
HidServices(boolean autoShutdown) Initialise and start scanning for USB devices at 500ms interval.
HidServices(boolean autoShutdown, int scanInterval) Initialise and start scanning for USB devices at the given interval.

Method Summary

Modifier and Type	Method and Description
void	addHidServicesListener(HidServicesListener listener)
List<HidDevice>	getAttachedHidDevices()
HidDevice	getHidDevice(int vendorId, int productId, String serialNumber)
void	removeUsbServicesListener(HidServicesListener listener)
void	scan() Manually scans for HID device connection changes and triggers listener events as required
void	shutdown() Stop scanning for devices and shut down the HidApi
void	start() Start scanning for devices (if not already scanning)
void	start(int scanInterval) Start scanning for devices with the specified interval (if not already scanning)
void	stop() Stop scanning for devices and close connection to HidApi

Methods inherited from class java.lang.Object

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

Constructor Detail

HidServices

public HidServices()
            throws HidException

Initialise and start scanning for USB devices at 500ms interval. Will shutdown the API automatically with a JRE shutdown hook.

Throws:

HidException - If something goes wrong (see HidDeviceManager.HidDeviceManager(HidServicesListenerList, int)

HidServices

public HidServices(boolean autoShutdown)
            throws HidException

Initialise and start scanning for USB devices at 500ms interval. Optionally shutdown the API automatically with a JRE shutdown hook.

Parameters:

autoShutdown - True if a shutdown hook should be set to close the API automatically

Throws:

HidException - If something goes wrong (see HidDeviceManager.HidDeviceManager(HidServicesListenerList, int)

HidServices

public HidServices(boolean autoShutdown,
                   int scanInterval)
            throws HidException

Initialise and start scanning for USB devices at the given interval. Optionally shutdown the API automatically with a JRE shutdown hook.

Parameters:

autoShutdown - True if a shutdown hook should be set to close the API automatically

Throws:

HidException - If something goes wrong (see HidDeviceManager.HidDeviceManager(HidServicesListenerList, int)

Method Detail

shutdown

public void shutdown()

Stop scanning for devices and shut down the HidApi

stop

public void stop()

Stop scanning for devices and close connection to HidApi

start

public void start()

Start scanning for devices (if not already scanning)

start

public void start(int scanInterval)

Start scanning for devices with the specified interval (if not already scanning)

Parameters:

scanInterval - The (new) scan interval in millis

addHidServicesListener

public void addHidServicesListener(HidServicesListener listener)

Parameters:

listener - The listener to add

removeUsbServicesListener

public void removeUsbServicesListener(HidServicesListener listener)

Parameters:

listener - The listener to remove

scan

public void scan()

Manually scans for HID device connection changes and triggers listener events as required

getAttachedHidDevices

public List<HidDevice> getAttachedHidDevices()

Returns:

A list of all attached HID devices

getHidDevice

public HidDevice getHidDevice(int vendorId,
                              int productId,
                              String serialNumber)

Parameters:

vendorId - The vendor ID

productId - The product ID

serialNumber - The serial number (use null for wildcard)

Returns:

The device if attached, null if detached