Contiki-NG
led-strip.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Zolertia
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  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 /* -------------------------------------------------------------------------- */
30 /**
31  * \addtogroup zoul-sensors
32  * @{
33  *
34  * \defgroup zoul-led-strip LED strip compatible with Zoul-based platforms
35  *
36  * Driver to control a bright LED strip powered at 3VDC, drawing power directly
37  * from the battery power supply. An example on how to adapt 12VDC LED strips
38  * to 3VDC is provided at http://www.hackster.io/zolertia
39  * @{
40  *
41  * \file
42  * Header file for a bright LED strip driver
43  */
44 /* -------------------------------------------------------------------------- */
45 #ifndef LED_STRIP_H_
46 #define LED_STRIP_H_
47 /* -------------------------------------------------------------------------- */
48 #include <stdint.h>
49 /* -------------------------------------------------------------------------- */
50 #define LED_STRIP_OFF 0xFF
51 #define LED_STRIP_ON 0x00
52 
53 #define LED_STRIP_ERROR -1
54 /* -------------------------------------------------------------------------- */
55 /**
56  * \brief Init function for the bright LED strip driver
57  *
58  * The LED strip driver allows to lighten up any application using up to 4
59  * LEDs 3VDC-powered per strip
60  * The function is set to power OFF the LEDs as default,
61  * it should be called from the contiki-main initialization process.
62  *
63  * \return ignored
64  */
65 void led_strip_config(void);
66 
67 /**
68  * \brief Function to turn ON/OFF the LED strip
69  *
70  * \param val Set ON/OFF (LED_STRIP_ON or LED_STRIP_OFF)
71  * \return the selected antenna position, or LED_STRIP_ERROR if not
72  * previously configured
73  */
74 int led_strip_switch(uint8_t val);
75 
76 /**
77  * \brief Function to get the LED strip current state
78  *
79  * \return Current LED strip state or LED_STRIP_ERROR if not
80  * previously configured
81  */
82 int led_strip_get(void);
83 /* -------------------------------------------------------------------------- */
84 #endif /* ifndef LED_STRIP_H_ */
85 /* -------------------------------------------------------------------------- */
86 /**
87  * @}
88  * @}
89  */
90 
int led_strip_switch(uint8_t val)
Function to turn ON/OFF the LED strip.
Definition: led-strip.c:75
void led_strip_config(void)
Init function for the bright LED strip driver.
Definition: led-strip.c:62
int led_strip_get(void)
Function to get the LED strip current state.
Definition: led-strip.c:92