Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

AbstractModbusListener - Class in com.ghgande.j2mod.modbus.net
Definition of a listener class
AbstractModbusListener() - Constructor for class com.ghgande.j2mod.modbus.net.AbstractModbusListener
 
AbstractModbusMaster - Class in com.ghgande.j2mod.modbus.facade
Modbus/TCP Master facade - common methods for all the facade implementations The emphasis is in making callas to Modbus devices as simple as possible for the most common Function Codes.
AbstractModbusMaster() - Constructor for class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
 
AbstractModbusTransport - Class in com.ghgande.j2mod.modbus.io
Interface defining the I/O mechanisms for ModbusMessage instances.
AbstractModbusTransport() - Constructor for class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
 
AbstractRegister - Class in com.ghgande.j2mod.modbus.procimg
Abstract class for a register.
AbstractRegister() - Constructor for class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
AbstractSerialConnection - Class in com.ghgande.j2mod.modbus.net
Interface that represents a public abstract serial port connection
AbstractSerialConnection() - Constructor for class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
AbstractSerialTransportListener - Class in com.ghgande.j2mod.modbus.io
Any class that wants to listen for the begining and ending of read/writes to the Serial channel need to implement this interface
AbstractSerialTransportListener() - Constructor for class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
 
AbstractUDPTerminal - Class in com.ghgande.j2mod.modbus.net
Interface defining a UDPTerminal.
AbstractUDPTerminal() - Constructor for class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
 
activate() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Activate this UDPTerminal.
addDigitalIn(DigitalIn) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new DigitalIn instance.
addDigitalIn(int, DigitalIn) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new DigitalIn instance at the given reference, possibly creating a hole between the last existing reference and the new object.
addDigitalIn(DigitalIn) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addDigitalIn(int, DigitalIn) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addDigitalOut(DigitalOut) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new DigitalOut instance.
addDigitalOut(int, DigitalOut) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new DigitalOut instance at the given reference.
addDigitalOut(DigitalOut) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addDigitalOut(int, DigitalOut) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addField(int, String) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
 
addFIFO(FIFO) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new FIFO instance.
addFIFO(int, FIFO) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new FIFO instance, possibly creating a hole between the last existing reference and the new object.
addFIFO(FIFO) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addFIFO(int, FIFO) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addFile(File) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new File instance.
addFile(int, File) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new File instance, possibly creating a hole between the last existing reference and the new object.
addFile(File) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addFile(int, File) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addInputRegister(InputRegister) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new InputRegister instance.
addInputRegister(int, InputRegister) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new InputRegister instance, possibly creating a hole between the last existing reference and the new object.
addInputRegister(InputRegister) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addInputRegister(int, InputRegister) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addListener(AbstractSerialTransportListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Adds a listener to the transport to be called when an event occurs
addObserver(Observer) - Method in class com.ghgande.j2mod.modbus.util.Observable
Adds an observer instance if it is not already in the set of observers for this Observable.
addProcessImage(int, ProcessImage) - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Adds a process image for the given Unit ID
addRegister(Register) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new Register instance.
addRegister(int, Register) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Adds a new Register instance, possibly creating a hole between the last existing reference and the new object.
addRegister(Register) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addRegister(int, Register) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
addRequest(ReadFileRecordRequest.RecordRequest) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
addRequest -- add a new record request.
addRequest(WriteFileRecordRequest.RecordRequest) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
addRequest -- add a new record request.
addResponse(ReadFileRecordResponse.RecordResponse) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
addResponse -- add a new record response.
addResponse(WriteFileRecordResponse.RecordResponse) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
addResponse -- add a new record response.
addSize(int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Skip the given number of bytes in the buffer.
afterMessageWrite(AbstractSerialConnection, ModbusMessage) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Will be called whenever a message has been written either successfully or unsuccessfully Although a message may not be sent (throws and error), this even is guaranteed to occur
afterRequestRead(AbstractSerialConnection, ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Called whenever a request has been received
afterResponseRead(AbstractSerialConnection, ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Called whenever a response has been received
available() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 

B

beforeMessageWrite(AbstractSerialConnection, ModbusMessage) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Will be called whenever a message is about to be written
beforeRequestRead(AbstractSerialConnection) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Called before a request is read
beforeResponseRead(AbstractSerialConnection) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Called before a response is read
BitVector - Class in com.ghgande.j2mod.modbus.util
Class that implements a collection for bits, storing them packed into bytes.
BitVector(int) - Constructor for class com.ghgande.j2mod.modbus.util.BitVector
Constructs a new BitVector instance with a given size.
bytesAvailable() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Bytes available to read
bytesAvailable() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
BytesInputStream - Class in com.ghgande.j2mod.modbus.io
Class implementing a byte array input stream with a DataInput interface.
BytesInputStream(int) - Constructor for class com.ghgande.j2mod.modbus.io.BytesInputStream
Constructs a new BytesInputStream instance, with an empty buffer of a given size.
BytesInputStream(byte[]) - Constructor for class com.ghgande.j2mod.modbus.io.BytesInputStream
Constructs a new BytesInputStream instance, that will read from the given data.
byteSize() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Returns the number of bytes used to store the collection of bits as int.
BytesOutputStream - Class in com.ghgande.j2mod.modbus.io
Class implementing a byte array output stream with a DataInput interface.
BytesOutputStream(int) - Constructor for class com.ghgande.j2mod.modbus.io.BytesOutputStream
Constructs a new BytesOutputStream instance with a new output buffer of the given size.
BytesOutputStream(byte[]) - Constructor for class com.ghgande.j2mod.modbus.io.BytesOutputStream
Constructs a new BytesOutputStream instance with a given output buffer.

C

calculateCRC(byte[], int, int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
 
clearListeners() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Clears the list of listeners
close() - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Closes the raw input and output streams of this ModbusTransport.
close() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Closes the comms port and any streams associated with it
close() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
close() - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
close() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Close the port and clean up associated elements
close() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
close() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Closes this TCPMasterConnection.
close() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Closes this TCPSlaveConnection.
close() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Closes this UDPMasterConnection.
close() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Convenience method for closing this port and removing it from the running list - simply calls ModbusSlaveFactory.close(this)
close(ModbusSlave) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Closes this slave and removes it from the running list
close() - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Closes all slaves and removes them from the running list
close() - Method in class com.ghgande.j2mod.modbus.util.ThreadPool
Shutdown the pool of threads
COIL_OFF - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the byte representation of the coil state pos.
COIL_OFF_BYTES - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the word representation of the coil state pos.
COIL_ON - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the byte representation of the coil state on.
COIL_ON_BYTES - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the word representation of the coil state on.
com.ghgande.j2mod.modbus - package com.ghgande.j2mod.modbus
 
com.ghgande.j2mod.modbus.facade - package com.ghgande.j2mod.modbus.facade
 
com.ghgande.j2mod.modbus.io - package com.ghgande.j2mod.modbus.io
 
com.ghgande.j2mod.modbus.msg - package com.ghgande.j2mod.modbus.msg
 
com.ghgande.j2mod.modbus.net - package com.ghgande.j2mod.modbus.net
 
com.ghgande.j2mod.modbus.procimg - package com.ghgande.j2mod.modbus.procimg
 
com.ghgande.j2mod.modbus.slave - package com.ghgande.j2mod.modbus.slave
 
com.ghgande.j2mod.modbus.util - package com.ghgande.j2mod.modbus.util
 
commitUpdate() - Method in interface com.ghgande.j2mod.modbus.io.NonWordDataHandler
Deprecated.
Commits the data if it has been read into an intermediate repository.
connect() - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Connects this ModbusTCPMaster with the slave.
connect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
Connects this ModbusSerialMaster with the slave.
connect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Connects this ModbusTCPMaster with the slave.
connect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
Connects this ModbusTCPMaster with the slave.
connect() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Opens this TCPMasterConnection.
connect(boolean) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Opens this TCPMasterConnection.
connect() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Opens this UDPMasterConnection.
CONNECT_RETRIES - Static variable in class com.ghgande.j2mod.modbus.net.SerialConnection
 
CONNECT_RETRY_DELAY - Static variable in class com.ghgande.j2mod.modbus.net.SerialConnection
 
createBitVector(byte[], int) - Static method in class com.ghgande.j2mod.modbus.util.BitVector
Factory method for creating a BitVector instance wrapping the given byte data.
createBitVector(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.BitVector
Factory method for creating a BitVector instance wrapping the given byte data.
createDigitalIn() - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new SimpleDigitalIn instance.
createDigitalIn(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new DigitalIn instance with the given state.
createDigitalIn() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new DigitalIn instance.
createDigitalIn(boolean) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new DigitalIn instance with the given state.
createDigitalOut() - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new SimpleDigitalOut instance.
createDigitalOut(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new DigitalOut instance with the given state.
createDigitalOut() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new DigitalOut instance.
createDigitalOut(boolean) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new DigitalOut instance with the given state.
createExceptionResponse(int) - Method in class com.ghgande.j2mod.modbus.msg.ModbusRequest
Factory method for creating exception responses with the given exception code.
createInputRegister() - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new SimpleInputRegister instance.
createInputRegister(byte, byte) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new InputRegister instance with a given value.
createInputRegister(int) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new InputRegister instance with a given value.
createInputRegister() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new InputRegister instance.
createInputRegister(byte, byte) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new InputRegister instance with a given value.
createModbusRequest(int) - Static method in class com.ghgande.j2mod.modbus.msg.ModbusRequest
Factory method creating the required specialized ModbusRequest instance.
createModbusResponse(int) - Static method in class com.ghgande.j2mod.modbus.msg.ModbusResponse
Factory method creating the required specialized ModbusResponse instance.
createProcessImageImplementation() - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new SimpleProcessImage instance.
createProcessImageImplementation() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new ProcessImageImplementation instance.
createRegister() - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Creates a new SimpleRegister instance.
createRegister(byte, byte) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Returns a new Register instance with a given value.
createRegister(int) - Method in class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
Creates a new SimpleRegister instance.
createRegister() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Creates a new Register instance.
createRegister(byte, byte) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageFactory
Returns a new Register instance with a given value.
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ModbusRequest
Returns the ModbusResponse that represents the answer to this ModbusRequest.
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
 
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
createResponse - Returns the WriteMultipleRegistersResponse that represents the answer to this WriteMultipleRegistersRequest.
createResponse(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
 
createSerialSlave(SerialParameters) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a serial modbus slave or returns the one already allocated to this port
createTCPSlave(int, int) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a TCP modbus slave or returns the one already allocated to this port
createTCPSlave(int, int, boolean) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a TCP modbus slave or returns the one already allocated to this port
createTCPSlave(InetAddress, int, int, boolean) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a TCP modbus slave or returns the one already allocated to this port
createTCPSlave(InetAddress, int, int, boolean, int) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a TCP modbus slave or returns the one already allocated to this port
createTransaction() - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Creates a Modbus transaction for the underlying transport.
createTransaction() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Creates a new transaction suitable for the serial port
createTransaction() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
createTransaction() - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
createUDPSlave(int) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a UDP modbus slave or returns the one already allocated to this port
createUDPSlave(InetAddress, int) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Creates a UDP modbus slave or returns the one already allocated to this port

D

deactivate() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Deactivates this UDPTerminal.
DEFAULT_PORT - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default port number of Modbus (=502).
DEFAULT_PROTOCOL_ID - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default protocol identifier (=0).
DEFAULT_RECONNECTING - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default reconnecting setting for transactions (=false).
DEFAULT_RETRIES - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default amount of retires for opening a connection (=3).
DEFAULT_SERIAL_ENCODING - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default serial encoding (ASCII).
DEFAULT_TIMEOUT - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default setting for I/O operation timeouts in milliseconds (=3000).
DEFAULT_TRANSACTION_ID - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default transaction identifier (=0).
DEFAULT_TRANSMIT_DELAY - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default number of msec to delay before transmission
Inter-message delays are managed by the SerialTransaction object automatically based on the baud rate.
DEFAULT_UNIT_ID - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default unit identifier (=0).
DEFAULT_VALIDITYCHECK - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default setting for validity checking in transactions (=true).
DefaultProcessImageFactory - Class in com.ghgande.j2mod.modbus.procimg
The default ProcessImageFactory.
DefaultProcessImageFactory() - Constructor for class com.ghgande.j2mod.modbus.procimg.DefaultProcessImageFactory
 
DIG_FALSE - Static variable in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Defines the unset state (i.e.
DIG_INVALID - Static variable in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Defines the invalid (unset, neither true nor false) state of a digital input or output.
DIG_TRUE - Static variable in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Defines the set state (i.e.
DigitalIn - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining a digital input.
DigitalOut - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining a digital output.
disableRs485Control() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Disables RS-485 control signals management.
disconnect() - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Disconnects this ModbusTCPMaster from the slave.
disconnect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
Disconnects this ModbusSerialMaster from the slave.
disconnect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Disconnects this ModbusTCPMaster from the slave.
disconnect() - Method in class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
Disconnects this ModbusTCPMaster from the slave.
disconnected(AbstractSerialConnection) - Method in class com.ghgande.j2mod.modbus.io.AbstractSerialTransportListener
Called whenever a device is disconnected
doubleToRegisters(double) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a double value to a byte[8].

E

equals(Object) - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
A ModbusTCPMaster is equal if the underlying TCPMasterConnection is equal.
equals(Object) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
A TCPMasterConnection is equal if InetAddress & port are equal.
EVEN_PARITY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
EXCEPTION_OFFSET - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception offset that is added to the function code, to flag an exception.
ExceptionResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing aModbusResponse that represents an exception.
ExceptionResponse(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ExceptionResponse
Constructs a new ExceptionResponse instance with a given function code and an exception code.
ExceptionResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.ExceptionResponse
Constructs a new ExceptionResponse instance with a given function code.
ExceptionResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ExceptionResponse
Constructs a new ExceptionResponse instance with no function or exception code.
execute() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
 
execute() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
 
execute() - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Executes this ModbusTransaction.
execute() - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
 
execute(Runnable) - Method in class com.ghgande.j2mod.modbus.util.ThreadPool
Execute the Runnable instance through a thread in this ThreadPool.

F

FastByteArrayInputStream - Class in com.ghgande.j2mod.modbus.io
This class is a replacement for ByteArrayInputStream that does not synchronize every byte read.
FastByteArrayOutputStream - Class in com.ghgande.j2mod.modbus.io
This class is a replacement implementation for ByteArrayOutputStream that does not synchronize every byte written.
FastByteArrayOutputStream(int, int) - Constructor for class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Creates an output stream with a given bump size and initial size.
FIFO - Class in com.ghgande.j2mod.modbus.procimg
 
FIFO(int) - Constructor for class com.ghgande.j2mod.modbus.procimg.FIFO
 
File - Class in com.ghgande.j2mod.modbus.procimg
 
File(int, int) - Constructor for class com.ghgande.j2mod.modbus.procimg.File
 
floatToRegisters(float) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a float value to a byte[4] binary float value.
FLOW_CONTROL_CTS_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
FLOW_CONTROL_DISABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Flow control values
FLOW_CONTROL_DSR_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
FLOW_CONTROL_DTR_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
FLOW_CONTROL_RTS_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
FLOW_CONTROL_XONXOFF_IN_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
FLOW_CONTROL_XONXOFF_OUT_ENABLED - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
forceSize(int) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Forces the number of bits in this BitVector.

G

GATEWAY_TARGET_NO_RESPONSE - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type Gateway target failed to respond.
getAddress() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Returns the address bound to this socket
getAddress() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Gets the local adapter address
getAddress() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Returns the destination InetAddress of this TCPMasterConnection.
getAddress() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Returns the destination InetAddress of this TCPSlaveConnection.
getAddress() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Returns the destination InetAddress of this UDPMasterConnection.
getAddress() - Method in class com.ghgande.j2mod.modbus.procimg.FIFO
 
getAndMask() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
getAndMask -- return the AND mask value;
getAndMask() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
getAndMask -- return the AND mask value;
getAuxiliaryType() - Method in class com.ghgande.j2mod.modbus.msg.ModbusResponse
Returns the auxiliary type of this response message Useful for adding extra information to the message that can be used by downstream processing
getBaudRate() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns current baud rate
getBaudRate() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getBaudRate() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Return the baud rate as int.
getBaudRateString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the baud rate as a String.
getBit(int) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Returns the state of the bit at the given index of this BitVector.
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Returns the number of bits (i.e.
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
getBitCount -- return the number of coils
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Returns the number of bits (i.e.
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Returns the number of bits (i.e.
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
getBitCount - Returns the number of coils written with the request.
getBitCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
getBitCount - Returns the quantity of coils written with the request.
getBuffer() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
Returns the reference to the input buffer.
getBuffer() - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
Returns the reference to the output buffer.
getBufferBytes() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
Returns the underlying data being read.
getBufferBytes() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the buffer owned by this object.
getBufferLength() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
getBufferLength() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
Returns the end of the buffer being read.
getBufferLength() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the length used in the internal buffer, that is, the offset at which data will be written next.
getBufferOffset() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
Returns the offset at which data is being read from the buffer.
getBufferOffset() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the offset of the internal buffer.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
Returns the number of bytes needed for the response.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Returns the number of bytes that have been read.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Returns the number of bytes that have been read.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getByteCount - Returns the number of bytes representing the values to be written.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Returns the number of bytes that have been read.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
getByteCount - Returns the number of bytes required for packing the coils.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getByteCount - Returns the number of bytes representing the values to be written.
getByteCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Returns the number of bytes that have been written.
getBytes() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Returns the byte[] which is used to store the bits of this BitVector.
getCoil() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Returns the state that should be written with this WriteCoilRequest.
getCoil() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Gets the state that has been returned in this WriteCoilRequest.
getCoils() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
getCoils -- get the coils bit vector.
getCoils() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
getCoils - Returns the BitVector instance holding coil status information.
getCoilStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
Convenience method that returns the state of the bit at the given index.
getCoilStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
getCoilStatus - Returns the status of the specified coil.
getCommPort() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Returns the comms port being used for this transport
getCommPort(String) - Static method in class com.ghgande.j2mod.modbus.net.SerialConnection
Returns a JSerialComm implementation for the given comms port
getCommPorts() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns a set of all the available comm port names
getCommPorts() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getConnection() - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
 
getCount() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
getData() - Method in interface com.ghgande.j2mod.modbus.io.NonWordDataHandler
Deprecated.
Returns the intermediate raw non-word data.
getData() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
getData
getData(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
Deprecated. 
getData() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
getData
getData(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
Deprecated. 
getData() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
getData -- get the device-depending data for the slave.
getDatabits() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the number of data bits as int.
getDatabitsString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the number of data bits as String.
getDataLength() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the length of the data appended after the protocol header.
getDataLength() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getDescriptivePortName() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns a descriptive name of the port
getDescriptivePortName() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getDigitalIn(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the DigitalIn instance at the given reference.
getDigitalIn(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDigitalInCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of DigitalIn instances in this ProcessImage.
getDigitalInCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDigitalInRange(int, int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns a range of DigitalIn instances.
getDigitalInRange(int, int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDigitalOut(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the DigitalOut instance at the given reference.
getDigitalOut(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDigitalOutCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of DigitalOut instances in this ProcessImage.
getDigitalOutCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDigitalOutRange(int, int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns a range of DigitalOut instances.
getDigitalOutRange(int, int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getDiscretes() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Returns the BitVector that stores the collection of bits that have been read.
getDiscreteStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Convenience method that returns the state of the bit at the given index.
getEncoding() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the encoding to be used.
getError() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Returns any startup errors that may have aoccurred
getError() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Returns the last error accrued by the listener
getEvent(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
getEvent -- get an event from the event log.
getEventCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
getEvents -- get device's event counter.
getEventCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
getEvents -- get device's event counter.
getEvents() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
 
getExceptionCode() - Method in class com.ghgande.j2mod.modbus.msg.ExceptionResponse
Returns the Modbus exception code of this ExceptionResponse.
getField(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
Convenience method that returns the field at the requested index
getFieldCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
Returns the number of fields read with the request.
getFieldId() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Returns the number of bits (i.e.
getFieldId(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
Convenience method that returns the field ID at the given index.
getFields() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
Returns the array of strings that were read
getFIFO(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the FIFO instance in the list of all FIFO objects in this ProcessImage.
getFIFO(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFIFOByAddress(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the FIFO instance having the specified base address.
getFIFOByAddress(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFIFOCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of File instances in this ProcessImage.
getFIFOCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFile(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the File instance at the given reference.
getFile(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFileByNumber(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the File instance having the specified file number.
getFileByNumber(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFileCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of File instances in this ProcessImage.
getFileCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getFileNumber() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
getFileNumber() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getFileNumber() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getFileNumber() - Method in class com.ghgande.j2mod.modbus.procimg.File
 
getFlowControlIn() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the input flow control type as int.
getFlowControlInString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the input flow control type as String.
getFlowControlOut() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the output flow control type as int.
getFlowControlOutString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the output flow control type as String.
getFunction() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
getFunction -- Get the DIAGNOSTICS sub-function.
getFunction() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
getFunction -- Get the DIAGNOSTICS sub-function.
getFunctionCode() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the function code of this ModbusMessage as int.
The function code is a 1-byte non negative integer value valid in the range of 0-127.
getFunctionCode() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getHexMessage() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the raw message as String containing a hexadecimal series of bytes.
getHexMessage() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getInputRegister(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the InputRegister instance at the given reference.
getInputRegister(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getInputRegisterCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of InputRegister instances in this ProcessImage.
getInputRegisterCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getInputRegisterRange(int, int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns a range of InputRegister instances.
getInputRegisterRange(int, int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getKey(int) - Method in enum com.ghgande.j2mod.modbus.slave.ModbusSlaveType
Returns a unique key for this port and type
getKey(String) - Method in enum com.ghgande.j2mod.modbus.slave.ModbusSlaveType
Returns a unique key for this port and type
getLastActivityTimestamp() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
getLastActivityTimestamp() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
 
getLevel() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Returns the reference of the register to to start reading from with this ReadCoilsRequest.
getMessage(int) - Static method in exception com.ghgande.j2mod.modbus.ModbusSlaveException
Get the exception type message associated with the given exception number.
getMessage() - Method in exception com.ghgande.j2mod.modbus.ModbusSlaveException
Get the exception type message associated with this exception.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ExceptionResponse
getMessage() return the exception type, which is the "message" for this response.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
getMessage -- return an empty array as there is no data for this request.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
getMessage -- format the message into a byte array.
getMessage() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the raw message as an array of bytes.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
getMessage -- format the message into a byte array.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
getMessage -- format the message into a byte array.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
getMessage -- format the message into a byte array.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
getMessage -- format the message into a byte array.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
getMessage -- Create the DIAGNOSTICS message paylaod.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
getMessage -- Create the DIAGNOSTICS message paylaod.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getMessage -- return a prepared message.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
getMessage
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
getMessage -- format the message into a byte array.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
getMessage -- return the raw binary message.
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
 
getMessage() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
 
getMessageCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
getMessageCount -- get device's message counter.
getModbusTransport() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns the ModbusTransport instance to be used for receiving and sending messages.
getModbusTransport() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getModbusTransport() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Returns the ModbusTransport associated with this TCPMasterConnection.
getModbusTransport() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Returns the ModbusTransport associated with this TCPMasterConnection.
getModbusTransport() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Returns the ModbusTransport associated with this UDPMasterConnection.
getNetworkInterface() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Gets the local NetworkInterface that this socket is bound to.
getNonWordDataHandler() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getNonWordDataHandler - Returns the actual non word data handler.
getNonWordDataHandler() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getNonWordDataHandler - Returns the actual non word data handler.
getNumDataBits() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns current data bits value
getNumDataBits() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getNumStopBits() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns current stop bits
getNumStopBits() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getObserverCount() - Method in class com.ghgande.j2mod.modbus.util.Observable
 
getOpenDelay() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Gets the open delay used to prevent some OS from losing the comms port
getOrMask() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
getOrMask -- return the OR mask value;
getOrMask() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
getOrMask -- return the OR mask value;
getOutputLength() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the number of bytes that will be written by ModbusMessage.writeTo(DataOutput).
getOutputLength() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getParity() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns current parity
getParity() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getParity() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the parity schema as int.
getParityString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the parity schema as String.
getPort() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Returns the port being listened on
getPort() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Returns the local port the terminal is listening on
getPort() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Returns the destination port of this TCPMasterConnection.
getPort() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Returns the destination port of this TCPSlaveConnection.
getPort() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Returns the destination port of this UDPMasterConnection.
getPort() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Returns the port that this IP slave is listening on
getPortName() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns a name of the port
getPortName() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getPortName() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the port name.
getProcessImage(int) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Returns the related process image for this listener and Unit Id
getProcessImage(int) - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Returns the process image for the given Unit ID
getProtocolID() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the protocol identifier of this ModbusMessage as int.
getProtocolID() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getReadReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getReadReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.
getReadRegisterValue(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getReadRegisterValue - Returns the value of the specified register interpreted as unsigned short.
getReadWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getReadWordCount - Returns the number of words to be read.
getRecord(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
getRecord
getRecord(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
getRecord
getRecord(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
getRecord -- return the record request indicated by the reference
getRecord(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
getRecord -- return the record request indicated by the reference
getRecord(int) - Method in class com.ghgande.j2mod.modbus.procimg.File
 
getRecordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
getRecordCount -- return the number of records in the response.
getRecordCount() - Method in class com.ghgande.j2mod.modbus.procimg.File
 
getRecordNumber() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
getRecordNumber() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getRecordNumber() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getRecordNumber() - Method in class com.ghgande.j2mod.modbus.procimg.Record
 
getReference() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
getReference
getReference() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
getReference
getReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Returns the reference of the register to to start reading from with this ReadCoilsRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
getReference -- get the queue register number.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Returns the reference of the discrete to to start reading from with this ReadInputDiscretesRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Returns the reference of the register to to start reading from with this ReadInputRegistersRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Returns the reference of the register to to start reading from with this ReadMultipleRegistersRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Returns the reference of the register of the coil that should be written to with this ReadCoilsRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Returns the reference of the register of the coil that has been written to with the request.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
getReference - Returns the reference of the coil to to start writing to with this WriteMultipleCoilsRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
getReference - Returns the reference of the coil to start reading from with this WriteMultipleCoilsResponse.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
setReference - Returns the reference of the register to start writing to with this WriteMultipleRegistersRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Returns the reference of the register to start writing to with this WriteMultipleRegistersResponse.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Returns the reference of the register to be written to with this WriteSingleRegisterRequest.
getReference() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
Returns the reference of the register that has been written to.
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
 
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
 
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Returns the InputRegister at the given position (relative to the reference used in the request).
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Returns the Register at the given position (relative to the reference used in the request).
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getRegister - Returns the specified Register.
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Returns the Register at the given position (relative to the reference used in the request).
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getRegister(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getRegister - Returns the Register at the given position.
getRegister() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Returns the register to be written with this WriteSingleRegisterRequest.
getRegister(int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the Register instance at the given reference.
getRegister(int) - Method in class com.ghgande.j2mod.modbus.procimg.Record
 
getRegister(int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getRegisterCount() - Method in class com.ghgande.j2mod.modbus.procimg.FIFO
 
getRegisterCount() - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns the number of Register instances in this ProcessImage.
getRegisterCount() - Method in class com.ghgande.j2mod.modbus.procimg.Record
 
getRegisterCount() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getRegisterRange(int, int) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImage
Returns a range of Register instances.
getRegisterRange(int, int) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
 
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Returns a reference to the array of input registers read.
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Returns the reference to the array of registers read.
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getRegisters - Returns the registers to be written with this ReadWriteMultipleRequest.
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Returns the reference to the array of registers read.
getRegisters() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getRegisters - Returns the registers to be written with this WriteMultipleRegistersRequest.
getRegisters() - Method in class com.ghgande.j2mod.modbus.procimg.FIFO
 
getRegisterValue(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Returns the value of the register at the given position (relative to the reference used in the request) interpreted as usigned short.
getRegisterValue(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Returns the value of the register at the given position (relative to the reference used in the request) interpreted as unsigned short.
getRegisterValue(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Returns the value of the register at the given position (relative to the reference used in the request) interpreted as unsigned short.
getRegisterValue(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getRegisterValue - Returns the value of the specified register.
getRegisterValue() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
Returns the value that has been returned in this WriteSingleRegisterResponse.
getRequest() - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Returns the ModbusRequest instance associated with this ModbusTransaction.
getRequest(byte[], int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
getRequest() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
getRequest(byte[], int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getRequest() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getRequestCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
getRequestCount
getRequestCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
getRequestCount -- return the number of record requests in this message.
getRequestCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
getRequestCount -- return the number of record requests in this message.
getRequestSize() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
getRequestSize -- return the total request size.
getRequestSize() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
getRequestSize
getRequestSize() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
getRequestSize -- return the total request size.
getRequestSize() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
getRequestSize -- return the size of the response in bytes.
getResponse() - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Returns the ModbusResponse instance associated with this ModbusTransaction.
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
There is no unit number associated with this exception.
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
getResponse -- create an empty response for this request.
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ModbusRequest
Returns the ModbusResponse that correlates with this ModbusRequest.
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
 
getResponse(byte[], int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
getResponse - return the response data for this record The response data is the byte size of the response, minus this byte, the function code (6), then the raw byte data for the registers (wordCount * 2 bytes).
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
 
getResponse(byte[], int) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
 
getResponse() - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
 
getResponseSize() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
getResponseSize -- return the size of the response in bytes.
getResponseSize() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
getRequestSize -- return the total request size.
getResponseSize() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
getResponseSize -- return the size of the response in bytes.
getRs485DelayAfterTxMicroseconds() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the delay between the end of transmitting data and deactivating the RS-485 transmitter.
getRs485DelayBeforeTxMicroseconds() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the delay between activating the RS-485 transmitter and actually sending data.
getRs485EnableTermination() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns whether the RS-485 interface shall enable internal bus termination.
getRs485Mode() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns whether RS-485 half-duplex mode is enabled.
getRs485RxDuringTx() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns whether the RS-485 interface receives data it sends.
getRs485TxEnableActiveHigh() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns whether the RS-485 transmitter is enabled by a high or low control signal.
getSerialParams() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Returns the serial parameters of this slave if it is a Serial type
getSlave(ModbusSlaveType, int) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Returns the running slave listening on the given port
getSlave(ModbusSlaveType, String) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Returns the running slave listening on the given port
getSlave(AbstractModbusListener) - Static method in class com.ghgande.j2mod.modbus.slave.ModbusSlaveFactory
Returns the running slave that utilises the give listener
getSlaveID() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
getSlaveID -- return the slave identifier field.
getStatus() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
getStatus -- get the device's status.
getStatus() - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
getStatus -- get the device's status.
getStatus() - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
getStatus -- get the device's status.
getStatus() - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
getStatus -- get the slave's "run" status.
getStopbits() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the number of stop bits as int.
getStopbitsString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns the number of stop bits as String.
getSubCode() - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Gets the MEI subcode associated with this request.
getTerminal() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Returns the terminal used for handling the package traffic.
getThreadName() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Gets the name of the thread used by the listener
getThreadName() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Gets the name of the thread used by the listener
getTimeout() - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Returns the receive timeout in milliseconds
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Get the socket timeout
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Returns the timeout for this connection
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Returns the timeout (msec) for this TCPMasterConnection.
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Returns the timeout for this TCPSlaveConnection.
getTimeout() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Returns the timeout for this UDPMasterConnection.
getTransactionID() - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
getTransactionID -- get the next transaction ID to use.
getTransactionID() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the transaction identifier of this ModbusMessage as int.
getTransactionID() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getTransDelayMS() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Get the TransDelayMS value.
getTransport() - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Returns the transport being used by the
getTransport() - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
 
getTransport() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
 
getTransport() - Method in class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
 
getTransport() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Get the transport
getType() - Method in exception com.ghgande.j2mod.modbus.ModbusSlaveException
Returns the type of this ModbusSlaveException.
getType() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Returns the type of this slave
getUnitID() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Returns the unit identifier of this ModbusMessage as int.
getUnitID() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
getUnitID() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
getUseUrgentData() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Gets the current setting of the flag which controls sending urgent data to test a network connection.
getValue() - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
getValue() - Method in interface com.ghgande.j2mod.modbus.procimg.InputRegister
Returns the value of this InputRegister.
getValue() - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
getValue() - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
getWordCount() - Method in interface com.ghgande.j2mod.modbus.io.NonWordDataHandler
Deprecated.
Returns the word count of the data.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
getWordCount -- get the queue size.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
 
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Returns the number of words to be read with this ReadInputRegistersRequest.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Returns the number of words that have been read.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Returns the number of words to be read with this ReadMultipleRegistersRequest.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Returns the number of words that have been read.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
getWordCount -- get the number of words in data.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
getWordCount -- get the number of words in data.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Returns the number of words that have been read.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
getWordCount - Returns the number of words to be written.
getWordCount() - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Returns the number of words that have been written.
getWriteReference() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getWriteReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.
getWriteWordCount() - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
getWriteWordCount - Returns the number of words to be written.

H

hashCode() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
The unique value of the ModbusTCPMaster is calculated from the unique value of the TCPMasterConnection
hashCode() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
The unique value of the TCPMasterConnection is calculated from the unique values of the InetAddress & port
hiByte(int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
 

I

ILLEGAL_ADDRESS_EXCEPTION - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type illegal data address.
ILLEGAL_FUNCTION_EXCEPTION - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type illegal function.
ILLEGAL_VALUE_EXCEPTION - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type illegal data value.
IllegalAddressException - Exception in com.ghgande.j2mod.modbus.procimg
Class implementing an IllegalAddressException.
IllegalAddressException() - Constructor for exception com.ghgande.j2mod.modbus.procimg.IllegalAddressException
Constructs a new IllegalAddressException.
IllegalAddressException(String) - Constructor for exception com.ghgande.j2mod.modbus.procimg.IllegalAddressException
Constructs a new IllegalAddressException with the given message.
IllegalAddressExceptionResponse - Class in com.ghgande.j2mod.modbus.msg
 
IllegalAddressExceptionResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalAddressExceptionResponse
 
IllegalAddressExceptionResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalAddressExceptionResponse
 
IllegalFunctionExceptionResponse - Class in com.ghgande.j2mod.modbus.msg
 
IllegalFunctionExceptionResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalFunctionExceptionResponse
 
IllegalFunctionExceptionResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalFunctionExceptionResponse
 
IllegalFunctionRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ModbusRequest which is created for illegal or non implemented function codes.
IllegalFunctionRequest(int) - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
Constructs a new IllegalFunctionRequest instance for a given function code.
IllegalFunctionRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
Constructs a new IllegalFunctionRequest instance for a given function code.
IllegalValueExceptionResponse - Class in com.ghgande.j2mod.modbus.msg
 
IllegalValueExceptionResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalValueExceptionResponse
 
IllegalValueExceptionResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.IllegalValueExceptionResponse
 
initPool(String) - Method in class com.ghgande.j2mod.modbus.util.ThreadPool
Initializes the pool, populating it with n started threads.
InputRegister - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining an input register.
INTER_CHARACTER_GAP - Static variable in interface com.ghgande.j2mod.modbus.Modbus
The number of characters delay that is the allowed maximum between characters on the same serial port (within the same transaction)
INTER_MESSAGE_GAP - Static variable in interface com.ghgande.j2mod.modbus.Modbus
The number of characters delay that must be maintained between adjacent requests on the same serial port (within the same transaction)
intToRegisters(int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts an int value to a byte[4] array.
is(ModbusSlaveType...) - Method in enum com.ghgande.j2mod.modbus.slave.ModbusSlaveType
Returns true if this type is one of those listed
isActive() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Tests if this UDPSlaveTerminal is active.
isBlank(String) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Return true if the string is null or empty
isBlank(List<Object>) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Return true if the list is null or empty
isBlank(Object[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Return true if the array is null or empty
isCheckingValidity() - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Tests whether the validity of a transaction will be checked.
isConnected() - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Returns true if the master is connected
isConnected() - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
 
isConnected() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
 
isConnected() - Method in class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
 
isConnected() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Tests if this TCPMasterConnection is connected.
isConnected() - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Tests if this TCPSlaveConnection is connected.
isConnected() - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Tests if this UDPMasterConnection is connected.
isEcho() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
isEcho method returns the output echo state.
isEcho() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Get the Echo value.
isEOF() - Method in exception com.ghgande.j2mod.modbus.ModbusIOException
Tests if this ModbusIOException is caused by an end of the stream.
isHeadless() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Check the flag which indicates that this ModbusMessage is for a headless (serial, or headless networked) connection.
isHeadless() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
isListening() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Tests if this ModbusTCPListener is listening and accepting incoming connections.
isLocked() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
The process image is locked to prevent changes.
isLSBAccess() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Tests if this BitVector has the LSB (rightmost) as the first bit (i.e.
isMSBAccess() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Tests if this BitVector has the MSB (leftmost) as the first bit (i.e.
isOpen() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Reports the open status of the port
isOpen() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
isReconnecting() - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Tests if a constant connection is maintained or if a new connection is established for every transaction.
isReconnecting() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Tests if the connection will be opened and closed for each execution.
isRs485ControlDisabled() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Returns whether RS-485 control signals management is disabled.
isSet() - Method in interface com.ghgande.j2mod.modbus.procimg.DigitalIn
Tests if this DigitalIn is set.
isSet() - Method in class com.ghgande.j2mod.modbus.procimg.ObservableDigitalOut
Determine if the digital output is set.
isSet() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleDigitalIn
 
isSet() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleDigitalOut
 
isType(int) - Method in exception com.ghgande.j2mod.modbus.ModbusSlaveException
Tests if this ModbusSlaveException is of a given type.
isUseRtuOverTcp() - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Returns true if this connection is an RTU over TCP type

L

longToRegisters(long) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a long value to a byte[8].
lowByte(int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Returns the low byte of an integer word.

M

main(String[]) - Static method in class com.ghgande.j2mod.modbus.util.ModPoll
Main entry point for the ModPoll applicaion
makeSpace(int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Ensure that at least the given number of bytes are available in the internal buffer.
makeWord(int, int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Makes a word from 2 bytes
mark(int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
MARK_PARITY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
markSupported() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
MASK_WRITE_REGISTER - Static variable in interface com.ghgande.j2mod.modbus.Modbus
mask write register Update a single register using its current value and an AND and OR mask.
maskWriteRegister(int, int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Mask write a single register to the slave.
maskWriteRegister(int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Mask write a single register to the slave.
MaskWriteRegisterRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Mask Write Register request.
MaskWriteRegisterRequest(int, int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
Constructs a new Mask Write Register request.
MaskWriteRegisterRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
Constructs a new Mask Write Register request.
MaskWriteRegisterResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadMEIResponse.
MaskWriteRegisterResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
Constructs a new ReportSlaveIDResponse instance.
MAX_BITS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the maximum number of bits in multiple read/write of input discretes or coils (2000).
MAX_MESSAGE_LENGTH - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the maximum message length in bytes (=256).
MAX_TRANSACTION_ID - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the maximum value of the transaction identifier.
MINIMUM_TRANSMIT_DELAY - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the default number of msec to delay before transmission if not overridden by DEFAULT_TRANSMIT_DELAY (=2).
Modbus - Interface in com.ghgande.j2mod.modbus
Interface defining all constants related to the Modbus protocol.
ModbusASCIITransport - Class in com.ghgande.j2mod.modbus.io
Class that implements the Modbus/ASCII transport flavor.
ModbusASCIITransport() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusASCIITransport
Constructs a new MobusASCIITransport instance.
ModbusException - Exception in com.ghgande.j2mod.modbus
Superclass of all specialised exceptions in this package.
ModbusException() - Constructor for exception com.ghgande.j2mod.modbus.ModbusException
Constructs a new ModbusException instance.
ModbusException(String) - Constructor for exception com.ghgande.j2mod.modbus.ModbusException
Constructs a new ModbusException instance with the given message.
ModbusException(String, Object...) - Constructor for exception com.ghgande.j2mod.modbus.ModbusException
Constructs a new ModbusException instance with the given message.
ModbusException(String, Throwable) - Constructor for exception com.ghgande.j2mod.modbus.ModbusException
Constructs a new ModbusException instance with the given message and underlying cause.
ModbusIOException - Exception in com.ghgande.j2mod.modbus
Class that implements a ModbusIOException.
ModbusIOException() - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance.
ModbusIOException(String) - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance with the given message.
ModbusIOException(String, Object...) - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance with the given message.
ModbusIOException(boolean) - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance.
ModbusIOException(String, boolean) - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance with the given message.
ModbusIOException(String, Throwable) - Constructor for exception com.ghgande.j2mod.modbus.ModbusIOException
Constructs a new ModbusIOException instance with the given message and underlying cause.
ModbusMessage - Interface in com.ghgande.j2mod.modbus.msg
Interface defining a ModbusMessage.
ModbusMessageImpl - Class in com.ghgande.j2mod.modbus.msg
Abstract class implementing a ModbusMessage.
ModbusMessageImpl() - Constructor for class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
ModbusRequest - Class in com.ghgande.j2mod.modbus.msg
Abstract class implementing a ModbusRequest.
ModbusRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ModbusRequest
 
ModbusResponse - Class in com.ghgande.j2mod.modbus.msg
Abstract class implementing a ModbusResponse.
ModbusResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ModbusResponse
 
ModbusResponse.AuxiliaryMessageTypes - Enum in com.ghgande.j2mod.modbus.msg
 
ModbusRTUTCPTransport - Class in com.ghgande.j2mod.modbus.io
Class that implements the ModbusRTU over tCP transport flavor.
ModbusRTUTCPTransport() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusRTUTCPTransport
Default constructor
ModbusRTUTCPTransport(Socket) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusRTUTCPTransport
Constructs a new ModbusTransport instance, for a given Socket.
ModbusRTUTransport - Class in com.ghgande.j2mod.modbus.io
Class that implements the ModbusRTU transport flavor.
ModbusRTUTransport() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusRTUTransport
 
ModbusSerialListener - Class in com.ghgande.j2mod.modbus.net
Class that implements a ModbusSerialListener.
If listening, it accepts incoming requests passing them on to be handled.
ModbusSerialListener(SerialParameters) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusSerialListener
Constructs a new ModbusSerialListener instance.
ModbusSerialListener(AbstractSerialConnection) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusSerialListener
Constructs a new ModbusSerialListener instance specifying the serial connection interface
ModbusSerialMaster - Class in com.ghgande.j2mod.modbus.facade
Modbus/Serial Master facade.
ModbusSerialMaster(SerialParameters) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
Constructs a new master facade instance for communication with a given slave.
ModbusSerialMaster(SerialParameters, int) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
Constructs a new master facade instance for communication with a given slave.
ModbusSerialMaster(SerialParameters, int, int) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
Constructs a new master facade instance for communication with a given slave.
ModbusSerialTransaction - Class in com.ghgande.j2mod.modbus.io
Class implementing the ModbusTransaction interface.
ModbusSerialTransaction() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Constructs a new ModbusSerialTransaction instance.
ModbusSerialTransaction(ModbusRequest) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Constructs a new ModbusSerialTransaction instance with a given ModbusRequest to be send when the transaction is executed.
ModbusSerialTransaction(AbstractSerialConnection) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Constructs a new ModbusSerialTransaction instance with a given ModbusRequest to be send when the transaction is executed.
ModbusSerialTransport - Class in com.ghgande.j2mod.modbus.io
Abstract base class for serial ModbusTransport implementations.
ModbusSerialTransport() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
ModbusSlave - Class in com.ghgande.j2mod.modbus.slave
Class that implements a wrapper around a Slave Listener
ModbusSlaveException - Exception in com.ghgande.j2mod.modbus
Class that implements a ModbusSlaveException.
ModbusSlaveException(int) - Constructor for exception com.ghgande.j2mod.modbus.ModbusSlaveException
Constructs a new ModbusSlaveException instance with the given type.
ModbusSlaveFactory - Class in com.ghgande.j2mod.modbus.slave
This is a factory class that allows users to easily create and manage slaves.
Each slave is uniquely identified by the port it is listening on, irrespective of if the socket type (TCP, UDP or Serial)
ModbusSlaveType - Enum in com.ghgande.j2mod.modbus.slave
Descibes the types of Modbus Slaves
ModbusTCPListener - Class in com.ghgande.j2mod.modbus.net
Class that implements a ModbusTCPListener.
ModbusTCPListener(int, InetAddress) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusTCPListener
Constructs a ModbusTCPListener instance.
ModbusTCPListener(int, InetAddress, boolean) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusTCPListener
Constructs a ModbusTCPListener instance.
ModbusTCPListener(int) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusTCPListener
/** Constructs a ModbusTCPListener instance.
ModbusTCPListener(int, boolean) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusTCPListener
/** Constructs a ModbusTCPListener instance.
ModbusTCPMaster - Class in com.ghgande.j2mod.modbus.facade
Modbus/TCP Master facade.
ModbusTCPMaster(String) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, Proxy) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, boolean) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int, Proxy) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int, boolean) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int, int, boolean) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int, int, boolean, boolean) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPMaster(String, int, int, boolean, boolean, Proxy) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusTCPTransaction - Class in com.ghgande.j2mod.modbus.io
Class implementing the ModbusTransaction interface.
ModbusTCPTransaction() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Constructs a new ModbusTCPTransaction instance.
ModbusTCPTransaction(ModbusRequest) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Constructs a new ModbusTCPTransaction instance with a given ModbusRequest to be send when the transaction is executed.
ModbusTCPTransaction(TCPMasterConnection) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Constructs a new ModbusTCPTransaction instance with a given TCPMasterConnection to be used for transactions.
ModbusTCPTransport - Class in com.ghgande.j2mod.modbus.io
Class that implements the Modbus transport flavor.
ModbusTCPTransport() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Default constructor
ModbusTCPTransport(Socket) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Constructs a new ModbusTransport instance, for a given Socket.
ModbusTransaction - Class in com.ghgande.j2mod.modbus.io
Interface defining a ModbusTransaction.
ModbusTransaction() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusTransaction
 
ModbusUDPListener - Class in com.ghgande.j2mod.modbus.net
Class that implements a ModbusUDPListener.
ModbusUDPListener(InetAddress) - Constructor for class com.ghgande.j2mod.modbus.net.ModbusUDPListener
Create a new ModbusUDPListener instance listening to the given interface address.
ModbusUDPListener() - Constructor for class com.ghgande.j2mod.modbus.net.ModbusUDPListener
Constructs a new ModbusUDPListener instance.
ModbusUDPMaster - Class in com.ghgande.j2mod.modbus.facade
Modbus/UDP Master facade.
ModbusUDPMaster(String) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusUDPMaster(String, int) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusUDPMaster(String, int, int) - Constructor for class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
Constructs a new master facade instance for communication with a given slave.
ModbusUDPTransaction - Class in com.ghgande.j2mod.modbus.io
Class implementing the ModbusTransaction interface for the UDP transport mechanism.
ModbusUDPTransaction() - Constructor for class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
Constructs a new ModbusUDPTransaction instance.
ModbusUDPTransaction(ModbusRequest) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
Constructs a new ModbusUDPTransaction instance with a given ModbusRequest to be send when the transaction is executed.
ModbusUDPTransaction(AbstractUDPTerminal) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
Constructs a new ModbusUDPTransaction instance with a given UDPTerminal to be used for transactions.
ModbusUDPTransaction(UDPMasterConnection) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
Constructs a new ModbusUDPTransaction instance with a given ModbusUDPConnection to be used for transactions.
ModbusUDPTransport - Class in com.ghgande.j2mod.modbus.io
Class that implements the Modbus UDP transport flavor.
ModbusUDPTransport(AbstractUDPTerminal) - Constructor for class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
Constructs a new ModbusTransport instance, for a given UDPTerminal.
ModbusUtil - Class in com.ghgande.j2mod.modbus.util
Helper class that provides utility methods.
ModPoll - Class in com.ghgande.j2mod.modbus.util
This class mimics ModPoll for serial connections see https://www.modbusdriver.com/modpoll.html
ModPoll() - Constructor for class com.ghgande.j2mod.modbus.util.ModPoll
 

N

NEGATIVE_ACKNOWLEDGEMENT - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type negative acknowledgment.
NO_PARITY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Parity values
NonWordDataHandler - Interface in com.ghgande.j2mod.modbus.io
Deprecated.
In the interests of keeping the library simple, this will be removed in a future release
notifyListenersDisconnected() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Calls any listeners with the given event and current port
notifyObservers(Object) - Method in class com.ghgande.j2mod.modbus.util.Observable
Notifies all observer instances in the set of observers of this Observable.

O

Observable - Class in com.ghgande.j2mod.modbus.util
A cleanroom implementation of the Observable pattern.
Observable() - Constructor for class com.ghgande.j2mod.modbus.util.Observable
Constructs a new Observable instance.
ObservableDigitalOut - Class in com.ghgande.j2mod.modbus.procimg
Class implementing an observable digital output.
ObservableDigitalOut() - Constructor for class com.ghgande.j2mod.modbus.procimg.ObservableDigitalOut
 
ObservableRegister - Class in com.ghgande.j2mod.modbus.procimg
Class implementing an observable register.
ObservableRegister() - Constructor for class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
Observer - Interface in com.ghgande.j2mod.modbus.util
A cleanroom implementation of the Observer interface for the Observable design pattern.
ODD_PARITY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
ONE_POINT_FIVE_STOP_BITS - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
ONE_STOP_BIT - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Stop bits values
open() - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Opens the port and throws an error if it cannot for some reason
open() - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
open() - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Opens the listener to service requests
OPEN_DELAY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Open delay (msec)

P

prepareData(int, int) - Method in interface com.ghgande.j2mod.modbus.io.NonWordDataHandler
Deprecated.
Prepares the raw data, putting it together from a backing data store.
ProcessImage - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining a process image in an object oriented manner.
ProcessImageFactory - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining the factory methods for the process image and it's elements.
ProcessImageImplementation - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining implementation specific details of the ProcessImage, adding mechanisms for creating and modifying the actual "process image".
pushRegister(Register) - Method in class com.ghgande.j2mod.modbus.procimg.FIFO
 

R

read() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
read(byte[]) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
read(byte[], int, int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
READ_COILS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the class 1 function code for read coils.
READ_COMM_EVENT_COUNTER - Static variable in interface com.ghgande.j2mod.modbus.Modbus
get comm event counter Serial devices only.
READ_COMM_EVENT_LOG - Static variable in interface com.ghgande.j2mod.modbus.Modbus
get comm event log Serial devices only.
READ_EXCEPTION_STATUS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
read exception status Serial devices only.
READ_FIFO_QUEUE - Static variable in interface com.ghgande.j2mod.modbus.Modbus
read FIFO queue Read from a FIFO queue.
READ_FILE_RECORD - Static variable in interface com.ghgande.j2mod.modbus.Modbus
read file record
READ_HOLDING_REGISTERS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a class 1 function code for read holding registers
READ_INPUT_DISCRETES - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a class 1 function code for read input discretes.
READ_INPUT_REGISTERS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a class 1 function code for read input registers.
READ_MEI - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the function code for reading encapsulated data, such as vendor information.
READ_MEI_VENDOR_INFO - Static variable in interface com.ghgande.j2mod.modbus.Modbus
 
READ_MULTIPLE_REGISTERS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the class 0 function code for read multiple registers.
READ_SERIAL_DIAGNOSTICS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
get serial diagnostics Serial devices only.
READ_WRITE_MULTIPLE - Static variable in interface com.ghgande.j2mod.modbus.Modbus
read / write multiple registers Write some number of registers, then read some number of potentially other registers back.
readBoolean() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readByte() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readBytes(byte[], int) - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Read a specified number of bytes from the serial port
readBytes(byte[], int) - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
readChar() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readCoils(int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of coil states from the slave.
readCoils(int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of coil states from the slave.
ReadCoilsRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadCoilsRequest.
ReadCoilsRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Constructs a new ReadCoilsRequest instance.
ReadCoilsRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Constructs a new ReadCoilsRequest instance with a given reference and count of coils (i.e.
ReadCoilsResponse - Class in com.ghgande.j2mod.modbus.msg
Completed re-implementation 1/10/2011 Created getMessage() method to abstractly create the message data.
ReadCoilsResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
ReadCoilsResponse -- create an empty response message to be filled in later.
ReadCoilsResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
ReadCoilsResponse -- create a response for a given number of coils.
ReadCommEventCounterRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read MEI Data request.
ReadCommEventCounterRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
Constructs a new Report Slave ID request instance.
ReadCommEventCounterResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadCommEventCounterResponse.
ReadCommEventCounterResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
Constructs a new ReportSlaveIDResponse instance.
ReadCommEventLogRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read MEI Data request.
ReadCommEventLogRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
Constructs a new Get Comm Event Log instance.
ReadCommEventLogResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadCommEventCounterResponse.
ReadCommEventLogResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
Constructs a new ReadCommEventLogResponse instance.
readData(DataInput, int, int) - Method in interface com.ghgande.j2mod.modbus.io.NonWordDataHandler
Deprecated.
Reads the non-word raw data based on an arbitrary implemented structure.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ExceptionResponse
readData() read the single byte of data, which is the exception code.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
Read all of the data that can be read.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
readData -- dummy function.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Reads the subclass specific data from the given DataInput instance.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
readData -- dummy function.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
readData -- dummy function.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
readData -- dummy function.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
readData -- read the reference word.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
readData -- read all the data for this request.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
readData -- Read the function code and data value
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
readData -- Read the function code and data value
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
readData -- read the values of the registers to be written, along with the reference and count for the registers to be read.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
readData -- dummy function.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
readData -- input the Modbus message from din.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
readData -- convert the byte stream into a request.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
readData - Initialize the attribute values for this message from the input buffer.
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
 
readData(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
 
readDouble() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
ReadExceptionStatusRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read Exception Status request.
ReadExceptionStatusRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
Constructs a new Read Exception Status request instance.
ReadExceptionStatusResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadCommEventCounterResponse.
ReadExceptionStatusResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
Constructs a new ReadExceptionStatusResponse instance.
ReadFIFOQueueRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read FIFO Queue request.
ReadFIFOQueueRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
Constructs a new Read FIFO Queue request instance.
ReadFIFOQueueResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadFIFOQueueResponse.
ReadFIFOQueueResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
Constructs a new ReadFIFOQueueResponse instance.
ReadFileRecordRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read File Record request.
ReadFileRecordRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
Constructs a new Read File Record request instance.
ReadFileRecordRequest.RecordRequest - Class in com.ghgande.j2mod.modbus.msg
 
ReadFileRecordResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadFileRecordResponse.
ReadFileRecordResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
Constructs a new ReadFileRecordResponse instance.
ReadFileRecordResponse.RecordResponse - Class in com.ghgande.j2mod.modbus.msg
 
readFloat() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readFrom(DataInput) - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Reads this Transportable from the given DataInput.
readFrom(DataInput) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
readFully(byte[]) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readFully(byte[], int, int) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readInputDiscretes(int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of input discrete states from the slave.
readInputDiscretes(int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of input discrete states from the slave.
ReadInputDiscretesRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadInputDiscretesRequest.
ReadInputDiscretesRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Constructs a new ReadInputDiscretesRequest instance.
ReadInputDiscretesRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Constructs a new ReadInputDiscretesRequest instance with a given reference and count of input discretes (i.e.
ReadInputDiscretesResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadInputDiscretesResponse.
ReadInputDiscretesResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Constructs a new ReadInputDiscretesResponse instance.
ReadInputDiscretesResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Constructs a new ReadInputDiscretesResponse instance with a given count of input discretes (i.e.
readInputRegisters(int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of input registers from the slave.
readInputRegisters(int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of input registers from the slave.
ReadInputRegistersRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadInputRegistersRequest.
ReadInputRegistersRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Constructs a new ReadInputRegistersRequest instance.
ReadInputRegistersRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Constructs a new ReadInputRegistersRequest instance with a given reference and count of words to be read.
ReadInputRegistersResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadInputRegistersRequest.
ReadInputRegistersResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Constructs a new ReadInputRegistersResponse instance.
ReadInputRegistersResponse(InputRegister[]) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Constructs a new ReadInputRegistersResponse instance.
readInt() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readLine() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readLong() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
ReadMEIRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read MEI Data request.
ReadMEIRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Constructs a new Read MEI Data request instance.
ReadMEIRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Constructs a new Read MEI Data request instance with a given reference and count of coils (i.e.
ReadMEIResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadMEIResponse.
ReadMEIResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
Constructs a new ReadMEIResponse instance.
readMultipleRegisters(int, int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of registers from the slave.
readMultipleRegisters(int, int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Reads a given number of registers from the slave.
ReadMultipleRegistersRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadMultipleRegistersRequest.
ReadMultipleRegistersRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Constructs a new ReadMultipleRegistersRequest instance.
ReadMultipleRegistersRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Constructs a new ReadMultipleRegistersRequest instance with a given reference and count of words to be read.
ReadMultipleRegistersResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadMultipleRegistersResponse.
ReadMultipleRegistersResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Constructs a new ReadMultipleRegistersResponse instance.
ReadMultipleRegistersResponse(Register[]) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Constructs a new ReadInputRegistersResponse instance.
readRequest(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Reads a ModbusRequest from the input stream of this ModbusTransport.
readRequest(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
readRequest(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
readRequest(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
readRequestIn(AbstractModbusListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusASCIITransport
 
readResponse() - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Reads a ModbusResponse from the input stream of this ModbusTransport.
readResponse() - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
readResponse() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
readResponse() - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
ReadSerialDiagnosticsRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadSerialDiagnosticsRequest.
ReadSerialDiagnosticsRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
Constructs a new Diagnostics request instance.
ReadSerialDiagnosticsResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadSerialDiagnosticsResponse.
ReadSerialDiagnosticsResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
Constructs a new Diagnostics response instance.
readShort() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readUnsignedByte() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readUnsignedShort() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
readUTF() - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
ReadWriteMultipleRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read / Write Multiple Registers request.
ReadWriteMultipleRequest(int, int, int, int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
Constructs a new Read/Write Multiple Registers Request instance.
ReadWriteMultipleRequest(int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
Constructs a new Read/Write Multiple Registers Request instance.
ReadWriteMultipleRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
Constructs a new Read/Write Multiple Registers Request instance.
ReadWriteMultipleResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadWriteMultipleResponse.
ReadWriteMultipleResponse(InputRegister[]) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Constructs a new ReadWriteMultipleResponse instance.
ReadWriteMultipleResponse(int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Constructs a new ReadWriteMultipleResponse instance.
ReadWriteMultipleResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Constructs a new ReadWriteMultipleResponse instance.
receiveMessage() - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Receives and returns a message.
Record - Class in com.ghgande.j2mod.modbus.procimg
 
Record(int, int) - Constructor for class com.ghgande.j2mod.modbus.procimg.Record
 
RecordRequest(int, int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest.RecordRequest
 
RecordRequest(int, int, short[]) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest.RecordRequest
 
RecordResponse(short[]) - Constructor for class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse.RecordResponse
 
RecordResponse(int, int, short[]) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse.RecordResponse
 
Register - Interface in com.ghgande.j2mod.modbus.procimg
Interface defining a register.
registersToDouble(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a byte[8] binary double value into a double primitive.
registersToFloat(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a byte[4] binary float value to a float primitive.
registersToInt(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a byte[4] binary int value to a primitive int.
The value returned is:
registersToLong(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a byte[8] binary long value into a long primitive.
registerToShort(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts the given register (16-bit value) into a short.
registerToShort(byte[], int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts the register (16-bit value) at the given index into a short.
registerToUnsignedShort(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts the register (a 16 bit value) into an unsigned short.
removeDigitalIn(DigitalIn) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given DigitalIn instance.
removeDigitalIn(DigitalIn) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
removeDigitalOut(DigitalOut) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given DigitalOut instance.
removeDigitalOut(DigitalOut) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
removeFIFO(FIFO) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given FIFO instance.
removeFIFO(FIFO) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
removeFile(File) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given File instance.
removeFile(File) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
removeInputRegister(InputRegister) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given InputRegister instance.
removeInputRegister(InputRegister) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
removeListener(AbstractSerialTransportListener) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
Removes a listener from the event callback chain
removeObserver(Observer) - Method in class com.ghgande.j2mod.modbus.util.Observable
Removes an observer instance from the set of observers of this Observable.
removeObservers() - Method in class com.ghgande.j2mod.modbus.util.Observable
Removes all observer instances from the set of observers of this Observable.
removeProcessImage(int) - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Removes the process image for the given Unit ID
removeRegister(Register) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Removes a given Register instance.
removeRegister(Register) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
REPORT_SLAVE_ID - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a standard function code for read slave ID.
ReportSlaveIDRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Read MEI Data request.
ReportSlaveIDRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
Constructs a new Report Slave ID request instance.
ReportSlaveIDResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a ReadMEIResponse.
ReportSlaveIDResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
Constructs a new ReportSlaveIDResponse instance.
reset(byte[]) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
Resets this BytesInputStream using the given byte[] as new input buffer.
reset(byte[], int) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
Resets this BytesInputStream using the given byte[] as new input buffer and a given length.
reset(int) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
Resets this BytesInputStream assigning the input buffer a new length.
reset() - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
reset(byte[]) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
Resets this BytesInputStream using the given byte[] as new input buffer.
reset() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
reset() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Resets this FastByteArrayOutputStream.
resetRegisters() - Method in class com.ghgande.j2mod.modbus.procimg.FIFO
 
RETRY_SLEEP_TIME - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the sleep period between transaction retries in milliseconds (=200).
run() - Method in class com.ghgande.j2mod.modbus.net.ModbusSerialListener
 
run() - Method in class com.ghgande.j2mod.modbus.net.ModbusTCPListener
 
run() - Method in class com.ghgande.j2mod.modbus.net.ModbusUDPListener
Starts this ModbusUDPListener.
run() - Method in class com.ghgande.j2mod.modbus.net.TCPConnectionHandler
 

S

sendMessage(byte[]) - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Sends the given message.
SERIAL_ENCODING_ASCII - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the serial encoding "ASCII".
SERIAL_ENCODING_RTU - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the serial encoding "RTU".
SerialConnection - Class in com.ghgande.j2mod.modbus.net
Class that implements a serial connection which can be used for master and slave implementations.
SerialConnection() - Constructor for class com.ghgande.j2mod.modbus.net.SerialConnection
Default constructor
SerialConnection(SerialParameters) - Constructor for class com.ghgande.j2mod.modbus.net.SerialConnection
Creates a SerialConnection object and initializes variables passed in as params.
SerialParameters - Class in com.ghgande.j2mod.modbus.util
Helper class wrapping all serial port communication parameters.
SerialParameters() - Constructor for class com.ghgande.j2mod.modbus.util.SerialParameters
Constructs a new SerialParameters instance with default values.
SerialParameters(String, int, int, int, int, int, int, boolean) - Constructor for class com.ghgande.j2mod.modbus.util.SerialParameters
Constructs a new SerialParameters instance with given parameters for a regular serial interface.
SerialParameters(String, int, int, int, int, int, int, boolean, boolean, boolean, int, int) - Constructor for class com.ghgande.j2mod.modbus.util.SerialParameters
Constructs a new SerialParameters instance with given parameters for a serial interface in RS-485 mode on Linux.
SerialParameters(Properties, String) - Constructor for class com.ghgande.j2mod.modbus.util.SerialParameters
Constructs a new SerialParameters instance with parameters obtained from a Properties instance.
set(boolean) - Method in interface com.ghgande.j2mod.modbus.procimg.DigitalOut
Sets the state of this DigitalOut.
set(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.ObservableDigitalOut
Set or clear the digital output.
set(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleDigitalIn
Sets the state of this SimpleDigitalIn.
set(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleDigitalOut
 
setAddress(InetAddress) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Sets the address of the interface to be listened to.
setAddress(InetAddress) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the destination InetAddress of this TCPMasterConnection.
setAddress(InetAddress) - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Sets the destination InetAddress of this UDPMasterConnection.
setAndMask(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
setAndMask -- set AND mask
setAndMask(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
setAndMask -- set AND mask
setAuxiliaryType(ModbusResponse.AuxiliaryMessageTypes) - Method in class com.ghgande.j2mod.modbus.msg.ModbusResponse
Sets the auxiliary type of this response
setBaudRate(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the baud rate.
setBaudRate(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the baud rate.
setBit(int, boolean) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Sets the state of the bit at the given index of this BitVector.
setBitCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Sets the number of bits (i.e.
setBitCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Sets the number of bits (i.e.
setBitCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Sets the number of bits in this response.
setBitCount(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
setBitCount - Sets the number of coils that will be in a response.
setBytes(byte[]) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Sets the byte[] which stores the bits of this BitVector.
setBytes(byte[], int) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Sets the byte[] which stores the bits of this BitVector.
setCheckingValidity(boolean) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Sets the flag that controls whether the validity of a transaction will be checked.
setCheckingValidity(boolean) - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Sets the flag that controls whether the validity of a transaction will be checked.
setCoil(boolean) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Sets the state that should be written with this WriteCoilRequest.
setCoil(boolean) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Sets the state that has been returned in the raw response.
setCoils(BitVector) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
setCoils - Sets the BitVector instance holding coil status information.
setCoilStatus(int, boolean) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
Sets the status of the given coil.
setCoilStatus(int, boolean) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
setCoilStatus - Sets the status of the specified coil.
setCommPort(AbstractSerialConnection) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
setCommPort sets the comm port member and prepares the input and output streams to be used for reading from and writing to.
setComPortTimeouts(int, int, int) - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Set port timeouts
setComPortTimeouts(int, int, int) - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
setConnection(TCPMasterConnection) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Sets the connection on which this ModbusTransaction should be executed.
setData(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
setData -- Set the optional data value
setData(int, int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
Deprecated. 
setData(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
setData -- Set the optional data value
setData(int, int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
Deprecated. 
setData(byte[]) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
setData -- initialize the slave's device dependent data when initializing a response.
setDatabits(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the number of data bits.
setDatabits(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the number of data bits from the given String.
setDataLength(int) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Sets the length of the data appended after the protocol header.
setDigitalIn(int, DigitalIn) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new DigitalIn instance at the given reference.
setDigitalIn(int, DigitalIn) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setDigitalOut(int, DigitalOut) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new DigitalOut instance at the given reference.
setDigitalOut(int, DigitalOut) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setDiscreteStatus(int, boolean) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
Sets the status of the given input discrete.
setEcho(boolean) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
setEcho method sets the output echo state.
setEcho(boolean) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Set the Echo value.
setEncoding(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the encoding to be used.
setEOF(boolean) - Method in exception com.ghgande.j2mod.modbus.ModbusIOException
Sets the flag that determines whether this ModbusIOException was caused by an end of the stream.
setEvent(int, int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
setEvent -- store an event number in the event log
setEventCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
setEvents -- set the device's event counter.
setEventCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
setEventCount -- set the device's event counter.
setEvents(byte[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
 
setEvents(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
 
setFieldId(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Sets the number of bits (i.e.
setFieldLevel(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
 
setFIFO(int, FIFO) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new FIFO instance at the given reference.
setFIFO(int, FIFO) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setFile(int, File) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new File instance at the given reference.
setFile(int, File) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setFlowControlIn(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the type of flow control for the input as given by the passed in int.
setFlowControlIn(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the type of flow control for the input as given by the passed in String.
setFlowControlOut(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the output flow control type as given by the passed in int.
setFlowControlOut(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the output flow control type as given by the passed in String.
setFunction(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
setFunction - Set the DIAGNOSTICS sub-function.
setFunction(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
setFunction - Set the DIAGNOSTICS sub-function.
setFunctionCode(int) - Method in class com.ghgande.j2mod.modbus.msg.IllegalAddressExceptionResponse
Sets the function code
setFunctionCode(int) - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionExceptionResponse
Sets the function code
setFunctionCode(int) - Method in class com.ghgande.j2mod.modbus.msg.IllegalValueExceptionResponse
Sets the function code
setHeadless() - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Set the transport to be headless
setHeadless(boolean) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Set the transport to be headless
setHeadless() - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Sets the flag that marks this ModbusMessage as headless (for serial transport).
setHeadless() - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
setHeadless(boolean) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Sets the headless flag of this message.
setInputRegister(int, InputRegister) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new InputRegister instance at the given reference.
setInputRegister(int, InputRegister) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setLevel(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
Sets the reference of the register to start reading from with this ReadCoilsRequest.
setListening(boolean) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Set the listening state of this ModbusTCPListener object.
setLocked(boolean) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
setLocked -- lock or unlock the process image.
setMaster(TCPMasterConnection) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Sets the master connection for the transport to use
setMaxIdleSeconds(int) - Method in class com.ghgande.j2mod.modbus.net.ModbusTCPListener
Sets a maximum time a connection can be idle, i.e.
setMessageCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
setMessageCount -- set device's message counter.
setModbusTransport(ModbusTCPTransport) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Set the ModbusTransport associated with this TCPMasterConnection
setNetworkInterface(NetworkInterface) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the local NetworkInterface to bind to for this TCPMasterConnection.
setNonWordDataHandler(NonWordDataHandler) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setNonWordDataHandler - Sets a non word data handler.
setNonWordDataHandler(NonWordDataHandler) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
setNonWordHandler - Sets a non word data handler.
setOpenDelay(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports.
setOpenDelay(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports.
setOrMask(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
setOrMask -- set OR mask
setOrMask(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
setOrMask -- set OR mask
setParity(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the parity schema.
setParity(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the parity schema from the given String.
setPort(int) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Sets the port to be listened to.
setPort(int) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the destination port of this TCPMasterConnection.
setPort(int) - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Sets the destination port of this UDPMasterConnection.
setPortName(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the port name.
setProtocolID(int) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Sets the protocol identifier of this ModbusMessage.
setProxy(Proxy) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the Proxy that this socket uses.
setReadReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setReadReference - Sets the reference of the register to writing to with this ReadWriteMultipleRequest.
setReadWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setReadWordCount - Sets the number of words to be read.
setReconnecting(boolean) - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
Sets the flag that specifies whether to maintain a constant connection or reconnect for every transaction.
setReconnecting(boolean) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransaction
Sets the flag that controls whether a connection is opened and closed for each execution or not.
setRecord(int, Record) - Method in class com.ghgande.j2mod.modbus.procimg.File
 
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
setReference -- set the reference field.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
setReference -- set the reference field.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
Sets the reference of the register to start reading from with this ReadCoilsRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
setReference -- set the queue register number.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
Sets the reference of the register to start reading from with this ReadInputDiscretesRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Sets the reference of the register to start reading from with this ReadInputRegistersRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Sets the reference of the register to start reading from with this ReadMultipleRegistersRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Sets the reference of the register of the coil that should be written to with this ReadCoilsRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Sets the reference of the register of the coil that has been written to with the request.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
setReference - Sets the reference of the coil to start writing to with this WriteMultipleCoilsRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
setReference - Sets the reference to the coil that is the first coil in this response.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
setReference - Sets the reference of the register to write to with this WriteMultipleRegistersRequest.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Sets the reference of the register to start writing to with this WriteMultipleRegistersResponse.
setReference(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Sets the reference of the register to be written to with this WriteSingleRegisterRequest.
setRegister(Register) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Sets the value that should be written to the register with this WriteSingleRegisterRequest.
setRegister(int, Register) - Method in interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation
Sets a new Register instance at the given reference.
setRegister(int, Register) - Method in class com.ghgande.j2mod.modbus.procimg.Record
 
setRegister(int, Register) - Method in class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
 
setRegisters(InputRegister[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
setRegisters -- set the device's status.
setRegisters(InputRegister[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Sets the entire block of registers for this response
setRegisters(Register[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
Sets the entire block of registers for this response
setRegisters(Register[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setRegisters - Sets the registers to be written with this ReadWriteMultipleRequest.
setRegisters(InputRegister[]) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
Sets the entire block of registers for this response
setRegisters(Register[]) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
setRegisters - Sets the registers to be written with this WriteMultipleRegistersRequest.
setRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Sets the ModbusRequest for this ModbusTransaction.
setRetries(int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Set the amount of retries for opening the connection for executing the transaction.
setRetries(int) - Method in class com.ghgande.j2mod.modbus.io.ModbusTransaction
Set the amount of retries for opening the connection for executing the transaction.
setRs485DelayAfterTxMicroseconds(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the delay between the end of transmitting data and deactivating the RS-485 transmitter.
setRs485DelayAfterTxMicroseconds(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the delay between end of transmitting data and deactivating the RS-458 transmitter.
setRs485DelayBeforeTxMicroseconds(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the delay between activating the RS-485 transmitter and actually sending data.
setRs485DelayBeforeTxMicroseconds(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the delay between activating the RS-485 transmitter and actually sending data.
setRs485EnableTermination(boolean) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets whether the RS-485 interface shall enable internal bus termination.
setRs485Mode(boolean) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets whether to configure the serial interface into RS-485 half-duplex mode.
setRs485RxDuringTx(boolean) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets whether the RS-485 interface receives the data its sends.
setRs485TxEnableActiveHigh(boolean) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets whether the RS-485 transmitter is enabled by a high or low control signal.
setSerialConnection(AbstractSerialConnection) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Sets the port on which this ModbusTransaction should be executed.
setSlaveID(int) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
setSlaveID -- initialize the slave identifier when constructing a response message.
setSocket(Socket) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
Sets the Socket used for message transport and prepares the streams used for the actual I/O.
setStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
setStatus -- set the device's status.
setStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
setStatus -- set the device's status.
setStatus(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
setStatus -- set the device's status.
setStatus(boolean) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
setStatus -- initialize the slave's "run" status when constructing a response message.
setStopbits(int) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the number of stop bits.
setStopbits(String) - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
Sets the number of stop bits from the given String.
setTerminal(AbstractUDPTerminal) - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransaction
Sets the terminal on which this ModbusTransaction should be executed.
setThreadName(String) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Sets the name of the thread used by the listener
setThreadName(String) - Method in class com.ghgande.j2mod.modbus.slave.ModbusSlave
Sets the name of the thread used by the listener
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Sets the receive timeout
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.facade.ModbusSerialMaster
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.facade.ModbusTCPMaster
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.facade.ModbusUDPMaster
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Set the socket timeout
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Sets the socket timeout
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Sets the timeout for this connection.
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.AbstractUDPTerminal
Sets the timeout in milliseconds for this UDPSlaveTerminal.
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.ModbusSerialListener
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.ModbusTCPListener
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.ModbusUDPListener
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the timeout (msec) for this TCPMasterConnection.
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Sets the timeout for this TCPSlaveConnection.
setTimeout(int) - Method in class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Sets the timeout for this UDPMasterConnection.
setTransactionID(int) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Sets the transaction identifier of this ModbusMessage.
setTransDelayMS(int) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
Set the TransDelayMS value.
setTransport(ModbusSerialTransport) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransaction
 
setUnitID(int) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Sets the unit identifier of this ModbusMessage.
The identifier should be a 1-byte non negative integer value valid in the range of 0-255.
setUseRtuOverTcp(boolean) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Sets the transport type to use Normally set during the connection but can also be set after a connection has been established
setUseUrgentData(boolean) - Method in class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Set the flag which controls sending urgent data to test a network connection.
setValue(short) - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
setValue(byte[]) - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
setValue(int) - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
setValue(short) - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
setValue(byte[]) - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
setValue(int) - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
setValue(int) - Method in interface com.ghgande.j2mod.modbus.procimg.Register
Sets the content of this Register from the given unsigned 16-bit value (unsigned short).
setValue(short) - Method in interface com.ghgande.j2mod.modbus.procimg.Register
Sets the content of this register from the given signed 16-bit value (short).
setValue(byte[]) - Method in interface com.ghgande.j2mod.modbus.procimg.Register
Sets the content of this register from the given raw bytes.
setValue(short) - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
setValue(byte[]) - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
setValue(int) - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
setWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
setWordCount -- set the queue size.
setWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
Sets the number of words to be read with this ReadInputRegistersRequest.
setWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
Set the number of words to be written.
setWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
Sets the number of words to be read with this ReadMultipleRegistersRequest.
setWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Sets the number of words that have been returned.
setWriteReference(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setWriteReference - Sets the reference of the register to write to with this ReadWriteMultipleRequest.
setWriteWordCount(int) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
setWriteWordCount - Sets the number of words to be written.
shortToRegister(short) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts the given short into a register (2 bytes).
SimpleDigitalIn - Class in com.ghgande.j2mod.modbus.procimg
Class implementing a simple DigitalIn.
SimpleDigitalIn() - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleDigitalIn
Constructs a new SimpleDigitalIn instance.
SimpleDigitalIn(boolean) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleDigitalIn
Constructs a new SimpleDigitalIn instance with a given valid state.
SimpleDigitalOut - Class in com.ghgande.j2mod.modbus.procimg
Class implementing a simple DigitalOut.
SimpleDigitalOut() - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleDigitalOut
Constructs a new SimpleDigitalOut instance.
SimpleDigitalOut(boolean) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleDigitalOut
Constructs a new SimpleDigitalOut instance with the given state.
SimpleInputRegister - Class in com.ghgande.j2mod.modbus.procimg
Class implementing a simple InputRegister.
SimpleInputRegister() - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleInputRegister
Constructs a new SimpleInputRegister instance.
SimpleInputRegister(byte, byte) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleInputRegister
Constructs a new SimpleInputRegister instance.
SimpleInputRegister(int) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleInputRegister
Constructs a new SimpleInputRegister instance with the given value.
SimpleProcessImage - Class in com.ghgande.j2mod.modbus.procimg
Class implementing a simple process image to be able to run unit tests or handle simple cases.
SimpleProcessImage() - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
Constructs a new SimpleProcessImage instance.
SimpleProcessImage(int) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleProcessImage
Constructs a new SimpleProcessImage instance having a (potentially) non-zero unit ID.
SimpleRegister - Class in com.ghgande.j2mod.modbus.procimg
Class implementing a simple Register.
SimpleRegister(byte, byte) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleRegister
Constructs a new SimpleRegister instance.
SimpleRegister(int) - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleRegister
Constructs a new SimpleRegister instance with the given value.
SimpleRegister() - Constructor for class com.ghgande.j2mod.modbus.procimg.SimpleRegister
Constructs a new SimpleRegister instance.
size() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the number of bytes written to this FastByteArrayOutputStream.
size() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Returns the number of bits in this BitVector as int.
skip(int) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
Skips the given number of bytes or all bytes till the end of the assigned input buffer length.
skip(long) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
skipBytes(int) - Method in class com.ghgande.j2mod.modbus.io.BytesInputStream
 
SLAVE_BUSY_EXCEPTION - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type slave busy.
SLAVE_DEVICE_FAILURE - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the Modbus slave exception type slave device failure.
sleep(long) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Sleeps safely for the specified amount of time unless awoken by an interruption
SPACE_PARITY - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
stop() - Method in class com.ghgande.j2mod.modbus.net.AbstractModbusListener
Stop the listener thread for this ModbusListener instance.
stop() - Method in class com.ghgande.j2mod.modbus.net.ModbusSerialListener
 
stop() - Method in class com.ghgande.j2mod.modbus.net.ModbusTCPListener
 
stop() - Method in class com.ghgande.j2mod.modbus.net.ModbusUDPListener
 
SynchronizedAbstractRegister - Class in com.ghgande.j2mod.modbus.procimg
Abstract class with synchronized register operations.
SynchronizedAbstractRegister() - Constructor for class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 

T

TCPConnectionHandler - Class in com.ghgande.j2mod.modbus.net
Class implementing a handler for incoming Modbus/TCP requests.
TCPConnectionHandler(AbstractModbusListener, TCPSlaveConnection, int) - Constructor for class com.ghgande.j2mod.modbus.net.TCPConnectionHandler
Constructs a new TCPConnectionHandler instance.
TCPMasterConnection - Class in com.ghgande.j2mod.modbus.net
Class that implements a TCPMasterConnection.
TCPMasterConnection(InetAddress) - Constructor for class com.ghgande.j2mod.modbus.net.TCPMasterConnection
Constructs a TCPMasterConnection instance with a given destination address.
TCPSlaveConnection - Class in com.ghgande.j2mod.modbus.net
Class that implements a TCPSlaveConnection.
TCPSlaveConnection(Socket) - Constructor for class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Constructs a TCPSlaveConnection instance using a given socket instance.
TCPSlaveConnection(Socket, boolean) - Constructor for class com.ghgande.j2mod.modbus.net.TCPSlaveConnection
Constructs a TCPSlaveConnection instance using a given socket instance.
ThreadPool - Class in com.ghgande.j2mod.modbus.util
Class implementing a simple thread pool.
ThreadPool(int) - Constructor for class com.ghgande.j2mod.modbus.util.ThreadPool
Constructs a new ThreadPool instance.
TIMEOUT_NONBLOCKING - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Timeout
TIMEOUT_READ_BLOCKING - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
TIMEOUT_READ_SEMI_BLOCKING - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
TIMEOUT_SCANNER - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
TIMEOUT_WRITE_BLOCKING - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 
toByteArray() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayInputStream
 
toByteArray() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the written bytes in a newly allocated byte[] of length getSize().
toByteArray(byte[], int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Copy the buffered data to the given array.
toBytes() - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
toBytes() - Method in interface com.ghgande.j2mod.modbus.procimg.InputRegister
Returns the content of this Register as bytes.
toBytes() - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
toBytes() - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
toggleAccess(boolean) - Method in class com.ghgande.j2mod.modbus.util.BitVector
Toggles the flag deciding whether the LSB or the MSB of the byte corresponds to the first bit (index=0).
toHex(ModbusMessage) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts a ModbusMessage instance into a hex encoded string representation.
toHex(byte[]) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Returns the given byte[] as hex encoded string.
toHex(byte[], int, int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Returns a String containing unsigned hexadecimal numbers as digits.
toHex(int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Returns a byte[] containing the given byte as unsigned hexadecimal number digits.
toShort() - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
toShort() - Method in interface com.ghgande.j2mod.modbus.procimg.InputRegister
Returns the content of this Register as signed 16-bit value (short).
toShort() - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
toShort() - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
toString() - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
 
toString(String) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Returns the content of this FastByteArrayOutputStream as String.
toString() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleInputRegister
 
toString() - Method in class com.ghgande.j2mod.modbus.procimg.SimpleRegister
 
toString() - Method in class com.ghgande.j2mod.modbus.util.BitVector
Returns a String representing the contents of the bit collection in a way that can be printed to a screen or log.
toString() - Method in class com.ghgande.j2mod.modbus.util.SerialParameters
 
toUnsignedShort() - Method in class com.ghgande.j2mod.modbus.procimg.AbstractRegister
 
toUnsignedShort() - Method in interface com.ghgande.j2mod.modbus.procimg.InputRegister
Returns the content of this Register as unsigned 16-bit value (unsigned short).
toUnsignedShort() - Method in class com.ghgande.j2mod.modbus.procimg.ObservableRegister
 
toUnsignedShort() - Method in class com.ghgande.j2mod.modbus.procimg.SynchronizedAbstractRegister
 
TWO_STOP_BITS - Static variable in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
 

U

UDPMasterConnection - Class in com.ghgande.j2mod.modbus.net
Class that implements a UDPMasterConnection.
UDPMasterConnection(InetAddress) - Constructor for class com.ghgande.j2mod.modbus.net.UDPMasterConnection
Constructs a UDPMasterConnection instance with a given destination address.
unsignedByteToInt(byte) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts an unsigned byte to an integer.
unsignedShortToRegister(int) - Static method in class com.ghgande.j2mod.modbus.util.ModbusUtil
Converts the given unsigned short into a register (2 bytes).
update(Observable, Object) - Method in interface com.ghgande.j2mod.modbus.util.Observer
Updates the state of this Observer to be in synch with an Observable instance.

V

valueOf(String) - Static method in enum com.ghgande.j2mod.modbus.msg.ModbusResponse.AuxiliaryMessageTypes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ghgande.j2mod.modbus.slave.ModbusSlaveType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ghgande.j2mod.modbus.msg.ModbusResponse.AuxiliaryMessageTypes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ghgande.j2mod.modbus.slave.ModbusSlaveType
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
 
write(byte[]) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
 
write(byte[], int, int) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
 
WRITE_COIL - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a class 1 function code for write coil.
WRITE_FILE_RECORD - Static variable in interface com.ghgande.j2mod.modbus.Modbus
write file record
WRITE_MULTIPLE_COILS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a standard function code for write multiple coils.
WRITE_MULTIPLE_REGISTERS - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines the class 0 function code for write multiple registers.
WRITE_SINGLE_REGISTER - Static variable in interface com.ghgande.j2mod.modbus.Modbus
Defines a class 1 function code for write single register.
writeBoolean(boolean) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeByte(int) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeBytes(String) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeBytes(byte[], int) - Method in class com.ghgande.j2mod.modbus.net.AbstractSerialConnection
Write a specified number of bytes to the serial port
writeBytes(byte[], int) - Method in class com.ghgande.j2mod.modbus.net.SerialConnection
 
writeChar(int) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeChars(String) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeCoil(int, int, boolean) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a coil state to the slave.
writeCoil(int, boolean) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a coil state to the slave.
WriteCoilRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteCoilRequest.
WriteCoilRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Constructs a new WriteCoilRequest instance.
WriteCoilRequest(int, boolean) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
Constructs a new WriteCoilRequest instance with a given reference and state to be written.
WriteCoilResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteCoilResponse.
WriteCoilResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Constructs a new WriteCoilResponse instance.
WriteCoilResponse(int, boolean) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
Constructs a new WriteCoilResponse instance.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ExceptionResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
Writes the subclass specific data to the given DataOutput.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCoilsResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventCounterResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadExceptionStatusResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFIFOQueueResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputDiscretesResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadInputRegistersResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMEIResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadMultipleRegistersResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReadWriteMultipleResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse
writeData -- output the completed Modbus message to dout
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteCoilResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
writeData -- output this Modbus message to dout.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
writeData - Copy the attribute values for this message to the output buffer.
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
 
writeData(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
 
writeDouble(double) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
WriteFileRecordRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a Write File Record request.
WriteFileRecordRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest
Constructs a new Write File Record request instance.
WriteFileRecordRequest.RecordRequest - Class in com.ghgande.j2mod.modbus.msg
 
WriteFileRecordResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteFileRecordResponse.
WriteFileRecordResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse
Constructs a new WriteFileRecordResponse instance.
WriteFileRecordResponse.RecordResponse - Class in com.ghgande.j2mod.modbus.msg
 
writeFloat(float) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeInt(int) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeLong(long) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeMultipleCoils(int, int, BitVector) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a given number of coil states to the slave.
writeMultipleCoils(int, BitVector) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a given number of coil states to the slave.
WriteMultipleCoilsRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteMultipleCoilsRequest.
WriteMultipleCoilsRequest(int, BitVector) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
Constructs a new WriteMultipleCoilsRequest instance with the given reference and coil values.
WriteMultipleCoilsRequest(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
Constructs a new WriteMultipleCoilsRequest instance with a given reference and count of coils to be written, followed by the actual byte count, and then count number of bytes.
WriteMultipleCoilsRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest
Constructs a new WriteMultipleCoilsRequest instance.
WriteMultipleCoilsResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteMultipleCoilsResponse.
WriteMultipleCoilsResponse(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
Constructs a new WriteMultipleCoilsResponse instance with a given count of coils and starting reference.
WriteMultipleCoilsResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse
Constructs a new WriteMultipleCoilsResponse instance.
writeMultipleRegisters(int, int, Register[]) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a number of registers to the slave.
writeMultipleRegisters(int, Register[]) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a number of registers to the slave.
WriteMultipleRegistersRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteMultipleRegistersRequest.
WriteMultipleRegistersRequest(int, Register[]) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
Constructs a new WriteMultipleRegistersRequest instance with a given starting reference and values to be written.
WriteMultipleRegistersRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest
Constructs a new WriteMultipleRegistersRequest instance.
WriteMultipleRegistersResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteMultipleRegistersResponse.
WriteMultipleRegistersResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Constructs a new WriteMultipleRegistersResponse instance.
WriteMultipleRegistersResponse(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse
Constructs a new WriteMultipleRegistersResponse instance.
writeRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Writes a ModbusMessage to the output stream of this ModbusTransport.
writeRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.ModbusRTUTCPTransport
 
writeRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
writeRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
writeRequest(ModbusRequest) - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
writeResponse(ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.AbstractModbusTransport
Writes a ModbusResponseMessage to the output stream of this ModbusTransport.
writeResponse(ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.ModbusRTUTCPTransport
 
writeResponse(ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.ModbusSerialTransport
 
writeResponse(ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.ModbusTCPTransport
 
writeResponse(ModbusResponse) - Method in class com.ghgande.j2mod.modbus.io.ModbusUDPTransport
 
writeShort(int) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
writeSingleRegister(int, int, Register) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a single register to the slave.
writeSingleRegister(int, Register) - Method in class com.ghgande.j2mod.modbus.facade.AbstractModbusMaster
Writes a single register to the slave.
WriteSingleRegisterRequest - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteSingleRegisterRequest.
WriteSingleRegisterRequest() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Constructs a new WriteSingleRegisterRequest instance.
WriteSingleRegisterRequest(int, Register) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest
Constructs a new WriteSingleRegisterRequest instance with a given reference and value to be written.
WriteSingleRegisterResponse - Class in com.ghgande.j2mod.modbus.msg
Class implementing a WriteSingleRegisterResponse.
WriteSingleRegisterResponse() - Constructor for class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
Constructs a new WriteSingleRegisterResponse instance.
WriteSingleRegisterResponse(int, int) - Constructor for class com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse
Constructs a new WriteSingleRegisterResponse instance.
writeTo(OutputStream) - Method in class com.ghgande.j2mod.modbus.io.FastByteArrayOutputStream
Writes the content of this FastByteArrayOutputStream to the given output stream.
writeTo(DataOutput) - Method in interface com.ghgande.j2mod.modbus.msg.ModbusMessage
Writes this Transportable to the given DataOutput.
writeTo(DataOutput) - Method in class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl
 
writeUTF(String) - Method in class com.ghgande.j2mod.modbus.io.BytesOutputStream
 
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links

Copyright © 2025. All Rights Reserved.