Package-level declarations

Types

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

Wraps alert effects for lighting

Link copied to clipboard
@Serializable
data class AlertInfo(val actionValues: List<AlertEffectType>)

Information on Alert effects for a light

Link copied to clipboard
@Serializable
data class ColorInfo(val color: Color, val gamutType: GamutType, val gamut: Gamut? = null)

Information about a light's color and color capabilities.

Link copied to clipboard
@Serializable
data class ColorPalette(val color: ColorValue, val dimming: DimmingValue)

Color/brightness pair reference.

Link copied to clipboard
@Serializable
data class ColorTemperatureInfo(val temperature: ColorTemperature?, val valid: Boolean, val range: ColorTemperatureRange)

Information about the bulb's color temperature and capabilities.

Link copied to clipboard
@Serializable
data class ColorTemperaturePalette(val colorTemperature: ColorTemperatureValue, val dimming: DimmingValue)

Color temperature/brightness pair reference.

Link copied to clipboard
data class ColorTemperatureRange(val coolest: ColorTemperature, val warmest: ColorTemperature)

Represents a range of color temperatures.

Link copied to clipboard
@Serializable
data class ColorTemperatureValue(val temperature: ColorTemperature?)

Describes the current color temperature of a light.

Link copied to clipboard
@Serializable
data class ColorValue(val color: Color)

Information about a light's color.

Link copied to clipboard
@Serializable
data class DimmingInfo(val brightness: Percentage, val minimum: Percentage? = null)

Info about a light's dimming status and capabilities.

Link copied to clipboard
@Serializable
data class DimmingValue(val brightness: Percentage)

Info about a light's dimming status.

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

Wraps potential values for LightDynamics state.

Link copied to clipboard
@Serializable
data class Gamut(val red: xyY, val green: xyY, val blue: xyY)

RGB Chromaticity values defining a color space gamut

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

Simple Gamut Type definition used by Hue products.

Link copied to clipboard
@Serializable
data class Gradient(val points: List<GradientPoint>, val pointsCapable: Int)

Basic feature containing gradient properties.

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

Mode in which gradient points are currently being deployed.

Link copied to clipboard
@Serializable
data class GradientPoint(val colorValue: ColorValue)

Contains information on a single gradient point.

Link copied to clipboard
@Serializable
data class GradientValue(val points: List<GradientPoint>, val mode: GradientMode)

Basic feature containing gradient properties.

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable
data class LightDynamics(val status: DynamicsStatus, val statusValues: List<DynamicsStatus>, val speed: Percentage, val speedValid: Boolean)

Dynamic Lighting Effects information

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

Static effect applied to a light.

Link copied to clipboard
@Serializable
data class LightingEffectInfo(val status: LightEffect, val values: List<LightEffect>)

Basic feature containing effect properties.

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

Wrap's a light mode flag/values

Link copied to clipboard
@Serializable(with = LightPowerup.Serializer::class)
abstract class LightPowerup

Properties to configure powerup behaviour of a lightsource.

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

Indicates which signal is currently active for a light signal.

Link copied to clipboard
@Serializable
data class LightSignaling(val status: LightSignalStatus? = null)

Signaling properties for a light.

Link copied to clipboard
@Serializable
data class LightSignalStatus(val signal: LightSignal, val estimatedEnd: Instant? = null)

Status of active light signal.

Link copied to clipboard
abstract class PowerupColorState

Color state properties for powerup.

Link copied to clipboard

Dimming/Brightness state to be activated on powerup.

Link copied to clipboard
abstract class PowerupPowerState

Power state to restore on light powerup.

Link copied to clipboard

Commonly used reference temperatures.

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

Timed Effect applied to a light

Link copied to clipboard
@Serializable
data class TimedLightingEffectInfo(val status: TimedLightEffect, val values: List<TimedLightEffect>)

Basic feature containing timed effect properties.