Class USBDevice

java.lang.Object

org.episteme.core.device.AbstractDevice

org.episteme.core.device.USBDevice

All Implemented Interfaces:

Serializable, AutoCloseable, Device, Commented, ComprehensiveIdentification, Identified<Identification>, Named

public abstract class USBDevice
extends AbstractDevice

Abstract base class for USB-connected devices.

This class provides the foundation for communication with USB-based laboratory devices including sensors (input) and actuators (output).

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractDevice

AbstractDevice.Record

Nested classes/interfaces inherited from interface Device

Device.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected int	productId
protected String	serialNumber
protected int	vendorId

Fields inherited from class AbstractDevice

accuracy, calibrationHistory, currentValue, displayUnit, firmware, history, identification, lastCalibration, locationDescription, manufacturer, maxRange, minRange, model, precisionDescription, resolution, sensitivity, status

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	USBDevice(String name)
protected	USBDevice(String name, int vendorId, int productId)

Method Summary

Modifier and Type	Method	Description
void	close()
int	getProductId()	Returns the USB Product ID.
String	getSerialNumber()	Returns the USB serial number.
int	getVendorId()	Returns the USB Vendor ID.
boolean	isConnected()	Checks if the device is currently connected.
abstract byte[]	read(int length)	Reads raw bytes from the USB device.
String	readResponse(int maxLength)	Reads a response string from the device.
void	sendCommand(String command)	Sends a command string to the device.
void	setSerialNumber(String serialNumber)
abstract void	write(byte[] data)	Sends raw bytes to the USB device.

Methods inherited from class AbstractDevice

calibrate, getAccuracy, getCalibrationHistory, getDeviceStatus, getDisplayUnit, getFirmware, getHistory, getId, getLastCalibration, getLocationDescription, getManufacturer, getMaxRange, getMeasurableQuantities, getMinRange, getModel, getPrecisionDescription, getResolution, getSensitivity, getStatus, getTrait, getTraitOptional, getTraits, getValue, isEnabled, measure, needsCalibration, performCalibration, recordMeasurement, setAccuracy, setCurrentValue, setDisplayUnit, setEnabled, setFirmware, setLastCalibration, setLocationDescription, setManufacturer, setMaxRange, setMinRange, setModel, setPrecisionDescription, setResolution, setSensitivity, setStatus

Methods inherited from class Object

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

Methods inherited from interface Commented

getComments, getTrait, setComments

Methods inherited from interface ComprehensiveIdentification

getName, setName, setTrait

Methods inherited from interface Device

calibrate, connect, disconnect, getCapabilities, getReadings

Field Details

vendorId

protected int vendorId

productId

protected int productId

serialNumber

protected String serialNumber

Constructor Details

USBDevice

protected USBDevice(String name)

USBDevice

protected USBDevice(String name,
 int vendorId,
 int productId)

Method Details

getVendorId

public int getVendorId()

Returns the USB Vendor ID.

getProductId

public int getProductId()

Returns the USB Product ID.

getSerialNumber

public String getSerialNumber()

Returns the USB serial number.

setSerialNumber

public void setSerialNumber(String serialNumber)

write

public abstract void write(byte[] data)
                    throws IOException

Sends raw bytes to the USB device.

Throws:

IOException

read

public abstract byte[] read(int length)
                     throws IOException

Reads raw bytes from the USB device.

Throws:

IOException

sendCommand

public void sendCommand(String command)
                 throws IOException

Sends a command string to the device.

Throws:

IOException

readResponse

public String readResponse(int maxLength)
                    throws IOException

Reads a response string from the device.

Throws:

IOException

isConnected

public boolean isConnected()

Description copied from interface: Device

Checks if the device is currently connected.

Returns:

true if connected, false otherwise

close

public void close()
           throws Exception

Throws:

Exception