net.solarnetwork.io.modbus.serial

Interface SerialPort

public interface SerialPort

API for a serial port.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the stream.
InputStream	getInputStream()	Get the serial input stream.
String	getName()	Get the name of the serial port, such as /dev/ttyUSB0 or COM1.
OutputStream	getOutputStream()	Get the serial output stream.
boolean	isOpen()	Test if the stream is open.
void	open(SerialParameters parameters)	Open the stream.

Method Detail

getName

String getName()

Get the name of the serial port, such as /dev/ttyUSB0 or COM1.

Returns:

the serial port name

open

void open(SerialParameters parameters)
   throws IOException

Open the stream.

Parameters:

parameters - the desired serial parameters

Throws:

IOException - if any communication error occurs

close

void close()
    throws IOException

Close the stream.

Throws:

IOException - if any communication error occurs

isOpen

boolean isOpen()

Test if the stream is open.

Returns:

true if the stream is open

getInputStream

InputStream getInputStream()
                    throws IOException

Get the serial input stream.

The stream must have been opened via open(SerialParameters) before calling this.

Returns:

the input stream

Throws:

IOException

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Get the serial output stream.

The stream must have been opened via open(SerialParameters) before calling this.

Returns:

the output stream

Throws:

IOException