LightEffectsTrait.LightEffectsFeature

data class LightEffectsTrait.LightEffectsFeature

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

Convert this ClusterBitmap to raw (bytes) format

Public properties
String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
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.
String

Trait identifier of the Matter Cluster that defines the bitmap Data Type.
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

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

pulse

val pulse: 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. 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 sleep: Boolean

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

traitId

val traitId: String

Trait identifier of the Matter Cluster that defines the bitmap Data Type. Refer to ClusterId.traitId for the format.

wake

val wake: Boolean

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