com.intelligt.modbus.jlibmodbus.master

Class ModbusMasterTCP

java.lang.Object

com.intelligt.modbus.jlibmodbus.master.ModbusMaster

com.intelligt.modbus.jlibmodbus.master.ModbusMasterTCP

All Implemented Interfaces:

FrameEventListenerList

public final class ModbusMasterTCP
extends ModbusMaster

Constructor Summary

Constructors

Constructor and Description
ModbusMasterTCP(TcpParameters parameters)

Method Summary

Modifier and Type	Method and Description
void	diagnosticsChangeAsciiInputDelimiter(int serverAddress, int delimiter) The character passed in the request data field becomes the end of message delimiter for future messages (replacing the default LF character).
void	diagnosticsClearCountersAndDiagnosticRegister(int serverAddress) The goal is to clear all counters and the diagnostic register.
void	diagnosticsClearOverrunCounterAndFlag(int serverAddress) Clears the overrun error counter and reset the error flag.
void	diagnosticsForceListenOnlyMode(int serverAddress) Forces the addressed remote device to its Listen Only Mode for MODBUS communications.
void	diagnosticsRestartCommunicationsOption(int serverAddress, boolean clearLog) The remote device serial line port must be initialized and restarted, and all of its communications event counters are cleared.
int	diagnosticsReturnBusCharacterOverrunCount(int serverAddress) The response data field returns the quantity of messages addressed to the remote device that it could not handle due to a character overrun condition, since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnBusCommunicationErrorCount(int serverAddress) The response data field returns the quantity of CRC errors encountered by the remote device since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnBusExceptionErrorCount(int serverAddress) The response data field returns the quantity of MODBUS exception responses returned by the remote device since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnBusMessageCount(int serverAddress) The response data field returns the quantity of messages that the remote device has detected on the communications system since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnDiagnosticRegister(int serverAddress) Returns the contents of the remote device’s 16–bit diagnostic register are returned in the response.
void	diagnosticsReturnQueryData(int serverAddress, int queryData) The data passed in the request data field is to be returned (looped back) in the response.
int	diagnosticsReturnSlaveBusyCount(int serverAddress) The response data field returns the quantity of messages addressed to the remote device for which it returned a Slave Device Busy exception response, since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnSlaveMessageCount(int serverAddress) The response data field returns the quantity of messages addressed to the remote device, or broadcast, that the remote device has processed since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnSlaveNAKCount(int serverAddress) The response data field returns the quantity of messages addressed to the remote device for which it returned a Negative Acknowledge (NAK) exception response, since its last restart, clear counters operation, or power–up.
int	diagnosticsReturnSlaveNoResponseCount(int serverAddress) The response data field returns the quantity of messages addressed to the remote device for which it has returned no response (neither a normal response nor an exception response), since its last restart, clear counters operation, or power–up.
CommStatus	getCommEventCounter(int serverAddress) This function code is used to get a status word and an event count from the remote device's communication event counter.
CommStatus	getCommEventLog(int serverAddress) This function code is used to get a status word, event count, message count, and a field of event bytes from the remote device.
boolean	isKeepAlive()
int	readExceptionStatus(int serverAddress) This function code is used to read the contents of eight Exception Status outputs in a remote device.
protected ModbusMessage	readResponse(ModbusRequest request)
byte[]	reportSlaveId(int serverAddress) This function code is used to read the description of the type, the current status, and other information specific to a remote device.
protected void	sendRequest(ModbusMessage msg)

Methods inherited from class com.intelligt.modbus.jlibmodbus.master.ModbusMaster

addListener, connect, connectImpl, countListeners, disconnect, disconnectImpl, fireFrameReceivedEvent, fireFrameSentEvent, getConnection, getTransactionId, isConnected, maskWriteRegister, processRequest, readCoils, readDeviceIdentification, readDiscreteInputs, readFifoQueue, readFileRecord, readHoldingRegisters, readInputRegisters, readWriteMultipleRegisters, removeListener, removeListeners, setResponseTimeout, setTransactionId, writeFileRecord, writeMultipleCoils, writeMultipleRegisters, writeSingleCoil, writeSingleRegister

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusMasterTCP

public ModbusMasterTCP(TcpParameters parameters)

Method Detail

isKeepAlive

public boolean isKeepAlive()

sendRequest

protected void sendRequest(ModbusMessage msg)
                    throws ModbusIOException

Overrides:

sendRequest in class ModbusMaster

Throws:

ModbusIOException

readResponse

protected ModbusMessage readResponse(ModbusRequest request)
                              throws ModbusNumberException,
                                     ModbusIOException,
                                     ModbusProtocolException

Overrides:

readResponse in class ModbusMaster

Throws:

ModbusNumberException

ModbusIOException

ModbusProtocolException

readExceptionStatus

public int readExceptionStatus(int serverAddress)
                        throws ModbusNumberException,
                               ModbusIOException,
                               ModbusProtocolException

Description copied from class: ModbusMaster

This function code is used to read the contents of eight Exception Status outputs in a remote device. The function provides a simple method for accessing this information, because the Exception Output references are known (no output reference is needed in the function). The normal response contains the status of the eight Exception Status outputs. The outputs are packed into one data byte, with one bit per output. The status of the lowest output reference is contained in the least significant bit of the byte. The contents of the eight Exception Status outputs are device specific.

Specified by:

readExceptionStatus in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

the eight Exception Status outputs

Throws:

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

ModbusProtocolException - if modbus-exception is received

reportSlaveId

public byte[] reportSlaveId(int serverAddress)
                     throws ModbusProtocolException,
                            ModbusNumberException,
                            ModbusIOException

Description copied from class: ModbusMaster

This function code is used to read the description of the type, the current status, and other information specific to a remote device. The data contents are specific to each type of device.

Specified by:

reportSlaveId in class ModbusMaster

Parameters:

serverAddress - slave address

Returns:

a byte array of the device's specific data

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

getCommEventCounter

public CommStatus getCommEventCounter(int serverAddress)
                               throws ModbusProtocolException,
                                      ModbusNumberException,
                                      ModbusIOException

Description copied from class: ModbusMaster

This function code is used to get a status word and an event count from the remote device's communication event counter. By fetching the current count before and after a series of messages, a client can determine whether the messages were handled normally by the remote device. The device’s event counter is incremented once for each successful message completion. It is not incremented for exception responses, poll commands, or fetch event counter commands. The event counter can be reset by means of the Diagnostics function (code 08), with a subfunction of Restart Communications Option (code 00 01) or Clear Counters and Diagnostic Register (code 00 0A).

Specified by:

getCommEventCounter in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

the CommStatus instance

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

See Also:

CommStatus

getCommEventLog

public CommStatus getCommEventLog(int serverAddress)
                           throws ModbusProtocolException,
                                  ModbusNumberException,
                                  ModbusIOException

Description copied from class: ModbusMaster

This function code is used to get a status word, event count, message count, and a field of event bytes from the remote device. The status word and event counts are identical to that returned by the Get Communications Event Counter function (11, 0B hex). The message counter contains the quantity of messages processed by the remote device since its last restart, clear counters operation, or power–up. This count is identical to that returned by the Diagnostic function (code 08), sub-function Return Bus Message Count (code 11, 0B hex). The event bytes field contains 0-64 bytes, with each byte corresponding to the status of one MODBUS send or receive operation for the remote device. The remote device enters the events into the field in chronological order. Byte 0 is the most recent event. Each new byte flushes the oldest byte from the field.

Specified by:

getCommEventLog in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

the CommStatus instance

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

See Also:

CommStatus

diagnosticsReturnQueryData

public void diagnosticsReturnQueryData(int serverAddress,
                                       int queryData)
                                throws ModbusNumberException,
                                       IllegalFunctionException

Description copied from class: ModbusMaster

The data passed in the request data field is to be returned (looped back) in the response. The entire response message should be identical to the request.

Specified by:

diagnosticsReturnQueryData in class ModbusMaster

Parameters:

serverAddress - a slave address

queryData - request data field

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsRestartCommunicationsOption

public void diagnosticsRestartCommunicationsOption(int serverAddress,
                                                   boolean clearLog)
                                            throws ModbusNumberException,
                                                   IllegalFunctionException

Description copied from class: ModbusMaster

The remote device serial line port must be initialized and restarted, and all of its communications event counters are cleared. If the port is currently in Listen Only Mode, no response is returned. This function is the only one that brings the port out of Listen Only Mode. If the port is not currently in Listen Only Mode, a normal response is returned. This occurs before the restart is executed. When the remote device receives the request, it attempts a restart and executes its power–up confidence tests. Successful completion of the tests will bring the port online. A request data field contents of FF 00 hex causes the port’s Communications Event Log to be cleared also. Contents of 00 00 leave the log as it was prior to the restart.

Specified by:

diagnosticsRestartCommunicationsOption in class ModbusMaster

Parameters:

serverAddress - a slave address

clearLog - causes the port’s Communications Event Log to be cleared

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnDiagnosticRegister

public int diagnosticsReturnDiagnosticRegister(int serverAddress)
                                        throws ModbusNumberException,
                                               IllegalFunctionException

Description copied from class: ModbusMaster

Returns the contents of the remote device’s 16–bit diagnostic register are returned in the response.

Specified by:

diagnosticsReturnDiagnosticRegister in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

16–bit diagnostic register

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsChangeAsciiInputDelimiter

public void diagnosticsChangeAsciiInputDelimiter(int serverAddress,
                                                 int delimiter)
                                          throws ModbusNumberException,
                                                 IllegalFunctionException

Description copied from class: ModbusMaster

The character passed in the request data field becomes the end of message delimiter for future messages (replacing the default LF character). This function is useful in cases of a Line Feed is not required at the end of ASCII messages.

Specified by:

diagnosticsChangeAsciiInputDelimiter in class ModbusMaster

Parameters:

serverAddress - a slave address

delimiter - request data field

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsForceListenOnlyMode

public void diagnosticsForceListenOnlyMode(int serverAddress)
                                    throws ModbusNumberException,
                                           IllegalFunctionException

Description copied from class: ModbusMaster

Forces the addressed remote device to its Listen Only Mode for MODBUS communications. This isolates it from the other devices on the network, allowing them to continue communicating without interruption from the addressed remote device. No response is returned. When the remote device enters its Listen Only Mode, all active communication controls are turned off. The Ready watchdog timer is allowed to expire, locking the controls off. While the device is in this mode, any MODBUS messages addressed to it or broadcast are monitored, but no actions will be taken and no responses will be sent. The only function that will be processed after the mode is entered will be the Restart Communications Option function (function code 8, sub-function 1).

Specified by:

diagnosticsForceListenOnlyMode in class ModbusMaster

Parameters:

serverAddress - a slave address

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsClearCountersAndDiagnosticRegister

public void diagnosticsClearCountersAndDiagnosticRegister(int serverAddress)
                                                   throws ModbusNumberException,
                                                          IllegalFunctionException

Description copied from class: ModbusMaster

The goal is to clear all counters and the diagnostic register. Counters are also cleared upon power–up.

Specified by:

diagnosticsClearCountersAndDiagnosticRegister in class ModbusMaster

Parameters:

serverAddress - a slave address

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnBusMessageCount

public int diagnosticsReturnBusMessageCount(int serverAddress)
                                     throws ModbusNumberException,
                                            IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages that the remote device has detected on the communications system since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnBusMessageCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

bus message count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnBusCommunicationErrorCount

public int diagnosticsReturnBusCommunicationErrorCount(int serverAddress)
                                                throws ModbusNumberException,
                                                       IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of CRC errors encountered by the remote device since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnBusCommunicationErrorCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

CRC error count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnBusExceptionErrorCount

public int diagnosticsReturnBusExceptionErrorCount(int serverAddress)
                                            throws ModbusNumberException,
                                                   IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of MODBUS exception responses returned by the remote device since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnBusExceptionErrorCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

MODBUS exception response count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnSlaveMessageCount

public int diagnosticsReturnSlaveMessageCount(int serverAddress)
                                       throws ModbusNumberException,
                                              IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages addressed to the remote device, or broadcast, that the remote device has processed since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnSlaveMessageCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

count of messages has been processed

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnSlaveNoResponseCount

public int diagnosticsReturnSlaveNoResponseCount(int serverAddress)
                                          throws ModbusNumberException,
                                                 IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages addressed to the remote device for which it has returned no response (neither a normal response nor an exception response), since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnSlaveNoResponseCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

no-response count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnSlaveNAKCount

public int diagnosticsReturnSlaveNAKCount(int serverAddress)
                                   throws ModbusNumberException,
                                          IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages addressed to the remote device for which it returned a Negative Acknowledge (NAK) exception response, since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnSlaveNAKCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

NAK count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnSlaveBusyCount

public int diagnosticsReturnSlaveBusyCount(int serverAddress)
                                    throws ModbusNumberException,
                                           IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages addressed to the remote device for which it returned a Slave Device Busy exception response, since its last restart, clear counters operation, or power–up.

Specified by:

diagnosticsReturnSlaveBusyCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

Slave Device Busy exception response count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsReturnBusCharacterOverrunCount

public int diagnosticsReturnBusCharacterOverrunCount(int serverAddress)
                                              throws ModbusNumberException,
                                                     IllegalFunctionException

Description copied from class: ModbusMaster

The response data field returns the quantity of messages addressed to the remote device that it could not handle due to a character overrun condition, since its last restart, clear counters operation, or power–up. A character overrun is caused by data characters arriving at the port faster than they can be stored, or by the loss of a character due to a hardware malfunction.

Specified by:

diagnosticsReturnBusCharacterOverrunCount in class ModbusMaster

Parameters:

serverAddress - a slave address

Returns:

character overrun count

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException

diagnosticsClearOverrunCounterAndFlag

public void diagnosticsClearOverrunCounterAndFlag(int serverAddress)
                                           throws ModbusNumberException,
                                                  IllegalFunctionException

Description copied from class: ModbusMaster

Clears the overrun error counter and reset the error flag.

Specified by:

diagnosticsClearOverrunCounterAndFlag in class ModbusMaster

Parameters:

serverAddress - a slave address

Throws:

ModbusNumberException - if server address is in-valid

IllegalFunctionException