ttp223: Grove touch sensor and examples

Added support for the TTP223 touch detector-based sensors
(like the Grove touch sensor) with corresponding examples
in C++, JavaScript, and Python.

Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
This commit is contained in:
sknepper
2015-01-07 14:06:07 -08:00
committed by Sarah Knepper
parent 811b33936b
commit df4706e3b1
9 changed files with 299 additions and 0 deletions

View File

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

View File

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

10
src/ttp223/pyupm_ttp223.i Normal file
View File

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

52
src/ttp223/ttp223.cxx Normal file
View File

@ -0,0 +1,52 @@
/*
* Author: Sarah Knepper <sarah.knepper@intel.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 "ttp223.h"
using namespace upm;
TTP223::TTP223(unsigned int pin) {
// initialize gpio input
mraa_init();
m_gpio = mraa_gpio_init(pin);
mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
m_name = "ttp223";
}
TTP223::~TTP223() {
// close gpio input
mraa_gpio_close(m_gpio);
}
std::string TTP223::name() {
return m_name;
}
int TTP223::value() {
return mraa_gpio_read(m_gpio);
}
bool TTP223::isPressed() {
return this->value() == 1;
}

88
src/ttp223/ttp223.h Normal file
View File

@ -0,0 +1,88 @@
/*
* Author: Sarah Knepper <sarah.knepper@intel.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 TTP223 Touch Detector sensor library
* @defgroup ttp223 libupm-ttp223
*/
/**
* @brief C++ API for TTP223 touch detector-based sensors,
* such as the Grove Touch sensor
*
* This touch sensor detects when a finger is near the metallic pad
* by a change in capacitance. It can replace a more traditional push
* button. The touch sensor can still function when placed under a
* non-metallic surface like glass or plastic.
*
* @ingroup ttp223 gpio
* @snippet ttp223.cxx Interesting
*/
class TTP223 {
public:
/**
* TTP223 touch sensor constructor
*
* @param pin GPIO pin where sensor is connected
*/
TTP223(unsigned int pin);
/**
* TTP223 destructor
*/
~TTP223();
/**
* Return name of this sensor
*
* @return the name of this sensor
*/
std::string name();
/**
* Get value from GPIO pin
*
* @return the value from the GPIO pin
*/
int value();
/**
* Returns whether or not the touch sensor is being touched
*
* @return true if the touch sensor is being touched; false otherwise
*/
bool isPressed();
protected:
std::string m_name; //!< name of this sensor
mraa_gpio_context m_gpio; //!< GPIO pin
};
}