Package-level declarations

Types

Link copied to clipboard
@Serializable
data class Scene(val id: ResourceId, val v1Id: String? = null, val actions: List<SceneActionReference>, val metadata: SceneMetadata, val group: ResourceReference, val speed: Percentage, val autoDynamic: Boolean, val palette: ScenePalette? = null)

Scene data, used to store and recall settings for a group of lights.

Link copied to clipboard
@Serializable
data class SceneAction(val powerValue: PowerValue? = null, val dimmingValue: DimmingValue? = null, val colorValue: ColorValue? = null, val colorTemperatureValue: ColorTemperatureValue? = null, val gradient: GradientValue? = null, val effect: LightEffect? = null, val dynamicsDuration: Duration? = null)

Action to be executed on the lights in the scene.

Link copied to clipboard
@Serializable
data class SceneActionReference(val target: ResourceReference, val action: SceneAction)

Action to be applied to a specified resource for a scene.

Link copied to clipboard
@Serializable
data class SceneMetadata(val name: String, val image: ResourceReference? = null)

User-configured metadata for the scene.

Link copied to clipboard
@Serializable
data class ScenePalette(val color: List<ColorPalette>? = null, val dimming: List<DimmingValue>? = null, val colorTemperature: List<ColorTemperaturePalette>? = null)

Group of colors that describe the palette of colors to be used when playing dynamics

Link copied to clipboard
@Serializable
data class SceneRecall(val action: SceneRecallAction, val status: SceneRecallStatus, val duration: Duration, val dimming: DimmingValue)
Link copied to clipboard
@Serializable
value class SceneRecallAction(val key: String)

When writing active, the actions in the scene are executed on the target.

Link copied to clipboard
@Serializable
value class SceneRecallStatus(val key: String)

When writing active, the actions in the scene are executed on the target.