de.toman.milight

Class Lights

java.lang.Object

de.toman.milight.Lights

public class Lights
extends java.lang.Object

This class represents a group of LED light bulbs that are connected to a WiFi box using the same group. These groups can be controlled individually, it is also possible to mix groups belonging to different WiFi boxes. To create a new Lights instance create a WiFiBox instance and call WiFiBox.getLights(int).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Lights(java.net.InetAddress address, int group) This constructor creates a new group of lights and a connection to a WiFi box using the default port.
protected	Lights(java.net.InetAddress address, int port, int group) This constructor creates a new group of lights and a connection to a WiFi box.
protected	Lights(java.lang.String host, int group) This constructor creates a new group of lights and a connection to a WiFi box using the default port.
protected	Lights(java.lang.String host, int port, int group) This constructor creates a new group of lights and a connection to a WiFi box.
protected	Lights(WiFiBox wifiBox, int group) This constructor creates a new group of lights for a given WiFi box.

Method Summary

Modifier and Type	Method and Description
void	addLightListener(LightListener listener) Use this function to add a new listener to the group of lights.
void	blink(java.awt.Color color) This function makes the light blink in a given color three times as a notification.
void	blink(java.awt.Color color, int times) This function makes the light blink in a given color as a notification.
void	blink(java.awt.Color color, int times, long colorTime, long whiteTime) This function makes the light blink in a given color as a notification.
void	brightness(int value) Set the brightness value for the group of lights.
void	color(java.awt.Color color) Set the color value for the group of lights.
void	color(java.awt.Color color, boolean forceColoredMode) Set the color value for the group of lights.
void	color(int value) Set the color value for the group of lights.
void	color(MilightColor color) Set the color value for the group of lights.
void	color(MilightColor color, boolean forceColoredMode) Set the color value for the group of lights.
void	colorAndBrightness(java.awt.Color color) Set the color and brightness values for the group of lights.
void	colorAndBrightness(java.awt.Color color, boolean forceColoredMode) Set the color and brightness values for the group of lights.
void	colorAndBrightness(MilightColor color) Set the color and brightness values for the group of lights.
void	colorAndBrightness(MilightColor color, boolean forceColoredMode) Set the color and brightness values for the group of lights.
void	discoMode() Switch the group of lights to the disco mode.
void	discoModeFaster() Increase the disco mode's speed.
void	discoModeSlower() Decrease the disco mode's speed.
int	getGroup() Get the number of the group of lights at the WiFi box.
LightObserver	getObserver() This function returns the LightObserver storing all the states of the group of lights.
WiFiBox	getWifiBox() Get the WiFi box used to control this group of lights.
void	off() Switch the group of lights off.
void	on() Switch the group of lights on and restore the last state.
void	removeLightListener(LightListener listener) This function removes a listener from this group of lights which was added before by addLightListener(LightListener).
java.lang.String	toString() This function describes the objet as a string.
void	white() Switch the group of lights to the wight mode and restore the last brightness value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Lights

protected Lights(WiFiBox wifiBox,
                 int group)
          throws java.lang.IllegalArgumentException

This constructor creates a new group of lights for a given WiFi box.

Parameters:

wifiBox - is the box controlling the group of lights

group - is the number of the group at the WiFi box (between 1 and 4)

Throws:

java.lang.IllegalArgumentException - if the group number is not between 1 and 4

Lights

protected Lights(java.net.InetAddress address,
                 int port,
                 int group)

This constructor creates a new group of lights and a connection to a WiFi box. If there is already a group of lights and you need to control another group connected to the same WiFi box then use light.getWiFiBox().getLights(group) instead to resuse the connection.

Parameters:

address - is the address of the WiFi box

port - is the port of the WiFi box (omit this if unsure)

group - is the number of the group at the WiFi box (between 1 and 4)

Throws:

java.lang.IllegalArgumentException - if the group number is not between 1 and 4

See Also:

to get the WiFi box connected to group of lights, to get another group of lights for the same WiFi box

Lights

protected Lights(java.net.InetAddress address,
                 int group)

This constructor creates a new group of lights and a connection to a WiFi box using the default port. If there is already a group of lights and you need to control another group connected to the same WiFi box then use light.getWiFiBox().getLights(group) instead to resuse the connection.

Parameters:

address - is the address of the WiFi box listening on the default port

group - is the number of the group at the WiFi box (between 1 and 4)

Throws:

java.lang.IllegalArgumentException - if the group number is not between 1 and 4

See Also:

to get the WiFi box connected to group of lights, to get another group of lights for the same WiFi box

Lights

protected Lights(java.lang.String host,
                 int port,
                 int group)
          throws java.net.UnknownHostException

This constructor creates a new group of lights and a connection to a WiFi box. If there is already a group of lights and you need to control another group connected to the same WiFi box then use light.getWiFiBox().getLights(group) instead to resuse the connection.

Parameters:

host - is the host given as hostname such as "domain.tld" or string repesentation of an ip address

port - is the port of the WiFi box (omit this if unsure)

group - is the number of the group at the WiFi box (between 1 and 4)

Throws:

java.lang.IllegalArgumentException - if the group number is not between 1 and 4

java.net.UnknownHostException - if the hostname could not be resolved

See Also:

to get the WiFi box connected to group of lights, to get another group of lights for the same WiFi box

Lights

protected Lights(java.lang.String host,
                 int group)
          throws java.net.UnknownHostException

This constructor creates a new group of lights and a connection to a WiFi box using the default port. If there is already a group of lights and you need to control another group connected to the same WiFi box then use light.getWiFiBox().getLights(group) instead to resuse the connection.

Parameters:

host - is the host given as hostname such as "domain.tld" or string repesentation of an ip address

group - is the number of the group at the WiFi box (between 1 and 4)

Throws:

java.lang.IllegalArgumentException - if the group number is not between 1 and 4

java.net.UnknownHostException - if the hostname could not be resolved

See Also:

to get the WiFi box connected to group of lights, to get another group of lights for the same WiFi box

Method Detail

getWifiBox

public WiFiBox getWifiBox()

Get the WiFi box used to control this group of lights.

Returns:

the WiFi box used to control this group of lights

getGroup

public int getGroup()

Get the number of the group of lights at the WiFi box.

Returns:

the number of the group of lights at the WiFi box

on

public void on()
        throws java.io.IOException

Switch the group of lights on and restore the last state.

Throws:

java.io.IOException - if the message could not be sent

off

public void off()
         throws java.io.IOException

Switch the group of lights off.

Throws:

java.io.IOException - if the message could not be sent

white

public void white()
           throws java.io.IOException

Switch the group of lights to the wight mode and restore the last brightness value.

Throws:

java.io.IOException - if the message could not be sent

discoMode

public void discoMode()
               throws java.io.IOException

Switch the group of lights to the disco mode.

Throws:

java.io.IOException - if the message could not be sent

discoModeFaster

public void discoModeFaster()
                     throws java.io.IOException

Increase the disco mode's speed.

Throws:

java.io.IOException - if the message could not be sent

discoModeSlower

public void discoModeSlower()
                     throws java.io.IOException

Decrease the disco mode's speed.

Throws:

java.io.IOException - if the message could not be sent

brightness

public void brightness(int value)
                throws java.io.IOException,
                       java.lang.IllegalArgumentException

Set the brightness value for the group of lights.

Parameters:

value - is the brightness value to set (between WiFiBox.MIN_BRIGHTNESS and WiFiBox.MAX_BRIGHTNESS)

Throws:

java.io.IOException - if the message could not be sent

java.lang.IllegalArgumentException - if the brightness value is not between WiFiBox.MIN_BRIGHTNESS and WiFiBox.MAX_BRIGHTNESS

color

public void color(int value)
           throws java.io.IOException,
                  java.lang.IllegalArgumentException

Set the color value for the group of lights.

Parameters:

value - is the color value to set (between WiFiBox.MIN_COLOR and WiFiBox.MAX_COLOR)

Throws:

java.io.IOException - if the message could not be sent

java.lang.IllegalArgumentException - if the color value is not between WiFiBox.MIN_COLOR and WiFiBox.MAX_COLOR

color

public void color(MilightColor color,
                  boolean forceColoredMode)
           throws java.io.IOException

Set the color value for the group of lights.

Parameters:

color - is the color to set

forceColoredMode - true if all colors should be displayed in colored mode, false to use white mode for colors with low saturation and else colored mode

Throws:

java.io.IOException - if the message could not be sent

color

public void color(MilightColor color)
           throws java.io.IOException

Set the color value for the group of lights. Colors with low saturation will be displayed in white mode for a better result.

Parameters:

color - is the color to set

Throws:

java.io.IOException - if the message could not be sent

color

public void color(java.awt.Color color,
                  boolean forceColoredMode)
           throws java.io.IOException

Set the color value for the group of lights.

Parameters:

color - is the color to set

forceColoredMode - true if all colors should be displayed in colored mode, false to use white mode for colors with low saturation and else colored mode

Throws:

java.io.IOException - if the message could not be sent

color

public void color(java.awt.Color color)
           throws java.io.IOException

Set the color value for the group of lights. Colors with low saturation will be displayed in white mode for a better result.

Parameters:

color - is the color to set

Throws:

java.io.IOException - if the message could not be sent

colorAndBrightness

public void colorAndBrightness(MilightColor color,
                               boolean forceColoredMode)

Set the color and brightness values for the group of lights. Both values are extracted from the color given to the function by transforming it to an HSB color.

Parameters:

color - is the color to extract hue and brightness from

forceColoredMode - true if all colors should be displayed in colored mode, false to use white mode for colors with low saturation and else colored mode

colorAndBrightness

public void colorAndBrightness(MilightColor color)

Set the color and brightness values for the group of lights. Both values are extracted from the color given to the function by transforming it to an HSB color. Colors with low saturation will be displayed in white mode for a better result.

Parameters:

color - is the color to extract hue and brightness from

colorAndBrightness

public void colorAndBrightness(java.awt.Color color,
                               boolean forceColoredMode)

Set the color and brightness values for the group of lights. Both values are extracted from the color given to the function by transforming it to an HSB color.

Parameters:

color - is the color to extract hue and brightness from

forceColoredMode - true if all colors should be displayed in colored mode, false to use white mode for colors with low saturation and else colored mode

colorAndBrightness

public void colorAndBrightness(java.awt.Color color)

Set the color and brightness values for the group of lights. Both values are extracted from the color given to the function by transforming it to an HSB color. Colors with low saturation will be displayed in white mode for a better result.

Parameters:

color - is the color to extract hue and brightness from

blink

public void blink(java.awt.Color color,
                  int times,
                  long colorTime,
                  long whiteTime)
           throws java.lang.IllegalArgumentException

This function makes the light blink in a given color as a notification. The messages will be sent in a new thread.

Parameters:

color - is the color to blink in (white mode in the mean time)

times - is the number of times to blink

colorTime - is the time to stay in colored mode in milliseconds

whiteTime - is the time to stay in white mode (between blinking) in milliseconds

Throws:

java.lang.IllegalArgumentException - if the time in colored or white mode is not at least 2*WiFiBox.MIN_SLEEP_BETWEEN_MESSAGES or the times variable is non-positive

blink

public void blink(java.awt.Color color,
                  int times)
           throws java.lang.IllegalArgumentException

This function makes the light blink in a given color as a notification. The each phase of the blinking will last one second. The messages will be sent in a new thread.

Parameters:

color - is the color to blink in (white mode in the mean time)

times - is the number of times to blink

Throws:

java.lang.IllegalArgumentException - if the times variable is non-positive

blink

public void blink(java.awt.Color color)
           throws java.lang.IllegalArgumentException

This function makes the light blink in a given color three times as a notification. The each phase of the blinking will last one second. The messages will be sent in a new thread.

Parameters:

color - is the color to blink in (white mode in the mean time)

Throws:

java.lang.IllegalArgumentException

addLightListener

public void addLightListener(LightListener listener)

Use this function to add a new listener to the group of lights. Listeners will be notified when the group of lights is switched on or off, color or brightness change, white or disco mode is activated or disco mode is set faster or slower.

Parameters:

listener - is the listener to add

removeLightListener

public void removeLightListener(LightListener listener)

This function removes a listener from this group of lights which was added before by addLightListener(LightListener).

Parameters:

listener - is the listener to remove

getObserver

public LightObserver getObserver()

This function returns the LightObserver storing all the states of the group of lights.

Returns:

the LightObserver storing all the states of the group of lights

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