org.eclipse.scada.protocol.modbus.codec

Class ModbusProtocol

java.lang.Object

org.eclipse.scada.protocol.modbus.codec.ModbusProtocol

public final class ModbusProtocol
extends Object

A class with modbus protocol helper functions

Method Summary

Modifier and Type	Method and Description
static org.apache.mina.core.buffer.IoBuffer	convertData(org.apache.mina.core.buffer.IoBuffer data, ByteOrder dataOrder) Encode the data from Java byte order to requested modbus byte order
static Object	decodeAsMaster(Pdu message) Decode a PDU as a master
static Object	decodeAsSlave(Pdu message) Decode a PDU as a slave
static Pdu	encodeAsMaster(BaseMessage message)
static Pdu	encodeAsSlave(BaseMessage message)
static byte[]	encodeData(byte[] data, ByteOrder dataOrder) Encode the data from Java byte order to requested modbus byte order
static ByteOrder	makeOrder(String string, ByteOrder defaultOrder) Convert the string to a ByteOrder

Methods inherited from class java.lang.Object

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

Method Detail

makeOrder

public static ByteOrder makeOrder(String string,
                                  ByteOrder defaultOrder)

Convert the string to a ByteOrder

Parameters:

string - the string to convert

defaultOrder - the default data byte order to use when string is null

Returns:

the byte order

Throws:

IllegalArgumentException - if the string is neither null, "BIG_ENDIAN" nor "LITTLE_ENDIAN"

encodeAsMaster

public static Pdu encodeAsMaster(BaseMessage message)

encodeAsSlave

public static Pdu encodeAsSlave(BaseMessage message)

decodeAsMaster

public static Object decodeAsMaster(Pdu message)

Decode a PDU as a master

Parameters:

message - the message PDU

Returns:

the decoded messages

Throws:

IllegalStateException - if the function code is not supported

decodeAsSlave

public static Object decodeAsSlave(Pdu message)
                            throws org.apache.mina.filter.codec.ProtocolCodecException

Decode a PDU as a slave

Parameters:

message - the message PDU

Returns:

the decoded messages

Throws:

IllegalStateException - if the function code is not supported

org.apache.mina.filter.codec.ProtocolCodecException

convertData

public static org.apache.mina.core.buffer.IoBuffer convertData(org.apache.mina.core.buffer.IoBuffer data,
                                                               ByteOrder dataOrder)

Encode the data from Java byte order to requested modbus byte order

Parameters:

data - the data to encode

dataOrder - the target modbus byte order

Returns:

the converted data, or the input data if no conversion was necessary

encodeData

public static byte[] encodeData(byte[] data,
                                ByteOrder dataOrder)

Encode the data from Java byte order to requested modbus byte order

Parameters:

data - the data to encode

dataOrder - the target modbus byte order

Returns:

the converted data, or the input data if no conversion was necessary