com.mbientlab.metawear.module

Interface Led

All Superinterfaces:

MetaWearBoard.Module

public interface Led
extends MetaWearBoard.Module

Ultra bright RGB light emitting diode

Author:

Eric Tsai

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Led.Color Enumeration of available colors on the LED
static interface	Led.PatternEditor Interface to edit pattern attributes
static class	Led.PatternPreset Enumeration of patterns from the blog post

Field Summary

Fields

Modifier and Type	Field and Description
static byte	PATTERN_REPEAT_INDEFINITELY Constant for PatternEditor.setRepeatCount indicating the pattern should repeat forever

Method Summary

Modifier and Type	Method and Description
void	autoplay() Play any programmed patterns and immediately plays patterns programmed later
Led.PatternEditor	editPattern(Led.Color ledColor) Edit the pattern attributes for the desired color
Led.PatternEditor	editPattern(Led.Color ledColor, Led.PatternPreset preset) Edit the pattern attributes for the desired color using a preset pattern as the initial attribute parameters
void	pause() Pause the pattern playback
void	play() Play any programmed patterns
void	stop(boolean clear) Stop playing LED patterns

Field Detail

PATTERN_REPEAT_INDEFINITELY

static final byte PATTERN_REPEAT_INDEFINITELY

Constant for PatternEditor.setRepeatCount indicating the pattern should repeat forever

See Also:

Led.PatternEditor.repeatCount(byte), Constant Field Values

Method Detail

editPattern

Led.PatternEditor editPattern(Led.Color ledColor)

Edit the pattern attributes for the desired color

Parameters:

ledColor - Color to configure

Returns:

Editor object to configure the pattern attributes

editPattern

Led.PatternEditor editPattern(Led.Color ledColor,
                              Led.PatternPreset preset)

Edit the pattern attributes for the desired color using a preset pattern as the initial attribute parameters

Parameters:

ledColor - Color to configure

preset - Pattern preset to use

Returns:

Editor object to configure the pattern attributes

autoplay

void autoplay()

Play any programmed patterns and immediately plays patterns programmed later

play

void play()

Play any programmed patterns

pause

void pause()

Pause the pattern playback

stop

void stop(boolean clear)

Stop playing LED patterns

Parameters:

clear - True if the patterns should be cleared as well