1 /* 2 * Author: Sarah Knepper <sarah.knepper@intel.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 <string> 27 #include <mraa/gpio.hpp> 28 29 #if defined(SWIGJAVA) || defined(JAVACALLBACK) 30 #include "../IsrCallback.h" 31 #endif 32 33 namespace upm { 34 /** 35 * @brief TTP223 Touch Detector Sensor library 36 * @defgroup ttp223 libupm-ttp223 37 * @ingroup seeed gpio touch 38 */ 39 /** 40 * @library ttp223 41 * @sensor ttp223 42 * @comname TTP223 Touch Sensor 43 * @altname Grove Touch Sensor 44 * @type touch 45 * @man seeed 46 * @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html 47 * @con gpio 48 * 49 * @brief API for the TTP223 Touch Sensor 50 * 51 * This touch sensor detects when a finger is near the metallic pad 52 * by the change in capacitance. It can replace a more traditional push 53 * button. The touch sensor can still function when placed under a 54 * non-metallic surface like glass or plastic. 55 * 56 * @image html ttp223.jpg 57 * @snippet ttp223.cxx Interesting 58 */ 59 class TTP223 { 60 public: 61 /** 62 * TTP223 constructor 63 * 64 * @param pin GPIO pin where the sensor is connected 65 */ 66 TTP223(unsigned int pin); 67 68 /** 69 * TTP223 destructor 70 */ 71 ~TTP223(); 72 73 /** 74 * Returns the name of this sensor 75 * 76 * @return Name of this sensor 77 */ 78 std::string name(); 79 80 /** 81 * Gets the value from the GPIO pin 82 * 83 * @return Value from the GPIO pin 84 */ 85 int value(); 86 87 /** 88 * Determines whether the touch sensor is being touched 89 * 90 * @return True if touched, false otherwise 91 */ 92 bool isPressed(); 93 94 /** 95 * Installs an interrupt service routine (ISR) to be called when 96 * the button is activated or deactivated. 97 * 98 * @param fptr Pointer to a function to be called on interrupt 99 * @param arg Pointer to an object to be supplied as an 100 * argument to the ISR. 101 */ 102 #if defined(SWIGJAVA) || defined(JAVACALLBACK) 103 void installISR(mraa::Edge level, IsrCallback *cb); 104 #else 105 void installISR(mraa::Edge level, void (*isr)(void *), void *arg); 106 #endif 107 /** 108 * Uninstalls the previously installed ISR 109 * 110 */ 111 void uninstallISR(); 112 113 protected: 114 #if defined(SWIGJAVA) || defined(JAVACALLBACK) 115 void installISR(mraa::Edge level, void (*isr)(void *), void *arg); 116 #endif 117 std::string m_name; //!< name of this sensor 118 mraa_gpio_context m_gpio; //!< GPIO pin 119 bool m_isrInstalled; 120 }; 121 122 } 123