1 /* 2 * Author: Jon Trulson <jtrulson@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 <string> 27 #include <mraa/gpio.h> 28 29 namespace upm { 30 31 /** 32 * @brief RFR359 Distance Interrupter library 33 * @defgroup rfr359f libupm-rfr359f 34 * @ingroup seeed gpio light robok tsk 35 */ 36 /** 37 * @library rfr359f 38 * @sensor rfr359f 39 * @comname RFR359F Distance Interrupter 40 * @altname Grove Distance Interrupter 41 * @type light 42 * @man seeed 43 * @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt 44 * @con gpio 45 * @kit robok tsk 46 * 47 * @brief API for the RFR359F-based Grove Distance Interrupter. 48 * 49 * UPM module for the Grove distance interrupter. The sensitivity 50 * can be adjusted with the potentiometer on the sensor module. It 51 * has a range of approximately 4 inches and a quick response time. 52 * 53 * @image html rfr359f.jpg 54 * @snippet rfr359f.cxx Interesting 55 */ 56 class RFR359F { 57 public: 58 /** 59 * RFR359F constructor 60 * 61 * @param pin Digital pin to use 62 */ 63 RFR359F(int pin); 64 65 /** 66 * RFR359F destructor 67 */ 68 ~RFR359F(); 69 70 /** 71 * Gets the status of the pin; true means an object has been detected 72 * 73 * @return True if the sensor has detected an object 74 */ 75 bool objectDetected(); 76 77 private: 78 mraa_gpio_context m_gpio; 79 }; 80 } 81 82 83