Package org.openremote.agent.protocol.tradfri.device

Class LightProperties

java.lang.Object
org.openremote.agent.protocol.tradfri.device.DeviceProperties
org.openremote.agent.protocol.tradfri.device.LightProperties
public class LightProperties extends DeviceProperties
The class that contains the properties of an IKEA TRÃ…DFRI light

  • Constructor Summary

    Constructors
    Constructor
    Description
    LightProperties()
    Construct the LightProperties class

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getBrightness()
    Get the brightness of the light
    String
    getColourHex()
    Get the colour of the light in hexadecimals
    Integer
    getColourTemperature()
    Get the colour temperature of the light
    Integer
    getColourX()
    Get the X value of the colour of the light
    Integer
    getColourY()
    Get the Y value of the colour of the light
    Integer
    getHue()
    Get the hue of the light
    Boolean
    getOn()
    Get the on state of the light
    Integer
    getSaturation()
    Get the saturation of the light
    Integer
    getTransitionTime()
    Get the transition time for updating the light
    void
    setBrightness(Integer brightness)
    Set the brightness of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setColourHex(String colourHex)
    Set the colour of the light to a predefined hexadecimal colour within the LightProperties class
    Note: This does not change the actual light Available colours:
    RGB: org.openremote.agent.protocol.tradfri.util.ColourHex Colour temperatures: org.openremote.agent.protocol.tradfri.util.ColourTemperatureHex
    void
    setColourTemperature(Integer colourTemperature)
    Set the colour temperature of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setColourX(Integer colourX)
    Set the X value of the colour of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setColourY(Integer colourY)
    Set the Y value of the colour of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setHue(Integer hue)
    Set the hue of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setOn(Boolean on)
    Set the on state of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setSaturation(Integer saturation)
    Set the saturation of the light within the LightProperties class
    Note: This does not change the actual light
    void
    setTransitionTime(Integer transitionTime)
    Set the transition time for updating the light within the LightProperties class
    Note: This does not change the actual light

    Methods inherited from class org.openremote.agent.protocol.tradfri.device.DeviceProperties

    getInstanceId, setInstanceId

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LightProperties

      public LightProperties()
      Construct the LightProperties class

  • Method Details

    • getOn

      public Boolean getOn()
      Get the on state of the light
      Returns:
      The on state of the light (true for on, false for off)

    • getBrightness

      public Integer getBrightness()
      Get the brightness of the light
      Returns:
      The brightness of the light

    • getColourHex

      public String getColourHex()
      Get the colour of the light in hexadecimals
      Returns:
      The colour of the light in hexadecimals

    • getHue

      public Integer getHue()
      Get the hue of the light
      Returns:
      The hue of the light

    • getSaturation

      public Integer getSaturation()
      Get the saturation of the light
      Returns:
      The saturation of the light

    • getColourX

      public Integer getColourX()
      Get the X value of the colour of the light
      Returns:
      The X value of the colour of the light

    • getColourY

      public Integer getColourY()
      Get the Y value of the colour of the light
      Returns:
      The Y value of the colour of the light

    • getColourTemperature

      public Integer getColourTemperature()
      Get the colour temperature of the light
      Returns:
      The colour temperature of the light

    • getTransitionTime

      public Integer getTransitionTime()
      Get the transition time for updating the light
      Returns:
      The transition time for updating the light

    • setOn

      public void setOn(Boolean on)
      Set the on state of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      on - The new on state for the light (true for on, false for off)

    • setBrightness

      public void setBrightness(Integer brightness)
      Set the brightness of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      brightness - The new brightness for the light

    • setColourHex

      public void setColourHex(String colourHex)
      Set the colour of the light to a predefined hexadecimal colour within the LightProperties class
      Note: This does not change the actual light Available colours:
      • RGB: org.openremote.agent.protocol.tradfri.util.ColourHex
      • Colour temperatures: org.openremote.agent.protocol.tradfri.util.ColourTemperatureHex
      Parameters:
      colourHex - The new colour for the light

    • setHue

      public void setHue(Integer hue)
      Set the hue of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      hue - The new hue for the light

    • setSaturation

      public void setSaturation(Integer saturation)
      Set the saturation of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      saturation - The new saturation for the light

    • setColourX

      public void setColourX(Integer colourX)
      Set the X value of the colour of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      colourX - The X value of the new colour for the light

    • setColourY

      public void setColourY(Integer colourY)
      Set the Y value of the colour of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      colourY - The Y value of the new colour for the light

    • setColourTemperature

      public void setColourTemperature(Integer colourTemperature)
      Set the colour temperature of the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      colourTemperature - The new colour temperature for the light

    • setTransitionTime

      public void setTransitionTime(Integer transitionTime)
      Set the transition time for updating the light within the LightProperties class
      Note: This does not change the actual light
      Parameters:
      transitionTime - The new transition time for updating the light