1 /* 2 * Author: Jon Trulson <jtrulson (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 <iostream> 27 #include <string> 28 #include <mraa/aio.h> 29 30 namespace upm { 31 /** 32 * @brief GP2Y0A-based IR Proximity Sensor library 33 * @defgroup gp2y0a libupm-gp2y0a 34 * @ingroup seeed analog light 35 */ 36 37 /** 38 * @library gp2y0a 39 * @sensor gp2y0a 40 * @comname GP2Y0A IR Proximity Sensor 41 * @altname Grove 80cm IR Proximity Sensor 42 * @type light 43 * @man seeed 44 * @con analog 45 * 46 * @brief API for the GP2Y0A family of IR Proximity Sensors 47 * 48 * Sensors of this family return an analog voltage corresponding to the distance 49 * of an object from the sensor. The voltage is lower when objects 50 * are far away; the voltage increases as objects get closer 51 * to the sensor. 52 * 53 * @image html gp2y0a.jpg 54 * @snippet gp2y0a.cxx Interesting 55 */ 56 class GP2Y0A { 57 public: 58 59 /** 60 * GP2Y0A sensor constructor 61 * 62 * @param pin Analog pin to use 63 */ 64 GP2Y0A(int pin); 65 66 /** 67 * GP2Y0A destructor 68 */ 69 ~GP2Y0A(); 70 71 /** 72 * Gets an average voltage value from the sensor 73 * 74 * @param aref Reference voltage in use (usually 5.0V or 3.3V) 75 * @param samples Number of samples to average over 76 * @return Average voltage reading 77 */ 78 float value(float aref, uint8_t samples); 79 80 private: 81 mraa_aio_context m_aio; 82 // ADC resolution 83 int m_aRes; 84 }; 85 } 86 87 88
