led.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include "vlcb/platform/time.h"

Include dependency graph for inc/vlcb/platform/driver/led.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	VlcbPlatformLedEffectDataBlink
struct	VlcbPlatformLedEffectDataPulse
union	VlcbPlatformLedEffectData
struct	VlcbPlatformLedEffect
struct	VlcbPlatformLedDriver

Typedefs
typedef VlcbPlatformLedState(*	VlcbPlatformLedStatusResolver) (void)
typedef void(*	VlcbPlatformLedStatusChangeHandler) (void)

Enumerations
enum	VlcbPlatformLedEffectType { VLCB_PLATFORM_LED_FX_BLINK , VLCB_PLATFORM_LED_FX_PULSE }
enum	VlcbPlatformLedState { VLCB_PLATFORM_LED_OFF , VLCB_PLATFORM_LED_ON }

Functions
VlcbPlatformLedEffect	vlcb_platform_led_fx_Blink (uint16_t hz)
VlcbPlatformLedEffect	vlcb_platform_led_fx_Pulse (uint32_t duration_ms)
VlcbPlatformLedDriver	vlcb_platform_led_New (VlcbPlatformLedStatusResolver resolver, VlcbPlatformLedStatusChangeHandler changeHandler)

Typedef Documentation

VlcbPlatformLedStatusChangeHandler

typedef void(* VlcbPlatformLedStatusChangeHandler) (void)

Definition at line 44 of file inc/vlcb/platform/driver/led.h.

VlcbPlatformLedStatusResolver

typedef VlcbPlatformLedState(* VlcbPlatformLedStatusResolver) (void)

Definition at line 43 of file inc/vlcb/platform/driver/led.h.

Enumeration Type Documentation

VlcbPlatformLedEffectType

enum VlcbPlatformLedEffectType

Enumerator
VLCB_PLATFORM_LED_FX_BLINK
VLCB_PLATFORM_LED_FX_PULSE

Definition at line 8 of file inc/vlcb/platform/driver/led.h.

VlcbPlatformLedState

enum VlcbPlatformLedState

Enumerator
VLCB_PLATFORM_LED_OFF
VLCB_PLATFORM_LED_ON

Definition at line 38 of file inc/vlcb/platform/driver/led.h.

Function Documentation

vlcb_platform_led_fx_Blink()

VlcbPlatformLedEffect vlcb_platform_led_fx_Blink

(

uint16_t

hz

)

Definition at line 4 of file led.c.

vlcb_platform_led_fx_Pulse()

VlcbPlatformLedEffect vlcb_platform_led_fx_Pulse

(

uint32_t

duration_ms

)

Definition at line 6 of file led.c.

vlcb_platform_led_New()

VlcbPlatformLedDriver vlcb_platform_led_New	(	VlcbPlatformLedStatusResolver	resolver,
		VlcbPlatformLedStatusChangeHandler	changeHandler )

Definition at line 8 of file led.c.