1 /*
2  * Author: Zion Orent <sorent@ics.com>
3  * Copyright (c) 2015 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include <mraa/gpio.h>
27 
28 #define HIGH      1
29 #define LOW       0
30 
31 namespace upm {
32   /**
33    * @brief Grove EL Driver Module library
34    * @defgroup groveeldriver libupm-groveeldriver
35    * @ingroup seeed gpio electric
36    */
37 
38   /**
39    * @library groveeldriver
40    * @sensor groveeldriver
41    * @comname Grove EL Driver
42    * @type electric
43    * @man seeed
44    * @con gpio
45    *
46    * @brief API for the Grove EL Driver Module
47    *
48    * The Grove EL Driver allows you to easily light up an
49    * EL wire with just one single Grove cable.
50    *
51    * @image html groveeldriver.jpg
52    * @snippet groveeldriver.cxx Interesting
53    */
54   class GroveElDriver {
55   public:
56     /**
57      * Grove EL Driver constructor
58      *
59      * @param pin Digital pin to use
60      */
61     GroveElDriver(int pin);
62     /**
63      * Grove EL Driver destructor
64      */
65     ~GroveElDriver();
66     /**
67      * Turns the EL wire on
68      */
69      void on();
70     /**
71      * Turns the EL wire off
72      */
73      void off();
74 
75   private:
76         mraa_gpio_context m_gpio;
77 	};
78 }
79