QuickMpr121.h

 
#pragma once
#include "Arduino.h"
#include "Wire.h"
#include "QuickMpr121Enums.h"
 
 
// please also update `PREDEFINED` in Doxyfile if changing any defines
 
#ifndef MPR121_I2C_BUFLEN
#define MPR121_I2C_BUFLEN 26 // note: arduino Wire library defines BUFFER_LENGTH as 32, so much larger values won't work
#endif
 
// use bitfields (stored in short) instead electrodeTouchBuf and electrodeOORBuf
#define MPR121_USE_BITFIELDS true
 
// make some buffers static (shared between instances) to save memory
#define MPR121_SAVE_MEMORY true
 
 
// define DEPRECATED so the same syntax can be used for any compiler without issues
#if __GNUC__
  # if (__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 5)) // GCC 4.5+ supports deprecated with msg
    #define DEPRECATED(func, msg) func __attribute__ ((deprecated(msg)))
  #else // GCC 4.5+
    #define DEPRECATED(func, msg) func __attribute__ ((deprecated))
  #endif // GCC 4.5+
#else // __GNUC__
  #warning "Please implement DEPRECATED for your compiler"
  #define DEPRECATED(func, msg) func
#endif // __GNUC__
 
 
// pin names (mainly useful for LED pins)
#define MPR_ELE0 0
#define MPR_ELE1 1
#define MPR_ELE2 2
#define MPR_ELE3 3
#define MPR_ELE4 4
#define MPR_ELE5 5
#define MPR_ELE6 6
#define MPR_ELE7 7
#define MPR_ELE8 8
#define MPR_ELE9 9
#define MPR_ELE10 10
#define MPR_ELE11 11
#define MPR_ELEPROX 12
 
#define MPR_LED0 MPR_ELE4
#define MPR_LED1 MPR_ELE5
#define MPR_LED2 MPR_ELE6
#define MPR_LED3 MPR_ELE7
#define MPR_LED4 MPR_ELE8
#define MPR_LED5 MPR_ELE9
#define MPR_LED6 MPR_ELE10
#define MPR_LED7 MPR_ELE11
 
 
class mpr121 {
private:
  byte i2cAddr; 
  TwoWire* i2cWire; 
 
  static byte i2cReadBuf[MPR121_I2C_BUFLEN]; 
  
  #if MPR121_SAVE_MEMORY
    static short electrodeDataBuf[13]; 
    static byte electrodeBaselineBuf[13]; 
    static byte electrodeCDCBuf[13]; 
    static mpr121FilterCDT electrodeCDTBuf[13]; 
    #if !MPR121_USE_BITFIELDS
      bool electrodeTouchBuf[13]; 
      static bool electrodeOORBuf[15]; 
    #endif
  #else // MPR121_SAVE_MEMORY
    short electrodeDataBuf[13]; 
    byte electrodeBaselineBuf[13]; 
    byte electrodeCDCBuf[13]; 
    mpr121FilterCDT electrodeCDTBuf[13]; 
    #if !MPR121_USE_BITFIELDS
      bool electrodeTouchBuf[13]; 
      bool electrodeOORBuf[15]; 
    #endif
  #endif // MPR121_SAVE_MEMORY
  
  #if MPR121_USE_BITFIELDS
    short electrodeTouchCache; 
  #endif
  unsigned long electrodeTouchCacheMicros; 
  
  
  void writeRegister(mpr121Register addr, byte value);
 
  byte* readRegister(mpr121Register addr, byte count);
  
  byte readRegister(mpr121Register addr) {
    return readRegister(addr, 1)[0];
  }
 
 
  bool checkElectrodeNum(byte &electrode, byte &count);
 
  bool checkElectrodeNum(byte &electrode);
 
  bool checkGPIOPinNum(byte &pin, byte &count);
 
  bool checkGPIOPinNum(byte &pin);
 
 
  void setElectrodeThresholds(byte electrode, byte count, byte touchThreshold, byte releaseThreshold);
  
  void setElectrodeThresholds(byte electrode, byte touchThreshold, byte releaseThreshold) {
    setElectrodeThresholds(electrode, 1, touchThreshold, releaseThreshold);
  }
 
 
  void setMHD(byte rising, byte falling);
  
  void setNHD(byte rising, byte falling, byte touched);
  
  void setNCL(byte rising, byte falling, byte touched);
  
  void setFDL(byte rising, byte falling, byte touched);
 
 
  void setMHDProx(byte rising, byte falling);
  
  void setNHDProx(byte rising, byte falling, byte touched);
  
  void setNCLProx(byte rising, byte falling, byte touched);
  
  void setFDLProx(byte rising, byte falling, byte touched);
 
  
  void setDebounce(byte touchNumber, byte releaseNumber);
 
 
  void setFilterConfig(mpr121FilterFFI FFI, byte CDC, mpr121FilterCDT CDT, mpr121FilterSFI SFI, mpr121FilterESI ESI);
 
  
  void setElectrodeConfiguration(mpr121ElectrodeConfigCL CL, mpr121ElectrodeConfigProx ELEPROX_EN, byte ELE_EN);
 
  
  void setAutoConfig(byte USL, byte LSL, byte TL, mpr121AutoConfigRetry RETRY, mpr121AutoConfigBVA BVA, bool ARE, bool ACE, bool SCTS, bool OORIE, bool ARFIE, bool ACFIE);
 
 
  void setPWM(byte pin, byte count, byte value);
  
public:
  mpr121(byte addr = 0, TwoWire *wire = &Wire);
 
  byte touchThresholds[13]; 
  byte releaseThresholds[13]; 
 
  byte MHDrising; 
  byte MHDfalling; 
  
  byte NHDrising; 
  byte NHDfalling; 
  byte NHDtouched; 
  
  byte NCLrising; 
  byte NCLfalling; 
  byte NCLtouched; 
  
  byte FDLrising; 
  byte FDLfalling; 
  byte FDLtouched; 
 
  
  byte MHDrisingProx; 
  byte MHDfallingProx; 
  
  byte NHDrisingProx; 
  byte NHDfallingProx; 
  byte NHDtouchedProx; 
  
  byte NCLrisingProx; 
  byte NCLfallingProx; 
  byte NCLtouchedProx; 
  
  byte FDLrisingProx; 
  byte FDLfallingProx; 
  byte FDLtouchedProx; 
 
 
  byte debounceTouch; 
  byte debounceRelease; 
 
 
  mpr121FilterFFI FFI; 
  byte globalCDC; 
  mpr121FilterCDT globalCDT; 
  mpr121FilterSFI SFI; 
  mpr121FilterESI ESI; 
 
 
  mpr121ElectrodeConfigCL calLock; 
  mpr121ElectrodeConfigProx proxEnable; 
 
  byte autoConfigUSL; 
  byte autoConfigLSL; 
  byte autoConfigTL; 
  mpr121AutoConfigRetry autoConfigRetry; 
  mpr121AutoConfigBVA autoConfigBaselineAdjust; 
  bool autoConfigEnableReconfig; 
  bool autoConfigEnableCalibration; 
  
  bool autoConfigSkipChargeTime; 
  bool autoConfigInterruptOOR; 
  bool autoConfigInterruptARF; 
  bool autoConfigInterruptACF; 
 
 
  bool readTouchState(byte electrode);
 
  #if MPR121_USE_BITFIELDS
 
    short readTouchState();
 
    short readOORState();
  #else
 
    bool* readTouchState();
 
    bool* readOORState();
  #endif
 
  bool readOverCurrent();
 
  void clearOverCurrent();
 
  short* readElectrodeData(byte electrode, byte count);
  
  short readElectrodeData(byte electrode) {
    return readElectrodeData(electrode, 1)[0];
  }
  
  byte* readElectrodeBaseline(byte electrode, byte count);
  
  byte readElectrodeBaseline(byte electrode) {
    return readElectrodeBaseline(electrode, 1)[0];
  }
 
  void writeElectrodeBaseline(byte electrode, byte count, byte value);
  
  void writeElectrodeBaseline(byte electrode, byte value) {
    writeElectrodeBaseline(electrode, 1, value);
  }
 
  void setAllThresholds(byte touched, byte released, bool prox);
  
  
  byte* readElectrodeCDC(byte electrode, byte count);
  
  byte readElectrodeCDC(byte electrode) {
    return readElectrodeCDC(electrode, 1)[0];
  }
  
  void writeElectrodeCDC(byte electrode, byte count, byte value);
  
  void writeElectrodeCDC(byte electrode, byte value) {
    writeElectrodeCDC(electrode, 1, value);
  }
  
  mpr121FilterCDT* readElectrodeCDT(byte electrode, byte count);
  
  mpr121FilterCDT readElectrodeCDT(byte electrode) {
    return readElectrodeCDT(electrode, 1)[0];
  }
  
  void writeElectrodeCDT(byte electrode, byte count, mpr121FilterCDT value);
  
  void writeElectrodeCDT(byte electrode, mpr121FilterCDT value) {
    writeElectrodeCDT(electrode, 1, value);
  }
 
 
  void setGPIOMode(byte pin, byte count, mpr121GPIOMode mode);
 
  void setGPIOMode(byte pin, mpr121GPIOMode mode) {
    setGPIOMode(pin, 1, mode);
  }
 
  void writeGPIODigital(byte pin, byte count, bool value);
 
  void writeGPIODigital(byte pin, bool value) {
    writeGPIODigital(pin, 1, value);
  }
 
  void writeGPIOAnalog(byte pin, byte count, byte value);
 
  void writeGPIOAnalog(byte pin, byte value) {
    writeGPIOAnalog(pin, 1, value);
  }
 
 
  void begin(unsigned long clock=400000);
 
 
  void start(byte electrodes);
  
  #ifndef NO_DOXYGEN
    // (deprecated) alias for start
    DEPRECATED(void startMPR(byte electrodes), "Renamed to `start`.") {
      start(electrodes);
    }
  #endif
 
  void stop();
  
  #ifndef NO_DOXYGEN
    // (deprecated) alias for stop
    DEPRECATED(void stopMPR(), "Renamed to `stop`.") {
      stop();
    }
  #endif
 
 
  bool checkRunning();
 
 
  void softReset();
};