com.mbientlab.metawear.api.controller

Interface LED.ChannelDataWriter

Enclosing interface:

LED

public static interface LED.ChannelDataWriter

Helper class to facilitate writing pulse information to a color channel

Author:

Eric Tsai

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Write the settings to the board
LED.ColorChannel	getChannel() Color the writing is setting
LED.ChannelDataWriter	withFallTime(short time) How long the transition should take from high to low state, in milliseconds
LED.ChannelDataWriter	withHighIntensity(byte intensity) Intensity value of the high state
LED.ChannelDataWriter	withHighTime(short time) How long the pulse stays in the high state
LED.ChannelDataWriter	withLowIntensity(byte intensity) Intensity value of the low state
LED.ChannelDataWriter	withPulseDuration(short duration) How long one pulse is
LED.ChannelDataWriter	withPulseOffset(short offset) How long to wait before starting the first pulse
LED.ChannelDataWriter	withRepeatCount(byte count) How many times to repeat a pulse pattern
LED.ChannelDataWriter	withRiseTime(short time) How long the transition should take from low to high state, in milliseconds

Method Detail

getChannel

LED.ColorChannel getChannel()

Color the writing is setting

withHighIntensity

LED.ChannelDataWriter withHighIntensity(byte intensity)

Intensity value of the high state

Parameters:

intensity - LED intensity the high state should be in, between [0 - 31]

Returns:

Calling object

withLowIntensity

LED.ChannelDataWriter withLowIntensity(byte intensity)

Intensity value of the low state

Parameters:

intensity - LED intensity the low state should be in, between [0 - 31]

Returns:

Calling object

withRiseTime

LED.ChannelDataWriter withRiseTime(short time)

How long the transition should take from low to high state, in milliseconds

Parameters:

time - Transition time (ms) from low to high state

Returns:

Calling object

withHighTime

LED.ChannelDataWriter withHighTime(short time)

How long the pulse stays in the high state

Parameters:

time - Length of time (ms) to spend in the high state

Returns:

Calling object

withFallTime

LED.ChannelDataWriter withFallTime(short time)

How long the transition should take from high to low state, in milliseconds

Parameters:

time - Length of time (ms) from high to low state

Returns:

Calling object

withPulseDuration

LED.ChannelDataWriter withPulseDuration(short duration)

How long one pulse is

Parameters:

duration - Length of one pulse (ms)

Returns:

Calling object

withPulseOffset

LED.ChannelDataWriter withPulseOffset(short offset)

How long to wait before starting the first pulse

Parameters:

offset - Wait time for first pulse (ms)

Returns:

Calling object

withRepeatCount

LED.ChannelDataWriter withRepeatCount(byte count)

How many times to repeat a pulse pattern

Parameters:

count - Number of repetitions, set to 255 to repeat indefinitely

Returns:

Calling object

commit

void commit()

Write the settings to the board