1 /* 2 * Author: Zion Orent <sorent@ics.com> 3 * Copyright (c) 2014 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 <string> 27 #include <mraa/aio.h> 28 29 namespace upm { 30 /** 31 * @brief BISS0001 Motion Sensor library 32 * @defgroup biss0001 libupm-biss0001 33 * @ingroup seeed gpio light tsk 34 */ 35 36 /** 37 * @library biss0001 38 * @sensor biss0001 39 * @comname BISS0001 Motion Sensor 40 * @altname Grove PIR Motion Sensor 41 * @type light 42 * @man seeed 43 * @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html 44 * @con gpio 45 * @kit tsk 46 * 47 * @brief API for the BISS0001 Motion Sensor 48 * 49 * UPM module for the BISS0001 Motion Sensor 50 * 51 * @image html biss0001.jpg 52 * @snippet biss0001.cxx Interesting 53 */ 54 class BISS0001 { 55 public: 56 /** 57 * BISS0001 motion sensor constructor 58 * 59 * @param pin Digital pin to use 60 */ 61 BISS0001(int pin); 62 /** 63 * BISS0001 destructor 64 */ 65 ~BISS0001(); 66 /** 67 * Gets the motion value from the sensor 68 * 69 * @return Motion reading 70 */ 71 bool value(); 72 73 private: 74 mraa_gpio_context m_gpio; 75 }; 76 } 77 78 79