nl.kevinjilissen.ledcontroller

Class LEDStrip

java.lang.Object

nl.kevinjilissen.ledcontroller.LEDStrip

public final class LEDStrip
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
byte[]	getBlueData() Gets the internal array of all blue bytes.
byte	getBrightness() Gets the brightness of the strip in a range from 0 to 255 as a signed byte.
javafx.scene.paint.Color	getColor(int index) Gets the color of the strip at the given index.
Controller	getController() Gets the controller of this strip.
StripFrequenty	getFrequenty()
byte[]	getGreenData() Gets the internal array of all green bytes.
byte	getIBlue() Gets the blue byte of the initial color of this strip.
javafx.scene.paint.Color	getIColor() Gets the initial color of this strip.
byte	getIGreen() Gets the green byte of the initial color of this strip.
byte	getIRed() Gets the red byte of the initial color of this strip.
int	getLength() Gets the amount of LED pixels of this LED strip.
byte	getPin() Gets the pin on the microcontroller this LED strip is connected to.
byte[]	getRedData() Gets the internal array of all red bytes.
StripType	getType() Gets the type of LEDs on this strip.
boolean	isDirty() Checks if the data on the LED strip has been updated since the last output to the microcontroller ( or calling setDirty(false) ).
boolean	isLoading() Checks if this LED strip is currently loading data from the board.
boolean	isMultiColor() Checks if this strip is multicolor.
void	setBrightness(byte brightness) Sets the brightness of the strip in a range from 0 to 255 as a signed byte.
void	setColor(int index, byte red, byte green, byte blue) Sets the color of the LED at the given index to the given Color.
void	setColor(int index, javafx.scene.paint.Color color) Sets the color of the LED at the given index to the given Color.
void	setColors(byte red, byte green, byte blue) Sets the color of the complete strip to the given Color.
void	setColors(javafx.scene.paint.Color color) Sets the color of the complete strip to the given Color.
void	setController(Controller controller) Sets the controller of this strip.
void	setDirty(boolean dirty) Sets the dirty flag of this LED strip.
void	setFrequenty(StripFrequenty freq)
void	setIBlue(byte iblue) Sets the blue byte of the initial color of this strip.
void	setIColor(javafx.scene.paint.Color color) Sets the initial color of this strip.
void	setIGreen(byte igreen) Sets the green byte of the initial color of this strip.
void	setIRed(byte ired) Sets the red byte of the initial color of this strip.
void	setLength(int length) Sets the amount of LED pixels of this LED strip.
void	setLoading(boolean loading) Sets the loading flag of this LED strip.
void	setType(StripType type)

Methods inherited from class java.lang.Object

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

Method Detail

getBrightness

public byte getBrightness()

Gets the brightness of the strip in a range from 0 to 255 as a signed byte.

Returns:

The brightness of the LED strip.

setBrightness

public void setBrightness(byte brightness)

Sets the brightness of the strip in a range from 0 to 255 as a signed byte.

Parameters:

brightness - The brightness of the LED strip.

getIColor

public javafx.scene.paint.Color getIColor()

Gets the initial color of this strip. This color is the strips color on boot of the microcontroller and a fallback for the strip controller.

Returns:

The initial strip color as a new Color object.

setIColor

public void setIColor(javafx.scene.paint.Color color)

Sets the initial color of this strip. This color is the strips color on boot of the microcontroller and a fallback for the strip controller.

Parameters:

color - The initial color as a Color object.

getColor

public javafx.scene.paint.Color getColor(int index)

Gets the color of the strip at the given index. The index is used to access the internal byte array of colors.

Parameters:

index - The index of the desired color. Every LED represents 1 index.

Returns:

The color of the LED as a Color object.

setColors

public void setColors(javafx.scene.paint.Color color)

Sets the color of the complete strip to the given Color.

Parameters:

color - The color for all LEDs as a Color object.

setColors

public void setColors(byte red,
                      byte green,
                      byte blue)

Sets the color of the complete strip to the given Color.

Parameters:

red - The red byte in a range from 0 to 255 as a signed byte.

green - The green byte in a range from 0 to 255 as a signed byte.

blue - The blue byte in a range from 0 to 255 as a signed byte.

setColor

public void setColor(int index,
                     javafx.scene.paint.Color color)
              throws java.lang.UnsupportedOperationException

Sets the color of the LED at the given index to the given Color.

Parameters:

index - The index of the LED in the strip. Every LED represents 1 index.

color - The desired color as a Color object.

Throws:

java.lang.UnsupportedOperationException - Throws an exception if the controller of this strip doesn't support multicolor.

setColor

public void setColor(int index,
                     byte red,
                     byte green,
                     byte blue)
              throws java.lang.UnsupportedOperationException

Sets the color of the LED at the given index to the given Color.

Parameters:

index - The index of the LED in the strip. Every LED represents 1 index.

red - The red byte in a range from 0 to 255 as a signed byte.

green - The green byte in a range from 0 to 255 as a signed byte.

blue - The blue byte in a range from 0 to 255 as a signed byte.

Throws:

java.lang.UnsupportedOperationException - Throws an exception if the controller of this strip doesn't support multicolor.

getPin

public byte getPin()

Gets the pin on the microcontroller this LED strip is connected to.

Returns:

The pin on the microcontroller.

getType

public StripType getType()

Gets the type of LEDs on this strip.

Returns:

The strip type of this LED strip.

setType

public void setType(StripType type)

getFrequenty

public StripFrequenty getFrequenty()

setFrequenty

public void setFrequenty(StripFrequenty freq)

getLength

public int getLength()

Gets the amount of LED pixels of this LED strip.

Returns:

The length of the strip.

setLength

public void setLength(int length)

Sets the amount of LED pixels of this LED strip.

Parameters:

length - The new length.

getIRed

public byte getIRed()

Gets the red byte of the initial color of this strip.

Returns:

The red value byte as a signed byte in range 0-255.

setIRed

public void setIRed(byte ired)

Sets the red byte of the initial color of this strip.

Parameters:

ired - The new red value byte as a signed byte in range 0-255.

getIGreen

public byte getIGreen()

Gets the green byte of the initial color of this strip.

Returns:

The green value byte as a signed byte in range 0-255.

setIGreen

public void setIGreen(byte igreen)

Sets the green byte of the initial color of this strip.

Parameters:

igreen - The new green value byte as a signed byte in range 0-255.

getIBlue

public byte getIBlue()

Gets the blue byte of the initial color of this strip.

Returns:

The blue value byte as a signed byte in range 0-255.

setIBlue

public void setIBlue(byte iblue)

Sets the blue byte of the initial color of this strip.

Parameters:

iblue - The new blue value byte as a signed byte in range 0-255.

getRedData

public byte[] getRedData()

Gets the internal array of all red bytes. The array has the same length as this LED strip.

Returns:

The internal red data array.

getGreenData

public byte[] getGreenData()

Gets the internal array of all green bytes. The array has the same length as this LED strip.

Returns:

The internal green data array.

getBlueData

public byte[] getBlueData()

Gets the internal array of all blue bytes. The array has the same length as this LED strip.

Returns:

The internal blue data array.

isDirty

public boolean isDirty()

Checks if the data on the LED strip has been updated since the last output to the microcontroller ( or calling setDirty(false) ).

Returns:

True if this strip is dirty, false otherwise.

setDirty

public void setDirty(boolean dirty)

Sets the dirty flag of this LED strip. Only dirty strips will send color data to the LED controller. Calling one of the color setting methods will automatically change this flag to true.

Parameters:

dirty - The new dirty flag for this strip.

isLoading

public boolean isLoading()

Checks if this LED strip is currently loading data from the board. If true, the strip will not be updated and not visible in the user interface.

Returns:

True if this strip is loading, false otherwise.

setLoading

public void setLoading(boolean loading)

Sets the loading flag of this LED strip. Only non-loading strip will be updated.

Parameters:

loading - The new loading flag for this strip.

getController

public Controller getController()

Gets the controller of this strip. Every instance of a LED strip has its own instance of a controller.

Returns:

The controller of this strip, or null if this strip doesn't have a controller.

setController

public void setController(Controller controller)
                   throws java.lang.IllegalArgumentException

Sets the controller of this strip. Every instance of a LED strip has its own instance of a controller.

Parameters:

controller - The controller of this strip, or null if this strip shouldn't have a controller.

Throws:

java.lang.IllegalArgumentException - Throws an exception when the strip reference of the given controller isn't equal to this object.

isMultiColor

public boolean isMultiColor()

Checks if this strip is multicolor.

Returns:

False if this strip doesn't have a controller, returns the value of the controller otherwise.