Interface: Leds

Abstraction of the LEDs.

Components providing this interface:: tos.lib.Commands.CommandLeds
tos.system.LedsC
tos.system.NoLeds

Components requiring this interface:: apps.BAPBase.BAPBaseM
apps.Blink.BlinkM
apps.BlinkTask.BlinkTaskM
apps.Chirp.ChirpM
apps.Diagnostic.DiagnosticM
apps.DotId.DotIdM
apps.GenericBase.GenericBaseM
apps.Ident.AppM
apps.Oscilloscope.OscilloscopeM
apps.OscilloscopeRF.OscilloscopeM
apps.Sense.SenseM
apps.SenseLightToLog.SenseLightToLogM
apps.SenseLightToLog.SimpleCmdM
apps.SenseLightToSounder.SenseLightToSounderM
apps.SenseTask.SenseTaskM
apps.SimpleCmd.SimpleCmdM
apps.Social.SocialM
apps.Surge.SurgeM
apps.TestBAP.TestBAPM
apps.TestByteEEPROM.TestByteEEPROMC
apps.TestEEPROM.TestEEPROMM
apps.TestI2CPot.TestI2CPotM
apps.TestMig1.Mig1M
apps.TestTemp.TestTempM
apps.TestTimer.TestSyncTimerM
apps.TestTinyAlloc.TestTinyAllocM
tos.lib.BapM
tos.lib.Bombilla.Bombilla
tos.lib.Commands.CommandLedsM
tos.lib.Commands.CommandPotM
tos.lib.Commands.CommandResetM
tos.lib.EventM
tos.lib.IdentC
tos.lib.IntToLedsM
tos.lib.Queue.QueuedSendM
tos.lib.Route.MultiHopRouteM
tos.lib.TinyAlloc
tos.lib.TinyDB.AggOperator
tos.lib.TinyDB.DBBufferC
tos.lib.TinyDB.NetworkC
tos.lib.TinyDB.ParsedQuery
tos.lib.TinyDB.QueryResult
tos.lib.TinyDB.TupleRouterM
tos.lib.UartDebuggerM
tos.platform.pc.TimerM
tos.sensorboards.micasb.I2CPotM
tos.system.AMPromiscuous
tos.system.AMStandard
tos.system.ByteEEPROMC
tos.system.LogicalTimeM
tos.system.NoCRCPacket

Commands

result_t init (void) Initialize the LEDs; among other things, initialization turns them all off.
result_t redOn (void) Turn the red LED on.
result_t redOff (void) Turn the red LED off.
result_t redToggle (void) Toggle the red LED.
result_t greenOn (void) Turn the green LED on.
result_t greenOff (void) Turn the green LED off.
result_t greenToggle (void) Toggle the green LED.
result_t yellowOn (void) Turn the yellow LED on.
result_t yellowOff (void) Turn the yellow LED off.
result_t yellowToggle (void) Toggle the yellow LED.
uint8_t get(void) Get current Leds information

Returns: A uint8_t typed value representing Leds status
result_t set(uint8_t value) Set Leds to a specified value

Parameters:
value - ranging from 0 to 7 inclusive

Returns: SUCCESS Always

Commands - Details

init

result_t init(void)

Initialize the LEDs; among other things, initialization turns them all off.

Returns:

SUCCESS always.

redOn

result_t redOn(void)

Turn the red LED on.

Returns:

SUCCESS always.

redOff

result_t redOff(void)

Turn the red LED off.

Returns:

SUCCESS always.

redToggle

result_t redToggle(void)

Toggle the red LED. If it was on, turn it off. If it was off, turn it on.

Returns:

SUCCESS always.

greenOn

result_t greenOn(void)

Turn the green LED on.

Returns:

SUCCESS always.

greenOff

result_t greenOff(void)

Turn the green LED off.

Returns:

SUCCESS always.

greenToggle

result_t greenToggle(void)

Toggle the green LED. If it was on, turn it off. If it was off, turn it on.

Returns:

SUCCESS always.

yellowOn

result_t yellowOn(void)

Turn the yellow LED on.

Returns:

SUCCESS always.

yellowOff

result_t yellowOff(void)

Turn the yellow LED off.

Returns:

SUCCESS always.

yellowToggle

result_t yellowToggle(void)

Toggle the yellow LED. If it was on, turn it off. If it was off, turn it on.

Returns:

SUCCESS always.

Parameters:	value - ranging from 0 to 7 inclusive
Returns:	SUCCESS Always