upm/src/at42qt1070/at42qt1070.h

/*
 * 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 <stdint.h>
#include <sys/time.h>

#include <string>
#include <mraa/i2c.h>

#define AT42QT1070_I2C_BUS 0
#define AT42QT1070_DEFAULT_I2C_ADDR 0x1b

namespace upm {
  
  /**
   * @brief UPM module for the Atmel AT42QT1070 QTouch sensor
   * @defgroup at42qt1070 libupm-at42qt1070
   * @ingroup seeed i2c touch
   */

  /**
   * @sensor at42qt1070
   * @library at42qt1070
   * @comname Atmel AT42QT1070 QTouch Sensor
   * @category touch
   * @manufacturer seeed
   * @connection i2c
   *
   * @brief C++ API for the Atmel AT42QT1070 QTouch sensor
   *
   * This class implements support for the Atmel AT42QT1070 QTouch
   * sensor, which supports 7 capacitive buttons.
   *
   * It was developed using the Grove Q Touch Sensor board.
   *
   * @snippet at42qt1070.cxx Interesting
   */
  class AT42QT1070 {
  public:

    // registers
    typedef enum { REG_CHIPID      = 0,
                   REG_FWVERS      = 1,

                   REG_DETSTATUS   = 2, // detection status
                   REG_KEYSTATUS   = 3, // key status

                   REG_KEYSIG0_H   = 4, // key signal
                   REG_KEYSIG0_L   = 5,
                   REG_KEYSIG1_H   = 6,
                   REG_KEYSIG1_L   = 7,
                   REG_KEYSIG2_H   = 8,
                   REG_KEYSIG2_L   = 9,
                   REG_KEYSIG3_H   = 10,
                   REG_KEYSIG3_L   = 11,
                   REG_KEYSIG4_H   = 12,
                   REG_KEYSIG4_L   = 13,
                   REG_KEYSIG5_H   = 14,
                   REG_KEYSIG5_L   = 15,
                   REG_KEYSIG6_H   = 16,
                   REG_KEYSIG6_L   = 17,

                   REG_REFDATA0_H  = 18, // key reference data
                   REG_REFDATA0_L  = 19,
                   REG_REFDATA1_H  = 20,
                   REG_REFDATA1_L  = 21,
                   REG_REFDATA2_H  = 22,
                   REG_REFDATA2_L  = 23,
                   REG_REFDATA3_H  = 24,
                   REG_REFDATA3_L  = 25,
                   REG_REFDATA4_H  = 26,
                   REG_REFDATA4_L  = 27,
                   REG_REFDATA5_H  = 28,
                   REG_REFDATA5_L  = 29,
                   REG_REFDATA6_H  = 30,
                   REG_REFDATA6_L  = 31,

                   REG_NTHR0       = 32, // negative threshold level
                   REG_NTHR1       = 33,
                   REG_NTHR2       = 34,
                   REG_NTHR3       = 35,
                   REG_NTHR4       = 36,
                   REG_NTHR5       = 37,
                   REG_NTHR6       = 38,

                   REG_AVE0        = 39, // key suppression
                   REG_AVE1        = 40,
                   REG_AVE2        = 41,
                   REG_AVE3        = 42,
                   REG_AVE4        = 43,
                   REG_AVE5        = 44,
                   REG_AVE6        = 45,

                   REG_DI0         = 46, // detection integrator
                   REG_DI1         = 47,
                   REG_DI2         = 48,
                   REG_DI3         = 49,
                   REG_DI4         = 50,
                   REG_DI5         = 51,
                   REG_DI6         = 52,

                   REG_GUARD       = 53, // FastOutDI/Max Cal/Guard channel
                   REG_LP          = 54, // low power
                   REG_MAXON       = 55, // max on duration
                   REG_CALIBRATE   = 56,
                   REG_RESET       = 57
    } AT42QT1070_REG_T;

    // detection register bits
    typedef enum { DET_TOUCH       = 0x01,
                   // 0x02-0x20 reserved
                   DET_OVERFLOW    = 0x40,
                   DET_CALIBRATE   = 0x80
    } AT42QT1070_DET_T;


    /**
     * AT42QT1070 constructor
     *
     * @param bus i2c bus to use
     * @param address the address for this sensor
     */
    AT42QT1070(int bus, uint8_t address = AT42QT1070_DEFAULT_I2C_ADDR);

    /**
     * AT42QT1070 Destructor
     */
    ~AT42QT1070();

    /**
     * Write byte value into register
     *
     * @param reg register location to write into
     * @param byte byte to write
     * @return true if successful
     */
    bool writeByte(uint8_t reg, uint8_t byte);

    /**
     * Write word value at register.  Note, the device must have the
     * auto-increment bit set in the MODE1 register to work.
     *
     * @param reg register location to write into
     * @param word word to write
     * @return true if successful
     */
    bool writeWord(uint8_t reg, uint16_t word);

    /**
     * Read byte value from register
     *
     * @param reg register location to read from
     * @return value at specified register
     */
    uint8_t readByte(uint8_t reg);

    /**
     * Read word value from register.  Note, the device must have the
     * auto-increment bit set in the MODE1 register to work.
     *
     * @param reg register location to read from
     * @return value at specified register
     */
    uint16_t readWord(uint8_t reg);

    /**
     * Read the current touch status and detection state
     *
     * @return key status bits for all keys (0-6)
     */
    void updateState();

    /**
     * return the overflow indicator
     *
     * @return true if overflow indicated
     */
    bool isOverflowed() { return m_overflow; };

    /**
     * return the calibrating indicator
     *
     * @return true if calibration is in progress
     */
    bool isCalibrating() { return m_calibrating; };

    /**
     * Issue a reset command
     *
     * @return true if reset successful
     */
    bool reset();

    /**
     * Issue a calibrate command
     *
     * @return true if calibrate successful
     */
    bool calibrate();

    /**
     * Get the current button states
     *
     * @returns the button states
     */
    uint8_t getButtons() { return m_buttonStates; };

  private:
    uint8_t m_buttonStates;
    bool m_calibrating;
    bool m_overflow;

    mraa_i2c_context m_i2c;
    uint8_t m_addr;
  };
}