com.mbientlab.metawear.module

Interface NeoPixel.Strand

Enclosing interface:

NeoPixel

public static interface NeoPixel.Strand

Represents a NeoPixel strand

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NeoPixel.Strand.RotationDirection Enumeration of rotation directions

Method Summary

Modifier and Type	Method and Description
void	clear(byte start, byte end) Clears the LEDs in the given range
void	free() Free resources allocated by the firmware for this strand.
void	hold() Enables strand holding.
int	nLeds() Return the number of Leds initialized for the strand
void	release() Disables strand holding.
void	rotate(NeoPixel.Strand.RotationDirection direction, byte repetitions, short period) Rotate the LED color patterns on a strand
void	rotate(NeoPixel.Strand.RotationDirection direction, short period) Rotate the LED color patterns on a strand indefinitely
void	setRgb(byte index, byte red, byte green, byte blue) Set and LED's rgb values
void	stopRotation() Stops the LED rotation

Method Detail

free

void free()

Free resources allocated by the firmware for this strand. After calling free, this object is no longer valid and should be discarded

hold

void hold()

Enables strand holding. When enabled, the strand will not refresh with any LED changes until the hold is disabled. This allows you to form complex LED patterns without having the strand refresh with partial changes.

release

void release()

Disables strand holding. The strand will be refreshed with any LED changes programmed while the hold was active

clear

void clear(byte start,
           byte end)

Clears the LEDs in the given range

Parameters:

start - Led index to start clearing from

end - Led index to clear to, exclusive

setRgb

void setRgb(byte index,
            byte red,
            byte green,
            byte blue)

Set and LED's rgb values

Parameters:

index - LED index to set, from [0, nLeds - 1]

red - Red value, between [0, 255]

green - Green value, between [0, 255]

blue - Blue value, between [0, 255]

rotate

void rotate(NeoPixel.Strand.RotationDirection direction,
            byte repetitions,
            short period)

Rotate the LED color patterns on a strand

Parameters:

direction - Rotation direction

repetitions - Number of times to repeat the rotation

period - Amount of time, in milliseconds, between rotations

rotate

void rotate(NeoPixel.Strand.RotationDirection direction,
            short period)

Rotate the LED color patterns on a strand indefinitely

Parameters:

direction - Rotation direction

period - Amount of time, in milliseconds, between rotations

stopRotation

void stopRotation()

Stops the LED rotation

nLeds

int nLeds()

Return the number of Leds initialized for the strand

Returns:

Number of initialized LEDs