com.ghgande.j2mod.modbus.net

Class SerialConnection

java.lang.Object

com.ghgande.j2mod.modbus.net.AbstractSerialConnection

com.ghgande.j2mod.modbus.net.SerialConnection

public class SerialConnection
extends AbstractSerialConnection

Class that implements a serial connection which can be used for master and slave implementations.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, John Charlton, Steve O'Hara (4NG)

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECT_RETRIES
static int	CONNECT_RETRY_DELAY

Fields inherited from class com.ghgande.j2mod.modbus.net.AbstractSerialConnection

EVEN_PARITY, FLOW_CONTROL_CTS_ENABLED, FLOW_CONTROL_DISABLED, FLOW_CONTROL_DSR_ENABLED, FLOW_CONTROL_DTR_ENABLED, FLOW_CONTROL_RTS_ENABLED, FLOW_CONTROL_XONXOFF_IN_ENABLED, FLOW_CONTROL_XONXOFF_OUT_ENABLED, MARK_PARITY, NO_PARITY, ODD_PARITY, ONE_POINT_FIVE_STOP_BITS, ONE_STOP_BIT, OPEN_DELAY, SPACE_PARITY, TIMEOUT_NONBLOCKING, TIMEOUT_READ_BLOCKING, TIMEOUT_READ_SEMI_BLOCKING, TIMEOUT_SCANNER, TIMEOUT_WRITE_BLOCKING, TWO_STOP_BITS

Constructor Summary

Constructors

Constructor and Description
SerialConnection() Default constructor
SerialConnection(SerialParameters parameters) Creates a SerialConnection object and initializes variables passed in as params.

Method Summary

Modifier and Type	Method and Description
int	bytesAvailable() Bytes available to read
void	close() Close the port and clean up associated elements
int	getBaudRate() Returns current baud rate
static AbstractSerialConnection	getCommPort(String commPort) Returns a JSerialComm implementation for the given comms port
Set<String>	getCommPorts() Returns a set of all the available comm port names
String	getDescriptivePortName() Returns a descriptive name of the port
AbstractModbusTransport	getModbusTransport() Returns the ModbusTransport instance to be used for receiving and sending messages.
int	getNumDataBits() Returns current data bits value
int	getNumStopBits() Returns current stop bits
int	getParity() Returns current parity
String	getPortName() Returns a name of the port
int	getTimeout() Returns the timeout for this connection
boolean	isOpen() Reports the open status of the port
void	open() Opens the port and throws an error if it cannot for some reason
int	readBytes(byte[] buffer, int bytesToRead) Read a specified number of bytes from the serial port
void	setComPortTimeouts(int newTimeoutMode, int newReadTimeout, int newWriteTimeout) Set port timeouts
void	setTimeout(int timeout) Sets the timeout for this connection.
int	writeBytes(byte[] buffer, int bytesToWrite) Write a specified number of bytes to the serial port

Methods inherited from class java.lang.Object

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

Field Detail

CONNECT_RETRY_DELAY

public static final int CONNECT_RETRY_DELAY

See Also:

Constant Field Values

CONNECT_RETRIES

public static final int CONNECT_RETRIES

See Also:

Constant Field Values

Constructor Detail

SerialConnection

public SerialConnection()

Default constructor

SerialConnection

public SerialConnection(SerialParameters parameters)

Creates a SerialConnection object and initializes variables passed in as params.

Parameters:

parameters - A SerialParameters object.

Method Detail

getCommPort

public static AbstractSerialConnection getCommPort(String commPort)

Returns a JSerialComm implementation for the given comms port

Parameters:

commPort - Comms port e.g. /dev/ttyAMA0

Returns:

JSerialComm implementation

getModbusTransport

public AbstractModbusTransport getModbusTransport()

Description copied from class: AbstractSerialConnection

Returns the ModbusTransport instance to be used for receiving and sending messages.

Specified by:

getModbusTransport in class AbstractSerialConnection

Returns:

a ModbusTransport instance

open

public void open()
          throws IOException

Description copied from class: AbstractSerialConnection

Opens the port and throws an error if it cannot for some reason

Specified by:

open in class AbstractSerialConnection

Throws:

IOException - If the port is not available or cannot be opened

close

public void close()

Description copied from class: AbstractSerialConnection

Close the port and clean up associated elements

Specified by:

close in class AbstractSerialConnection

isOpen

public boolean isOpen()

Description copied from class: AbstractSerialConnection

Reports the open status of the port

Specified by:

isOpen in class AbstractSerialConnection

Returns:

true if port is open, false if port is closed

getTimeout

public int getTimeout()

Description copied from class: AbstractSerialConnection

Returns the timeout for this connection

Specified by:

getTimeout in class AbstractSerialConnection

Returns:

the timeout as int milliseconds

setTimeout

public void setTimeout(int timeout)

Description copied from class: AbstractSerialConnection

Sets the timeout for this connection.

Specified by:

setTimeout in class AbstractSerialConnection

Parameters:

timeout - the timeout as int milliseconds

readBytes

public int readBytes(byte[] buffer,
                     int bytesToRead)

Description copied from class: AbstractSerialConnection

Read a specified number of bytes from the serial port

Specified by:

readBytes in class AbstractSerialConnection

Parameters:

buffer - Buffer to recieve bytes from the port

bytesToRead - Number of bytes to read

Returns:

number of currently bytes read

writeBytes

public int writeBytes(byte[] buffer,
                      int bytesToWrite)

Description copied from class: AbstractSerialConnection

Write a specified number of bytes to the serial port

Specified by:

writeBytes in class AbstractSerialConnection

Parameters:

buffer - Bytes to send to the port

bytesToWrite - How many bytes to send

Returns:

number of currently bytes written

bytesAvailable

public int bytesAvailable()

Description copied from class: AbstractSerialConnection

Bytes available to read

Specified by:

bytesAvailable in class AbstractSerialConnection

Returns:

number of bytes currently available to read

getBaudRate

public int getBaudRate()

Description copied from class: AbstractSerialConnection

Returns current baud rate

Specified by:

getBaudRate in class AbstractSerialConnection

Returns:

Baud rate

getNumDataBits

public int getNumDataBits()

Description copied from class: AbstractSerialConnection

Returns current data bits value

Specified by:

getNumDataBits in class AbstractSerialConnection

Returns:

Number of data bits

getNumStopBits

public int getNumStopBits()

Description copied from class: AbstractSerialConnection

Returns current stop bits

Specified by:

getNumStopBits in class AbstractSerialConnection

Returns:

Number of stop bits

getParity

public int getParity()

Description copied from class: AbstractSerialConnection

Returns current parity

Specified by:

getParity in class AbstractSerialConnection

Returns:

Parity type

getPortName

public String getPortName()

Description copied from class: AbstractSerialConnection

Returns a name of the port

Specified by:

getPortName in class AbstractSerialConnection

Returns:

a String instance

getDescriptivePortName

public String getDescriptivePortName()

Description copied from class: AbstractSerialConnection

Returns a descriptive name of the port

Specified by:

getDescriptivePortName in class AbstractSerialConnection

Returns:

a String instance

setComPortTimeouts

public void setComPortTimeouts(int newTimeoutMode,
                               int newReadTimeout,
                               int newWriteTimeout)

Description copied from class: AbstractSerialConnection

Set port timeouts

Specified by:

setComPortTimeouts in class AbstractSerialConnection

Parameters:

newTimeoutMode - Timeout mode

newReadTimeout - Read timeout (milliseconds)

newWriteTimeout - Write timeout (milliseconds)

getCommPorts

public Set<String> getCommPorts()

Description copied from class: AbstractSerialConnection

Returns a set of all the available comm port names

Specified by:

getCommPorts in class AbstractSerialConnection

Returns:

Set of comm port names