Contiki-NG
rgb-led.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, George Oikonomou - http://www.spd.gr
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29  * OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 /*---------------------------------------------------------------------------*/
32 #ifndef RGB_LED_H_
33 #define RGB_LED_H_
34 /*---------------------------------------------------------------------------*/
35 /**
36  * \addtogroup dev
37  * @{
38  */
39 /*---------------------------------------------------------------------------*/
40 /**
41  * \defgroup rgb-led Generic RGB LED driver
42  *
43  * This is a driver for a tri-color RGB LED part, such as for example the
44  * Broadcom (ex Avago Technologies) PLCC-4 Tricolor Black Surface LED present
45  * on all Zolertia Zoul-based boards.
46  *
47  *
48  * This driver sits on top of the LED HAL. Therefore, any port that wishes to
49  * use this driver should first implement the GPIO HAL and the new LED API.
50  * This driver will set the colour of the RGB LED by using combinations of
51  * LED_RED, LED_GREEN and LED_BLUE. Therefore, those must be correctly defined
52  * by the platform configuration.
53  * @{
54  *
55  * \file
56  * Header file for the RGB LED driver.
57  */
58 /*---------------------------------------------------------------------------*/
59 #include "contiki.h"
60 
61 #include <stdint.h>
62 /*---------------------------------------------------------------------------*/
63 #define RGB_LED_RED 1
64 #define RGB_LED_GREEN 2
65 #define RGB_LED_BLUE 4
66 #define RGB_LED_MAGENTA (RGB_LED_RED | RGB_LED_BLUE)
67 #define RGB_LED_YELLOW (RGB_LED_RED | RGB_LED_GREEN)
68 #define RGB_LED_CYAN (RGB_LED_GREEN | RGB_LED_BLUE )
69 #define RGB_LED_WHITE (RGB_LED_RED | RGB_LED_GREEN | RGB_LED_BLUE)
70 /*---------------------------------------------------------------------------*/
71 /**
72  * \brief Turn off the RGB LED
73  */
74 void rgb_led_off(void);
75 
76 /**
77  * \brief Set the colour of the RGB LED
78  * \param colour The colour to set
79  *
80  * \e colour can take the value of one of the RGB_LED_xyz defines.
81  */
82 void rgb_led_set(uint8_t colour);
83 /*---------------------------------------------------------------------------*/
84 #endif /* RGB_LED_H_ */
85 /*---------------------------------------------------------------------------*/
86 /**
87  * @}
88  * @}
89  */
void rgb_led_off(void)
Turn off the RGB LED.
Definition: rgb-led.c:45
void rgb_led_set(uint8_t colour)
Set the colour of the RGB LED.
Definition: rgb-led.c:51