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

TransitionTime

data class TransitionTime(val steps: UByte, val stepResolution: StepResolution)

This structure represents a time needed to transition from one state to another, for example dimming a light.

Internally, it uses steps and step resolution. Thanks to that only some time intervals are possible. Use TransitionTime.interval to get exact time.

Constructors

constructor()

Creates a new transition time object for an unknown time.

constructor(rawValue: UByte)

constructor(steps: UByte, stepResolution: StepResolution)

Creates a new transition time.

Types

object Companion

Properties

val interval: Duration?

Transition time as an `Duration` in seconds. Null if unknown.

val isImmediate: Boolean

Returns true if the transition time is immediate.

val isKnown: Boolean

Returns true if the transition time is unknown.

val milliseconds: Int?

Transition time in milliseconds. Null if the time is unknown.

val rawValue: UByte

Raw representation of the transition in a mesh message.

val stepResolution: StepResolution

Step resolution.

val steps: UByte

Transition Number of Steps, 6-bit value. Value 0 indicates an immediate transition. Value 0x3F means that the value is unknown. The state cannot be set to this value, but an element may report an unknown value if a transition is higher than 0x3E or not determined. Valid values are 0 to 62

Functions

open override fun toString(): String