MansOS LEDs - Revision history

Leo at 13:36, 15 October 2014

2014-10-15T13:36:54Z

Leo: /* Counter representation on LEDs */

2014-10-15T13:35:13Z

‎Counter representation on LEDs

Leo: /* Blink */

2014-10-15T13:34:48Z

‎Blink

Leo: /* Function reference */

2014-10-15T13:33:33Z

‎Function reference

Leo: /* Function reference */

2014-10-15T13:30:28Z

‎Function reference

Leo: /* Function reference */

2014-10-15T13:30:11Z

‎Function reference

Leo at 12:59, 15 October 2014

2014-10-15T12:59:15Z

Girts at 16:46, 14 November 2011

2011-11-14T16:46:18Z

Girts at 16:41, 14 November 2011

2011-11-14T16:41:54Z

Girts at 16:41, 14 November 2011

2011-11-14T16:41:44Z

@@ Line 1: / Line 1: @@
 {{TocRight}}
+Key include files:
  mos/hil/leds.h
+ mos/platforms/<name>/ledslist.h
 MansOS provides API for Light-Emitting Diode (LED) setting and status checking (whether a LED is ON or OFF). LEDs are connected directly to GPIO pins, and each platform must define pin numbers for available LEDs on the hardware platform.

@@ Line 85: / Line 85: @@
 counter = 1;
 while (1) {
-    setLeds(counter++);
+    ledsSet(counter++);
     msleep(1000); // sleep one second
 }

@@ Line 67: / Line 67: @@
 while (1) {
-    // change red LED status
+    // change the red (default) LED status
-    toggleLed();
+    ledToggle();
     // wait for 1000 milliseconds
      mdelay(1000);

@@ Line 22: / Line 22: @@
 All platform-independent LED functions are described in mos/hil/leds.h . Implementation can be found under mos/hal/platforms/<platform-name>/
-The following functions are available for '''any individual led'''. The "red" led is used as an example, and can be substituted by any other LED name or alias, such as green or led3.
+The following functions are available for '''any individual led'''. The ''"redLed"'' prefix is used as an example, and can be substituted by any other LED name or alias valid for the chosen platform, such as ''greenLed'' or ''led3''.
  redLedInit();        // Initialize the LED

← Older revision		Revision as of 13:30, 15 October 2014
Line 33:		Line 33:


	The following functions are for a group of leds, addressed by using a mask, a bitfield.		The following functions are for a '''group of leds''', addressed by using a mask, a bitfield.

	// Init All leds (kernel uses this)		// Init All leds (kernel uses this)

@@ Line 22: / Line 22: @@
 All platform-independent LED functions are described in mos/hil/leds.h . Implementation can be found under mos/hal/platforms/<platform-name>/
+The following functions are available for '''any individual led'''. The "red" led is used as an example, and can be substituted by any other LED name or alias, such as green or led3.
-<pre>
- // Toggle an LED, addressed by color
- toggleRedLed()
- toggleGreenLed()
- toggleBlueLed()
+ redLedInit();        // Initialize the LED
- // Toggle an LED, addressed by number
+ redLedGet();         // Get the state of the LED
- toggleLed(ledNr)
+ redLedSet( val );    // Set the state of the LED to "val"
+ redLedOn();          // Turn the LED on
+ redLedOff();         // Turn the LED off
+ redLedToggle();      // Toggle the LED
+ redLedMask();        // Get the mask value for the LED
- // Toggle platform's default LED
- toggleLed()
- // Turn ON an LED, addressed by color
+The following functions are for a group of leds, addressed by using a mask, a bitfield.
- redLedOn()
- greenLedOn()
- blueLedOn()
- // Turn OFF an LED, addressed by color
+ // Init All leds (kernel uses this)
+ void ledsInit(void);
- redLedOff()
- greenLedOff()
+ // Set LEDs from a bitmask
- blueLedOff()
+ void ledsSet(uint_t led_bitmask);
- // Turn ON/OFF an LED, addressed by number
+ // Which LEDs are on? Returns a bitmask
- ledOn(uint8_t ledNr)
+ uint_t ledsGet(void);
- ledOff(uint8_t ledNr)
- // Turn platform's default LED ON/OFF
+ // Turn LEDs on using a bitmask
+ #define ledsOn(led_bitmask) ...
- ledOn();
- ledOff();
+ // Turn LEDs off using a bitmask
+ #define ledsOff(led_bitmask) ...
- // Return true, if an LED, addressed by number, is ON; false (zero) otherwise
- bool ledIsOn(ledNr)
+ // Toggle LEDs using a bitmask
+ #define ledsToggle(led_bitmask) ...
- // Get and set all LEDs, addressed by a bitmask
- // for example, if getLeds() returns 5, LEDs #0 and #2 are ON ((2 << 0) + (2 << 2) = 5)
+ // LEDs Constants
- uint8_t getLeds()
+ leds_count_t   LEDS_COUNT;     // Number of available LEDs
- setLeds(bitmap)
+ leds_all_t     LEDS_ALL_MASK;   // Mask for all LEDs
-</pre>
 == Examples ==

← Older revision		Revision as of 16:41, 14 November 2011
Line 1:		Line 1:
			___TOC___

	mos/hil/leds.h		mos/hil/leds.h