ConfigHeartbeatPublicationSet

class ConfigHeartbeatPublicationSet(val destination: Address = UnassignedAddress.address, val countLog: CountLog, val periodLog: UByte, val ttl: UByte, val features: Array<Feature>, val networkKeyIndex: KeyIndex) : AcknowledgedConfigMessage, ConfigNetKeyMessage

This message can be sent to set Heartbeat Publication of a given element.

Parameters

destination

Destination address of the Heartbeat Publication.

countLog

Number of Heartbeat messages remaining to be sent.

periodLog

Period between publication of two consecutive periodic heartbeat transport control messages.

ttl

TTL value used when sending Heartbeat messages.

features

Features that trigger Heartbeat messages.

Constructors

Link copied to clipboard
constructor(destination: Address = UnassignedAddress.address, countLog: CountLog, periodLog: UByte, ttl: UByte, features: Array<Feature>, networkKeyIndex: KeyIndex)

Creates a ConfigHeartbeatPublicationSet message.

Types

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Defines if the message should be sent as an acknowledged message.

Link copied to clipboard
Link copied to clipboard

Defines if the message should be sent or was sent as Segmented Access Message. By default, this returns false. To force segmentation for shorter messages return true despite payload length. If payload size is longer than 11 bytes this field is not checked as the message must be segmented.

Link copied to clipboard

Whether the message is a Vendor Message, or not.

Link copied to clipboard
open override val networkKeyIndex: KeyIndex

The Network Key Index.

Link copied to clipboard
open override val opCode: UInt
Link copied to clipboard
open override val parameters: ByteArray

Access layer payload, including the Op Code.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val responseOpCode: UInt

Op Code of the response message.

Link copied to clipboard

Defines if the message should be sent or has been sent using 32-bit or 64-bit TransMIC value. By default MeshMessageSecurity.Low is used. Only Segmented Access Messages can use 64-bit MIC. If the payload is shorter than 11 bytes, make sure you return true from MeshMessage.isSegmented, otherwise this field will be ignored.

Link copied to clipboard
val ttl: UByte

Functions

Link copied to clipboard
open fun decodeNetKeyIndex(data: ByteArray, offset: Int): KeyIndex
Link copied to clipboard