Package org.harctoolbox.harchardware.comm

Class LocalSerialPort

java.lang.Object

org.harctoolbox.harchardware.comm.LocalSerialPort

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware

Direct Known Subclasses:

LocalSerialPortBuffered, LocalSerialPortRaw

public abstract class LocalSerialPort
extends Object
implements IHarcHardware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LocalSerialPort.FlowControl
static enum	LocalSerialPort.Parity
static enum	LocalSerialPort.StopBits

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT
static final int	DEFAULT_BAUD
static final int	DEFAULT_DATABITS
static final LocalSerialPort.FlowControl	DEFAULT_FLOWCONTROL
static final LocalSerialPort.Parity	DEFAULT_PARITY
static final String	DEFAULT_PORT
static final LocalSerialPort.StopBits	DEFAULT_STOPBITS
static final int	DEFAULT_TIMEOUT
protected InputStream	inStream
protected OutputStream	outStream
protected boolean	verbose

Constructor Summary

Constructors

Constructor	Description
LocalSerialPort(Integer portNumber)
LocalSerialPort(String portName)
LocalSerialPort(String portName, boolean verbose)
LocalSerialPort(String portName, boolean verbose, Integer timeout)
LocalSerialPort(String portName, boolean verbose, Integer timeout, Integer baud)
LocalSerialPort(String portName, boolean verbose, Integer timeout, Integer baud, Integer dataLength, LocalSerialPort.StopBits stopBits, LocalSerialPort.Parity parity, LocalSerialPort.FlowControl flowControl)

Method Summary

Modifier and Type	Method	Description
static String	canonicalizePortName(String portName)
static String	canonicalizePortName(String name, String dflt)
void	close()
void	dropDTR(int duration)
void	flush()
void	flushInput()
String	getPortName()	Returns the nominal port name being used.
static String	getSerialPortName(Integer portNumber)
static List<String>	getSerialPortNames(boolean useCached)	Returns all serial port names found in the system.
static String	getSoftwareVersion()
String	getVersion()	Returns the hardware version (not the version of the driver software).
boolean	isValid()	Checks validity of an instance.
static LocalSerialPort.StopBits	mkStopBits(int stopBits)
void	open()	Opens the device.
void	setDebug(int dbg)	Sets a debug parameter.
void	setDTR(boolean state)
static void	setLibraryDir(File libraryDir)
void	setTimeout(int timeout)	Set timeout in milliseconds.
void	setVerbose(boolean verbose)	Sets a verbosity flag, causing commands to be executed verbosely.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PORT

public static final String DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_BAUD

public static final int DEFAULT_BAUD

See Also:

• Constant Field Values

DEFAULT_DATABITS

public static final int DEFAULT_DATABITS

See Also:

• Constant Field Values

DEFAULT_PARITY

public static final LocalSerialPort.Parity DEFAULT_PARITY

DEFAULT_STOPBITS

public static final LocalSerialPort.StopBits DEFAULT_STOPBITS

DEFAULT_FLOWCONTROL

public static final LocalSerialPort.FlowControl DEFAULT_FLOWCONTROL

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

• Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

• Constant Field Values

inStream

protected InputStream inStream

outStream

protected OutputStream outStream

verbose

protected boolean verbose

Constructor Details

LocalSerialPort

public LocalSerialPort(String portName,
 boolean verbose,
 Integer timeout,
 Integer baud,
 Integer dataLength,
 LocalSerialPort.StopBits stopBits,
 LocalSerialPort.Parity parity,
 LocalSerialPort.FlowControl flowControl)
                throws IOException

Throws:

IOException

LocalSerialPort

public LocalSerialPort(String portName,
 boolean verbose,
 Integer timeout,
 Integer baud)
                throws IOException

Throws:

IOException

LocalSerialPort

public LocalSerialPort(String portName,
 boolean verbose,
 Integer timeout)
                throws IOException

Throws:

IOException

LocalSerialPort

public LocalSerialPort(String portName,
 boolean verbose)
                throws IOException

Throws:

IOException

LocalSerialPort

public LocalSerialPort(String portName)
                throws IOException

Throws:

IOException

LocalSerialPort

public LocalSerialPort(Integer portNumber)
                throws NonExistingPortException,
IOException

Throws:

NonExistingPortException

IOException

Method Details

setLibraryDir

public static void setLibraryDir(File libraryDir)
                          throws IOException

Throws:

IOException

getSerialPortName

public static String getSerialPortName(Integer portNumber)
                                throws NonExistingPortException

Throws:

NonExistingPortException

getSerialPortNames

public static List<String> getSerialPortNames(boolean useCached)
                                       throws IOException

Returns all serial port names found in the system.

Parameters:

useCached - If true, use previously acquired list, if available

Returns:

ArrayList<String>

Throws:

IOException

canonicalizePortName

public static String canonicalizePortName(String name,
 String dflt)
                                   throws IOException

Throws:

IOException

canonicalizePortName

public static String canonicalizePortName(String portName)
                                   throws IOException

Throws:

IOException

getSoftwareVersion

public static String getSoftwareVersion()

mkStopBits

public static LocalSerialPort.StopBits mkStopBits(int stopBits)

setVerbose

public void setVerbose(boolean verbose)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation. Typically, all communication with the device is echoed to stderr.

Specified by:

setVerbose in interface IHarcHardware

Parameters:

verbose - on or off

open

public void open()
          throws NonExistingPortException,
HarcHardwareException,
IOException

Opens the device.

Specified by:

open in interface IHarcHardware

Throws:

NonExistingPortException

HarcHardwareException - Bundles RXTX exceptions together.

IOException

flushInput

public void flushInput()
                throws IOException

Throws:

IOException

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Checks validity of an instance. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

setTimeout

public void setTimeout(int timeout)
                throws IOException

Description copied from interface: IHarcHardware

Set timeout in milliseconds. Exact semantics may be dependent on the hardware.

Specified by:

setTimeout in interface IHarcHardware

Parameters:

timeout - Timeout in milliseconds.

Throws:

IOException

getVersion

public String getVersion()

Description copied from interface: IHarcHardware

Returns the hardware version (not the version of the driver software). May be null if no relevant information available.

Specified by:

getVersion in interface IHarcHardware

Returns:

Version string. Semantics can vary.

getPortName

public String getPortName()

Returns the nominal port name being used. May differ from one requested in the constructor if the device was opened with open(true), or if it is symlink (for example created by udev).

Returns:

port name used.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

flush

public void flush()
           throws IOException

Throws:

IOException

setDTR

public void setDTR(boolean state)

dropDTR

public void dropDTR(int duration)

setDebug

public void setDebug(int dbg)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware