A B C D E F G H I L M N P R S T U W

A

ADDRESS_MAX - Static variable in class net.sourceforge.jmodbus.Modbus

Highest permissible address value.

B

buff - Variable in class net.sourceforge.jmodbus.ModbusMessage

The byte array containing the message.

ByteUtils - class net.sourceforge.jmodbus.ByteUtils.

This class contains basic utilities for dumping byte arrays to standout oputput.

ByteUtils() - Constructor for class net.sourceforge.jmodbus.ByteUtils

C

COIL_OFF - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to turn a single coil off.

COIL_ON - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to turn a single coil on.

D

DATA_MAX - Static variable in class net.sourceforge.jmodbus.ModbusTCPTransport

The maximum number of bytes in the body of a Modbus TCP packet.

debug - Static variable in class net.sourceforge.jmodbus.Modbus

Flag to adjust the debug output level at compile time.

E

END_FRAME_MARKER_1 - Static variable in class net.sourceforge.jmodbus.ModbusASCIITransport

The first character of the end of frame marker for Modbus ASCII messages.

END_FRAME_MARKER_2 - Static variable in class net.sourceforge.jmodbus.ModbusASCIITransport

The first character of the end of frame marker for Modbus ASCII messages.

EXCEPTION_MODIFIER - Static variable in class net.sourceforge.jmodbus.Modbus

Function code modfifer for exceptions.

F

FRAME_SEPERATOR_LENGTH - Static variable in class net.sourceforge.jmodbus.ModbusRTUTransport

Frame seperator length.

G

getCoil(int) - Method in class net.sourceforge.jmodbus.ModbusCoilBank

Gets the value of a particular coil.

getCoils(int, int) - Method in class net.sourceforge.jmodbus.ModbusCoilBank

Gets the value of a particular block of coils.

getNumberCoils() - Method in class net.sourceforge.jmodbus.ModbusCoilBank

Get the size of this bank of coils.

getNumberRegisters() - Method in class net.sourceforge.jmodbus.ModbusRegisterBank

Get the size of this bank of registers.

getRegister(int) - Method in class net.sourceforge.jmodbus.ModbusRegisterBank

Gets the value of a particular register.

getRegisters(int, int) - Method in class net.sourceforge.jmodbus.ModbusRegisterBank

Gets the value of a particular block of registers.

H

HEADER_LENGTH - Static variable in class net.sourceforge.jmodbus.ModbusTCPTransport

The length (in bytes) of the header of a Modbus TCP packet.

I

ILLEGAL_DATA_ADDRESS - Static variable in class net.sourceforge.jmodbus.Modbus

Exception code to signify that the request contains an illegal data address.

ILLEGAL_DATA_VALUE - Static variable in class net.sourceforge.jmodbus.Modbus

Exception code to signify that the request contains an illegal data value.

ILLEGAL_FUNCTION - Static variable in class net.sourceforge.jmodbus.Modbus

Exception code to signify that the function code is unknown or illegal.

ILLEGAL_RESPONSE_LENGTH - Static variable in class net.sourceforge.jmodbus.Modbus

Exception code to signify that the request whould have generated an illegaly long response.

L

length - Variable in class net.sourceforge.jmodbus.ModbusMessage

Length field to indicate how much of the byte buffer contains valid data.

M

MAX_ASCII_MESSAGE_LENGTH - Static variable in class net.sourceforge.jmodbus.ModbusASCIITransport

The maximum length of a Modbus ASCII message that is based on the maximum length of a Modbus message, with 2 characters per byte encoding and start and end delimiters.

MAX_MESSAGE_LENGTH - Static variable in class net.sourceforge.jmodbus.Modbus

Longest legal message length.

MAX_RTU_MESSAGE_LENGTH - Static variable in class net.sourceforge.jmodbus.ModbusRTUTransport

The maximum length of a Modbus RTU message which is the maximum Modbus message length plus one byte for the CRC16.

MAX_TRANSACTION_LENGTH - Static variable in class net.sourceforge.jmodbus.ModbusTCPTransport

The maximum length (in bytes) of a Modbus TCP packet.

Modbus - class net.sourceforge.jmodbus.Modbus.

Class to represent a Modbus device.

MODBUS_TCP_PORT - Static variable in class net.sourceforge.jmodbus.ModbusTCPTransport

The TCP port number that Modbus TCP services should operate over.

Modbus(ModbusTransport) - Constructor for class net.sourceforge.jmodbus.Modbus

Class constructor.

ModbusASCIIMaster - class net.sourceforge.jmodbus.ModbusASCIIMaster.

Class to implement a Modbus ASCII Master device.

ModbusASCIIMaster() - Constructor for class net.sourceforge.jmodbus.ModbusASCIIMaster

Constructor that uses the ASCII transport created with default parameters.

ModbusASCIISlave - class net.sourceforge.jmodbus.ModbusASCIISlave.

Class to implement a Modbus ASCII Slave device.

ModbusASCIISlave(int) - Constructor for class net.sourceforge.jmodbus.ModbusASCIISlave

Constructor that uses the ASCII transport created with default parameters.

ModbusASCIITransport - class net.sourceforge.jmodbus.ModbusASCIITransport.

Class to implement a ASCII transport mechanisim for Modbus communication.

ModbusASCIITransport() - Constructor for class net.sourceforge.jmodbus.ModbusASCIITransport

Default constructor that will create it's own serial port connection with the default port settings.

ModbusASCIITransport(SerialPort) - Constructor for class net.sourceforge.jmodbus.ModbusASCIITransport

Constructor that passes a open serial port.

ModbusCoilBank - class net.sourceforge.jmodbus.ModbusCoilBank.

Class to represent the coils (1 bit data items) in a Modbus device.

ModbusCoilBank(int) - Constructor for class net.sourceforge.jmodbus.ModbusCoilBank

Class constructor that, given the size of the coil bank required, will allocate suficient memory for the coil bank and initilize all the values to zero

ModbusMaster - class net.sourceforge.jmodbus.ModbusMaster.

Class to represent a Modbus Master device.

ModbusMaster(ModbusTransport) - Constructor for class net.sourceforge.jmodbus.ModbusMaster

Class constructor.

ModbusMessage - class net.sourceforge.jmodbus.ModbusMessage.

Class to represent a Modbus message.

ModbusMessage() - Constructor for class net.sourceforge.jmodbus.ModbusMessage

Class constructor that will allocate memory for the byte buffer and initilize the message object.

ModbusRegisterBank - class net.sourceforge.jmodbus.ModbusRegisterBank.

Class to represent the registers (16 bit data items) in a Modbus device.

ModbusRegisterBank(int) - Constructor for class net.sourceforge.jmodbus.ModbusRegisterBank

Class constructor that, given the size of the register bank required, will allocate suficient memory for the register bank and initilize all the values to zero

ModbusRTUMaster - class net.sourceforge.jmodbus.ModbusRTUMaster.

Class to implement a Modbus RTU Master device.

ModbusRTUMaster() - Constructor for class net.sourceforge.jmodbus.ModbusRTUMaster

Constructor that uses the RTU transport created with default parameters.

ModbusRTUSlave - class net.sourceforge.jmodbus.ModbusRTUSlave.

Class to implement a Modbus RTU Slave device.

ModbusRTUSlave(int) - Constructor for class net.sourceforge.jmodbus.ModbusRTUSlave

Constructor that uses the RTU transport created with default parameters.

ModbusRTUTransport - class net.sourceforge.jmodbus.ModbusRTUTransport.

Class to implement a RTU transport mechanisim for Modbus communication.

ModbusRTUTransport() - Constructor for class net.sourceforge.jmodbus.ModbusRTUTransport

Default constructor that will create it's own serial port connection with the default port settings.

ModbusRTUTransport(SerialPort) - Constructor for class net.sourceforge.jmodbus.ModbusRTUTransport

Constructor that passes a open serial port.

ModbusSlave - class net.sourceforge.jmodbus.ModbusSlave.

Class to represent a Modbus Slave device.

ModbusSlave(ModbusTransport, int) - Constructor for class net.sourceforge.jmodbus.ModbusSlave

Class constructor.

ModbusTCPMaster - class net.sourceforge.jmodbus.ModbusTCPMaster.

Class to implement a Modbus TCP Master device.

ModbusTCPMaster(String, int) - Constructor for class net.sourceforge.jmodbus.ModbusTCPMaster

Constructor that uses the TCP transport.

ModbusTCPSlave - class net.sourceforge.jmodbus.ModbusTCPSlave.

Class to implement a Modbus TCP Slave device.

ModbusTCPSlave(int, Socket) - Constructor for class net.sourceforge.jmodbus.ModbusTCPSlave

Constructor that uses the TCP transport created with the supplied socket.

ModbusTCPTransport - class net.sourceforge.jmodbus.ModbusTCPTransport.

Class to implement a TCP transport mechanisim for Modbus communication.

ModbusTCPTransport(Socket) - Constructor for class net.sourceforge.jmodbus.ModbusTCPTransport

Constructor for the ModbusTCPTransport.

ModbusTCPTransport(String, int) - Constructor for class net.sourceforge.jmodbus.ModbusTCPTransport

Constructor for the ModbusTCPTransport.

ModbusTransport - interface net.sourceforge.jmodbus.ModbusTransport.

Interface for Modbus transport mechanisims.

N

net.sourceforge.jmodbus - package net.sourceforge.jmodbus

P

processRequest() - Method in class net.sourceforge.jmodbus.ModbusSlave

Function to process a single request.

PROTOCOL_IDENTIFIER - Static variable in class net.sourceforge.jmodbus.ModbusTCPTransport

The protocol identifier for Modbus TCP.

R

READ_COILS - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to read multiple coils.

READ_EXCEPTION_STATUS - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to read the exception status.

READ_INPUT_DISCRETES - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to read read input discretes.

READ_INPUT_REGISTERS - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to read imput registers.

READ_MULTIPLE_REGISTERS - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to read multiple registers.

readInputRegisters(int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to read input registers from the slave device.

readInputRegisters(int, int, int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to read input registers from the slave device.

readMultipleRegisters(int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to read multiple registers from the slave device.

readMultipleRegisters(int, int, int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to read multiple registers from the slave device.

receiveFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.Modbus

Method to receive a Modbus frame via the transport media.

receiveFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusRTUTransport

Method to receive a Modbus frame via the transport media.

receiveFrame(ModbusMessage) - Method in interface net.sourceforge.jmodbus.ModbusTransport

Method to receive a Modbus frame via the transport media.

receiveFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusTCPTransport

Method to receive a Modbus frame via the transport media.

receiveFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusASCIITransport

Method to receive a Modbus frame via the transport media.

run() - Method in class net.sourceforge.jmodbus.ModbusSlave

The run method for the slave object.

S

sendFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.Modbus

Method to send a Modbus frame via the transport media.

sendFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusRTUTransport

Method to send a Modbus frame via the transport media.

sendFrame(ModbusMessage) - Method in interface net.sourceforge.jmodbus.ModbusTransport

Method to send a Modbus frame via the transport media.

sendFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusTCPTransport

Method to send a Modbus frame via the transport media.

sendFrame(ModbusMessage) - Method in class net.sourceforge.jmodbus.ModbusASCIITransport

Method to send a Modbus frame via the transport media.

setCoil(int, boolean) - Method in class net.sourceforge.jmodbus.ModbusCoilBank

Sets the value of a particular coil.

setCoils(int, boolean[]) - Method in class net.sourceforge.jmodbus.ModbusCoilBank

Sets the value of a particular block of coils.

setInputCoils(ModbusCoilBank) - Method in class net.sourceforge.jmodbus.ModbusSlave

Set the reference to the Input Coil Bank.

setInputRegisters(ModbusRegisterBank) - Method in class net.sourceforge.jmodbus.ModbusSlave

Set the reference to the Input Register Bank.

setOutputCoils(ModbusCoilBank) - Method in class net.sourceforge.jmodbus.ModbusSlave

Set the reference to the Output Coil Bank.

setOutputRegisters(ModbusRegisterBank) - Method in class net.sourceforge.jmodbus.ModbusSlave

Set the reference to the Output Register Bank.

setRegister(int, int) - Method in class net.sourceforge.jmodbus.ModbusRegisterBank

Sets the value of a particular register.

setRegister(int, int[]) - Method in class net.sourceforge.jmodbus.ModbusRegisterBank

Sets the value of a particular block of registers.

START_FRAME_MARKER - Static variable in class net.sourceforge.jmodbus.ModbusASCIITransport

The start of frame marker for Modbus ASCII messages.

T

toHex(byte) - Static method in class net.sourceforge.jmodbus.ByteUtils

Convert a single byte into a string representation of the byte as two hexadecimal characters.

toHex(byte[], int) - Static method in class net.sourceforge.jmodbus.ByteUtils

Convert a byte array into a string hex dump of the bytes with a coulmn width of 8 bytes and a 2 byte offset number printed on the side.

toHex(short) - Static method in class net.sourceforge.jmodbus.ByteUtils

Convert a single short into a string representation of the short as four hexadecimal characters.

transID - Variable in class net.sourceforge.jmodbus.ModbusMessage

The transaction ID of this message, this is only really used by the TCP implementations.

transport - Variable in class net.sourceforge.jmodbus.Modbus

Modbus transport object that will be used to perform all communication of Modbus messages.

U

UINT16_MAX - Static variable in class net.sourceforge.jmodbus.Modbus

The maximum value for a 16 bit unsigend integer.

UINT16_MIN - Static variable in class net.sourceforge.jmodbus.Modbus

The minimum value for a 16 bit unsigned integer.

UINT8_MAX - Static variable in class net.sourceforge.jmodbus.Modbus

The maximum value for a 8 bit unsigend integer.

UINT8_MIN - Static variable in class net.sourceforge.jmodbus.Modbus

The minimum value for a 8 bit unsigned integer.

W

WRITE_COIL - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to write a single coil.

WRITE_MULTIPLE_REGISTERS - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to write multiple registers.

WRITE_SINGLE_REGISTER - Static variable in class net.sourceforge.jmodbus.Modbus

Command code to write a single register.

writeMultipleRegisters(int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to write multiple registers from the slave device.

writeMultipleRegisters(int, int, int, int, int[]) - Method in class net.sourceforge.jmodbus.ModbusMaster

Function to write multiple registers to the slave device.

A B C D E F G H I L M N P R S T U W