MilightColor

java.lang.Object
- de.toman.milight.MilightColor

```
public class MilightColor
extends java.lang.Object
```
This class extracts hue, saturation and brightness values from java.awt.Color instances and transforms them to values that can be sent to the Milight WiFi box.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_BRIGHTNESS` The maximum brightness value to send to the WiFi box.
`static int`	`MAX_COLOR` The maximum color value to send to the WiFi box.
`static int`	`MIN_BRIGHTNESS` The minimum brightness value to send to the WiFi box.
`static int`	`MIN_COLOR` The minimum color value to send to the WiFi box.
`static float`	`SATURATION_THRESHOLD` This threshold defines where the lights should change between white and colored mode.

Constructor Summary

Constructors
Constructor and Description

MilightColor(java.awt.Color color)
Use this constructor to generate a new MilightColor representing a specified color.

Constructors
Constructor and Description
`MilightColor(java.awt.Color color)` Use this constructor to generate a new MilightColor representing a specified color.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(MilightColor color)` This function checks whether two MilightColors represent the same color by comparing their hsb values.
`float`	`getBrightness()` Extract the brightness value from the color the instance is representing.
`java.awt.Color`	`getColor()` This function returns the color the instance is representing.
`float[]`	`getHSB()` This function extracts hue, saturation and brightness of the color the instance is representing.
`float`	`getHue()` Extract the hue value from the color the instance is representing.
`int`	`getMilightBrightness()` This function extracts the brightness value from the color the instance is representing and transforms it to a value that can be sent to the WiFi box.
`int`	`getMilightHue()` This function extracts the hue value from the color the instance is representing and transforms it to a value that can be sent to the WiFi box.
`float`	`getSaturation()` Extract the saturation value from the color the instance is representing.
`MilightColor`	`getTransition(MilightColor target, float x)` This function finds colors between two MilightColors.
`boolean`	`isColoredMode()` This function computes whether a color should be displayed in white or colored mode.
`boolean`	`isWhiteMode()` This function computes whether a color should be displayed in white or colored mode.
`void`	`setBrightness(float brightness)` Set a new brightness value and let the hue and saturation values untouched.
`void`	`setColor(java.awt.Color color)` Use this function to set the color the instance is representing.
`void`	`setHue(float hue)` Set a new hue value and let the brightness and saturation values untouched.
`void`	`setMilightBrightness(int milightBrightness)` This function sets a new brightness value for the color the instance is representingThe value is given as it could be sent to the WiFiBox and internally transferred to a float.
`void`	`setMilightHue(int milightHue)` This function sets a new hue value given as it would be sent to the WiFiBox.
`void`	`setSaturation(float saturation)` Set a new saturation value and let the brightness and hue values untouched.
`java.lang.String`	`toString()` This function describes the objet as a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_COLOR
```
public static final int MIN_COLOR
```
    The minimum color value to send to the WiFi box.
    
    See Also:
    
    Constant Field Values
  - MAX_COLOR
```
public static final int MAX_COLOR
```
    The maximum color value to send to the WiFi box.
    
    See Also:
    
    Constant Field Values
  - MIN_BRIGHTNESS
```
public static final int MIN_BRIGHTNESS
```
    The minimum brightness value to send to the WiFi box. The documentation of the "LimitlessLED Technical Developer Opensource API" mentions that brightness values should be between 0x00 and 0x3B. However, in practice this does not hold. All available brightness levels are between 0x02 and 0x1B, outside this interval some arguments don't change the light at all, others give unexpected brightness values with the same result as the values between 0x02 and 0x1B.
    
    See Also:
    
    Constant Field Values
  - MAX_BRIGHTNESS
```
public static final int MAX_BRIGHTNESS
```
    The maximum brightness value to send to the WiFi box. The documentation of the "LimitlessLED Technical Developer Opensource API" mentions that brightness values should be between 0x00 and 0x3B. However, in practice this does not hold. All available brightness levels are between 0x02 and 0x1B, outside this interval some arguments don't change the light at all, others give unexpected brightness values with the same result as the values between 0x02 and 0x1B.
    
    See Also:
    
    Constant Field Values
  - SATURATION_THRESHOLD
```
public static final float SATURATION_THRESHOLD
```
    This threshold defines where the lights should change between white and colored mode. All saturation values under the threshold will be displayed in white mode, everything equal or above in colored mode.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MilightColor
```
public MilightColor(java.awt.Color color)
```
    Use this constructor to generate a new MilightColor representing a specified color.
    
    Parameters:
    
    color - is the colorthe new instance should represent
- Method Detail
  - getColor
```
public java.awt.Color getColor()
```
    This function returns the color the instance is representing.
    
    Returns:
    
    is the color the instance is representing
  - setColor
```
public void setColor(java.awt.Color color)
```
    Use this function to set the color the instance is representing.
    
    Parameters:
    
    color - is the color the instance should be representing
  - getHSB
```
public float[] getHSB()
```
    This function extracts hue, saturation and brightness of the color the instance is representing. The values are returned as an array of size 3, each value is in the range betwen 0 and 1.
    
    Returns:
    
    is an array consisting of the hue, saturation and brightness values (in this order). All values are given in a range between 0 and 1
    
    See Also:
    
    Color.RGBtoHSB(int, int, int, float[])
  - getHue
```
public float getHue()
```
    Extract the hue value from the color the instance is representing.
    
    Returns:
    
    the hue value in a range between 0 and 1
    
    See Also:
    
    Color.RGBtoHSB(int, int, int, float[])
  - setHue
```
public void setHue(float hue)
```
    Set a new hue value and let the brightness and saturation values untouched.
    
    Parameters:
    
    hue - is the new hue value from 0 to 1
  - getSaturation
```
public float getSaturation()
```
    Extract the saturation value from the color the instance is representing.
    
    Returns:
    
    the saturation value in a range between 0 and 1
    
    See Also:
    
    Color.RGBtoHSB(int, int, int, float[])
  - setSaturation
```
public void setSaturation(float saturation)
```
    Set a new saturation value and let the brightness and hue values untouched.
    
    Parameters:
    
    saturation - is the new saturation value from 0 to 1
  - getBrightness
```
public float getBrightness()
```
    Extract the brightness value from the color the instance is representing.
    
    Returns:
    
    the brightness value in a range between 0 and 1
    
    See Also:
    
    Color.RGBtoHSB(int, int, int, float[])
  - setBrightness
```
public void setBrightness(float brightness)
```
    Set a new brightness value and let the hue and saturation values untouched.
    
    Parameters:
    
    brightness - is the new brightness value from 0 to 1
  - getMilightHue
```
public int getMilightHue()
```
    This function extracts the hue value from the color the instance is representing and transforms it to a value that can be sent to the WiFi box. Therefore a linear change on the scale between 0 and 1 is applied setting 0 to 2/3, 1/3 to 1/3 and 2/3 to 0. Afterwards, the value is scaled to a maximum of MilightColor.MAX_COLOR.
    
    Returns:
    
    the hue value to send to the WiFi box
  - setMilightHue
```
public void setMilightHue(int milightHue)
```
    This function sets a new hue value given as it would be sent to the WiFiBox. This function inverts the computation at getMilightHue().
    
    Parameters:
    
    milightHue - is the hue value to set, given as it would be sent to the WiFiBox
  - getMilightBrightness
```
public int getMilightBrightness()
```
    This function extracts the brightness value from the color the instance is representing and transforms it to a value that can be sent to the WiFi box. Therefore the value is scaled to a scale between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS.
    
    Returns:
    
    the brightness value to send to the WiFi box
  - setMilightBrightness
```
public void setMilightBrightness(int milightBrightness)
```
    This function sets a new brightness value for the color the instance is representingThe value is given as it could be sent to the WiFiBox and internally transferred to a float. This reverses the computation of getMilightBrightness().
    
    Parameters:
    
    milightBrightness - is the brightness value to set, given as it would be sent to the WiFiBox
  - isWhiteMode
```
public boolean isWhiteMode()
```
    This function computes whether a color should be displayed in white or colored mode. The white mode will be used if the saturation of the color is below SATURATION_THRESHOLD.
    
    Returns:
    
    true if the white mode should be used, false if the colored mode should be used
  - isColoredMode
```
public boolean isColoredMode()
```
    This function computes whether a color should be displayed in white or colored mode. The white mode will be used if the saturation of the color is below SATURATION_THRESHOLD.
    
    Returns:
    
    true if the colored mode should be used, false if the white mode should be used
  - equals
```
public boolean equals(MilightColor color)
```
    This function checks whether two MilightColors represent the same color by comparing their hsb values.
    
    Parameters:
    
    color - the color to compare to
    
    Returns:
    
    true if both MilightColors represent the same color, false otherwise
  - getTransition
```
public MilightColor getTransition(MilightColor target,
                                  float x)
```
    This function finds colors between two MilightColors. By changing x from 0 to 1 the color will turn to the given one smoothly.
    
    Parameters:
    
    target - is the color to reach at x=1
    
    x - is the influence of the colors (x=0 returns this MilightColor, x=1 returns target)
    
    Returns:
    
    the newly created MilightColor between the given ones
  - toString
```
public java.lang.String toString()
```
    This function describes the objet as a string. Use this for debugging.
    
    Overrides:
    
    toString in class java.lang.Object

Class MilightColor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_COLOR

MAX_COLOR

MIN_BRIGHTNESS

MAX_BRIGHTNESS

SATURATION_THRESHOLD

Constructor Detail

MilightColor

Method Detail

getColor

setColor

getHSB

getHue

setHue

getSaturation

setSaturation

getBrightness

setBrightness

getMilightHue

setMilightHue

getMilightBrightness

setMilightBrightness

isWhiteMode

isColoredMode

equals

getTransition

toString