Loading...
Searching...
No Matches
Files
Control on-board LEDs
Drivers » Actuator Device Drivers

Access macros and functions to control the on-board LEDs. More...

Detailed Description

Access macros and functions to control the on-board LEDs.

This header contains a set of macros for controlling the on-board LEDs of a board. The LEDs are enumerated, starting from LED0 to LED7. As most platforms have a different number of LEDs, the existing ones are mapped onto the lowest LED numbers, while the higher LED numbers will simply be empty defines. This ensures, that the LED macros are portable to any platform with any number of LEDs.

Providing access macros to 8 LEDs is a random decision, as currently 8 is the maximum number of on-board LEDs found on any board in RIOT (stm32f3discovery).

Files

file  led.h
 Macros and inline functions for controlling the on-board LEDs.
 

Convenience LED control functions and macros

static void led_on (unsigned id)
 Turn on an LED.
 
static void led_off (unsigned id)
 Turn off an LED.
 
static void led_toggle (unsigned id)
 Toggle an LED.
 
#define LED_ON(id)   LED ## id ##_ON
 Turn on an LED.
 
#define LED_OFF(id)   LED ## id ## _OFF
 Turn off an LED.
 
#define LED_TOGGLE(id)   LED ## id ##_TOGGLE
 Toggle an LED.
 

LED fallback macros

#define LED0_ON
 defined empty
 
#define LED0_OFF
 defined empty
 
#define LED0_TOGGLE
 defined empty
 
#define LED1_ON
 defined empty
 
#define LED1_OFF
 defined empty
 
#define LED1_TOGGLE
 defined empty
 
#define LED2_ON
 defined empty
 
#define LED2_OFF
 defined empty
 
#define LED2_TOGGLE
 defined empty
 
#define LED3_ON
 defined empty
 
#define LED3_OFF
 defined empty
 
#define LED3_TOGGLE
 defined empty
 
#define LED4_ON
 defined empty
 
#define LED4_OFF
 defined empty
 
#define LED4_TOGGLE
 defined empty
 
#define LED5_ON
 defined empty
 
#define LED5_OFF
 defined empty
 
#define LED5_TOGGLE
 defined empty
 
#define LED6_ON
 defined empty
 
#define LED6_OFF
 defined empty
 
#define LED6_TOGGLE
 defined empty
 
#define LED7_ON
 defined empty
 
#define LED7_OFF
 defined empty
 
#define LED7_TOGGLE
 defined empty
 
#define LED_NUMOF   0
 Number of LEDs available on the current board.
 

Macro Definition Documentation

◆ LED0_OFF

#define LED0_OFF

defined empty

Definition at line 47 of file led.h.

◆ LED0_ON

#define LED0_ON

defined empty

Definition at line 46 of file led.h.

◆ LED0_TOGGLE

#define LED0_TOGGLE

defined empty

Definition at line 48 of file led.h.

◆ LED1_OFF

#define LED1_OFF

defined empty

Definition at line 55 of file led.h.

◆ LED1_ON

#define LED1_ON

defined empty

Definition at line 54 of file led.h.

◆ LED1_TOGGLE

#define LED1_TOGGLE

defined empty

Definition at line 56 of file led.h.

◆ LED2_OFF

#define LED2_OFF

defined empty

Definition at line 63 of file led.h.

◆ LED2_ON

#define LED2_ON

defined empty

Definition at line 62 of file led.h.

◆ LED2_TOGGLE

#define LED2_TOGGLE

defined empty

Definition at line 64 of file led.h.

◆ LED3_OFF

#define LED3_OFF

defined empty

Definition at line 71 of file led.h.

◆ LED3_ON

#define LED3_ON

defined empty

Definition at line 70 of file led.h.

◆ LED3_TOGGLE

#define LED3_TOGGLE

defined empty

Definition at line 72 of file led.h.

◆ LED4_OFF

#define LED4_OFF

defined empty

Definition at line 79 of file led.h.

◆ LED4_ON

#define LED4_ON

defined empty

Definition at line 78 of file led.h.

◆ LED4_TOGGLE

#define LED4_TOGGLE

defined empty

Definition at line 80 of file led.h.

◆ LED5_OFF

#define LED5_OFF

defined empty

Definition at line 87 of file led.h.

◆ LED5_ON

#define LED5_ON

defined empty

Definition at line 86 of file led.h.

◆ LED5_TOGGLE

#define LED5_TOGGLE

defined empty

Definition at line 88 of file led.h.

◆ LED6_OFF

#define LED6_OFF

defined empty

Definition at line 95 of file led.h.

◆ LED6_ON

#define LED6_ON

defined empty

Definition at line 94 of file led.h.

◆ LED6_TOGGLE

#define LED6_TOGGLE

defined empty

Definition at line 96 of file led.h.

◆ LED7_OFF

#define LED7_OFF

defined empty

Definition at line 103 of file led.h.

◆ LED7_ON

#define LED7_ON

defined empty

Definition at line 102 of file led.h.

◆ LED7_TOGGLE

#define LED7_TOGGLE

defined empty

Definition at line 104 of file led.h.

◆ LED_NUMOF

#define LED_NUMOF   0

Number of LEDs available on the current board.

Definition at line 129 of file led.h.

◆ LED_OFF

#define LED_OFF (   id)    LED ## id ## _OFF

Turn off an LED.

Definition at line 139 of file led.h.

◆ LED_ON

#define LED_ON (   id)    LED ## id ##_ON

Turn on an LED.

Definition at line 138 of file led.h.

◆ LED_TOGGLE

#define LED_TOGGLE (   id)    LED ## id ##_TOGGLE

Toggle an LED.

Definition at line 140 of file led.h.

Function Documentation

◆ led_off()

static void led_off ( unsigned  id)
inlinestatic

Turn off an LED.

Note
If id is a compile-time constant, consider using LED_OFF(id) instead.
Parameters
idid of LED between 0 and 7

Definition at line 170 of file led.h.

◆ led_on()

static void led_on ( unsigned  id)
inlinestatic

Turn on an LED.

Note
If id is a compile-time constant, consider using LED_ON(id) instead.
Parameters
idid of LED between 0 and 7

Definition at line 149 of file led.h.

◆ led_toggle()

static void led_toggle ( unsigned  id)
inlinestatic

Toggle an LED.

Note
If id is a compile-time constant, consider using LED_TOGGLE(id) instead.
Parameters
idid of LED between 0 and 7

Definition at line 191 of file led.h.