com.sparetimelabs.serial

Class PureJavaSerialPort

java.lang.Object

com.sparetimelabs.serial.CommPort

com.sparetimelabs.serial.SerialPort

com.sparetimelabs.serial.PureJavaSerialPort

public class PureJavaSerialPort
extends SerialPort

The type Pure java serial port.

Field Summary

Fields inherited from class com.sparetimelabs.serial.SerialPort

DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8, FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN, FLOWCONTROL_XONXOFF_OUT, PARITY_EVEN, PARITY_MARK, PARITY_NONE, PARITY_ODD, PARITY_SPACE, STOPBITS_1, STOPBITS_1_5, STOPBITS_2

Fields inherited from class com.sparetimelabs.serial.CommPort

name

Method Summary

Modifier and Type	Method and Description
void	addEventListener(SerialPortEventListener eventListener) Registers a SerialPortEventListener object to listen for SerialEvents.
void	close() Closes the communications port.
void	disableReceiveFraming() Disables receive framing.
void	disableReceiveThreshold() Disables receive threshold.
void	disableReceiveTimeout() Disables receive timeout.
void	enableReceiveFraming(int arg0) Enables receive framing.
void	enableReceiveThreshold(int value) Enables receive threshold.
void	enableReceiveTimeout(int value) Enables receive timeout.
int	getBaudRate() Returns the currently configured baud rate.
int	getDataBits() Returns the currently configured number of data bits.
int	getFlowControlMode() Returns the currently configured flow control mode.
int	getInputBufferSize() Returns the input buffer size in bytes.
InputStream	getInputStream() Returns an input stream.
int	getNativeFileDescriptor() Gets the native file descriptor used by this port.
int	getOutputBufferSize() Returns the output buffer size in bytes.
OutputStream	getOutputStream() Returns an output stream.
int	getParity() Returns the currently configured parity setting.
int	getReceiveFramingByte() Returns the current byte used for receive framing.
int	getReceiveThreshold() Returns the integer value of the receive threshold.
int	getReceiveTimeout() Returns the integer value of the receive timeout.
int	getStopBits() Returns the currently defined stop bits.
boolean	isCD() Returns the state of the CD (Carrier Detect) bit in the UART, if supported by the underlying implementation.
boolean	isCTS() Returns the state of the CTS (Clear To Send) bit in the UART, if supported by the underlying implementation.
boolean	isDSR() Returns the state of the DSR (Data Set Ready) bit in the UART, if supported by the underlying implementation.
boolean	isDTR() Returns the state of the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation.
boolean	isInternalThreadRunning() This is not part of the PureJavaComm API, this is purely for testing, do not depend on this
boolean	isReceiveFramingEnabled() Returns true if receive framing is enabled.
boolean	isReceiveThresholdEnabled() Returns true if receive threshold is enabled.
boolean	isReceiveTimeoutEnabled() Returns true if receive timeout is enabled.
boolean	isRI() Returns the state of the RI (Ring Indicator) bit in the UART, if supported by the underlying implementation.
boolean	isRTS() Returns the state of the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.
void	notifyOnBreakInterrupt(boolean x) Expresses interest in receiving notification when there is a break interrupt on the line.
void	notifyOnCarrierDetect(boolean x) Expresses interest in receiving notification when the CD (Carrier Detect) bit changes.
void	notifyOnCTS(boolean x) Expresses interest in receiving notification when the CTS (Clear To Send) bit changes.
void	notifyOnDataAvailable(boolean x) Expresses interest in receiving notification when input data is available.
void	notifyOnDSR(boolean x) Expresses interest in receiving notification when the DSR (Data Set Ready) bit changes.
void	notifyOnFramingError(boolean x) Expresses interest in receiving notification when there is a framing error.
void	notifyOnOutputEmpty(boolean x) Expresses interest in receiving notification when the output buffer is empty.
void	notifyOnOverrunError(boolean x) Expresses interest in receiving notification when there is an overrun error.
void	notifyOnParityError(boolean x) Expresses interest in receiving notification when there is a parity error.
void	notifyOnRingIndicator(boolean x) Expresses interest in receiving notification when the RI (Ring Indicator) bit changes.
void	removeEventListener() Deregisters event listener registered using addEventListener .
void	sendBreak(int duration) Sends a break of duration milliseconds duration.
void	setDTR(boolean x) Sets or clears the DTR (Data Terminal Ready) signal, if supported by the underlying implementation.
void	setFlowControlMode(int mode) Sets the flow control mode.
void	setInputBufferSize(int arg0) Sets the input buffer size.
void	setOutputBufferSize(int arg0) Sets the output buffer size.
void	setRTS(boolean x) Sets or clears the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.
void	setSerialPortParams(int baudRate, int dataBits, int stopBits, int parity) Sets the serial port parameters.

Methods inherited from class com.sparetimelabs.serial.CommPort

getName

Methods inherited from class java.lang.Object

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

Method Detail

addEventListener

public void addEventListener(SerialPortEventListener eventListener)
                      throws TooManyListenersException

Description copied from class: SerialPort

Registers a SerialPortEventListener object to listen for SerialEvents.

Specified by:

addEventListener in class SerialPort

Parameters:

eventListener - the listener

Throws:

TooManyListenersException - the too many listeners exception

getBaudRate

public int getBaudRate()

Description copied from class: SerialPort

Returns the currently configured baud rate.

Specified by:

getBaudRate in class SerialPort

Returns:

The currently configured baud rate.

getDataBits

public int getDataBits()

Description copied from class: SerialPort

Returns the currently configured number of data bits.

Specified by:

getDataBits in class SerialPort

Returns:

The currently configured number of data bits.

getFlowControlMode

public int getFlowControlMode()

Description copied from class: SerialPort

Returns the currently configured flow control mode.

Specified by:

getFlowControlMode in class SerialPort

Returns:

The currently configured flow control mode.

getParity

public int getParity()

Description copied from class: SerialPort

Returns the currently configured parity setting.

Specified by:

getParity in class SerialPort

Returns:

The currently configured parity setting.

getStopBits

public int getStopBits()

Description copied from class: SerialPort

Returns the currently defined stop bits.

Specified by:

getStopBits in class SerialPort

Returns:

The currently defined stop bits.

isCD

public boolean isCD()

Description copied from class: SerialPort

Returns the state of the CD (Carrier Detect) bit in the UART, if supported by the underlying implementation.

Specified by:

isCD in class SerialPort

Returns:

The state of the CD (Carrier Detect) bit.

isCTS

public boolean isCTS()

Description copied from class: SerialPort

Returns the state of the CTS (Clear To Send) bit in the UART, if supported by the underlying implementation.

Specified by:

isCTS in class SerialPort

Returns:

The state of the CTS (Clear To Send) bit.

isDSR

public boolean isDSR()

Description copied from class: SerialPort

Returns the state of the DSR (Data Set Ready) bit in the UART, if supported by the underlying implementation.

Specified by:

isDSR in class SerialPort

Returns:

The state of the DSR (Data Set Ready) bit.

isDTR

public boolean isDTR()

Description copied from class: SerialPort

Returns the state of the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation.

Specified by:

isDTR in class SerialPort

Returns:

The state of the DTR (Data Terminal Ready) bit.

isRI

public boolean isRI()

Description copied from class: SerialPort

Returns the state of the RI (Ring Indicator) bit in the UART, if supported by the underlying implementation.

Specified by:

isRI in class SerialPort

Returns:

The state of the RI (Ring Indicator) bit.

isRTS

public boolean isRTS()

Description copied from class: SerialPort

Returns the state of the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.

Specified by:

isRTS in class SerialPort

Returns:

The state of the RTS (Request To Send) bit.

notifyOnBreakInterrupt

public void notifyOnBreakInterrupt(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when there is a break interrupt on the line.

Specified by:

notifyOnBreakInterrupt in class SerialPort

Parameters:

x - the enable

notifyOnCTS

public void notifyOnCTS(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when the CTS (Clear To Send) bit changes.

Specified by:

notifyOnCTS in class SerialPort

Parameters:

x - the enable

notifyOnCarrierDetect

public void notifyOnCarrierDetect(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when the CD (Carrier Detect) bit changes.

Specified by:

notifyOnCarrierDetect in class SerialPort

Parameters:

x - the enable

notifyOnDSR

public void notifyOnDSR(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when the DSR (Data Set Ready) bit changes.

This notification is hardware dependent and may not be supported by all implementations.

Specified by:

notifyOnDSR in class SerialPort

Parameters:

x - the enable

notifyOnDataAvailable

public void notifyOnDataAvailable(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when input data is available.

Specified by:

notifyOnDataAvailable in class SerialPort

Parameters:

x - the enable

notifyOnFramingError

public void notifyOnFramingError(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when there is a framing error.

Specified by:

notifyOnFramingError in class SerialPort

Parameters:

x - the enable

notifyOnOutputEmpty

public void notifyOnOutputEmpty(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when the output buffer is empty.

Specified by:

notifyOnOutputEmpty in class SerialPort

Parameters:

x - the enable

notifyOnOverrunError

public void notifyOnOverrunError(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when there is an overrun error.

Specified by:

notifyOnOverrunError in class SerialPort

Parameters:

x - the enable

notifyOnParityError

public void notifyOnParityError(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when there is a parity error.

Specified by:

notifyOnParityError in class SerialPort

Parameters:

x - the enable

notifyOnRingIndicator

public void notifyOnRingIndicator(boolean x)

Description copied from class: SerialPort

Expresses interest in receiving notification when the RI (Ring Indicator) bit changes.

Specified by:

notifyOnRingIndicator in class SerialPort

Parameters:

x - the enable

removeEventListener

public void removeEventListener()

Description copied from class: SerialPort

Deregisters event listener registered using addEventListener .

This is done automatically when the port is closed.

Specified by:

removeEventListener in class SerialPort

sendBreak

public void sendBreak(int duration)

Description copied from class: SerialPort

Sends a break of duration milliseconds duration.

Specified by:

sendBreak in class SerialPort

Parameters:

duration - The break duration in milliseconds.

setDTR

public void setDTR(boolean x)

Description copied from class: SerialPort

Sets or clears the DTR (Data Terminal Ready) signal, if supported by the underlying implementation.

Specified by:

setDTR in class SerialPort

Parameters:

x - the state

setRTS

public void setRTS(boolean x)

Description copied from class: SerialPort

Sets or clears the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.

Specified by:

setRTS in class SerialPort

Parameters:

x - the state

disableReceiveFraming

public void disableReceiveFraming()

Description copied from class: CommPort

Disables receive framing.

Specified by:

disableReceiveFraming in class CommPort

disableReceiveThreshold

public void disableReceiveThreshold()

Description copied from class: CommPort

Disables receive threshold.

Specified by:

disableReceiveThreshold in class CommPort

disableReceiveTimeout

public void disableReceiveTimeout()

Description copied from class: CommPort

Disables receive timeout.

Specified by:

disableReceiveTimeout in class CommPort

enableReceiveThreshold

public void enableReceiveThreshold(int value)
                            throws UnsupportedCommOperationException

Description copied from class: CommPort

Enables receive threshold.

Specified by:

enableReceiveThreshold in class CommPort

Parameters:

value - the threshold

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

enableReceiveTimeout

public void enableReceiveTimeout(int value)
                          throws UnsupportedCommOperationException

Description copied from class: CommPort

Enables receive timeout.

Specified by:

enableReceiveTimeout in class CommPort

Parameters:

value - Timeout value in milliseconds

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

enableReceiveFraming

public void enableReceiveFraming(int arg0)
                          throws UnsupportedCommOperationException

Description copied from class: CommPort

Enables receive framing.

Specified by:

enableReceiveFraming in class CommPort

Parameters:

arg0 - the framing byte

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

getInputBufferSize

public int getInputBufferSize()

Description copied from class: CommPort

Returns the input buffer size in bytes.

Specified by:

getInputBufferSize in class CommPort

Returns:

The input buffer size in bytes.

getOutputBufferSize

public int getOutputBufferSize()

Description copied from class: CommPort

Returns the output buffer size in bytes.

Specified by:

getOutputBufferSize in class CommPort

Returns:

The output buffer size in bytes.

setFlowControlMode

public void setFlowControlMode(int mode)
                        throws UnsupportedCommOperationException

Description copied from class: SerialPort

Sets the flow control mode.

Specified by:

setFlowControlMode in class SerialPort

Parameters:

mode - the flowcontrol

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

setSerialPortParams

public void setSerialPortParams(int baudRate,
                                int dataBits,
                                int stopBits,
                                int parity)
                         throws UnsupportedCommOperationException

Description copied from class: SerialPort

Sets the serial port parameters. Default: 9600 baud, 8 data bits, 1 stop bit, no parity.

Specified by:

setSerialPortParams in class SerialPort

Parameters:

baudRate - the baud rate

dataBits - the data bits

stopBits - the stop bits

parity - the parity

Throws:

UnsupportedCommOperationException - the unsupported comm operation exception

getNativeFileDescriptor

public int getNativeFileDescriptor()

Gets the native file descriptor used by this port.

The file descriptor can be used in calls to JTermios functions. This maybe useful in extreme cases where performance is more important than convenience, for example using JTermios.read(...) instead of SerialPort.getInputStream().read(...).

Note that mixing direct JTermios read/write calls with SerialPort stream read/write calls is at best fragile and likely to fail, which also implies that when using JTermios directly then configuring the port, especially termios.cc[VMIN] and termios.cc[VTIME] is the users responsibility.

Below is a sketch of minimum necessary to perform a read using raw JTermios functionality.

 
 		// import the JTermios functionality like this
 		import jtermios.*;
 		import static jtermios.JTermios.*;

 		SerialPort port = ...;

 		// cast the port to PureJavaSerialPort to get access to getNativeFileDescriptor
 		int FD = ((PureJavaSerialPort) port).getNativeFileDescriptor();

 		// timeout and threshold values
 		int messageLength = 25; // bytes
 		int timeout = 200; // msec

 		// to initialize timeout and threshold first read current termios
 		Termios termios = new Termios();

 		if (0 != tcgetattr(FD, termios))
 			errorHandling();

 		// then set VTIME and VMIN, note VTIME in 1/10th of sec and both max 255
 		termios.c_cc[VTIME] = (byte) ((timeout+99) / 100);
 		termios.c_cc[VMIN] = (byte) messageLength;

 		// update termios
 		if (0 != tcsetattr(FD, TCSANOW, termios))
 			errorHandling();

      ...
 		// allocate read buffer
 		byte[] readBuffer = new byte[messageLength];
      ...

 		// then perform raw read, not this may block indefinitely
 		int n = read(FD, readBuffer, messageLength);
 		if (n < 0)
 			errorHandling();
 
 

Returns:

the native OS file descriptor as int

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from class: CommPort

Returns an output stream.

Specified by:

getOutputStream in class CommPort

Returns:

An output stream, or null if the port is unidirectional and doesn't support sending data.

Throws:

IOException - the io exception

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: SerialPort

Returns an input stream. This is the only way to receive data from the communications port. If the port is unidirectional and doesn't support receiving data, then getInputStream returns null. The read behavior of the input stream returned by getInputStream depends on combination of the threshold and timeout values. The behaviors are described in the table below.

threshold		timeout		read buffer size	read behaviour
state	value	state	value
disabled	-	disabled	-	n bytes	block until minimum one byte of data is available
enabled	m bytes	disabled	-	n bytes	block until min(m,n) bytes are available
disabled	-	enabled	x msec	n bytes	block for x msec or until any data is available
enabled	m bytes	enabled	x msec	n bytes	block for x msec or until min(m,n) bytes are available

Framing errors may cause the Timeout and Threshold trigger early and to complete the read prematurely without raising an exception.

Enabling the Timeout OR Threshold with a value a zero is a special case. This causes the underlying driver to poll for incoming data instead being event driven. Otherwise, the behaviour is identical to having both the Timeout and Threshold disabled. Returns: InputStream object that can be used to read from the port Throws: java.io.IOException - if an I/O error occurred.

Timeout is interpreted as inter character timeout, in other words the timeout will not occur as long as the pause before the first character or between characters is shorter that the timeout value.

Specified by:

getInputStream in class SerialPort

Returns:

An input stream, or null if the port is unidirectional and doesn't support receiving data.

Throws:

IOException - the io exception

getReceiveFramingByte

public int getReceiveFramingByte()

Description copied from class: CommPort

Returns the current byte used for receive framing.

Specified by:

getReceiveFramingByte in class CommPort

Returns:

The current byte used for receive framing.

getReceiveThreshold

public int getReceiveThreshold()

Description copied from class: CommPort

Returns the integer value of the receive threshold.

Specified by:

getReceiveThreshold in class CommPort

Returns:

The integer value of the receive threshold.

getReceiveTimeout

public int getReceiveTimeout()

Description copied from class: CommPort

Returns the integer value of the receive timeout. If the receive timeout is disabled, then the value returned is meaningless.

Specified by:

getReceiveTimeout in class CommPort

Returns:

The integer value of the receive timeout.

isReceiveFramingEnabled

public boolean isReceiveFramingEnabled()

Description copied from class: CommPort

Returns true if receive framing is enabled.

Specified by:

isReceiveFramingEnabled in class CommPort

Returns:

true if receive framing is enabled.

isReceiveThresholdEnabled

public boolean isReceiveThresholdEnabled()

Description copied from class: CommPort

Returns true if receive threshold is enabled.

Specified by:

isReceiveThresholdEnabled in class CommPort

Returns:

true if receive threshold is enabled.

isReceiveTimeoutEnabled

public boolean isReceiveTimeoutEnabled()

Description copied from class: CommPort

Returns true if receive timeout is enabled.

Specified by:

isReceiveTimeoutEnabled in class CommPort

Returns:

true if receive timeout is enabled.

setInputBufferSize

public void setInputBufferSize(int arg0)

Description copied from class: CommPort

Sets the input buffer size.

Specified by:

setInputBufferSize in class CommPort

Parameters:

arg0 - the size

setOutputBufferSize

public void setOutputBufferSize(int arg0)

Description copied from class: CommPort

Sets the output buffer size.

Specified by:

setOutputBufferSize in class CommPort

Parameters:

arg0 - the size

close

public void close()

Description copied from class: CommPort

Closes the communications port.

Overrides:

close in class CommPort

isInternalThreadRunning

public boolean isInternalThreadRunning()

This is not part of the PureJavaComm API, this is purely for testing, do not depend on this

Returns:

the boolean