mirror of
https://github.com/eclipse/upm.git
synced 2025-03-19 23:17:29 +03:00
922e0cc26b
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp. This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.
* Renamed all cxx/cpp header files which contain the string
'copyright intel' from .h -> .hpp (if not already hpp).
* Replaced all references to .h with .hpp in documentation,
source files, cmake collateral, example code, and swig interface
files.
* Replaced cmake variable module_h with module_hpp.
* Intentionally left upm.h since this file currently does not
contain code (documentation only).
Signed-off-by: Noel Eck <noel.eck@intel.com>
83 lines
2.4 KiB
C++
83 lines
2.4 KiB
C++
/*
|
|
* Author: Jon Trulson <jtrulson@ics.com>
|
|
* Copyright (c) 2015 Intel Corporation.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <mraa/gpio.h>
|
|
|
|
namespace upm {
|
|
|
|
/**
|
|
* @brief RFR359 Distance Interrupter library
|
|
* @defgroup rfr359f libupm-rfr359f
|
|
* @ingroup seeed gpio light robok tsk
|
|
*/
|
|
/**
|
|
* @library rfr359f
|
|
* @sensor rfr359f
|
|
* @comname RFR359F Distance Interrupter
|
|
* @altname Grove Distance Interrupter
|
|
* @type light
|
|
* @man seeed
|
|
* @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt
|
|
* @con gpio
|
|
* @kit robok tsk
|
|
*
|
|
* @brief API for the RFR359F-based Grove Distance Interrupter.
|
|
*
|
|
* UPM module for the Grove distance interrupter. The sensitivity
|
|
* can be adjusted with the potentiometer on the sensor module. It
|
|
* has a range of approximately 4 inches and a quick response time.
|
|
*
|
|
* @image html rfr359f.jpg
|
|
* @snippet rfr359f.cxx Interesting
|
|
*/
|
|
class RFR359F {
|
|
public:
|
|
/**
|
|
* RFR359F constructor
|
|
*
|
|
* @param pin Digital pin to use
|
|
*/
|
|
RFR359F(int pin);
|
|
|
|
/**
|
|
* RFR359F destructor
|
|
*/
|
|
~RFR359F();
|
|
|
|
/**
|
|
* Gets the status of the pin; true means an object has been detected
|
|
*
|
|
* @return True if the sensor has detected an object
|
|
*/
|
|
bool objectDetected();
|
|
|
|
private:
|
|
mraa_gpio_context m_gpio;
|
|
};
|
|
}
|
|
|
|
|