org.openmuc.jrxtx

Interface SerialPort

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface SerialPort
extends java.io.Closeable

Serial port for communication using UARTs. Can be used for communication protocols such as RS-232 and RS-485.

A SerialPort is created using SerialPortBuilder. Once closed it cannot be opened again but has to be recreated.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the serial port.
int	getBaudRate()
DataBits	getDataBits() Get the current data bits config.
FlowControl	getFlowControl() Get the current flow control settings.
java.io.InputStream	getInputStream() Returns the input stream for this serial port.
java.io.OutputStream	getOutputStream() Returns the output stream for this serial port.
Parity	getParity() Get the parity.
java.lang.String	getPortName() Get the name of the serial port.
int	getSerialPortTimeout() Returns setting for serial port timeout.
StopBits	getStopBits() Get the current stop bits settings.
boolean	isClosed() Returns whether the serial port is currently open and available for communication.
void	setBaudRate(int baudRate) Sets the baud rate of the system.
void	setDataBits(DataBits dataBits) Set the data bits.
void	setFlowControl(FlowControl flowControl) Set the flow control type.
void	setParity(Parity parity) Set the new parity.
void	setSerialPortTimeout(int serialPortTimeout) Enable/disable serial port timeout with the specified timeout, in milliseconds.
void	setStopBits(StopBits stopBits) Set the stop bits.

Method Detail

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Returns the input stream for this serial port.

Closing the returned InputStream will close the associated serial port.

Returns:

the InputStream object that can be used to read from the port.

Throws:

java.io.IOException - if an I/O error occurred

getOutputStream

java.io.OutputStream getOutputStream()
                              throws java.io.IOException

Returns the output stream for this serial port.

Returns:

the OutputStream object that can be used to write to the port.

Throws:

java.io.IOException - if an I/O error occurred.

close

void close()
    throws java.io.IOException

Closes the serial port.

Also closes the associated input and output streams.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - if an I/O error occurred.

isClosed

boolean isClosed()

Returns whether the serial port is currently open and available for communication.

Returns:

true if the serial port is closed.

getPortName

java.lang.String getPortName()

Get the name of the serial port.

Returns:

the serial port name.

getDataBits

DataBits getDataBits()

Get the current data bits config.

Returns:

the dataBits the data bits.

setDataBits

void setDataBits(DataBits dataBits)
          throws java.io.IOException

Set the data bits.

Parameters:

dataBits - the new dataBits.

Throws:

java.io.IOException - if an I/O exception occurred when setting the new data bits..

getParity

Parity getParity()

Get the parity.

Returns:

the new parity.

setParity

void setParity(Parity parity)
        throws java.io.IOException

Set the new parity.

Parameters:

parity - the new parity.

Throws:

java.io.IOException - if an I/O exception occurred when setting the new parity.

getStopBits

StopBits getStopBits()

Get the current stop bits settings.

Returns:

the stopBits the stop bits.

setStopBits

void setStopBits(StopBits stopBits)
          throws java.io.IOException

Set the stop bits.

Parameters:

stopBits - the stopBits to set

Throws:

java.io.IOException - if an I/O exception occurred when setting the new stop bits.

getBaudRate

int getBaudRate()

Returns:

the baudRate setting.

See Also:

setBaudRate(int)

setBaudRate

void setBaudRate(int baudRate)
          throws java.io.IOException

Sets the baud rate of the system.

Parameters:

baudRate - the new baud rate.

Throws:

java.io.IOException - if an I/O exception occurred when setting the new baud rate.

See Also:

getBaudRate()

getSerialPortTimeout

int getSerialPortTimeout()

Returns setting for serial port timeout. 0 returns implies that the option is disabled (i.e., timeout of infinity).

Returns:

the serialPortTimeout.

See Also:

setSerialPortTimeout(int)

setSerialPortTimeout

void setSerialPortTimeout(int serialPortTimeout)
                   throws java.io.IOException

Enable/disable serial port timeout with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a read() call on the InputStream associated with this serial port will block for only this amount of time. If the timeout expires, a org.openmuc.jrxtx.SerialPortTimeoutExcepption is raised, though the serial port is still valid. The option must be enabled prior to entering the blocking operation to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout.

Parameters:

serialPortTimeout - the specified timeout, in milliseconds.

Throws:

java.io.IOException - if there is an error in the underlying protocol.

See Also:

getSerialPortTimeout()

setFlowControl

void setFlowControl(FlowControl flowControl)
             throws java.io.IOException

Set the flow control type.

Parameters:

flowControl - the flow control.

Throws:

java.io.IOException - if an I/O exception occurred when setting the new baud rate.

getFlowControl

FlowControl getFlowControl()

Get the current flow control settings.

Returns:

the flow control.