Package org.openremote.agent.protocol.velbus

Class VelbusPacket

java.lang.Object

org.openremote.agent.protocol.velbus.VelbusPacket

public class VelbusPacket
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VelbusPacket.InboundCommand	Command for inbound packets
static enum	VelbusPacket.OutboundCommand	Command for outbound packets
static enum	VelbusPacket.PacketPriority	Packet priority.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	ETX
static final int	MAX_PACKET_SIZE	Maximum packet size used by the Velbus protocol.
static final int	MIN_PACKET_SIZE	Minimum packet size
static final byte	STX

Constructor Summary

Constructors

Constructor	Description
VelbusPacket()
VelbusPacket(byte[] content)
VelbusPacket(int address)
VelbusPacket(int address, int command, byte... dataBytes)
VelbusPacket(int address, int command, VelbusPacket.PacketPriority priority, byte... dataBytes)
VelbusPacket(int address, VelbusPacket.PacketPriority priority, int dataSize, boolean rtr)

Method Summary

Modifier and Type	Method	Description
static byte	calculateChecksum(VelbusPacket packet)
VelbusPacket	clone()
boolean	equals(Object obj)
static VelbusPacket	fromString(String packetStr)
int	getAddress()
byte	getByte(int index)
byte	getChecksum()	Get the checksum byte
int	getCommand()
int	getDataSize()
int	getInt(int index)
VelbusPacket.PacketPriority	getPriority()
boolean	getRtr()
int	getSize()
int	getTypeCode()
boolean	hasCommand()
int	hashCode()
boolean	isHandled()
boolean	isValid()
byte[]	pack()
void	setAddress(int address)
void	setByte(int index, byte value)
void	setCommand(int command)
void	setDataSize(int dataSize)
void	setHandled(boolean handled)
void	setPriority(VelbusPacket.PacketPriority priority)
void	setRtr(boolean rtr)
void	setTypeCode(int typeCode)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MIN_PACKET_SIZE

public static final int MIN_PACKET_SIZE

Minimum packet size

See Also:

• Constant Field Values

MAX_PACKET_SIZE

public static final int MAX_PACKET_SIZE

Maximum packet size used by the Velbus protocol.

See Also:

• Constant Field Values

STX

public static final byte STX

See Also:

• Constant Field Values

ETX

public static final byte ETX

See Also:

• Constant Field Values

Constructor Details

VelbusPacket

public VelbusPacket(byte[] content)

VelbusPacket

public VelbusPacket()

VelbusPacket

public VelbusPacket(int address)

VelbusPacket

public VelbusPacket(int address,
 int command,
 byte... dataBytes)

VelbusPacket

public VelbusPacket(int address,
 int command,
 VelbusPacket.PacketPriority priority,
 byte... dataBytes)

VelbusPacket

public VelbusPacket(int address,
 VelbusPacket.PacketPriority priority,
 int dataSize,
 boolean rtr)

Method Details

calculateChecksum

public static byte calculateChecksum(VelbusPacket packet)

getAddress

public int getAddress()

setAddress

public void setAddress(int address)

getTypeCode

public int getTypeCode()

setTypeCode

public void setTypeCode(int typeCode)

getDataSize

public int getDataSize()

setDataSize

public void setDataSize(int dataSize)

getSize

public int getSize()

getChecksum

public byte getChecksum()

Get the checksum byte

getPriority

public VelbusPacket.PacketPriority getPriority()

setPriority

public void setPriority(VelbusPacket.PacketPriority priority)

getRtr

public boolean getRtr()

setRtr

public void setRtr(boolean rtr)

getByte

public byte getByte(int index)

setByte

public void setByte(int index,
 byte value)

getInt

public int getInt(int index)

getCommand

public int getCommand()

setCommand

public void setCommand(int command)

hasCommand

public boolean hasCommand()

isHandled

public boolean isHandled()

setHandled

public void setHandled(boolean handled)

pack

public byte[] pack()

clone

public VelbusPacket clone()

Overrides:

clone in class Object

isValid

public boolean isValid()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

fromString

public static VelbusPacket fromString(String packetStr)