Class LinuxUsbDeviceJNA

java.lang.Object

oshi.hardware.common.AbstractUsbDevice

oshi.hardware.common.platform.linux.LinuxUsbDevice

oshi.hardware.platform.linux.LinuxUsbDeviceJNA

All Implemented Interfaces:

Comparable<UsbDevice>, UsbDevice

public final class LinuxUsbDeviceJNA
extends LinuxUsbDevice

Linux USB device helper using JNA/udev. Instantiates LinuxUsbDevice objects.

Method Summary

Modifier and Type	Method	Description
static List<UsbDevice>	getUsbDevices(boolean tree)	Instantiates a list of UsbDevice objects, representing devices connected via a usb port (including internal devices).

Methods inherited from class LinuxUsbDevice

getDeviceAndChildren

Modifier and Type	Method	Description
protected static LinuxUsbDevice	getDeviceAndChildren(String devPath, String vid, String pid, Map<String,String> nameMap, Map<String,String> vendorMap, Map<String,String> vendorIdMap, Map<String,String> productIdMap, Map<String,String> serialMap, Map<String, List<String>> hubMap)	Recursively creates LinuxUsbDevices by fetching information from maps to populate fields

Methods inherited from class AbstractUsbDevice

addDevicesToList, compareTo, getConnectedDevices, getName, getProductId, getSerialNumber, getUniqueDeviceId, getVendor, getVendorId, toString

Modifier and Type	Method	Description
protected static void	addDevicesToList(List<UsbDevice> deviceList, List<UsbDevice> list)	Recursively adds USB devices from list to deviceList, depth-first.
int	compareTo(UsbDevice usb)
List<UsbDevice>	getConnectedDevices()	Other devices connected to this hub
String	getName()	Name of the USB device
String	getProductId()	Product ID of the USB device
String	getSerialNumber()	Serial number of the USB device
String	getUniqueDeviceId()	A Unique Device ID of the USB device, such as the PnPDeviceID (Windows), Device Node Path (Linux), Registry Entry ID (macOS), or Device Node number (Unix)
String	getVendor()	Vendor that manufactured the USB device
String	getVendorId()	ID of the vendor that manufactured the USB device
String	toString()

Methods inherited from class Object

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

Method Details

getUsbDevices

public static List<UsbDevice> getUsbDevices(boolean tree)

Instantiates a list of UsbDevice objects, representing devices connected via a usb port (including internal devices).

If the value of tree is true, the top level devices returned from this method are the USB Controllers; connected hubs and devices in its device tree share that controller's bandwidth. If the value of tree is false, USB devices (not controllers) are listed in a single flat list.

Parameters:

tree - If true, returns a list of controllers, which requires recursive iteration of connected devices. If false, returns a flat list of devices excluding controllers.

Returns:

a list of UsbDevice objects.