BlinkStick Interface. A reference to a class implementing this interface is returned by BlinkStickFinder class. More...

Inheritance diagram for BlinkStickInterop.IBlinkStick:

Public Member Functions
void	SetColor (byte r, byte g, byte b)
	Sets the color of the led. More...

void	SetColorCSS (String color)
	Sets the color of the led. More...

void	SetIndexedColor (byte channel, byte index, byte r, byte g, byte b)
	Sets the color of the led. More...

void	SetIndexedColorCSS (byte channel, byte index, String color)
	Sets the color of the led. More...

void	TurnOff ()
	Turn BlinkStick off. More...

void	SetRepeats (int repeats)
	Set the number of repeats for Blink and Pulse functions More...

void	SetDelay (int delay)
	Sets the delay for Blink function. More...

void	SetDuration (int duration)
	Sets the duration for Pulse and Morph animations. More...

void	SetSteps (int steps)
	Sets the number of steps for Pulse and Morph animations. More...

void	Blink (byte r, byte g, byte b)
	Blink the LED. SetRepeats and SetDelay functions control animation parameters. More...

void	BlinkCSS (String color)
	Blink the LED. SetRepeats and SetDelay functions control animation parameters. More...

void	BlinkIndexed (byte channel, byte index, byte r, byte g, byte b)
	Blink an LED on BlinkStick Pro. SetRepeats and SetDelay functions control animation parameters. More...

void	BlinkIndexedCSS (byte channel, byte index, String color)
	Blink an LED on BlinkStick Pro. SetRepeats and SetDelay functions control animation parameters. More...

void	Pulse (byte r, byte g, byte b)
	Pulse specified color. SetDuration and SetSteps control the animation parameters. More...

void	PulseCSS (String color)
	Pulse specified color. SetDuration and SetSteps control the animation parameters. More...

void	PulseIndexed (byte channel, byte index, byte r, byte g, byte b)
	Pulse specified color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters. More...

void	PulseIndexedCSS (byte channel, byte index, String color)
	Pulse specified color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters. More...

void	Morph (byte r, byte g, byte b)
	Morph from current color to new color. SetDuration and SetSteps control the animation parameters. More...

void	MorphCSS (String color)
	Morph from current color to new color. SetDuration and SetSteps control the animation parameters. More...

void	MorphIndexed (byte channel, byte index, byte r, byte g, byte b)
	Morph from current color to new color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters. More...

void	MorphIndexedCSS (byte channel, byte index, String color)
	Morph from current color to new color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters. More...

void	SetColors (byte channel, [In] ref Byte[] colorData)
	Send a packet of data to LEDs on BlinkStick Pro More...

String	GetManufacturer ()
	Gets the manufacturer of the BlinkStick device. More...

String	GetSerial ()
	Returns the serial number of BlinkStick. More...

int	GetVersionMajor ()
	Gets the major version number from serial number. More...

int	GetVersionMinor ()
	Gets the minor version number from serial number. More...

String	GetProductName ()
	Gets the product name of the device. More...

String	GetInfoBlock1 ()
	Gets the name of the device (InfoBlock1). More...

String	GetInfoBlock2 ()
	Gets the data on the device (InfoBlock2). More...

void	SetInfoBlock1 (String data)
	Sets the name of the device (InfoBlock1). More...

void	SetInfoBlock2 (String data)
	Sets the data on the device (InfoBlock2). More...

void	SetMode (byte mode)
	Sets the mode on BlinkStick Pro. More...

byte	GetMode ()
	Gets the mode on BlinkStick Pro. More...

Detailed Description

BlinkStick Interface. A reference to a class implementing this interface is returned by BlinkStickFinder class.

Member Function Documentation

void BlinkStickInterop.IBlinkStick.Blink	(	byte	r,
		byte	g,
		byte	b
	)

Blink the LED. SetRepeats and SetDelay functions control animation parameters.

Parameters

r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.BlinkCSS ( String color )

Blink the LED. SetRepeats and SetDelay functions control animation parameters.

Parameters

color Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.BlinkIndexed	(	byte	channel,
		byte	index,
		byte	r,
		byte	g,
		byte	b
	)

Blink an LED on BlinkStick Pro. SetRepeats and SetDelay functions control animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.BlinkIndexedCSS	(	byte	channel,
		byte	index,
		String	color
	)

Blink an LED on BlinkStick Pro. SetRepeats and SetDelay functions control animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
color	Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

String BlinkStickInterop.IBlinkStick.GetInfoBlock1 ( )

Gets the name of the device (InfoBlock1).

Returns: String value of InfoBlock1

Implemented in BlinkStickInterop.BlinkStick.

String BlinkStickInterop.IBlinkStick.GetInfoBlock2 ( )

Gets the data on the device (InfoBlock2).

Returns: String value of InfoBlock2

Implemented in BlinkStickInterop.BlinkStick.

String BlinkStickInterop.IBlinkStick.GetManufacturer ( )

Gets the manufacturer of the BlinkStick device.

Returns: The manufacturer name as string.

Implemented in BlinkStickInterop.BlinkStick.

byte BlinkStickInterop.IBlinkStick.GetMode ( )

Gets the mode on BlinkStick Pro.

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

Implemented in BlinkStickInterop.BlinkStick.

String BlinkStickInterop.IBlinkStick.GetProductName ( )

Gets the product name of the device.

Returns: Returns the name of the product.

Implemented in BlinkStickInterop.BlinkStick.

String BlinkStickInterop.IBlinkStick.GetSerial ( )

Returns the serial number of BlinkStick.

BSnnnnnn-1.0
||  |    | |- Software minor version
||  |    |--- Software major version
||  |-------- Denotes sequential number
||----------- Denotes BlinkStick device

Software version defines the capabilities of the device

Returns: Returns the serial.

Implemented in BlinkStickInterop.BlinkStick.

int BlinkStickInterop.IBlinkStick.GetVersionMajor ( )

Gets the major version number from serial number.

Returns: Returns the major version number.

Implemented in BlinkStickInterop.BlinkStick.

int BlinkStickInterop.IBlinkStick.GetVersionMinor ( )

Gets the minor version number from serial number.

Returns: Returns the version minor.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.Morph	(	byte	r,
		byte	g,
		byte	b
	)

Morph from current color to new color. SetDuration and SetSteps control the animation parameters.

Parameters

r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.MorphCSS ( String color )

Morph from current color to new color. SetDuration and SetSteps control the animation parameters.

Parameters

color Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.MorphIndexed	(	byte	channel,
		byte	index,
		byte	r,
		byte	g,
		byte	b
	)

Morph from current color to new color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.MorphIndexedCSS	(	byte	channel,
		byte	index,
		String	color
	)

Morph from current color to new color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
color	Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.Pulse	(	byte	r,
		byte	g,
		byte	b
	)

Pulse specified color. SetDuration and SetSteps control the animation parameters.

Parameters

r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.PulseCSS ( String color )

Pulse specified color. SetDuration and SetSteps control the animation parameters.

Parameters

color Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.PulseIndexed	(	byte	channel,
		byte	index,
		byte	r,
		byte	g,
		byte	b
	)

Pulse specified color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.PulseIndexedCSS	(	byte	channel,
		byte	index,
		String	color
	)

Pulse specified color on BlinkStick Pro. SetDuration and SetSteps control the animation parameters.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
color	Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetColor	(	byte	r,
		byte	g,
		byte	b
	)

Sets the color of the led.

Parameters

r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetColorCSS ( String color )

Sets the color of the led.

Parameters

color Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetColors	(	byte	channel,
		[In] ref Byte[]	colorData
	)

Send a packet of data to LEDs on BlinkStick Pro

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 ...]

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetDelay ( int delay )

Sets the delay for Blink function.

Parameters

delay Delay in milliseconds for on/off pulse. Defaults to 500

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetDuration ( int duration )

Sets the duration for Pulse and Morph animations.

Parameters

duration Duration in milliseconds. Defaults to 1000

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetIndexedColor	(	byte	channel,
		byte	index,
		byte	r,
		byte	g,
		byte	b
	)

Sets the color of the led.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
r	The red component.
g	The green component.
b	The blue component.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetIndexedColorCSS	(	byte	channel,
		byte	index,
		String	color
	)

Sets the color of the led.

Parameters

channel	Channel (0 - R, 1 - G, 2 - B)
index	Index of the LED
color	Must be in #rrggbb format

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetInfoBlock1 ( String data )

Sets the name of the device (InfoBlock1).

Parameters

data	String value to set for InfoBlock1

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetInfoBlock2 ( String data )

Sets the data on the device (InfoBlock2).

Parameters

data	String value to set for InfoBlock2

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetMode ( byte mode )

Sets the mode on BlinkStick Pro.

Parameters

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

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetRepeats ( int repeats )

Set the number of repeats for Blink and Pulse functions

Parameters

repeats Number of repeats. Defaults to 1.

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.SetSteps ( int steps )

Sets the number of steps for Pulse and Morph animations.

Parameters

steps Number of steps for animation. More steps result in smoother transitions between colors. Defaults to 50

Implemented in BlinkStickInterop.BlinkStick.

void BlinkStickInterop.IBlinkStick.TurnOff ( )

Turn BlinkStick off.

Implemented in BlinkStickInterop.BlinkStick.

The documentation for this interface was generated from the following file:

BlinkStickInterop/BlinkStick.cs

Public Member Functions

Detailed Description

Member Function Documentation