blinkstick

Class BlinkStick

java.lang.Object

blinkstick.BlinkStick

public class BlinkStick
extends Object

Author:

Arvydas

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRODUCT_ID BlinkStick product ID
static int	VENDOR_ID BlinkStick vendor ID
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
BlinkStick()

Method Summary

Methods

Modifier and Type	Method and Description
static BlinkStick[]	findAll() Find all BlinkSticks connected to the computer
static BlinkStick	findBySerial(String serial) Find BlinkStick by serial number
static BlinkStick	findFirst() Find first BlinkStick connected to the computer
int	getColor() Get the current color of the device as int
String	getColorString() Get the current color of the device in #rrggbb format
String	getInfoBlock1() Get value of InfoBlock1
String	getInfoBlock2() Get value of InfoBlock2
String	getManufacturer() Get the manufacturer of the device
byte	getMode() Get the mode of BlinkStick Pro
String	getProduct() Get the product description of the device
String	getSerial() Get the serial number of the device
static void	Initialize() Load hidapi library based on the OS.
void	setColor(byte r, byte g, byte b) Set the color of the device with separate r, g and b byte values
void	setColor(int value) Set the color of the device with Processing color value
void	setColor(int r, int g, int b) Set the color of the device with separate r, g and b int values.
void	setColor(String value) Set the color of the device with string value
void	setColors(byte[] colorData) Send a packet of data to LEDs on channel 0 (R)
void	setColors(byte channel, byte[] colorData) Send a packet of data to LEDs
void	setColors(int channel, byte[] colorData) Send a packet of data to LEDs
void	setIndexedColor(byte channel, byte index, byte r, byte g, byte b) Set indexed color of the device with separate r, g and b byte values for channel and LED index
void	setIndexedColor(int index, int value) Set the indexed color of BlinkStick Pro with Processing color value for channel 0
void	setIndexedColor(int channel, int index, int value) Set the indexed color of BlinkStick Pro with Processing color value
void	setIndexedColor(int channel, int index, int r, int g, int b) Set indexed color of the device with separate r, g and b byte values for channel and LED index
void	setInfoBlock1(String value) Set value for InfoBlock1
void	setInfoBlock2(String value) Set value for InfoBlock2
void	setMode(byte mode) Set the mode of BlinkStick Pro as byte
void	setMode(int mode) Set the mode of BlinkStick Pro as int
void	setRandomColor() Set random color
void	turnOff() Turn the device off
static String	version() return the version of the library.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

VENDOR_ID

public static final int VENDOR_ID

BlinkStick vendor ID

See Also:

Constant Field Values

PRODUCT_ID

public static final int PRODUCT_ID

BlinkStick product ID

See Also:

Constant Field Values

Constructor Detail

BlinkStick

public BlinkStick()

Method Detail

version

public static String version()

return the version of the library.

Returns:

String

Initialize

public static void Initialize()

Load hidapi library based on the OS. This function is automatically called whenever a search for BlinkStick is performed for the first time.

findFirst

public static BlinkStick findFirst()

Find first BlinkStick connected to the computer

Returns:

BlinkStick object or null if no BlinkSticks are connected

findBySerial

public static BlinkStick findBySerial(String serial)

Find BlinkStick by serial number

Parameters:

serial - The serial number to search

Returns:

BlinkStick object or null if device was not found

findAll

public static BlinkStick[] findAll()

Find all BlinkSticks connected to the computer

Returns:

an array of BlinkStick objects

setColor

public void setColor(int r,
            int g,
            int b)

Set the color of the device with separate r, g and b int values. The values are automatically converted to byte values

Parameters:

r - red int color value 0..255

g - gree int color value 0..255

b - blue int color value 0..255

setColor

public void setColor(byte r,
            byte g,
            byte b)

Set the color of the device with separate r, g and b byte values

Parameters:

r - red byte color value 0..255

g - gree byte color value 0..255

b - blue byte color value 0..255

setIndexedColor

public void setIndexedColor(int channel,
                   int index,
                   int r,
                   int g,
                   int b)

Set indexed color of the device with separate r, g and b byte values for channel and LED index

Parameters:

channel - Channel (0 - R, 1 - G, 2 - B)

index - Index of the LED

r - red int color value 0..255

g - gree int color value 0..255

b - blue int color value 0..255

setIndexedColor

public void setIndexedColor(byte channel,
                   byte index,
                   byte r,
                   byte g,
                   byte b)

Set indexed color of the device with separate r, g and b byte values for channel and LED index

Parameters:

channel - Channel (0 - R, 1 - G, 2 - B)

index - Index of the LED

r - red byte color value 0..255

g - gree byte color value 0..255

b - blue byte color value 0..255

setIndexedColor

public void setIndexedColor(int channel,
                   int index,
                   int value)

Set the indexed color of BlinkStick Pro with Processing color value

Parameters:

channel - Channel (0 - R, 1 - G, 2 - B)

index - Index of the LED

value - color as int

setIndexedColor

public void setIndexedColor(int index,
                   int value)

Set the indexed color of BlinkStick Pro with Processing color value for channel 0

Parameters:

index - Index of the LED

value - color as int

setColor

public void setColor(int value)

Set the color of the device with Processing color value

Parameters:

value - color as int

setColor

public void setColor(String value)

Set the color of the device with string value

Parameters:

value - this can either be a named color "red", "green", "blue" and etc. or a hex color in #rrggbb format

setRandomColor

public void setRandomColor()

Set random color

turnOff

public void turnOff()

Turn the device off

getColor

public int getColor()

Get the current color of the device as int

Returns:

The current color of the device as int

getColorString

public String getColorString()

Get the current color of the device in #rrggbb format

Returns:

Returns the current color of the device as #rrggbb formated string

getInfoBlock1

public String getInfoBlock1()

Get value of InfoBlock1

Returns:

The value of info block 1

getInfoBlock2

public String getInfoBlock2()

Get value of InfoBlock2

Returns:

The value of info block 2

setInfoBlock1

public void setInfoBlock1(String value)

Set value for InfoBlock1

Parameters:

value - The value to be written to the info block 1

setInfoBlock2

public void setInfoBlock2(String value)

Set value for InfoBlock2

Parameters:

value - The value to be written to the info block 2

getManufacturer

public String getManufacturer()

Get the manufacturer of the device

Returns:

Returns the manufacturer name of the device

getProduct

public String getProduct()

Get the product description of the device

Returns:

Returns the product name of the device.

getSerial

public String getSerial()

Get the serial number of the device

Returns:

Returns the serial number of device.

setColors

public void setColors(byte[] colorData)

Send a packet of data to LEDs on channel 0 (R)

Parameters:

colorData - Report data must be a byte array in the following format: [g0, r0, b0, g1, r1, b1, g2, r2, b2 ...]

setColors

public void setColors(int channel,
             byte[] colorData)

Send a packet of data to LEDs

Parameters:

channel - Channel (0 - R, 1 - G, 2 - B)

colorData - Report data must be a byte array in the following format: [g0, r0, b0, g1, r1, b1, g2, r2, b2 ...]

setColors

public void setColors(byte channel,
             byte[] colorData)

Send a packet of data to LEDs

Parameters:

channel - Channel (0 - R, 1 - G, 2 - B)

colorData - Report data must be a byte array in the following format: [g0, r0, b0, g1, r1, b1, g2, r2, b2 ...]

setMode

public void setMode(int mode)

Set the mode of BlinkStick Pro as int

Parameters:

mode - 0 - Normal, 1 - Inverse, 2 - WS2812, 3 - WS2812 mirror

setMode

public void setMode(byte mode)

Set the mode of BlinkStick Pro as byte

Parameters:

mode - 0 - Normal, 1 - Inverse, 2 - WS2812, 3 - WS2812 mirror

getMode

public byte getMode()

Get the mode of BlinkStick Pro

Returns:

0 - Normal, 1 - Inverse, 2 - WS2812, 3 - WS2812 mirror