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 and Description
static class	LocalSerialPort.FlowControl
static class	LocalSerialPort.Parity

Field Summary

Fields

Modifier and Type	Field and Description
protected int	debug
static String	defaultPort
protected InputStream	inStream
protected OutputStream	outStream
protected boolean	verbose

Constructor Summary

Constructors

Constructor and Description
LocalSerialPort(int portNumber)
LocalSerialPort(String portName)
LocalSerialPort(String portName, int baud)
LocalSerialPort(String portName, int baud, int length, int stopBits, LocalSerialPort.Parity parity, LocalSerialPort.FlowControl flowControl, int timeout)

Method Summary

Modifier and Type	Method and Description
void	close()
void	dropDTR(int duration)
void	flush()
void	flushInput()
String	getActualPortName() Returns the actual port name being used.
static String	getSerialPortName(int portNumber)
static ArrayList<String>	getSerialPortNames(boolean useCached) Returns all serial port names found in the system.
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isValid() Tries to identify instances that are not valid.
void	open() Opens the device with previously set parameters.
void	open(boolean iterate) This version of open tries, if its argument is true, to open the "following" device if opening of the requested device fails.
void	setDebug(int debug) Sets a debug parameter.
void	setDTR(boolean state)
void	setTimeout(int timeout) Set timeout in milliseconds.
void	setVerbosity(boolean verbosity) 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 Detail

defaultPort

public static final String defaultPort

See Also:

Constant Field Values

inStream

protected InputStream inStream

outStream

protected OutputStream outStream

verbose

protected boolean verbose

debug

protected int debug

Constructor Detail

LocalSerialPort

public LocalSerialPort(String portName,
                       int baud,
                       int length,
                       int stopBits,
                       LocalSerialPort.Parity parity,
                       LocalSerialPort.FlowControl flowControl,
                       int timeout)
                throws gnu.io.NoSuchPortException,
                       gnu.io.PortInUseException,
                       gnu.io.UnsupportedCommOperationException,
                       IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPort

public LocalSerialPort(String portName,
                       int baud)
                throws gnu.io.NoSuchPortException,
                       gnu.io.PortInUseException,
                       gnu.io.UnsupportedCommOperationException,
                       IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPort

public LocalSerialPort(String portName)
                throws gnu.io.NoSuchPortException,
                       gnu.io.PortInUseException,
                       gnu.io.UnsupportedCommOperationException,
                       IOException

Throws:

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

IOException

LocalSerialPort

public LocalSerialPort(int portNumber)
                throws IOException,
                       gnu.io.NoSuchPortException,
                       gnu.io.PortInUseException,
                       gnu.io.UnsupportedCommOperationException

Throws:

IOException

gnu.io.NoSuchPortException

gnu.io.PortInUseException

gnu.io.UnsupportedCommOperationException

Method Detail

setVerbosity

public void setVerbosity(boolean verbosity)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation.

Specified by:

setVerbosity in interface IHarcHardware

Parameters:

verbosity - on or off

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

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

Specified by:

setDebug in interface IHarcHardware

open

public void open()
          throws HarcHardwareException,
                 IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Throws:

HarcHardwareException

IOException

open

public void open(boolean iterate)
          throws HarcHardwareException,
                 IOException

This version of open tries, if its argument is true, to open the "following" device if opening of the requested device fails. Up to maxtries attempts are made, then a HarcHardwareException is thrown on failure.

Parameters:

iterate -

Throws:

HarcHardwareException

IOException

getSerialPortName

public static String getSerialPortName(int portNumber)
                                throws IOException,
                                       gnu.io.NoSuchPortException

Throws:

IOException

gnu.io.NoSuchPortException

getSerialPortNames

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

Returns all serial port names found in the system.

Parameters:

useCached -

Returns:

ArrayList<String>

Throws:

IOException

flushInput

public void flushInput()
                throws IOException

Throws:

IOException

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Tries to identify instances that are not valid. 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.

getActualPortName

public String getActualPortName()

Returns the actual port name being used. May differ from one requested in the constructor if the device was opened with open(true).

Returns:

Actual port name used.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

flush

public void flush()
           throws IOException

Throws:

IOException

setDTR

public void setDTR(boolean state)

dropDTR

public void dropDTR(int duration)