leds.h File Reference

The header file describes the leds interface. More...

Go to the source code of this file.

Defines
#define	LED_FIRST   0
#define	LED_SECOND   1
#define	LED_THIRD   2
#define	LED_FOURTH   3
#define	LED_FIFTH   4
#define	LED_SIXTH   5
#define	LED_SEVENTH   6
#define	LED_EIGHTH   7
#define	LED_RED   LED_FIRST
#define	LED_YELLOW   LED_SECOND
#define	LED_GREEN   LED_THIRD
#define	LED_BLUE   LED_FOURTH
Functions
result_t	BSP_OpenLeds (void)
	Opens leds module to use.
result_t	BSP_CloseLeds (void)
	Closes leds module.
void	BSP_OnLed (uint8_t id)
	Turns on a led.
void	BSP_OffLed (uint8_t id)
	Turns off a led.
void	BSP_ToggleLed (uint8_t id)
	Switches the led state to the opposite.

---

Detailed Description

The header file describes the leds interface.

Author:

Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com

Copyright (c) 2008 , Atmel Corporation. All rights reserved. Licensed under Atmel's Limited License Agreement (BitCloudTM).

Definition in file leds.h.

---

Define Documentation

#define LED_FIRST   0

Definition at line 30 of file leds.h.

#define LED_SECOND   1

Definition at line 31 of file leds.h.

#define LED_THIRD   2

Definition at line 32 of file leds.h.

#define LED_FOURTH   3

Definition at line 33 of file leds.h.

#define LED_FIFTH   4

Definition at line 34 of file leds.h.

#define LED_SIXTH   5

Definition at line 35 of file leds.h.

#define LED_SEVENTH   6

Definition at line 36 of file leds.h.

#define LED_EIGHTH   7

Definition at line 37 of file leds.h.

#define LED_RED   LED_FIRST

Definition at line 38 of file leds.h.

#define LED_YELLOW   LED_SECOND

Definition at line 39 of file leds.h.

#define LED_GREEN   LED_THIRD

Definition at line 40 of file leds.h.

#define LED_BLUE   LED_FOURTH

Definition at line 41 of file leds.h.

---

Function Documentation

result_t BSP_OpenLeds

(

void

)

Opens leds module to use.

Returns:

SUCCESS - always.

result_t BSP_CloseLeds

(

void

)

Closes leds module.

Returns:

SUCCESS - always.

void BSP_OnLed

(

uint8_t

id

)

Turns on a led.

Parameters:

[in]

id

- number of the led to proceed. Must be chosen from defines.

void BSP_OffLed

(

uint8_t

id

)

Turns off a led.

Parameters:

[in]

id

- number of the led to proceed. Must be chosen from defines.

void BSP_ToggleLed

(

uint8_t

id

)

Switches the led state to the opposite.

Parameters:

[in]

id

- number of the led to proceed. Must be chosen from defines.

---