LED Pattern Functions

Functions
enum sd_led_err	sd_led_breathe (struct sd_led *led)
	LED Breathe Set the LED to breathe. More...
enum sd_led_err	sd_led_blink (struct sd_led *led)
	LED blink Set a short non-repeating blink on a single LED. More...
enum sd_led_err	sd_led_rapid (struct sd_led *led)
	LED rapid blinking Set an LED to a continuous rapid blinking. More...
enum sd_led_err	sd_led_solid (struct sd_led *led)
	LED solid on Set an LED to an continuous on state. More...

Detailed Description

Function Documentation

sd_led_blink()

enum sd_led_err sd_led_blink

(

struct sd_led *

led

)

#include <Src/sd_led_pattern.c>

LED blink Set a short non-repeating blink on a single LED.

Parameters

led	The LED pattern handle

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
    /* Set the pattern */
    return sd_led_set_pattern(led, 
                led_short_blink_pattern,
                COUNT_OF(led_short_blink_pattern),
                0);
}

sd_led_breathe()

enum sd_led_err sd_led_breathe

(

struct sd_led *

led

)

#include <Src/sd_led_pattern.c>

LED Breathe Set the LED to breathe.

Parameters

led	The LED handle

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
    /* Set the pattern */
    return sd_led_set_pattern(led,
                led_breathe_pattern,
                COUNT_OF(led_breathe_pattern),
                1);
}

sd_led_rapid()

enum sd_led_err sd_led_rapid

(

struct sd_led *

led

)

#include <Src/sd_led_pattern.c>

LED rapid blinking Set an LED to a continuous rapid blinking.

Parameters

led	The LED pattern handle

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
    /* Set the pattern */
    return sd_led_set_pattern(led,
                led_rapid_pattern,
                COUNT_OF(led_rapid_pattern),
                1);
}        

sd_led_solid()

enum sd_led_err sd_led_solid

(

struct sd_led *

led

)

#include <Src/sd_led_pattern.c>

LED solid on Set an LED to an continuous on state.

Parameters

led	The LED pattern handle

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
    /* Set the pattern */
    return sd_led_set_pattern(led,
                led_solid_pattern, 
                1, 
                1);
}