LightEffects

interface LightEffects : LightEffectsTrait.Attributes, MatterTrait, LightEffectsCommands


API for the LightEffects trait. This trait belongs to devices that can support complex lighting commands to change states, such as looping through various colors.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions

Boolean
Boolean

Public properties

open TraitFactory<LightEffects>

Inherited functions

From com.google.home.google.LightEffectsCommands
suspend Unit
pulseEffectSet(durationSeconds: UInt, color: LightEffectsTrait.Color)

Activates the pulse effect.

suspend Unit
sleepEffectSet(durationSeconds: UInt)

Activates the sleep effect.

suspend Unit

Stops the active effect.

suspend Unit
wakeEffectSet(durationSeconds: UInt)

Activates the wake effect.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.google.LightEffectsTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

UInt?

The default duration, in seconds, for the effect triggered by the sleepEffectSet command.

UInt?

The default duration, in seconds, for the effect triggered by the wakeEffectSet command.

Long?

Unix timestamp for when the current effect is expected to end, assuming that the effect ends on its own.

LightEffectsTrait.LightEffectsFeature

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

Boolean?

Indicates that the pulse effect is currently active.

Boolean?

Indicates that the sleep effect is currently active.

Boolean?

Indicates that the wake effect is currently active.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: LightEffects.Attribute): Boolean

supports

fun supports(command: LightEffects.Command): Boolean

Public properties

factory

open val factoryTraitFactory<LightEffects>