Package com.diozero.api

Class SerialDevice.DeviceInfo

java.lang.Object

com.diozero.api.SerialDevice.DeviceInfo

Enclosing class:

SerialDevice

public static class SerialDevice.DeviceInfo
extends Object

Provides descriptive information for a connected serial device. The information can be provided by the manufacturer of the device or by the UART used by the device.

Often the information can be used to identify specific devices connected to a serial port. If two identical devices are connected to serial ports, they cannot be differentiated using this information.

The following fields are supported:

deviceFile

the file system name for a serial device, e.g., /dev/ttyACM0 /dev/ttyS0, /dev/ttyAMA0

deviceName

generally a subset of deviceFile, e.g., ttyACM0

description

human readable, and theoretically unique, text that identifies the device attached to a serial port, e.g., Pololu A-Star 32U4; can be generic, e.g., Physical Port

manufacturer

human readable text that identifies the manufacturer of the device attached to a serial port, e.g., Pololu Corporation; can be null

driverName

the name of the device driver, e.g., usb:cdc_acm, bcm2835-aux-uart, uart-pl011

usbVendorId

a theoretically unique number identifying the vendor, e.g., 1ffb; can be null

usbProductId

theoretically unique number identifying the product, e.g., 2300; can be null

Constructor Summary

Constructors

Constructor	Description
DeviceInfo(String deviceName, String deviceFile, String description, String manufacturer, String driverName, String usbVendorId, String usbProductId)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getDeviceFile()
String	getDeviceName()
String	getDriverName()
String	getManufacturer()
String	getUsbProductId()
String	getUsbVendorId()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceInfo

public DeviceInfo(String deviceName,
                  String deviceFile,
                  String description,
                  String manufacturer,
                  String driverName,
                  String usbVendorId,
                  String usbProductId)

Method Detail

getDeviceName

public String getDeviceName()

getDeviceFile

public String getDeviceFile()

getDescription

public String getDescription()

getManufacturer

public String getManufacturer()

getDriverName

public String getDriverName()

getUsbVendorId

public String getUsbVendorId()

getUsbProductId

public String getUsbProductId()