com.serotonin.modbus4j

Class ModbusMaster

java.lang.Object

com.serotonin.modbus4j.Modbus

com.serotonin.modbus4j.ModbusMaster

Direct Known Subclasses:

SerialMaster, TcpMaster, UdpMaster

public abstract class ModbusMaster
extends Modbus

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized

Fields inherited from class com.serotonin.modbus4j.Modbus

DEFAULT_MAX_READ_BIT_COUNT, DEFAULT_MAX_READ_REGISTER_COUNT, DEFAULT_MAX_WRITE_REGISTER_COUNT

Constructor Summary

Constructors

Constructor and Description
ModbusMaster()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeMessageControl(MessageControl conn)
abstract void	destroy()
int	getDiscardDataDelay()
InputStreamEPoll	getePoll()
IOLog	getIoLog()
protected MessageControl	getMessageControl()
int	getRetries()
int	getTimeout()
<T> T	getValue(BaseLocator<T> locator) Returns a value from the modbus network according to the given locator information.
abstract void	init()
boolean	isInitialized()
boolean	isMultipleWritesOnly()
java.util.List<java.lang.Integer>	scanForSlaveNodes() Node scanning.
ProgressiveTask	scanForSlaveNodes(NodeScanListener l)
<K> BatchResults<K>	send(BatchRead<K> batch) Useful for sending a number of polling commands at once, or at least in as optimal a batch as possible.
ModbusResponse	send(ModbusRequest request)
abstract ModbusResponse	sendImpl(ModbusRequest request)
void	setDiscardDataDelay(int discardDataDelay)
void	setePoll(InputStreamEPoll ePoll)
void	setIoLog(IOLog ioLog)
void	setMultipleWritesOnly(boolean multipleWritesOnly)
void	setRetries(int retries)
void	setTimeout(int timeout)
<T> void	setValue(BaseLocator<T> locator, java.lang.Object value) Sets the given value in the modbus network according to the given locator information.
boolean	testSlaveNode(int node)

Methods inherited from class com.serotonin.modbus4j.Modbus

getExceptionHandler, getMaxReadBitCount, getMaxReadCount, getMaxReadRegisterCount, getMaxWriteRegisterCount, setExceptionHandler, setMaxReadBitCount, setMaxReadRegisterCount, setMaxWriteRegisterCount, validateNumberOfBits, validateNumberOfRegisters

Methods inherited from class java.lang.Object

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

Field Detail

initialized

protected boolean initialized

Constructor Detail

ModbusMaster

public ModbusMaster()

Method Detail

init

public abstract void init()
                   throws ModbusInitException

Throws:

ModbusInitException

isInitialized

public boolean isInitialized()

destroy

public abstract void destroy()

send

public final ModbusResponse send(ModbusRequest request)
                          throws ModbusTransportException

Throws:

ModbusTransportException

sendImpl

public abstract ModbusResponse sendImpl(ModbusRequest request)
                                 throws ModbusTransportException

Throws:

ModbusTransportException

getValue

public <T> T getValue(BaseLocator<T> locator)
           throws ModbusTransportException,
                  ErrorResponseException

Returns a value from the modbus network according to the given locator information. Various data types are allowed to be requested including multi-word types. The determination of the correct request message to send is handled automatically.

Parameters:

locator - the information required to locate the value in the modbus network.

Returns:

an object representing the value found. This will be one of Boolean, Short, Integer, Long, BigInteger, Float, or Double. See the DataType enumeration for details on which type to expect.

Throws:

ModbusTransportException - if there was an IO error or other technical failure while sending the message

ErrorResponseException - if the response returned from the slave was an exception.

setValue

public <T> void setValue(BaseLocator<T> locator,
                java.lang.Object value)
              throws ModbusTransportException,
                     ErrorResponseException

Sets the given value in the modbus network according to the given locator information. Various data types are allowed to be set including including multi-word types. The determination of the correct write message to send is handled automatically.

Parameters:

locator - the information required to locate the value in the modbus network.

Throws:

ModbusTransportException - if there was an IO error or other technical failure while sending the message

ErrorResponseException - if the response returned from the slave was an exception.

scanForSlaveNodes

public java.util.List<java.lang.Integer> scanForSlaveNodes()

Node scanning. Returns a list of slave nodes that respond to a read exception status request (perhaps with an error, but respond nonetheless). Note: a similar scan could be done for registers in nodes, but, for one thing, it would take some time to run, and in any case the results would not be meaningful since there would be no semantic information accompanying the results.

scanForSlaveNodes

public ProgressiveTask scanForSlaveNodes(NodeScanListener l)

testSlaveNode

public boolean testSlaveNode(int node)

getRetries

public int getRetries()

setRetries

public void setRetries(int retries)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

isMultipleWritesOnly

public boolean isMultipleWritesOnly()

setMultipleWritesOnly

public void setMultipleWritesOnly(boolean multipleWritesOnly)

getDiscardDataDelay

public int getDiscardDataDelay()

setDiscardDataDelay

public void setDiscardDataDelay(int discardDataDelay)

getIoLog

public IOLog getIoLog()

setIoLog

public void setIoLog(IOLog ioLog)

getePoll

public InputStreamEPoll getePoll()

setePoll

public void setePoll(InputStreamEPoll ePoll)

send

public <K> BatchResults<K> send(BatchRead<K> batch)
                     throws ModbusTransportException,
                            ErrorResponseException

Useful for sending a number of polling commands at once, or at least in as optimal a batch as possible.

Throws:

ModbusTransportException

ErrorResponseException

getMessageControl

protected MessageControl getMessageControl()

closeMessageControl

protected void closeMessageControl(MessageControl conn)