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

Field Summary

Fields

Modifier and Type	Field	Description
private final HidDeviceManager	hidDeviceManager	The HID device manager handles scanning operations
private final HidServicesListenerList	listeners	The HID services listeners for receiving attach/detach events etc

Constructor Summary

Constructors

Constructor	Description
HidServices()	Initialise with a default HID specification
HidServices(HidServicesSpecification hidServicesSpecification)

Method Summary

Modifier and Type	Method	Description
void	addHidServicesListener(HidServicesListener listener)
List<HidDevice>	getAttachedHidDevices()
HidDevice	getHidDevice(int vendorId, int productId, String serialNumber)
static String	getVersion()
static void	main(String[] args)	Jar entry point to allow for version interrogation
void	removeHidServicesListener(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	stop()	Stop scanning for devices

Methods inherited from class Object

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

Field Details

listeners

private final HidServicesListenerList listeners

The HID services listeners for receiving attach/detach events etc

hidDeviceManager

private final HidDeviceManager hidDeviceManager

The HID device manager handles scanning operations

Constructor Details

HidServices

public HidServices()
            throws HidException

Initialise with a default HID specification

Throws:

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

HidServices

public HidServices(HidServicesSpecification hidServicesSpecification)

Parameters:

hidServicesSpecification - Provides various parameters for configuring HID services

Throws:

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

Method Details

main

public static void main(String[] args)

Jar entry point to allow for version interrogation

Parameters:

args - Nothing required

shutdown

public void shutdown()

Stop scanning for devices and shut down the HidApi

stop

public void stop()

Stop scanning for devices

start

public void start()

Start scanning for devices (if not already scanning)

addHidServicesListener

public void addHidServicesListener(HidServicesListener listener)

Parameters:

listener - The listener to add

removeHidServicesListener

public void removeHidServicesListener(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

getVersion

public static String getVersion()

Returns:

The current library version from the manifest or 0.0.x if an error occurs