com.intelligt.modbus.jlibmodbus.master

Class ModbusMaster

java.lang.Object

com.intelligt.modbus.jlibmodbus.master.ModbusMaster

All Implemented Interfaces:

FrameEventListenerList

Direct Known Subclasses:

ModbusMasterSerial, ModbusMasterTCP

public abstract class ModbusMaster
extends Object
implements FrameEventListenerList

Constructor Summary

Constructors

Constructor and Description
ModbusMaster(ModbusConnection conn)

Method Summary

Modifier and Type	Method and Description
void	addListener(FrameEventListener listener)
void	connect()
protected void	connectImpl() this method allows you to implement your own behavior of connect method.
int	countListeners()
abstract 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).
abstract void	diagnosticsClearCountersAndDiagnosticRegister(int serverAddress) The goal is to clear all counters and the diagnostic register.
abstract void	diagnosticsClearOverrunCounterAndFlag(int serverAddress) Clears the overrun error counter and reset the error flag.
abstract void	diagnosticsForceListenOnlyMode(int serverAddress) Forces the addressed remote device to its Listen Only Mode for MODBUS communications.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract int	diagnosticsReturnDiagnosticRegister(int serverAddress) Returns the contents of the remote device’s 16–bit diagnostic register are returned in the response.
abstract void	diagnosticsReturnQueryData(int serverAddress, int queryData) The data passed in the request data field is to be returned (looped back) in the response.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
void	disconnect()
protected void	disconnectImpl() this method allows you to implement your own behavior of disconnect method.
void	fireFrameReceivedEvent(FrameEvent event)
void	fireFrameSentEvent(FrameEvent event)
abstract 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.
abstract 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.
protected ModbusConnection	getConnection()
int	getTransactionId()
boolean	isConnected()
void	maskWriteRegister(int serverAddress, int startAddress, int and, int or) This function code is used to modify the contents of a specified holding register using a combination of an AND mask, an OR mask, and the register's current contents.
ModbusResponse	processRequest(ModbusRequest request) this function allows you to process your own ModbusRequest.
boolean[]	readCoils(int serverAddress, int startAddress, int quantity) This function code is used to read from 1 to 2000 contiguous status of coils in a remote device.
MEIReadDeviceIdentification	readDeviceIdentification(int serverAddress, int objectId, ReadDeviceIdentificationCode readDeviceId) This function code allows reading the identification and additional information relative to the physical and functional description of a remote device, only.
boolean[]	readDiscreteInputs(int serverAddress, int startAddress, int quantity) This function code is used to read from 1 to 2000 contiguous status of discrete inputs in a remote device.
abstract int	readExceptionStatus(int serverAddress) This function code is used to read the contents of eight Exception Status outputs in a remote device.
int[]	readFifoQueue(int serverAddress, int fifoPointerAddress) This function code allows to read the contents of a First-In-First-Out (FIFO) queue of register in a remote device.
ModbusFileRecord[]	readFileRecord(int serverAddress, ModbusFileRecord[] records) This function code is used to perform a file record read.
int[]	readHoldingRegisters(int serverAddress, int startAddress, int quantity) This function code is used to read the contents of a contiguous block of holding registers in a remote device.
int[]	readInputRegisters(int serverAddress, int startAddress, int quantity) This function code is used to read from 1 to 125 contiguous input registers in a remote device.
protected ModbusMessage	readResponse(ModbusRequest request)
int[]	readWriteMultipleRegisters(int serverAddress, int readAddress, int readQuantity, int writeAddress, int[] registers) This function code performs a combination of one read operation and one write operation in a single MODBUS transaction.
void	removeListener(FrameEventListener listener)
void	removeListeners()
abstract 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)
void	setResponseTimeout(int timeout) ModbusMaster will block for only this amount of time.
void	setTransactionId(int transactionId)
void	writeFileRecord(int serverAddress, ModbusFileRecord record) This function code is used to perform a file record write.
void	writeMultipleCoils(int serverAddress, int startAddress, boolean[] coils) This function code is used to force each coil in a sequence of coils to either ON or OFF in a remote device.
void	writeMultipleRegisters(int serverAddress, int startAddress, int[] registers) This function code is used to write a block of contiguous registers (1 to 123 registers) in a remote device.
void	writeSingleCoil(int serverAddress, int startAddress, boolean flag) This function code is used to write a single output to either ON or OFF in a remote device.
void	writeSingleRegister(int serverAddress, int startAddress, int register) This function code is used to write a single holding register in a remote device.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusMaster

public ModbusMaster(ModbusConnection conn)

Method Detail

getTransactionId

public int getTransactionId()

setTransactionId

public void setTransactionId(int transactionId)

getConnection

protected ModbusConnection getConnection()

connectImpl

protected void connectImpl()
                    throws ModbusIOException

this method allows you to implement your own behavior of connect method.

Throws:

ModbusIOException

disconnectImpl

protected void disconnectImpl()
                       throws ModbusIOException

this method allows you to implement your own behavior of disconnect method.

Throws:

ModbusIOException

connect

public final void connect()
                   throws ModbusIOException

Throws:

ModbusIOException

disconnect

public final void disconnect()
                      throws ModbusIOException

Throws:

ModbusIOException

isConnected

public boolean isConnected()

sendRequest

protected void sendRequest(ModbusMessage msg)
                    throws ModbusIOException

Throws:

ModbusIOException

readResponse

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

Throws:

ModbusProtocolException

ModbusNumberException

ModbusIOException

processRequest

public ModbusResponse processRequest(ModbusRequest request)
                              throws ModbusProtocolException,
                                     ModbusIOException

this function allows you to process your own ModbusRequest. Each request class has a compliant response class for instance ReadHoldingRegistersRequest and ReadHoldingRegistersResponse. If you process an instance of ReadHoldingRegistersRequest this function exactly either returns a ReadHoldingRegistersResponse instance or throws an exception.

Parameters:

request - an instance of ModbusRequest.

Returns:

an instance of ModbusResponse.

Throws:

ModbusProtocolException

ModbusIOException

See Also:

ModbusRequestFactory, ModbusRequest, ModbusResponse, com.intelligt.modbus.jlibmodbus.msg.request, com.intelligt.modbus.jlibmodbus.msg.request

setResponseTimeout

public void setResponseTimeout(int timeout)

ModbusMaster will block for only this amount of time. If the timeout expires, a ModbusTransportException is raised, though the ModbusMaster is still valid.

Parameters:

timeout - the specified timeout, in milliseconds.

readHoldingRegisters

public final int[] readHoldingRegisters(int serverAddress,
                                        int startAddress,
                                        int quantity)
                                 throws ModbusProtocolException,
                                        ModbusNumberException,
                                        ModbusIOException

This function code is used to read the contents of a contiguous block of holding registers in a remote device. The Request PDU specifies the starting register address and the number of registers. In the PDU Registers are addressed starting at zero. Therefore registers numbered 1-16 are addressed as 0-15.

Parameters:

serverAddress - a slave address

startAddress - starting register address

quantity - the number of registers

Returns:

the register data

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readInputRegisters

public final int[] readInputRegisters(int serverAddress,
                                      int startAddress,
                                      int quantity)
                               throws ModbusProtocolException,
                                      ModbusNumberException,
                                      ModbusIOException

This function code is used to read from 1 to 125 contiguous input registers in a remote device. The Request PDU specifies the starting register address and the number of registers. In the PDU Registers are addressed starting at zero. Therefore input registers numbered 1-16 are addressed as 0-15.

Parameters:

serverAddress - a slave address

startAddress - starting register address

quantity - the number of registers

Returns:

the register data

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readCoils

public final boolean[] readCoils(int serverAddress,
                                 int startAddress,
                                 int quantity)
                          throws ModbusProtocolException,
                                 ModbusNumberException,
                                 ModbusIOException

This function code is used to read from 1 to 2000 contiguous status of coils in a remote device. The Request PDU specifies the starting address, i.e. the address of the first coil specified, and the number of coils. In the PDU Coils are addressed starting at zero. Therefore coils numbered 1-16 are addressed as 0-15. If the returned output quantity is not a multiple of eight, the remaining coils in the final boolean array will be padded with FALSE.

Parameters:

serverAddress - a slave address

startAddress - the address of the first coil

quantity - the number of coils

Returns:

the coils

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readDiscreteInputs

public final boolean[] readDiscreteInputs(int serverAddress,
                                          int startAddress,
                                          int quantity)
                                   throws ModbusProtocolException,
                                          ModbusNumberException,
                                          ModbusIOException

This function code is used to read from 1 to 2000 contiguous status of discrete inputs in a remote device. The Request PDU specifies the starting address, i.e. the address of the first input specified, and the number of inputs. In the PDU Discrete Inputs are addressed starting at zero. Therefore Discrete inputs numbered 1-16 are addressed as 0-15. If the returned input quantity is not a multiple of eight, the remaining inputs in the final boolean array will be padded with FALSE.

Parameters:

serverAddress - a slave address

startAddress - the address of the first input

quantity - the number of inputs

Returns:

the discrete inputs

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

writeSingleCoil

public final void writeSingleCoil(int serverAddress,
                                  int startAddress,
                                  boolean flag)
                           throws ModbusProtocolException,
                                  ModbusNumberException,
                                  ModbusIOException

This function code is used to write a single output to either ON or OFF in a remote device. The requested ON/OFF state is specified by a constant in the request data field. A value of TRUE requests the output to be ON. A value of FALSE requests it to be OFF. The Request PDU specifies the address of the coil to be forced. Coils are addressed starting at zero. Therefore coil numbered 1 is addressed as 0.

Parameters:

serverAddress - a slave address

startAddress - the address of the coil to be forced

flag - the request data field

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

writeSingleRegister

public final void writeSingleRegister(int serverAddress,
                                      int startAddress,
                                      int register)
                               throws ModbusProtocolException,
                                      ModbusNumberException,
                                      ModbusIOException

This function code is used to write a single holding register in a remote device. The Request PDU specifies the address of the register to be written. Registers are addressed starting at zero. Therefore register numbered 1 is addressed as 0.

Parameters:

serverAddress - a slave address

startAddress - the address of the register to be written

register - value

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

writeMultipleCoils

public final void writeMultipleCoils(int serverAddress,
                                     int startAddress,
                                     boolean[] coils)
                              throws ModbusProtocolException,
                                     ModbusNumberException,
                                     ModbusIOException

This function code is used to force each coil in a sequence of coils to either ON or OFF in a remote device. The Request PDU specifies the coil references to be forced. Coils are addressed starting at zero. Therefore coil numbered 1 is addressed as 0. The requested ON/OFF states are specified by contents of the request array of boolean. A logical 'true' in position of the array requests the corresponding output to be ON. A logical 'false' requests it to be OFF.

Parameters:

serverAddress - a slave address

startAddress - the address of the coils to be written

coils - the coils

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

writeMultipleRegisters

public final void writeMultipleRegisters(int serverAddress,
                                         int startAddress,
                                         int[] registers)
                                  throws ModbusProtocolException,
                                         ModbusNumberException,
                                         ModbusIOException

This function code is used to write a block of contiguous registers (1 to 123 registers) in a remote device. The requested written values are specified in the request data field. Data is packed as two bytes per register.

Parameters:

serverAddress - a slave address

startAddress - the address of the registers to be written

registers - the register data

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readWriteMultipleRegisters

public final int[] readWriteMultipleRegisters(int serverAddress,
                                              int readAddress,
                                              int readQuantity,
                                              int writeAddress,
                                              int[] registers)
                                       throws ModbusProtocolException,
                                              ModbusNumberException,
                                              ModbusIOException

This function code performs a combination of one read operation and one write operation in a single MODBUS transaction. The write operation is performed before the read. Holding registers are addressed starting at zero. Therefore holding registers 1-16 are addressed in the PDU as 0-15. The request specifies the starting address and number of holding registers to be read as well as the starting address, number of holding registers, and the data to be written.

Parameters:

serverAddress - a slave address

readAddress - the address of the registers to be read

readQuantity - the number of registers to be read

writeAddress - the address of the registers to be written

registers - the number of registers to be written

Returns:

the register value

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readFifoQueue

public final int[] readFifoQueue(int serverAddress,
                                 int fifoPointerAddress)
                          throws ModbusProtocolException,
                                 ModbusNumberException,
                                 ModbusIOException

This function code allows to read the contents of a First-In-First-Out (FIFO) queue of register in a remote device. The function returns the queued data. Up to 31 queue data registers can be read. The function reads the queue contents, but does not clear them. If the queue count exceeds 31, an exception response is returned with an error code of 03 (Illegal Data Value).

Parameters:

serverAddress - a slave address

fifoPointerAddress - address of a fifo pointer register

Returns:

the data register value

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readFileRecord

public final ModbusFileRecord[] readFileRecord(int serverAddress,
                                               ModbusFileRecord[] records)
                                        throws ModbusProtocolException,
                                               ModbusNumberException,
                                               ModbusIOException

This function code is used to perform a file record read. A file is an organization of records. Each file contains 10000 records, addressed 0000 to 9999 decimal or 0X0000 to 0X270F. For example, record 12 is addressed as 12. The function can read multiple groups of references.

Parameters:

serverAddress - a slave address

records - array of ModbusFileRecord

Returns:

array of ModbusFileRecord has been read

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

writeFileRecord

public final void writeFileRecord(int serverAddress,
                                  ModbusFileRecord record)
                           throws ModbusProtocolException,
                                  ModbusNumberException,
                                  ModbusIOException

This function code is used to perform a file record write. All Request Data Lengths are provided in terms of number of bytes and all Record Lengths are provided in terms of the number of 16-bit words. A file is an organization of records. Each file contains 10000 records, addressed 0000 to 9999 decimal or 0X0000 to 0X270F. For example, record 12 is addressed as 12. The function can write multiple groups of references.

Parameters:

serverAddress - a server address

record - the ModbusFileRecord to be written

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

maskWriteRegister

public final void maskWriteRegister(int serverAddress,
                                    int startAddress,
                                    int and,
                                    int or)
                             throws ModbusProtocolException,
                                    ModbusNumberException,
                                    ModbusIOException

This function code is used to modify the contents of a specified holding register using a combination of an AND mask, an OR mask, and the register's current contents. The function can be used to set or clear individual bits in the register. The request specifies the holding register to be written, the data to be used as the AND mask, and the data to be used as the OR mask. Registers are addressed starting at zero. Therefore registers 1-16 are addressed as 0-15. The function’s algorithm is: Result = (Current Contents AND And_Mask) OR (Or_Mask AND (NOT And_Mask)) For example: Hex Binary Current Contents= 12 0001 0010 And_Mask = F2 1111 0010 Or_Mask = 25 0010 0101

(NOT And_Mask)= 0D 0000 1101

Result = 17 0001 0111

Note: y If the Or_Mask value is zero, the result is simply the logical ANDing of the current contents and And_Mask. If the And_Mask value is zero, the result is equal to the Or_Mask value. y The contents of the register can be read with the Read Holding Registers function (function code 03). They could, however, be changed subsequently as the controller scans its user logic program.

Parameters:

serverAddress - slave id

startAddress - reference address

and - the AND mask

or - the OR mask

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

readExceptionStatus

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

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.

Parameters:

serverAddress - a slave address

Returns:

the eight Exception Status outputs

Throws:

ModbusProtocolException - if modbus-exception is received

ModbusNumberException - if response is invalid

ModbusIOException - if remote slave is unavailable

reportSlaveId

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

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.

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 abstract CommStatus getCommEventCounter(int serverAddress)
                                        throws ModbusProtocolException,
                                               ModbusNumberException,
                                               ModbusIOException

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

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 abstract CommStatus getCommEventLog(int serverAddress)
                                    throws ModbusProtocolException,
                                           ModbusNumberException,
                                           ModbusIOException

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.

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 abstract void diagnosticsReturnQueryData(int serverAddress,
                                                int queryData)
                                         throws ModbusNumberException,
                                                ModbusProtocolException,
                                                ModbusIOException

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

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsRestartCommunicationsOption

public abstract void diagnosticsRestartCommunicationsOption(int serverAddress,
                                                            boolean clearLog)
                                                     throws ModbusNumberException,
                                                            ModbusProtocolException,
                                                            ModbusIOException

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

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnDiagnosticRegister

public abstract int diagnosticsReturnDiagnosticRegister(int serverAddress)
                                                 throws ModbusNumberException,
                                                        ModbusProtocolException,
                                                        ModbusIOException

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

Parameters:

serverAddress - a slave address

Returns:

16–bit diagnostic register

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsChangeAsciiInputDelimiter

public abstract void diagnosticsChangeAsciiInputDelimiter(int serverAddress,
                                                          int delimiter)
                                                   throws ModbusNumberException,
                                                          ModbusProtocolException,
                                                          ModbusIOException

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

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsForceListenOnlyMode

public abstract void diagnosticsForceListenOnlyMode(int serverAddress)
                                             throws ModbusNumberException,
                                                    ModbusProtocolException,
                                                    ModbusIOException

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

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsClearCountersAndDiagnosticRegister

public abstract void diagnosticsClearCountersAndDiagnosticRegister(int serverAddress)
                                                            throws ModbusNumberException,
                                                                   ModbusProtocolException,
                                                                   ModbusIOException

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

Parameters:

serverAddress - a slave address

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnBusMessageCount

public abstract int diagnosticsReturnBusMessageCount(int serverAddress)
                                              throws ModbusNumberException,
                                                     ModbusProtocolException,
                                                     ModbusIOException

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:

bus message count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnBusCommunicationErrorCount

public abstract int diagnosticsReturnBusCommunicationErrorCount(int serverAddress)
                                                         throws ModbusNumberException,
                                                                ModbusProtocolException,
                                                                ModbusIOException

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:

CRC error count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnBusExceptionErrorCount

public abstract int diagnosticsReturnBusExceptionErrorCount(int serverAddress)
                                                     throws ModbusNumberException,
                                                            ModbusProtocolException,
                                                            ModbusIOException

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:

MODBUS exception response count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnSlaveMessageCount

public abstract int diagnosticsReturnSlaveMessageCount(int serverAddress)
                                                throws ModbusNumberException,
                                                       ModbusProtocolException,
                                                       ModbusIOException

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:

count of messages has been processed

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnSlaveNoResponseCount

public abstract int diagnosticsReturnSlaveNoResponseCount(int serverAddress)
                                                   throws ModbusNumberException,
                                                          ModbusProtocolException,
                                                          ModbusIOException

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:

no-response count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnSlaveNAKCount

public abstract int diagnosticsReturnSlaveNAKCount(int serverAddress)
                                            throws ModbusNumberException,
                                                   ModbusProtocolException,
                                                   ModbusIOException

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:

NAK count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnSlaveBusyCount

public abstract int diagnosticsReturnSlaveBusyCount(int serverAddress)
                                             throws ModbusNumberException,
                                                    ModbusProtocolException,
                                                    ModbusIOException

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:

Slave Device Busy exception response count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsReturnBusCharacterOverrunCount

public abstract int diagnosticsReturnBusCharacterOverrunCount(int serverAddress)
                                                       throws ModbusNumberException,
                                                              ModbusProtocolException,
                                                              ModbusIOException

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:

character overrun count

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

diagnosticsClearOverrunCounterAndFlag

public abstract void diagnosticsClearOverrunCounterAndFlag(int serverAddress)
                                                    throws ModbusNumberException,
                                                           ModbusProtocolException,
                                                           ModbusIOException

Clears the overrun error counter and reset the error flag.

Parameters:

serverAddress - a slave address

Throws:

ModbusNumberException - if server address is in-valid

ModbusProtocolException

ModbusIOException

readDeviceIdentification

public final MEIReadDeviceIdentification readDeviceIdentification(int serverAddress,
                                                                  int objectId,
                                                                  ReadDeviceIdentificationCode readDeviceId)
                                                           throws ModbusProtocolException,
                                                                  ModbusNumberException,
                                                                  ModbusIOException

This function code allows reading the identification and additional information relative to the physical and functional description of a remote device, only. The Read Device Identification interface is modeled as an address space composed of a set of addressable data elements. The data elements are called objects and an object Id identifies them. The interface consists of 3 categories of objects : ƒ Basic Device Identification. All objects of this category are mandatory : VendorName, Product code, and revision number. ƒ Regular Device Identification. In addition to Basic data objects, the device provides additional and optional identification and description data objects. All of the objects of this category are defined in the standard but their implementation is optional . ƒ Extended Device Identification. In addition to regular data objects, the device provides additional and optional identification and description private data about the physical device itself. All of these data are device dependent. ObjectId ObjectName/Description Type M/O category 0x00 VendorName ASCII String Mandatory Basic 0x01 ProductCode ASCII String Mandatory Basic 0x02 MajorMinorRevision ASCII String Mandatory Basic 0x03 VendorUrl ASCII String Optional Regular 0x04 ProductName ASCII String Optional Regular 0x05 ModelName ASCII String Optional Regular 0x06 UserApplicationName ASCII String Optional Regular 0x07 Reserved Optional Optional Regular … 0x7F 0x80 Private objects may be optionally device Optional Extended … defined. The range [0x80 – 0xFF] dependant 0xFF is Product dependant.

Throws:

ModbusProtocolException

ModbusNumberException

ModbusIOException

addListener

public void addListener(FrameEventListener listener)

Specified by:

addListener in interface FrameEventListenerList

removeListener

public void removeListener(FrameEventListener listener)

Specified by:

removeListener in interface FrameEventListenerList

removeListeners

public void removeListeners()

Specified by:

removeListeners in interface FrameEventListenerList

fireFrameReceivedEvent

public void fireFrameReceivedEvent(FrameEvent event)

Specified by:

fireFrameReceivedEvent in interface FrameEventListenerList

fireFrameSentEvent

public void fireFrameSentEvent(FrameEvent event)

Specified by:

fireFrameSentEvent in interface FrameEventListenerList

countListeners

public int countListeners()

Specified by:

countListeners in interface FrameEventListenerList