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 namespace upm {
29   /**
30    * @brief Grove Collision Sensor library
31    * @defgroup grovecollision libupm-grovecollision
32    * @ingroup seeed gpio accelerometer
33    */
34 
35   /**
36    * @library grovecollision
37    * @sensor grovecollision
38    * @comname Grove Collision Sensor
39    * @type accelerometer
40    * @man seeed
41    * @con gpio
42    *
43    * @brief API for the Grove Collision Sensor
44    *
45    * The Grove Collision Sensor can detect whether any
46    * collision movement or vibration happens.
47    * It outputs a low pulse signal when vibration is detected.
48    *
49    * @image html grovecollision.jpg
50    * @snippet grovecollision.cxx Interesting
51    */
52   class GroveCollision {
53   public:
54     /**
55      * Grove collision sensor constructor
56      *
57      * @param pin Digital pin to use
58      */
59     GroveCollision(int pin);
60     /**
61      * GroveCollision destructor
62      */
63     ~GroveCollision();
64     /**
65      * @return bool  Defines whether something is colliding with sensor
66      */
67      bool isColliding();
68 
69   private:
70         mraa_gpio_context m_gpio;
71 	};
72 }
73