lights

inkapplications.shade.lights.parameters

lights/inkapplications.shade.lights.parameters

Package-level declarations

Types

AlertParameters

@Serializable

data class AlertParameters(val action: AlertEffectType)

Change alert state of the light

ColorParameters

@Serializable

data class ColorParameters(val color: Color? = null)

Color setting parameters for a light

ColorTemperatureDeltaParameters

@Serializable

data class ColorTemperatureDeltaParameters(val action: DeltaAction, val temperatureDelta: Mireds? = null)

Relative color temperature change for a light

ColorTemperatureParameters

@Serializable

data class ColorTemperatureParameters(val temperature: ColorTemperature? = null)

Color temperature setting for a light

@Serializable

value class DeltaAction(val key: String)

Defines the type of delta argument provided in a parameter.

DimmingDeltaParameters

@Serializable

data class DimmingDeltaParameters(val action: DeltaAction, val brightnessDelta: Percentage? = null)

Relative brightness changes for a light.

DimmingParameters

@Serializable

data class DimmingParameters(val brightness: Percentage)

Brightness changes for a light

DynamicsParameters

@Serializable

data class DynamicsParameters(val duration: Duration? = null, val speed: Percentage? = null)

Settings for dynamics during a light setting change

EffectsParameters

@Serializable

data class EffectsParameters(val effect: LightEffect? = null)

Basic feature containing effect properties.

GradientParameters

@Serializable

data class GradientParameters(val points: List<GradientPoint>)

Basic feature containing gradient properties.

LightUpdateParameters

@Serializable

data class LightUpdateParameters( val power: PowerParameters? = null, val dimming: DimmingParameters? = null, val dimmingDelta: DimmingDeltaParameters? = null, val colorTemperature: ColorTemperatureParameters? = null, val colorTemperatureDelta: ColorTemperatureDeltaParameters? = null, val color: ColorParameters? = null, val dynamics: DynamicsParameters? = null, val alert: AlertParameters? = null, val gradient: GradientParameters? = null, val effects: EffectsParameters? = null, val timedEffects: TimedEffectsParameters? = null)

Data available to be updated on a light object via the bridge.

TimedEffectsParameters

@Serializable

data class TimedEffectsParameters(val effect: TimedLightEffect? = null, val duration: Duration? = null)

Basic feature containing timed effect properties.