com.mbientlab.metawear.module

Interface NeoPixel

All Superinterfaces:

MetaWearBoard.Module

public interface NeoPixel
extends MetaWearBoard.Module

Controls NeoPixel strands connected to the board

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NeoPixel.ColorOrdering Color ordering for the NeoPixel color values
static class	NeoPixel.RotationDirection Enumeration of rotation directions
static class	NeoPixel.StrandSpeed Operating speeds for a NeoPixel strand

Method Summary

Methods

Modifier and Type	Method and Description
void	clearStrand(byte strand, byte start, byte end) Clear pixel states on a strand
void	deinitializeStrand(byte strand) Free resources on the MetaWeard board for a NeoPixel strand
void	holdStrand(byte strand) Enables strand holding.
void	initializeStrand(byte strand, NeoPixel.ColorOrdering ordering, NeoPixel.StrandSpeed speed, byte gpioPin, byte length) Initialize memory on the MetaWear board for a NeoPixel strand
void	releaseHold(byte strand) Disables strand holding.
void	rotate(byte strand, NeoPixel.RotationDirection direction, byte repetitions, short period) Rotate the pixels on a strand
void	rotate(byte strand, NeoPixel.RotationDirection direction, short period) Rotate the pixels on a strand indefinitely
void	setPixel(byte strand, byte pixel, byte red, byte green, byte blue) Set pixel color
void	stopRotation(byte strand) Stops the LED rotation

Method Detail

initializeStrand

void initializeStrand(byte strand,
                    NeoPixel.ColorOrdering ordering,
                    NeoPixel.StrandSpeed speed,
                    byte gpioPin,
                    byte length)

Initialize memory on the MetaWear board for a NeoPixel strand

Parameters:

strand - Strand number (id) to initialize, can be in the range [0, 2]

ordering - Color ordering format

speed - Operating speed

gpioPin - GPIO pin the strand is connected to

length - Number of pixels to initialize

deinitializeStrand

void deinitializeStrand(byte strand)

Free resources on the MetaWeard board for a NeoPixel strand

Parameters:

strand - Strand index to free

holdStrand

void holdStrand(byte strand)

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.

Parameters:

strand - Strand number (id) to hold

releaseHold

void releaseHold(byte strand)

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

Parameters:

strand - Strand number (id) to release

clearStrand

void clearStrand(byte strand,
               byte start,
               byte end)

Clear pixel states on a strand

Parameters:

strand - Strand number to clear

start - Pixel index to start clearing from

end - Pixel index to clear to, inclusive

setPixel

void setPixel(byte strand,
            byte pixel,
            byte red,
            byte green,
            byte blue)

Set pixel color

Parameters:

strand - Strand number the pixel is on

pixel - Index of the pixel

red - Red value, between [0, 255]

green - Green value, between [0, 255]

blue - Blue value, between [0, 255]

rotate

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

Rotate the pixels on a strand

Parameters:

strand - Strand to rotate

direction - Rotation direction

repetitions - Number of times to repeat the rotation

period - Amount of time, in milliseconds, between rotations

rotate

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

Rotate the pixels on a strand indefinitely

Parameters:

strand - Strand to rotate

direction - Rotation direction

period - Amount of time, in milliseconds, between rotations

stopRotation

void stopRotation(byte strand)

Stops the LED rotation

Parameters:

strand - Strand to stop LED rotation