core/no.nordicsemi.kotlin.mesh.core.model/HeartbeatPublication

HeartbeatPublication

@Serializable

The heartbeat publication represents parameters that define the sending of periodic Heartbeat transport control messages.

Properties

address

val address: HeartbeatPublicationDestination

Destination for heartbeat messages. This can be a UnicastAddress, GroupAddress or an UnassignedAddress. Setting an unassigned address as destination will stop sending heartbeat messages.

count

val count: UShort

Number of Heartbeat messages, 2^(n-1), remaining to be sent.

countLog

var countLog: UByte

Heartbeat Publication Count Log is a representation of the Heartbeat Publication Count value.

features

val features: Array<Feature>

The functionality of nodes is determined by the Features that they support. All nodes have the ability to transmit and receive mesh messages. Nodes can also optionally support one or more additional features such as Features.

index

val index: KeyIndex

Represents a NetworkKey with the given index.

isEnabled

val isEnabled: Boolean

If True Heartbeat Publication is enabled.

isFeatureTriggeredPublishingEnabled

val isFeatureTriggeredPublishingEnabled: Boolean

If True feature-triggered Heartbeat Publishing is enabled.

isPeriodicHeartbeatStateEnabled

val isPeriodicHeartbeatStateEnabled: Boolean

If True Periodic Heartbeat messages are enabled.

period

val period: UShort

An integer from 0 to 65536 that represents the cadence of periodical heartbeat messages in seconds.

periodLog

val periodLog: UByte

Heartbeat Publication Period Log state is an 8-bit value that controls the cadence of periodical Heartbeat transport control messages. The value is represented as 2^(n-1) seconds.

ttl

val ttl: UByte

An integer from 0 to 127 that represents the Time to Live (TTL) value for the heartbeat messages.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int