net.solarnetwork.io.modbus.rtu

Interface RtuModbusMessage

All Superinterfaces:

net.solarnetwork.io.modbus.ModbusMessage

All Known Implementing Classes:

RtuModbusMessage

public interface RtuModbusMessage
extends net.solarnetwork.io.modbus.ModbusMessage

RTU encapsulated Modbus message API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRC_MISMATCH_VALIDATION_MESSAGE A ModbusValidationException message template.

Method Summary

Modifier and Type	Method and Description
short	computeCrc() Compute the 16-bit cyclic redundancy check value from the message data.
short	getCrc() Get the 16-bit cyclic redundancy check value presented in the RTU message frame.
long	getTimestamp() Get a message creation date.
default boolean	isCrcValid() Test if the provided and computed CRC values match.
default RtuModbusMessage	validate()

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

equals, getError, getFunction, getUnitId, hashCode, isException, isSameAs, unwrap

Field Detail

CRC_MISMATCH_VALIDATION_MESSAGE

static final String CRC_MISMATCH_VALIDATION_MESSAGE

A ModbusValidationException message template.

The message accepts two short values: the provided CRC and the computed CRC.

See Also:

Constant Field Values

Method Detail

getTimestamp

long getTimestamp()

Get a message creation date.

Returns:

the message creation date

getCrc

short getCrc()

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

Returns:

the provided CRC value

computeCrc

short computeCrc()

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

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

Returns:

the computed CRC value

isCrcValid

default boolean isCrcValid()

Test if the provided and computed CRC values match.

Returns:

true if getCrc() and computeCrc() return the same value

validate

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

Specified by:

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

Throws:

net.solarnetwork.io.modbus.ModbusValidationException