lights/inkapplications.shade.lights.structures

Package-level declarations

Types

AlertEffectType

@Serializable

value class AlertEffectType(val key: String)

Wraps alert effects for lighting

@Serializable

data class AlertInfo(val actionValues: List<AlertEffectType>)

Information on Alert effects for a light

@Serializable

data class ColorInfo(val color: Color, val gamutType: GamutType, val gamut: Gamut? = null)

Information about a light's color and color capabilities.

@Serializable

data class ColorPalette(val color: ColorValue, val dimming: DimmingValue)

Color/brightness pair reference.

ColorTemperatureInfo

@Serializable

data class ColorTemperatureInfo(val temperature: ColorTemperature?, val valid: Boolean, val range: ColorTemperatureRange)

Information about the bulb's color temperature and capabilities.

ColorTemperaturePalette

@Serializable

data class ColorTemperaturePalette(val colorTemperature: ColorTemperatureValue, val dimming: DimmingValue)

Color temperature/brightness pair reference.

ColorTemperatureRange

data class ColorTemperatureRange(val coolest: ColorTemperature, val warmest: ColorTemperature)

Represents a range of color temperatures.

ColorTemperatureValue

@Serializable

data class ColorTemperatureValue(val temperature: ColorTemperature?)

Describes the current color temperature of a light.

@Serializable

data class ColorValue(val color: Color)

Information about a light's color.

@Serializable

data class DimmingInfo(val brightness: Percentage, val minimum: Percentage? = null)

Info about a light's dimming status and capabilities.

@Serializable

data class DimmingValue(val brightness: Percentage)

Info about a light's dimming status.

@Serializable

value class DynamicsStatus(val key: String)

Wraps potential values for LightDynamics state.

@Serializable

data class Gamut(val red: xyY, val green: xyY, val blue: xyY)

RGB Chromaticity values defining a color space gamut

@Serializable

value class GamutType(val key: String)

Simple Gamut Type definition used by Hue products.

@Serializable

data class Gradient(val points: List<GradientPoint>, val pointsCapable: Int)

Basic feature containing gradient properties.

@Serializable

value class GradientMode(val key: String)

Mode in which gradient points are currently being deployed.

@Serializable

data class GradientPoint(val colorValue: ColorValue)

Contains information on a single gradient point.

@Serializable

data class GradientValue(val points: List<GradientPoint>, val mode: GradientMode)

Basic feature containing gradient properties.

@Serializable

data class Light(val id: ResourceId, val owner: ResourceReference, val powerInfo: PowerInfo, val mode: LightMode, val dimmingInfo: DimmingInfo? = null, val colorTemperatureInfo: ColorTemperatureInfo? = null, val colorInfo: ColorInfo? = null, val v1Id: String? = null, val dynamics: LightDynamics? = null, val alertInfo: AlertInfo? = null, val gradient: Gradient? = null, val effects: LightingEffectInfo? = null, val timedEffects: TimedLightingEffectInfo? = null, val signaling: LightSignaling? = null, val powerup: LightPowerup? = null)

State and capabilities of a light resource.

@Serializable

data class LightDynamics(val status: DynamicsStatus, val statusValues: List<DynamicsStatus>, val speed: Percentage, val speedValid: Boolean)

Dynamic Lighting Effects information

@Serializable

value class LightEffect(val key: String)

Static effect applied to a light.

LightingEffectInfo

@Serializable

data class LightingEffectInfo(val status: LightEffect, val values: List<LightEffect>)

Basic feature containing effect properties.

@Serializable

value class LightMode(val key: String)

Wrap's a light mode flag/values

@Serializable(with = LightPowerup.Serializer::class)

abstract class LightPowerup

Properties to configure powerup behaviour of a lightsource.

@Serializable

value class LightSignal(val key: String)

Indicates which signal is currently active for a light signal.

@Serializable

data class LightSignaling(val status: LightSignalStatus? = null)

Signaling properties for a light.

LightSignalStatus

@Serializable

data class LightSignalStatus(val signal: LightSignal, val estimatedEnd: Instant? = null)

Status of active light signal.

PowerupColorState

@Serializable(with = PowerupColorState.Serializer::class)

abstract class PowerupColorState

Color state properties for powerup.

PowerupDimmingState

@Serializable(with = PowerupDimmingState.Serializer::class)

abstract class PowerupDimmingState

Dimming/Brightness state to be activated on powerup.

PowerupPowerState

@Serializable(with = PowerupPowerState.Serializer::class)

abstract class PowerupPowerState

Power state to restore on light powerup.

StandardTemperatures

object StandardTemperatures

Commonly used reference temperatures.

TimedLightEffect

@Serializable

value class TimedLightEffect(val key: String)

Timed Effect applied to a light

TimedLightingEffectInfo

@Serializable

data class TimedLightingEffectInfo(val status: TimedLightEffect, val values: List<TimedLightEffect>)

Basic feature containing timed effect properties.