com.sentilla.system
Interface Leds

All Superinterfaces:
Action
All Known Implementing Classes:
Leds

public interface Leds
extends Action

Set, turn on, turn off, and toggle the platform's LEDs. The LEDs on/off state is represented as a bit-vector encoded as an integer. If the platform has three LEDs, then only the lowest three bits of the int value are significant.


Field Summary
 
Fields inherited from interface com.sentilla.system.Action
DONE, ERROR, IDLE, PENDING
 
Method Summary
 void off(int value)
          Turns off selected LEDs.
 void on(int value)
          Turns on selected LEDs.
 void set(int value)
          Set all LED values.
 Leds setOff(int value)
          Asynchronous interface to turn off selected LEDs.
 Leds setOn(int value)
          Asynchronous interface to turn on selected LEDs.
 Leds setSet(int value)
          Asynchronous interface to set all LED values.
 Leds setToggle(int value)
          Asynchronous interface to toggle selected LEDs.
 void toggle(int value)
          Toggle selected LEDs.
 
Methods inherited from interface com.sentilla.system.Action
block, block, cancel, getActionState, isDone, submit
 

Method Detail

set

void set(int value)
Set all LED values.

Parameters:
value - a bit mask where true means on and false means off

on

void on(int value)
Turns on selected LEDs.

Parameters:
value - a bit mask where true means on and false means ignore

off

void off(int value)
Turns off selected LEDs.

Parameters:
value - a bit mask where true means off and false means ignore

toggle

void toggle(int value)
Toggle selected LEDs.

Parameters:
value - a bit mask where true means toggle and false means ignore

setSet

Leds setSet(int value)
Asynchronous interface to set all LED values.

Prepares the Action to set all LED values but does not initiate the operation until submit() is called.

Parameters:
value - a bit mask where true means on and false means off
Returns:
this, the Leds object that has been set to the specified state

setOn

Leds setOn(int value)
Asynchronous interface to turn on selected LEDs.

Prepares the Action to turn on selected LEDs but does not initiate the operation until submit() is called.

Parameters:
value - a bit mask where true means on and false means ignore
Returns:
this, the Leds object that has been set to the specified state

setOff

Leds setOff(int value)
Asynchronous interface to turn off selected LEDs.

Prepares the Action to turn off selected LEDs but does not initiate the operation until submit() is called.

Parameters:
value - a bit mask where true means off and false means ignore
Returns:
this, the Leds object that has been set to the specified state

setToggle

Leds setToggle(int value)
Asynchronous interface to toggle selected LEDs.

Prepares the Action to toggle selected LEDs but does not initiate the operation until submit() is called.

Parameters:
value - a bit mask where true means toggle and false means ignore
Returns:
this, the Leds object that has been set to the specified state


Copyright © 2007 Sentilla Corporation. All Rights Reserved.