Home | History | Annotate | Download | only in groveelectromagnet 
      1 /*
      2  * Author: Zion Orent <sorent (at) 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 Electromagnet library
     34    * @defgroup groveelectromagnet libupm-groveelectromagnet
     35    * @ingroup seeed gpio electric
     36    */
     37 
     38   /**
     39    * @library groveelectromagnet
     40    * @sensor groveelectromagnet
     41    * @comname Grove Electromagnet
     42    * @type electric
     43    * @man seeed
     44    * @con gpio
     45    *
     46    * @brief API for the Grove Electromagnet
     47    *
     48    * The Grove Electromagnet can hold up to 1 kg (approximately 2.2 lbs)
     49    *
     50    * @image html groveelectromagnet.jpg
     51    * @snippet groveelectromagnet.cxx Interesting
     52    */
     53   class GroveElectromagnet {
     54   public:
     55     /**
     56      * Grove Electromagnet constructor
     57      *
     58      * @param pin Digital pin to use
     59      */
     60     GroveElectromagnet(int pin);
     61     /**
     62      * Grove Electromagnet destructor
     63      */
     64     ~GroveElectromagnet();
     65     /**
     66      * Turns the magnet on
     67      */
     68      void on();
     69     /**
     70      * Turns the magnet off
     71      */
     72      void off();
     73 
     74   private:
     75         mraa_gpio_context m_gpio;
     76 	};
     77 }
     78