diff options
Diffstat (limited to 'peripheral/libupm/src/groveeldriver/groveeldriver.h')
-rw-r--r-- | peripheral/libupm/src/groveeldriver/groveeldriver.h | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/peripheral/libupm/src/groveeldriver/groveeldriver.h b/peripheral/libupm/src/groveeldriver/groveeldriver.h new file mode 100644 index 0000000..7ed7963 --- /dev/null +++ b/peripheral/libupm/src/groveeldriver/groveeldriver.h @@ -0,0 +1,78 @@ +/* + * Author: Zion Orent <sorent@ics.com> + * Copyright (c) 2015 Intel Corporation. + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#pragma once + +#include <mraa/gpio.h> + +#define HIGH 1 +#define LOW 0 + +namespace upm { + /** + * @brief Grove EL Driver Module library + * @defgroup groveeldriver libupm-groveeldriver + * @ingroup seeed gpio electric + */ + + /** + * @library groveeldriver + * @sensor groveeldriver + * @comname Grove EL Driver + * @type electric + * @man seeed + * @con gpio + * + * @brief API for the Grove EL Driver Module + * + * The Grove EL Driver allows you to easily light up an + * EL wire with just one single Grove cable. + * + * @image html groveeldriver.jpg + * @snippet groveeldriver.cxx Interesting + */ + class GroveElDriver { + public: + /** + * Grove EL Driver constructor + * + * @param pin Digital pin to use + */ + GroveElDriver(int pin); + /** + * Grove EL Driver destructor + */ + ~GroveElDriver(); + /** + * Turns the EL wire on + */ + void on(); + /** + * Turns the EL wire off + */ + void off(); + + private: + mraa_gpio_context m_gpio; + }; +} |