Changeset 780 for firmware/trunk/core/makingthings/led.c

Timestamp:

08/05/08 21:01:24 (5 months ago)

Author:

liamstask

Message:

- updated LED documentation

Files:

• firmware/trunk/core/makingthings/led.c (modified) (5 diffs)

firmware/trunk/core/makingthings/led.c

@@ -40 +40 @@
 static int Led_Stop( void );
 
-/** LED
-* This whole thing needs to run on timers and events so that the LED can 
-* be asked to flash at various times
-*/
-
 /** \defgroup Led LED
-  The Led subsystem controls the single green LED on the MAKE Controller Board.
+  Controls the single green LED on the MAKE Controller Board.
   There are two LEDs on the MAKE Controller Board - one green and one red.  The red LED is simply
   a power indicator and cannot be controlled by the Controller.  The green LED can be used for
@@ -59 +54 @@
   @param state An integer specifying the active state of the LED system - 1 (on) or 0 (off).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // enable the LED system
+  Led_SetActive(1);
+  \endcode
 */
 int Led_SetActive( int state )
@@ -71 +72 @@
   Read the active state of the LED system.
   @return State - 1/non-zero (on) or 0 (off).
+  
+  \b Example
+  \code
+  int enabled = Led_GetActive();
+  if(enabled)
+  {
+    // then we're enabled
+  }
+  else
+  {
+    // not enabled
+  }
+  \endcode
 */
 int Led_GetActive( )
@@ -81 +95 @@
   @param state An integer specifying the state - on (1) or off (0).
   @return 0 on success.
+  
+  \b Example
+  \code
+  // turn the LED on
+  Led_SetState(1);
+  \endcode
 */
 int Led_SetState( int state )
@@ -97 +117 @@
   Read the state of the LED on the MAKE Controller Board.
   @return State - 1/non-zero (on) or 0 (off).
+  
+  \b Example
+  \code
+  int led_on = Led_GetState();
+  if(led_on)
+  {
+    // the LED is on
+  }
+  else
+  {
+    // the LED is off
+  }
+  \endcode
 */
 int Led_GetState( )