grovecollision: initial implementation

This implements support for the Grove Collision Sensor.

Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
Zion Orent
2015-02-25 16:49:37 -05:00
committed by John Van Drasek
parent 5f3b88b00a
commit ae10518a0f
8 changed files with 263 additions and 0 deletions

View File

@ -0,0 +1,5 @@
set (libname "grovecollision")
set (libdescription "upm grovecollision sensor module")
set (module_src ${libname}.cxx)
set (module_h ${libname}.h)
upm_module_init("-lrt")

View File

@ -0,0 +1,44 @@
/*
* Author: Zion Orent <sorent@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 "grovecollision.h"
using namespace upm;
GroveCollision::GroveCollision(int pin)
{
m_gpio = mraa_gpio_init(pin);
mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
}
GroveCollision::~GroveCollision()
{
mraa_gpio_close(m_gpio);
}
bool GroveCollision::isColliding()
{
// Collisions cause 0; no collision is 1
return (!(bool)mraa_gpio_read(m_gpio));
}

View File

@ -0,0 +1,63 @@
/*
* Author: Zion Orent <sorent@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 <mraa/gpio.h>
namespace upm {
/**
* @brief UPM module for the Grove Collision
* @defgroup grovecollision libupm-grovecollision
*/
/**
* @brief C++ API for the Grove Collision
*
* The Grove Collision Sensor can detect whether any
* collision movement or vibration happens.
* It will output a low pulse signal when vibration is detected.
*
* @ingroup gpio grovecollision
* @snippet grovecollision.cxx Interesting
*/
class GroveCollision {
public:
/**
* Grove Collision Constructor
*
* @param pin digital pin to use
*/
GroveCollision(int pin);
/**
* Grove Collision Destructor
*/
~GroveCollision();
/**
* @return bool returns whether something is colliding with sensor
*/
bool isColliding();
private:
mraa_gpio_context m_gpio;
};
}

View File

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

View File

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