Package org.openremote.agent.protocol.bluetooth.mesh.utils

Class HeartbeatPublication

java.lang.Object

org.openremote.agent.protocol.bluetooth.mesh.utils.Heartbeat

org.openremote.agent.protocol.bluetooth.mesh.utils.HeartbeatPublication

public class HeartbeatPublication
extends Heartbeat

Field Summary

Fields inherited from class org.openremote.agent.protocol.bluetooth.mesh.utils.Heartbeat

COUNT_MAX, COUNT_MIN, countLog, DEFAULT_PUBLICATION_TTL, DO_NOT_SEND_PERIODICALLY, dst, PERIOD_LOG_MAX, PERIOD_LOG_MIN, PERIOD_MAX, PERIOD_MIN, periodLog, SEND_INDEFINITELY

Constructor Summary

Constructors

Constructor	Description
HeartbeatPublication(int dst, byte countLog, byte periodLog, int ttl, Features features, int netKeyIndex)	Heartbeat subscription.

Method Summary

Modifier and Type	Method	Description
String	getCountLogDescription()
Features	getFeatures()	Returns the features.
int	getNetKeyIndex()	Returns the Net key index.
int	getPeriod()
Short	getPeriodLog2Period(int periodLog)
String	getPeriodLogDescription()
int	getTtl()	Returns the publication ttl.
boolean	isEnabled()	Returns true if the heartbeat subscriptions are enabled.
String	toString()

Methods inherited from class org.openremote.agent.protocol.bluetooth.mesh.utils.Heartbeat

calculateHeartbeatCount, calculateHeartbeatPeriod, decodeHeartbeatPeriod, getCountLog, getDst, getPeriodLog, isValidHeartbeatPeriod, isValidHeartbeatPeriodLog, periodToTime

Methods inherited from class java.lang.Object

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

Constructor Details

HeartbeatPublication

public HeartbeatPublication(int dst,
 byte countLog,
 byte periodLog,
 int ttl,
 Features features,
 int netKeyIndex)

Heartbeat subscription.

Parameters:

dst - Destination address identifies the Heartbeat Publication destination where the address can only be an unassigned address, unicast address or a group address. All other values are prohibited.

countLog - Number of Heartbeat messages to be sent.

periodLog - Period for sending Heartbeat messages.

ttl - TTL to be used when sending Heartbeat messages.

features - Bit field indicating features that trigger Heartbeat messages when changed.

netKeyIndex - Net key index.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getPeriod

public int getPeriod()

getTtl

public int getTtl()

Returns the publication ttl.

getFeatures

public Features getFeatures()

Returns the features.

getNetKeyIndex

public int getNetKeyIndex()

Returns the Net key index.

isEnabled

public boolean isEnabled()

Returns true if the heartbeat subscriptions are enabled.

Specified by:

isEnabled in class Heartbeat

getPeriodLogDescription

public String getPeriodLogDescription()

getPeriodLog2Period

public Short getPeriodLog2Period(int periodLog)

getCountLogDescription

public String getCountLogDescription()