com.kuka.roboticsAPI.capabilities.interfaces
Interface ILEDStripControlCapability

All Superinterfaces:

ICapability

public interface ILEDStripControlCapability
extends ICapability

This interface represents the RAPI led strip control capability contract.

Method Summary

void	resetDefaultColor() Resets the default color to WHITE color with 'IDLE' priority.
void	setDefaultColor(SegmentColor color, LEDStripUserStatePriority priority) Sets a default LED Strip color as a LED Strip state. * Only one default color can be set, the previously set default is always removed during a new setDefaultColor() invocation
boolean	showUserEffect() Starts the last given user effect "indefinitely".
boolean	showUserEffect(ILedStripUserEffect effect) Stops the previously activated user led strip effect, if there is any, and starts the given effect "indefinitely".
boolean	showUserEffect(ILedStripUserEffect effect, long timeout) Stops the previously activated user led strip effect, if there is any, and starts the given effect for the given duration.
boolean	showUserEffect(long timeout) Starts the last given user effect for the passed timeout.
void	showWarningSignal() Shows a distinctive warning signal (flashing yellow color) on the LED strip.
void	showWarningSignal(long timeout) Shows a warning signal (flashing yellow color) on the LED strip.
boolean	stopUserEffect() Stops the active user effect.
void	stopWarningSignal() Stops all warning signals, if any.

Method Detail

showWarningSignal

void showWarningSignal(long timeout)

Shows a warning signal (flashing yellow color) on the LED strip. This command is asynchronous. If the application terminates, the warning signal also stops.

Parameters:

timeout - The time in milliseconds while the warning signal is visible. Giving a timeout lesser than or equals zero will stop the signal.

showWarningSignal

void showWarningSignal()

Shows a distinctive warning signal (flashing yellow color) on the LED strip. This command is asynchronous. If the application terminates, the warning signal also stops.

stopWarningSignal

void stopWarningSignal()

Stops all warning signals, if any.

showUserEffect

boolean showUserEffect(ILedStripUserEffect effect)

Stops the previously activated user led strip effect, if there is any, and starts the given effect "indefinitely".

Parameters:

effect - custom user effect.

Returns:

true, if effect activation is successful.

showUserEffect

boolean showUserEffect(long timeout)

Starts the last given user effect for the passed timeout.

Parameters:

timeout - duration of the effect [ms].

Returns:

true, if effect activation is successful.

showUserEffect

boolean showUserEffect()

Starts the last given user effect "indefinitely".

Returns:

true, if effect activation is successful.

showUserEffect

boolean showUserEffect(ILedStripUserEffect effect,
                       long timeout)

Stops the previously activated user led strip effect, if there is any, and starts the given effect for the given duration. Duration is only taken into account if effect is a blinking user effect. Static color user effects are always active till stopped explicitely.

Parameters:

effect - custom user effect.

timeout - duration of the effect [ms]

Returns:

true, if effect activation is successful.

stopUserEffect

boolean stopUserEffect()

Stops the active user effect.

Returns:

true, if there was an active effect to stop.

setDefaultColor

void setDefaultColor(SegmentColor color,
                     LEDStripUserStatePriority priority)

Sets a default LED Strip color as a LED Strip state. * Only one default color can be set, the previously set default is always removed during a new setDefaultColor() invocation

Parameters:

color - color of all segments, when the default color is active.

priority - priority of the default color [User,CHARGING,IDLE].

resetDefaultColor

void resetDefaultColor()

Resets the default color to WHITE color with 'IDLE' priority.