com.intelligt.modbus.jlibmodbus.msg

Class ModbusRequestBuilder

java.lang.Object

com.intelligt.modbus.jlibmodbus.msg.ModbusRequestBuilder

public class ModbusRequestBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ModbusRequestBuilder()

Method Summary

Modifier and Type	Method and Description
ModbusRequest	buildChangeAsciiInputDelimiter(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).
ModbusRequest	buildClearCountersAndDiagnosticRegister(int serverAddress) The goal is to clear all counters and the diagnostic register.
ModbusRequest	buildClearOverrunCounterAndFlag(int serverAddress) Clears the overrun error counter and reset the error flag.
ModbusRequest	buildDiagnostics(DiagnosticsSubFunctionCode subFunctionCode, int serverAddress, int data) The function uses a sub-function code field in the query to define the type of test to be performed.
ModbusRequest	buildForceListenOnlyMode(int serverAddress) Forces the addressed remote device to its Listen Only Mode for MODBUS communications.
ModbusRequest	buildGetCommEventCounter(int serverAddress)
ModbusRequest	buildGetCommEventLog(int serverAddress)
ModbusRequest	buildMaskWriteRegister(int serverAddress, int startAddress, int and, int or)
ModbusRequest	buildReadCoils(int serverAddress, int startAddress, int quantity)
ModbusRequest	buildReadDeviceIdentification(int serverAddress, int objectId, ReadDeviceIdentificationCode readDeviceId)
ModbusRequest	buildReadDiscreteInputs(int serverAddress, int startAddress, int quantity)
ModbusRequest	buildReadExceptionStatus(int serverAddress)
ModbusRequest	buildReadFifoQueue(int serverAddress, int fifoPointerAddress)
ModbusRequest	buildReadFileRecord(int serverAddress, ModbusFileRecord[] records)
ModbusRequest	buildReadHoldingRegisters(int serverAddress, int startAddress, int quantity)
ModbusRequest	buildReadInputRegisters(int serverAddress, int startAddress, int quantity)
ModbusRequest	buildReadWriteMultipleRegisters(int serverAddress, int readAddress, int readQuantity, int writeAddress, int[] registers)
ModbusRequest	buildReportSlaveId(int serverAddress)
ModbusRequest	buildRestartCommunicationsOption(int serverAddress, boolean clearLog) The remote device serial line port must be initialized and restarted, and all of its communications event counters are cleared.
ModbusRequest	buildReturnBusCharacterOverrunCount(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.
ModbusRequest	buildReturnBusCommunicationErrorCount(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.
ModbusRequest	buildReturnBusExceptionErrorCount(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.
ModbusRequest	buildReturnBusMessageCount(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.
ModbusRequest	buildReturnDiagnosticRegister(int serverAddress) Returns the contents of the remote device’s 16–bit diagnostic register are returned in the response.
ModbusRequest	buildReturnQueryData(int serverAddress, int queryData) The data passed in the request data field is to be returned (looped back) in the response.
ModbusRequest	buildReturnSlaveBusyCount(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.
ModbusRequest	buildReturnSlaveMessageCount(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.
ModbusRequest	buildReturnSlaveNAKCount(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.
ModbusRequest	buildReturnSlaveNoResponseCount(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.
ModbusRequest	buildWriteFileRecord(int serverAddress, ModbusFileRecord record)
ModbusRequest	buildWriteMultipleCoils(int serverAddress, int startAddress, boolean[] coils)
ModbusRequest	buildWriteMultipleRegisters(int serverAddress, int startAddress, byte[] bytes)
ModbusRequest	buildWriteMultipleRegisters(int serverAddress, int startAddress, int[] registers)
ModbusRequest	buildWriteSingleCoil(int serverAddress, int startAddress, boolean coil)
ModbusRequest	buildWriteSingleRegister(int serverAddress, int startAddress, int register)
static ModbusRequestBuilder	getInstance()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusRequestBuilder

public ModbusRequestBuilder()

Method Detail

getInstance

public static ModbusRequestBuilder getInstance()

buildReadCoils

public ModbusRequest buildReadCoils(int serverAddress,
                                    int startAddress,
                                    int quantity)
                             throws ModbusNumberException

Throws:

ModbusNumberException

buildReadDiscreteInputs

public ModbusRequest buildReadDiscreteInputs(int serverAddress,
                                             int startAddress,
                                             int quantity)
                                      throws ModbusNumberException

Throws:

ModbusNumberException

buildReadInputRegisters

public ModbusRequest buildReadInputRegisters(int serverAddress,
                                             int startAddress,
                                             int quantity)
                                      throws ModbusNumberException

Throws:

ModbusNumberException

buildReadHoldingRegisters

public ModbusRequest buildReadHoldingRegisters(int serverAddress,
                                               int startAddress,
                                               int quantity)
                                        throws ModbusNumberException

Throws:

ModbusNumberException

buildReadWriteMultipleRegisters

public ModbusRequest buildReadWriteMultipleRegisters(int serverAddress,
                                                     int readAddress,
                                                     int readQuantity,
                                                     int writeAddress,
                                                     int[] registers)
                                              throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteSingleCoil

public ModbusRequest buildWriteSingleCoil(int serverAddress,
                                          int startAddress,
                                          boolean coil)
                                   throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteMultipleCoils

public ModbusRequest buildWriteMultipleCoils(int serverAddress,
                                             int startAddress,
                                             boolean[] coils)
                                      throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteMultipleRegisters

public ModbusRequest buildWriteMultipleRegisters(int serverAddress,
                                                 int startAddress,
                                                 int[] registers)
                                          throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteMultipleRegisters

public ModbusRequest buildWriteMultipleRegisters(int serverAddress,
                                                 int startAddress,
                                                 byte[] bytes)
                                          throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteSingleRegister

public ModbusRequest buildWriteSingleRegister(int serverAddress,
                                              int startAddress,
                                              int register)
                                       throws ModbusNumberException

Throws:

ModbusNumberException

buildMaskWriteRegister

public ModbusRequest buildMaskWriteRegister(int serverAddress,
                                            int startAddress,
                                            int and,
                                            int or)
                                     throws ModbusNumberException

Throws:

ModbusNumberException

buildReadExceptionStatus

public ModbusRequest buildReadExceptionStatus(int serverAddress)
                                       throws ModbusNumberException

Throws:

ModbusNumberException

buildReportSlaveId

public ModbusRequest buildReportSlaveId(int serverAddress)
                                 throws ModbusNumberException

Throws:

ModbusNumberException

buildGetCommEventCounter

public ModbusRequest buildGetCommEventCounter(int serverAddress)
                                       throws ModbusNumberException

Throws:

ModbusNumberException

buildGetCommEventLog

public ModbusRequest buildGetCommEventLog(int serverAddress)
                                   throws ModbusNumberException

Throws:

ModbusNumberException

buildReadFifoQueue

public ModbusRequest buildReadFifoQueue(int serverAddress,
                                        int fifoPointerAddress)
                                 throws ModbusNumberException

Throws:

ModbusNumberException

buildReadFileRecord

public ModbusRequest buildReadFileRecord(int serverAddress,
                                         ModbusFileRecord[] records)
                                  throws ModbusNumberException

Throws:

ModbusNumberException

buildWriteFileRecord

public ModbusRequest buildWriteFileRecord(int serverAddress,
                                          ModbusFileRecord record)
                                   throws ModbusNumberException

Throws:

ModbusNumberException

buildDiagnostics

public ModbusRequest buildDiagnostics(DiagnosticsSubFunctionCode subFunctionCode,
                                      int serverAddress,
                                      int data)
                               throws ModbusNumberException

The function uses a sub-function code field in the query to define the type of test to be performed. The server echoes both the function code and sub-function code in a normal response. Some of the diagnostics cause data to be returned from the remote device in the data field of a normal response.

Parameters:

subFunctionCode - a sub-function code

serverAddress - a slave address

data - request data field

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

See Also:

DiagnosticsRequest, DiagnosticsSubFunctionCode

buildReturnQueryData

public ModbusRequest buildReturnQueryData(int serverAddress,
                                          int queryData)
                                   throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

queryData - request data field

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildRestartCommunicationsOption

public ModbusRequest buildRestartCommunicationsOption(int serverAddress,
                                                      boolean clearLog)
                                               throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

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

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnDiagnosticRegister

public ModbusRequest buildReturnDiagnosticRegister(int serverAddress)
                                            throws ModbusNumberException

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

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildChangeAsciiInputDelimiter

public ModbusRequest buildChangeAsciiInputDelimiter(int serverAddress,
                                                    int delimiter)
                                             throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

delimiter - request data field

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildForceListenOnlyMode

public ModbusRequest buildForceListenOnlyMode(int serverAddress)
                                       throws ModbusNumberException

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).

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildClearCountersAndDiagnosticRegister

public ModbusRequest buildClearCountersAndDiagnosticRegister(int serverAddress)
                                                      throws ModbusNumberException

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

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnBusMessageCount

public ModbusRequest buildReturnBusMessageCount(int serverAddress)
                                         throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnBusCommunicationErrorCount

public ModbusRequest buildReturnBusCommunicationErrorCount(int serverAddress)
                                                    throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnBusExceptionErrorCount

public ModbusRequest buildReturnBusExceptionErrorCount(int serverAddress)
                                                throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnSlaveMessageCount

public ModbusRequest buildReturnSlaveMessageCount(int serverAddress)
                                           throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnSlaveNoResponseCount

public ModbusRequest buildReturnSlaveNoResponseCount(int serverAddress)
                                              throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnSlaveNAKCount

public ModbusRequest buildReturnSlaveNAKCount(int serverAddress)
                                       throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnSlaveBusyCount

public ModbusRequest buildReturnSlaveBusyCount(int serverAddress)
                                        throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReturnBusCharacterOverrunCount

public ModbusRequest buildReturnBusCharacterOverrunCount(int serverAddress)
                                                  throws ModbusNumberException

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.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildClearOverrunCounterAndFlag

public ModbusRequest buildClearOverrunCounterAndFlag(int serverAddress)
                                              throws ModbusNumberException

Clears the overrun error counter and reset the error flag.

Parameters:

serverAddress - a slave address

Returns:

DiagnosticsRequest instance

Throws:

ModbusNumberException - if server address is in-valid

buildReadDeviceIdentification

public ModbusRequest buildReadDeviceIdentification(int serverAddress,
                                                   int objectId,
                                                   ReadDeviceIdentificationCode readDeviceId)
                                            throws ModbusNumberException

Throws:

ModbusNumberException