ConfigHeartbeatPublicationStatus

data class ConfigHeartbeatPublicationStatus(val destination: HeartbeatPublicationDestination = UnassignedAddress, val countLog: CountLog = 0x00.toUByte(), val periodLog: UByte = 0x00.toUByte(), val ttl: UByte = 0x00.toUByte(), val features: Array<Feature> = emptyArray(), val networkKeyIndex: KeyIndex, val status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS) : ConfigResponse, ConfigStatusMessage

This message contains the Heartbeat Publication status of an element. This is sent in response to a ConfigHeartbeatPublicationGet or ConfigHeartbeatPublicationSet message.

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: HeartbeatPublicationDestination = UnassignedAddress, countLog: CountLog = 0x00.toUByte(), periodLog: UByte = 0x00.toUByte(), ttl: UByte = 0x00.toUByte(), features: Array<Feature> = emptyArray(), networkKeyIndex: KeyIndex, status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS)

Creates a ConfigHeartbeatPublicationStatus message.

Types

Link copied to clipboard

Properties

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

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
open override val isSuccess: Boolean

True if the message was successful or false otherwise.

Link copied to clipboard

Whether the message is a Vendor Message, or not.

Link copied to clipboard
open override val message: String

Status message of the operation.

Link copied to clipboard
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

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
open override val status: ConfigMessageStatus

Status of the Config operation.

Link copied to clipboard
val ttl: UByte

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int