de.toman.milight

Class Timer

java.lang.Object

de.toman.milight.Timer

All Implemented Interfaces:

java.lang.Runnable

public class Timer
extends java.lang.Object
implements java.lang.Runnable

This class dims a group of lights over time from one brightness level to another in a smooth way. It supports the brightness value to get bigger or smaller and can switch the lights of in the end of the animation. The animation can run over a long time and is carried out in a seperate thread. Use the start() function to run this class in a seperate thread.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SLEEP_PER_CYCLE_DEFAULT The default amount of time to sleep between two adjustments in milliseconds.

Constructor Summary

Constructors

Constructor and Description
Timer(Lights lights, long time) This constructor creates a new timer that dims a group of lights from full brightness until switched off in the end.
Timer(Lights lights, long time, int brightnessLevelStart, int brightnessLevelGoal) This constructor creates a new timer that dims a group of lights during a longer time and switches the group of lights off in the end.
Timer(Lights lights, long time, int brightnessLevelStart, int brightnessLevelGoal, boolean switchOff) This constructor creates a new timer that dims a group of lights during a longer time.
Timer(Lights lights, long time, MilightColor colorStart, MilightColor colorGoal, boolean switchOff) This constructor creates a new timer that changes the color and brightness of a group of lights during a longer time.

Method Summary

Modifier and Type	Method and Description
void	addTimerListener(TimerListener listener) Use this function to add a new listener to the timer.
void	removeTimerListener(TimerListener listener) This function removes a listener from this timer which was added before by addTimerListener(TimerListener).
void	run() This function runs the timer with the settings given in the constructor resp.
void	setSleepPerCycle(int sleepPerCycle) Set the amount of time to sleep between two cycles.
void	start() This function starts the timer in a new thread.
void	stop() This function stops the thread running the timer.
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

SLEEP_PER_CYCLE_DEFAULT

public static final int SLEEP_PER_CYCLE_DEFAULT

The default amount of time to sleep between two adjustments in milliseconds.

See Also:

Constant Field Values

Constructor Detail

Timer

public Timer(Lights lights,
             long time,
             MilightColor colorStart,
             MilightColor colorGoal,
             boolean switchOff)
      throws java.io.IOException

This constructor creates a new timer that changes the color and brightness of a group of lights during a longer time. The timer will not be started immediately, you need to call the function start() to run the timer. The amount of time to sleep between two adjustments is set to SLEEP_PER_CYCLE_DEFAULT. You can change it with setSleepPerCycle(int).

Parameters:

lights - is the group of lights to dim

time - is the overall time until the timer should finish in milliseconds

colorStart - is color to start with

colorGoal - is color the group of lights should have in the end

switchOff - is true if the lights should be switched off after the animation ends

Throws:

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

Timer

public Timer(Lights lights,
             long time,
             int brightnessLevelStart,
             int brightnessLevelGoal,
             boolean switchOff)
      throws java.io.IOException,
             java.lang.IllegalArgumentException

This constructor creates a new timer that dims a group of lights during a longer time. The timer will not be started immediately, you need to call the function start() to run the timer. The amount of time to sleep between two adjustments is set to SLEEP_PER_CYCLE_DEFAULT. You can change it with setSleepPerCycle(int).

Parameters:

lights - is the group of lights to dim

time - is the overall time until the timer should finish in milliseconds

brightnessLevelStart - is the brightness level to start with (between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS)

brightnessLevelGoal - is the brightness level the group of lights should have in the end (between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS)

switchOff - is true if the lights should be switched off after the animation ends

Throws:

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

java.lang.IllegalArgumentException - if the brightness levels to start with or reach in the end are not between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS

Timer

public Timer(Lights lights,
             long time,
             int brightnessLevelStart,
             int brightnessLevelGoal)
      throws java.io.IOException,
             java.lang.IllegalArgumentException

This constructor creates a new timer that dims a group of lights during a longer time and switches the group of lights off in the end. The timer will not be started immediately, you need to call the function start() to run the timer. The amount of time to sleep between two adjustments is set to SLEEP_PER_CYCLE_DEFAULT. You can change it with setSleepPerCycle(int).

Parameters:

lights - is the group of lights to dim

time - is the overall time until the timer should finish in milliseconds

brightnessLevelStart - is the brightness level to start with (between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS)

brightnessLevelGoal - is the brightness level the group of lights should have in the end (between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS)

Throws:

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

java.lang.IllegalArgumentException - if the brightness levels to start with or reach in the end are not between MilightColor.MIN_BRIGHTNESS and MilightColor.MAX_BRIGHTNESS

Timer

public Timer(Lights lights,
             long time)
      throws java.io.IOException,
             java.lang.IllegalArgumentException

This constructor creates a new timer that dims a group of lights from full brightness until switched off in the end. The timer will not be started immediately, you need to call the function start() to run the timer. The amount of time to sleep between two adjustments is set to SLEEP_PER_CYCLE_DEFAULT. You can change it with setSleepPerCycle(int).

Parameters:

lights - is the group of lights to dim

time - is the overall time until the timer should finish in milliseconds

Throws:

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

java.lang.IllegalArgumentException

Method Detail

run

public void run()

This function runs the timer with the settings given in the constructor resp. setters. Use the function start to run this in a seperate thread.

Specified by:

run in interface java.lang.Runnable

See Also:

start()

stop

public void stop()

This function stops the thread running the timer. The timer can be resumed where it was interrupted by calling start again.

See Also:

start()

start

public void start()

This function starts the timer in a new thread.

setSleepPerCycle

public void setSleepPerCycle(int sleepPerCycle)

Set the amount of time to sleep between two cycles.

Parameters:

sleepPerCycle - is the amount of time to sleep between two cycles in milliseconds.

addTimerListener

public void addTimerListener(TimerListener listener)

Use this function to add a new listener to the timer. Listeners will be notified when the timer has finished its animation.

Parameters:

listener - is the listener to add

removeTimerListener

public void removeTimerListener(TimerListener listener)

This function removes a listener from this timer which was added before by addTimerListener(TimerListener).

Parameters:

listener - is the listener to remove

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