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

PublishPeriod

@Serializable
data class PublishPeriod(val steps: UByte, val resolution: StepResolution)

The publish period object determines the interval at which messages are published by a model and is defined by two values: the number of steps and step resolution. The publish period is calculated as a product of the number of steps and step resolution. For example, if the value of the numberOfSteps property is 3 and the value of the resolution property is 1000, the publish period is 3000 ms.

Constructors

Link copied to clipboard
constructor(steps: UByte, resolution: StepResolution)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val interval: Duration

The interval between subsequent publications in milliseconds.

Link copied to clipboard
@Serializable(with = StepResolutionSerializer::class)
val resolution: StepResolution

The resolution of the number of steps.

Link copied to clipboard
val steps: UByte

Integer from 0 to 63 that represents the number of steps used to calculate the publish period.