net.solarnetwork.io.modbus.rtu.netty

Class RtuModbusMessage

java.lang.Object

net.solarnetwork.io.modbus.rtu.netty.RtuModbusMessage

All Implemented Interfaces:

net.solarnetwork.io.modbus.ModbusMessage, net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder, RtuModbusMessage

public class RtuModbusMessage
extends Object
implements RtuModbusMessage, net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder

A RTU-encapsulated Modbus message.

Field Summary

Fields inherited from interface net.solarnetwork.io.modbus.rtu.RtuModbusMessage

CRC_MISMATCH_VALIDATION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
RtuModbusMessage(int unitId, net.solarnetwork.io.modbus.ModbusMessage body) Constructor.
RtuModbusMessage(long timestamp, int unitId, net.solarnetwork.io.modbus.ModbusMessage body) Constructor.
RtuModbusMessage(long timestamp, net.solarnetwork.io.modbus.ModbusMessage body, short crc) Constructor.
RtuModbusMessage(net.solarnetwork.io.modbus.ModbusMessage body, short crc) Constructor.

Method Summary

Modifier and Type	Method and Description
short	computeCrc() Compute the 16-bit cyclic redundancy check value from the message data.
static short	computeCrc(int unitId, net.solarnetwork.io.modbus.ModbusMessage body) Compute the cyclic redundancy check of a message and given unit ID.
void	encodeModbusPayload(io.netty.buffer.ByteBuf out)
net.solarnetwork.io.modbus.ModbusMessage	getBody() Get the wrapped message.
short	getCrc() Get the 16-bit cyclic redundancy check value presented in the RTU message frame.
net.solarnetwork.io.modbus.ModbusError	getError()
net.solarnetwork.io.modbus.ModbusFunction	getFunction()
long	getTimestamp() Get a message creation date.
int	getUnitId()
boolean	isSameAs(net.solarnetwork.io.modbus.ModbusMessage obj)
int	payloadLength()
String	toString()
<T extends net.solarnetwork.io.modbus.ModbusMessage> T	unwrap(Class<T> msgType)
RtuModbusMessage	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.io.modbus.rtu.RtuModbusMessage

isCrcValid

Methods inherited from interface net.solarnetwork.io.modbus.ModbusMessage

equals, hashCode, isException

Constructor Detail

RtuModbusMessage

public RtuModbusMessage(int unitId,
                        net.solarnetwork.io.modbus.ModbusMessage body)

Constructor.

The current system time will be used for the timestamp value, and the CRC will be calculated from the unitId and body values.

Parameters:

unitId - the unit ID

body - the message body, must implement ModbusPayloadEncoder.

Throws:

ClassCastException - if body does not implement ModbusPayloadEncoder

RtuModbusMessage

public RtuModbusMessage(long timestamp,
                        int unitId,
                        net.solarnetwork.io.modbus.ModbusMessage body)

Constructor.

The CRC will be calculated from the unitId and body values.

Parameters:

timestamp - the timestamp

unitId - the unit ID

body - the message body, must implement ModbusPayloadEncoder.

Throws:

ClassCastException - if body does not implement ModbusPayloadEncoder

RtuModbusMessage

public RtuModbusMessage(net.solarnetwork.io.modbus.ModbusMessage body,
                        short crc)

Constructor.

The current system time will be used for the timestamp value.

Parameters:

body - the message body, must implement ModbusPayloadEncoder.

crc - the provided cyclic redundancy check value

Throws:

IllegalArgumentException - if body does not implement ModbusPayloadEncoder

RtuModbusMessage

public RtuModbusMessage(long timestamp,
                        net.solarnetwork.io.modbus.ModbusMessage body,
                        short crc)

Constructor.

Parameters:

timestamp - the timestamp

body - the message body, must implement ModbusPayloadEncoder.

crc - the provided cyclic redundancy check value

Throws:

IllegalArgumentException - if body does not implement ModbusPayloadEncoder

Method Detail

validate

public RtuModbusMessage validate()
                          throws net.solarnetwork.io.modbus.ModbusValidationException

Specified by:

validate in interface net.solarnetwork.io.modbus.ModbusMessage

Specified by:

validate in interface RtuModbusMessage

Throws:

net.solarnetwork.io.modbus.ModbusValidationException

isSameAs

public boolean isSameAs(net.solarnetwork.io.modbus.ModbusMessage obj)

Specified by:

isSameAs in interface net.solarnetwork.io.modbus.ModbusMessage

unwrap

public <T extends net.solarnetwork.io.modbus.ModbusMessage> T unwrap(Class<T> msgType)

Specified by:

unwrap in interface net.solarnetwork.io.modbus.ModbusMessage

toString

public String toString()

Overrides:

toString in class Object

getBody

public net.solarnetwork.io.modbus.ModbusMessage getBody()

Get the wrapped message.

Returns:

the wrapped message

getTimestamp

public long getTimestamp()

Description copied from interface: RtuModbusMessage

Get a message creation date.

Specified by:

getTimestamp in interface RtuModbusMessage

Returns:

the message creation date

getCrc

public short getCrc()

Description copied from interface: RtuModbusMessage

Get the 16-bit cyclic redundancy check value presented in the RTU message frame.

Specified by:

getCrc in interface RtuModbusMessage

Returns:

the provided CRC value

computeCrc

public short computeCrc()

Description copied from interface: RtuModbusMessage

Compute the 16-bit cyclic redundancy check value from the message data.

If the RtuModbusMessage.getCrc() and this value differ, the message should be considered corrupted.

Specified by:

computeCrc in interface RtuModbusMessage

Returns:

the computed CRC value

computeCrc

public static short computeCrc(int unitId,
                               net.solarnetwork.io.modbus.ModbusMessage body)

Compute the cyclic redundancy check of a message and given unit ID.

Parameters:

unitId - the unit ID

body - the message

Returns:

the computed CRC

getUnitId

public int getUnitId()

Specified by:

getUnitId in interface net.solarnetwork.io.modbus.ModbusMessage

getFunction

public net.solarnetwork.io.modbus.ModbusFunction getFunction()

Specified by:

getFunction in interface net.solarnetwork.io.modbus.ModbusMessage

getError

public net.solarnetwork.io.modbus.ModbusError getError()

Specified by:

getError in interface net.solarnetwork.io.modbus.ModbusMessage

encodeModbusPayload

public void encodeModbusPayload(io.netty.buffer.ByteBuf out)

Specified by:

encodeModbusPayload in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder

payloadLength

public int payloadLength()

Specified by:

payloadLength in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder