Package org.hid4java
Class HidServices
- java.lang.Object
-
- org.hid4java.HidServices
-
public class HidServices extends java.lang.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
- Access to the
-
-
Field Summary
Fields Modifier and Type Field Description private HidDeviceManager
hidDeviceManager
The HID device manager handles scanning operationsprivate HidServicesListenerList
listeners
The HID services listeners for receiving attach/detach events etc
-
Constructor Summary
Constructors Constructor Description HidServices()
Initialise with a default HID specificationHidServices(HidServicesSpecification hidServicesSpecification)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHidServicesListener(HidServicesListener listener)
java.util.List<HidDevice>
getAttachedHidDevices()
HidDevice
getHidDevice(int vendorId, int productId, java.lang.String serialNumber)
static java.lang.String
getVersion()
static void
main(java.lang.String[] args)
Jar entry point to allow for version interrogationvoid
removeHidServicesListener(HidServicesListener listener)
void
scan()
Manually scans for HID device connection changes and triggers listener events as requiredvoid
shutdown()
Stop scanning for devices and shut down theHidApi
void
start()
Start scanning for devices (if not already scanning)void
stop()
Stop scanning for devices
-
-
-
Field Detail
-
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 Detail
-
HidServices
public HidServices() throws HidException
Initialise with a default HID specification- Throws:
HidException
- If something goes wrong (seeHidDeviceManager(HidServicesListenerList, HidServicesSpecification)
-
HidServices
public HidServices(HidServicesSpecification hidServicesSpecification)
- Parameters:
hidServicesSpecification
- Provides various parameters for configuring HID services- Throws:
HidException
- If something goes wrong (seeHidDeviceManager(HidServicesListenerList, HidServicesSpecification)
-
-
Method Detail
-
main
public static void main(java.lang.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 theHidApi
-
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 java.util.List<HidDevice> getAttachedHidDevices()
- Returns:
- A list of all attached HID devices
-
getHidDevice
public HidDevice getHidDevice(int vendorId, int productId, java.lang.String serialNumber)
- Parameters:
vendorId
- The vendor IDproductId
- The product IDserialNumber
- The serial number (use null for wildcard)- Returns:
- The device if attached, null if detached
-
getVersion
public static java.lang.String getVersion()
- Returns:
- The current library version from the manifest or 0.0.x if an error occurs
-
-