net.wimpi.modbus.net

Class SerialConnection

java.lang.Object

net.wimpi.modbus.net.SerialConnection

All Implemented Interfaces:

SerialPortEventListener, EventListener

public class SerialConnection
extends Object
implements SerialPortEventListener

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

Version:

1.2

Author:

Dieter Wimberger, John Charlton, Dennis Geesen

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the port and clean up associated elements.
ModbusTransport	getModbusTransport() Returns the ModbusTransport instance to be used for receiving and sending messages.
SerialPort	getSerialPort() Returns the reference to the SerialPort instance.
boolean	isOpen() Reports the open status of the port.
void	open() Opens the communication port.
void	serialEvent(SerialPortEvent e) Serial event.
void	setConnectionParameters() Sets the connection parameters to the setting in the parameters object.
void	setReceiveTimeout(int ms) Sets receive timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialConnection

public SerialConnection(SerialParameters parameters)

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

Parameters:

parameters - A SerialParameters object.

Method Detail

getSerialPort

public SerialPort getSerialPort()

Returns the reference to the SerialPort instance.

Returns:

a reference to the SerialPort.

getModbusTransport

public ModbusTransport getModbusTransport()

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

Returns:

a ModbusTransport instance.

open

public void open()
          throws Exception

Opens the communication port.

Throws:

Exception - if an error occurs.

setReceiveTimeout

public void setReceiveTimeout(int ms)

Sets receive timeout.

Parameters:

ms - the ms

setConnectionParameters

public void setConnectionParameters()
                             throws Exception

Sets the connection parameters to the setting in the parameters object. If set fails return the parameters object to origional settings and throw exception.

Throws:

Exception - if the configured parameters cannot be set properly on the port.

close

public void close()
           throws IOException

Close the port and clean up associated elements.

Throws:

IOException

isOpen

public boolean isOpen()

Reports the open status of the port.

Returns:

true if port is open, false if port is closed.

serialEvent

public void serialEvent(SerialPortEvent e)

Description copied from interface: SerialPortEventListener

Serial event.

Specified by:

serialEvent in interface SerialPortEventListener

Parameters:

e - the event