com.ghgande.j2mod.modbus.facade

Class ModbusSerialMaster

java.lang.Object

com.ghgande.j2mod.modbus.facade.AbstractModbusMaster

com.ghgande.j2mod.modbus.facade.ModbusSerialMaster

public class ModbusSerialMaster
extends AbstractModbusMaster

Modbus/Serial Master facade.

Version:

2.0 (March 2016)

Author:

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

Constructor Summary

Constructors

Constructor and Description
ModbusSerialMaster(SerialParameters param) Constructs a new master facade instance for communication with a given slave.
ModbusSerialMaster(SerialParameters param, int timeout) Constructs a new master facade instance for communication with a given slave.
ModbusSerialMaster(SerialParameters param, int timeout, int transDelay) Constructs a new master facade instance for communication with a given slave.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects this ModbusSerialMaster with the slave.
void	disconnect() Disconnects this ModbusSerialMaster from the slave.
AbstractSerialConnection	getConnection()
AbstractModbusTransport	getTransport() Returns the transport being used by the
boolean	isConnected() Returns true if the master is connected
void	setTimeout(int timeout) Sets the receive timeout

Methods inherited from class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster

getTimeout, maskWriteRegister, maskWriteRegister, readCoils, readCoils, readInputDiscretes, readInputDiscretes, readInputRegisters, readInputRegisters, readMultipleRegisters, readMultipleRegisters, setCheckingValidity, setRetries, writeCoil, writeCoil, writeMultipleCoils, writeMultipleCoils, writeMultipleRegisters, writeMultipleRegisters, writeSingleRegister, writeSingleRegister

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusSerialMaster

public ModbusSerialMaster(SerialParameters param)

Constructs a new master facade instance for communication with a given slave.

Parameters:

param - SerialParameters specifies the serial port parameters to use to communicate with the slave device network.

ModbusSerialMaster

public ModbusSerialMaster(SerialParameters param,
                          int timeout)

Constructs a new master facade instance for communication with a given slave.

Parameters:

param - SerialParameters specifies the serial port parameters to use to communicate with the slave device network.

timeout - Receive timeout in milliseconds

ModbusSerialMaster

public ModbusSerialMaster(SerialParameters param,
                          int timeout,
                          int transDelay)

Constructs a new master facade instance for communication with a given slave.

Parameters:

param - SerialParameters specifies the serial port parameters to use to communicate with the slave device network.

timeout - Receive timeout in milliseconds

transDelay - The transmission delay to use between frames (milliseconds)

Method Detail

getConnection

public AbstractSerialConnection getConnection()

connect

public void connect()
             throws Exception

Connects this ModbusSerialMaster with the slave.

Specified by:

connect in class AbstractModbusMaster

Throws:

Exception - if the connection cannot be established.

disconnect

public void disconnect()

Disconnects this ModbusSerialMaster from the slave.

Specified by:

disconnect in class AbstractModbusMaster

setTimeout

public void setTimeout(int timeout)

Description copied from class: AbstractModbusMaster

Sets the receive timeout

Overrides:

setTimeout in class AbstractModbusMaster

Parameters:

timeout - Timeout in milliseconds

getTransport

public AbstractModbusTransport getTransport()

Description copied from class: AbstractModbusMaster

Returns the transport being used by the

Specified by:

getTransport in class AbstractModbusMaster

Returns:

ModbusTransport

isConnected

public boolean isConnected()

Description copied from class: AbstractModbusMaster

Returns true if the master is connected

Specified by:

isConnected in class AbstractModbusMaster

Returns:

True if connected