com.esf.sbc.helios.led.service
Interface IHeliosLedService

public interface IHeliosLedService

Field Summary

static int	HELIOS_LED_FAST_FLASH represents fast flashing (period=200ms) for Helios LEDs
static int	HELIOS_LED_SLOW_FLASH represents slow flashing (period=1000ms) for Helios LEDs
static int	HELIOS_LED_STATE_AMBER represents the AMBER state for a Helios LED
static int	HELIOS_LED_STATE_GREEN represents the GREEN state for a Helios LED
static int	HELIOS_LED_STATE_OFF represents the OFF state for a Helios LED
static int	HELIOS_LED_STATE_RED represents the RED state for a Helios LED
static int	HELIOS_LED_STATE_TRICOLOR represents the tricolor state for a Helios LED.
static int	HELIOS_SW_LED_0 represents software controlled LED0 on the Helios
static int	HELIOS_SW_LED_1 represents software controlled LED1 on the Helios
static int	HELIOS_SW_LED_2 represents software controlled LED2 on the Helios
static int	HELIOS_SW_LED_3 represents software controlled LED3 on the Helios
static java.lang.String	SERVICE_NAME

Method Summary

void	setAll(int ledState) sets the state of all software controlled LEDs to a specified state
void	setLed(int led, int ledState) sets the LED state of a single LED
void	startBlinking(int led, int color, int period) starts a specified LED blinking a certain color with a specified period
void	startTriColorBlinking(int led, int period) starts a specified LED blinking in tricolor mode with a specified period
void	stopBlinking(int led) stops a specified LED from blinking.

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

HELIOS_SW_LED_0

public static final int HELIOS_SW_LED_0

represents software controlled LED0 on the Helios

See Also:

Constant Field Values

HELIOS_SW_LED_1

public static final int HELIOS_SW_LED_1

represents software controlled LED1 on the Helios

See Also:

Constant Field Values

HELIOS_SW_LED_2

public static final int HELIOS_SW_LED_2

represents software controlled LED2 on the Helios

See Also:

Constant Field Values

HELIOS_SW_LED_3

public static final int HELIOS_SW_LED_3

represents software controlled LED3 on the Helios

See Also:

Constant Field Values

HELIOS_LED_STATE_OFF

public static final int HELIOS_LED_STATE_OFF

represents the OFF state for a Helios LED

See Also:

Constant Field Values

HELIOS_LED_STATE_RED

public static final int HELIOS_LED_STATE_RED

represents the RED state for a Helios LED

See Also:

Constant Field Values

HELIOS_LED_STATE_AMBER

public static final int HELIOS_LED_STATE_AMBER

represents the AMBER state for a Helios LED

See Also:

Constant Field Values

HELIOS_LED_STATE_GREEN

public static final int HELIOS_LED_STATE_GREEN

represents the GREEN state for a Helios LED

See Also:

Constant Field Values

HELIOS_LED_STATE_TRICOLOR

public static final int HELIOS_LED_STATE_TRICOLOR

represents the tricolor state for a Helios LED. This should be used when setting an LED to blink in tricolor mode

See Also:

Constant Field Values

HELIOS_LED_FAST_FLASH

public static final int HELIOS_LED_FAST_FLASH

represents fast flashing (period=200ms) for Helios LEDs

See Also:

Constant Field Values

HELIOS_LED_SLOW_FLASH

public static final int HELIOS_LED_SLOW_FLASH

represents slow flashing (period=1000ms) for Helios LEDs

See Also:

Constant Field Values

Method Detail

setLed

public void setLed(int led,
                   int ledState)
            throws java.lang.Exception

sets the LED state of a single LED

Parameters:

led - the LED to set

ledState - the state to set it in

Throws:

java.lang.Exception - if the LED state can not be set

setAll

public void setAll(int ledState)
            throws java.lang.Exception

sets the state of all software controlled LEDs to a specified state

Parameters:

ledState - the LED state to set all software controlled LEDs to

Throws:

java.lang.Exception - if the LED states can not be set

startBlinking

public void startBlinking(int led,
                          int color,
                          int period)
                   throws java.lang.Exception

starts a specified LED blinking a certain color with a specified period

Parameters:

led - the LED to start blinking

color - the color to blink

period - the period in milliseconds to blink. one period is a full cycle (on and off).

Throws:

java.lang.Exception - if the blinker can not be started

startTriColorBlinking

public void startTriColorBlinking(int led,
                                  int period)
                           throws java.lang.Exception

starts a specified LED blinking in tricolor mode with a specified period

Parameters:

led - the LED to start blinking

period - the period in milliseconds to blink. one period is a full cycle (on and off) in any given color state.

Throws:

java.lang.Exception - if the blinker can not be started

stopBlinking

public void stopBlinking(int led)
                  throws java.lang.Exception

stops a specified LED from blinking.

Parameters:

led - the LED to stop blinking

Throws:

java.lang.Exception - if the LED blinker can not be stopped or the LED is not currently blinking.