/*
 * 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
 *
 *   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.
 *
 * @defgroup ttp223 libupm-ttp223
 * @ingroup seeed gpio touch
 */
/**
 * @library ttp223
 * @sensor ttp223
 * @comname Touch sensor
 * @type touch
 * @man seeed
 * @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html
 * @con gpio
 *
 * @brief TTP223 Touch Detector sensor library
 * 
 *   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.
 *
 * @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
};

}
