org.avineas.modbus

Class ModbusResponse

java.lang.Object

org.avineas.modbus.ModbusPacket

org.avineas.modbus.ModbusResponse

Direct Known Subclasses:

ReadHoldingRegistersResponse, WriteMultipleRegistersResponse

public class ModbusResponse
extends ModbusPacket

Modbus response. A response as received as a reply to a request at application level. Responses can either contain an error code, in which case they have a specific error format, or they can be a valid reply to a request. In that case the contents can be used to create the expected reply.

Constructor Summary

Constructors

Constructor and Description
ModbusResponse(byte[] data) Create a modbus response from a byte stream as received from a remote system.
ModbusResponse(ModbusRequest request, int error) Create a response from a request giving an error to reply to the sender.

Method Summary

Methods

Modifier and Type	Method and Description
int	getError() Get the error that is present in this response.
int	getFunction() Get the plain function code as present in the reply.

Methods inherited from class org.avineas.modbus.ModbusPacket

decode, encode, toBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusResponse

public ModbusResponse(ModbusRequest request,
              int error)

Create a response from a request giving an error to reply to the sender.

Parameters:

request - The request to create the error for

error - The error code. Valid codes are normally 1-9. See modbus documentation

ModbusResponse

public ModbusResponse(byte[] data)

Create a modbus response from a byte stream as received from a remote system.

Parameters:

data - The data received

Method Detail

getFunction

public int getFunction()

Get the plain function code as present in the reply. This function code must be the same as the related request. The error bit is stripped off.

Overrides:

getFunction in class ModbusPacket

Returns:

The function code, as integer

getError

public int getError()

Get the error that is present in this response. Will return 0 if there is no error.

Returns:

The error code. 0 means no error, 1, 2, 3, 4 are exception codes, see modbus manual