rfr359f: Initial implementation

This was tested on the Grove IR Distance Interrupter.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
This commit is contained in:
Jon Trulson
2015-01-14 12:45:07 -07:00
committed by Sarah Knepper
parent db1ca3d08a
commit 6642ee9eef
8 changed files with 258 additions and 0 deletions

View File

@ -0,0 +1,5 @@
set (libname "rfr359f")
set (libdescription "upm rfr359f grove distance interrupter")
set (module_src ${libname}.cxx)
set (module_h ${libname}.h)
upm_module_init()

View File

@ -0,0 +1,8 @@
%module jsupm_rfr359f
%include "../upm.i"
%{
#include "rfr359f.h"
%}
%include "rfr359f.h"

View File

@ -0,0 +1,9 @@
%module pyupm_rfr359f
%include "../upm.i"
%feature("autodoc", "3");
%include "rfr359f.h"
%{
#include "rfr359f.h"
%}

51
src/rfr359f/rfr359f.cxx Normal file
View File

@ -0,0 +1,51 @@
/*
* 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.
*/
#include <iostream>
#include "rfr359f.h"
using namespace upm;
using namespace std;
RFR359F::RFR359F(int pin)
{
if ( !(m_gpio = mraa_gpio_init(pin)) )
{
cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
return;
}
mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
}
RFR359F::~RFR359F()
{
mraa_gpio_close(m_gpio);
}
bool RFR359F::objectDetected()
{
return (!mraa_gpio_read(m_gpio) ? true : false);
}

67
src/rfr359f/rfr359f.h Normal file
View File

@ -0,0 +1,67 @@
/*
* 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 C++ 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 fast response time.
*
* @ingroup grove gpio
* @snippet rfr359f.cxx Interesting
*/
class RFR359F {
public:
/**
* Grove Distance Interrupter constructor
*
* @param pin digital pin to use
*/
RFR359F(int pin);
/**
* RFR359F Destructor
*/
~RFR359F();
/**
* Get the status of the pin, true means object detected
*
* @return true if the sensor detected an object
*/
bool objectDetected();
private:
mraa_gpio_context m_gpio;
};
}