LightEffectsTrait.LightEffectsFeature

data class LightEffectsTrait.LightEffectsFeature : ClusterBitmap


Contains specific capabilities related to light effects.

Summary

Public constructors

LightEffectsFeature(pulse: Boolean, sleep: Boolean, wake: Boolean)

Creates the LightEffectsFeature data class.

Public functions

open ULong

Public properties

Boolean

The device supports the pulse effect, which means that light intensity ramps from mid-level brightness to maximum-level brightness and then ramps back to mid-level brightness, with a total cycle time of one pulse per second.

Boolean

The device supports the sleep effect, which gradually lowers brightness and, optionally, adjusts the color temperature over a period of time.

Boolean

The device supports the wake effect, which gradually increases brightness and, optionally, adjusts the color temperature over a period of time.

Public constructors

LightEffectsFeature

LightEffectsFeature(
    pulse: Boolean = false,
    sleep: Boolean = false,
    wake: Boolean = false
)

Creates the LightEffectsFeature data class.

Public functions

toRaw

open fun toRaw(): ULong

Public properties

pulse

val pulseBoolean

The device supports the pulse effect, which means that light intensity ramps from mid-level brightness to maximum-level brightness and then ramps back to mid-level brightness, with a total cycle time of one pulse per second. During each cycle, maximum-level brightness lasts for about 200 milliseconds and mid-level brightness, excluding ramping, typically lasts for at least 500 milliseconds.

sleep

val sleepBoolean

The device supports the sleep effect, which gradually lowers brightness and, optionally, adjusts the color temperature over a period of time.

wake

val wakeBoolean

The device supports the wake effect, which gradually increases brightness and, optionally, adjusts the color temperature over a period of time.