Bryce Williams / MPR121

Anthony Buckton's MPR121 Driver Library

Dependents:   DRV2605L_Haptic_Driver_Demo 3872_Project

mpr121.h@0:f0e656f25701, 2015-10-21 (annotated)

Committer:
electromotivated
Date:
Wed Oct 21 01:07:25 2015 +0000
Revision:
0:f0e656f25701
v1 upload;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
electromotivated 0:f0e656f25701 1 /*
electromotivated 0:f0e656f25701 2 Copyright (c) 2011 Anthony Buckton (abuckton [at] blackink [dot} net {dot} au)
electromotivated 0:f0e656f25701 3
electromotivated 0:f0e656f25701 4
electromotivated 0:f0e656f25701 5 Permission is hereby granted, free of charge, to any person obtaining a copy
electromotivated 0:f0e656f25701 6 of this software and associated documentation files (the "Software"), to deal
electromotivated 0:f0e656f25701 7 in the Software without restriction, including without limitation the rights
electromotivated 0:f0e656f25701 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
electromotivated 0:f0e656f25701 9 copies of the Software, and to permit persons to whom the Software is
electromotivated 0:f0e656f25701 10 furnished to do so, subject to the following conditions:
electromotivated 0:f0e656f25701 11
electromotivated 0:f0e656f25701 12 The above copyright notice and this permission notice shall be included in
electromotivated 0:f0e656f25701 13 all copies or substantial portions of the Software.
electromotivated 0:f0e656f25701 14
electromotivated 0:f0e656f25701 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
electromotivated 0:f0e656f25701 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
electromotivated 0:f0e656f25701 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
electromotivated 0:f0e656f25701 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
electromotivated 0:f0e656f25701 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
electromotivated 0:f0e656f25701 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
electromotivated 0:f0e656f25701 21 THE SOFTWARE.
electromotivated 0:f0e656f25701 22
electromotivated 0:f0e656f25701 23 Parts written by Jim Lindblom of Sparkfun
electromotivated 0:f0e656f25701 24 Ported to mbed by A.Buckton, Feb 2011
electromotivated 0:f0e656f25701 25 */
electromotivated 0:f0e656f25701 26
electromotivated 0:f0e656f25701 27 #ifndef MPR121_H
electromotivated 0:f0e656f25701 28 #define MPR121_H
electromotivated 0:f0e656f25701 29
electromotivated 0:f0e656f25701 30 //using namespace std;
electromotivated 0:f0e656f25701 31
electromotivated 0:f0e656f25701 32 class Mpr121
electromotivated 0:f0e656f25701 33 {
electromotivated 0:f0e656f25701 34
electromotivated 0:f0e656f25701 35 public:
electromotivated 0:f0e656f25701 36 // i2c Addresses, bit-shifted
electromotivated 0:f0e656f25701 37 enum Address { ADD_VSS = 0xb4,// ADD->VSS = 0x5a <-wiring on Sparkfun board
electromotivated 0:f0e656f25701 38 ADD_VDD = 0xb6,// ADD->VDD = 0x5b
electromotivated 0:f0e656f25701 39 ADD_SCL = 0xb8,// ADD->SDA = 0x5c
electromotivated 0:f0e656f25701 40 ADD_SDA = 0xba // ADD->SCL = 0x5d
electromotivated 0:f0e656f25701 41 };
electromotivated 0:f0e656f25701 42
electromotivated 0:f0e656f25701 43 // Real initialiser, takes the i2c address of the device.
electromotivated 0:f0e656f25701 44 Mpr121(I2C *i2c, Address i2cAddress);
electromotivated 0:f0e656f25701 45
electromotivated 0:f0e656f25701 46 bool getProximityMode();
electromotivated 0:f0e656f25701 47
electromotivated 0:f0e656f25701 48 void setProximityMode(bool mode);
electromotivated 0:f0e656f25701 49
electromotivated 0:f0e656f25701 50 int readTouchData();
electromotivated 0:f0e656f25701 51
electromotivated 0:f0e656f25701 52 unsigned char read(int key);
electromotivated 0:f0e656f25701 53
electromotivated 0:f0e656f25701 54 int write(int address, unsigned char value);
electromotivated 0:f0e656f25701 55 int writeMany(int start, unsigned char* dataSet, int length);
electromotivated 0:f0e656f25701 56
electromotivated 0:f0e656f25701 57 void setElectrodeThreshold(int electrodeId, unsigned char touchThreshold, unsigned char releaseThreshold);
electromotivated 0:f0e656f25701 58
electromotivated 0:f0e656f25701 59 protected:
electromotivated 0:f0e656f25701 60 // Configures the MPR with standard settings. This is permitted to be overwritten by sub-classes.
electromotivated 0:f0e656f25701 61 void configureSettings();
electromotivated 0:f0e656f25701 62
electromotivated 0:f0e656f25701 63 private:
electromotivated 0:f0e656f25701 64 // The I2C bus instance.
electromotivated 0:f0e656f25701 65 I2C *i2c;
electromotivated 0:f0e656f25701 66
electromotivated 0:f0e656f25701 67 // i2c address of this mpr121
electromotivated 0:f0e656f25701 68 Address address;
electromotivated 0:f0e656f25701 69 };
electromotivated 0:f0e656f25701 70
electromotivated 0:f0e656f25701 71
electromotivated 0:f0e656f25701 72 // MPR121 Register Defines
electromotivated 0:f0e656f25701 73 #define MHD_R 0x2B
electromotivated 0:f0e656f25701 74 #define NHD_R 0x2C
electromotivated 0:f0e656f25701 75 #define NCL_R 0x2D
electromotivated 0:f0e656f25701 76 #define FDL_R 0x2E
electromotivated 0:f0e656f25701 77 #define MHD_F 0x2F
electromotivated 0:f0e656f25701 78 #define NHD_F 0x30
electromotivated 0:f0e656f25701 79 #define NCL_F 0x31
electromotivated 0:f0e656f25701 80 #define FDL_F 0x32
electromotivated 0:f0e656f25701 81 #define NHDT 0x33
electromotivated 0:f0e656f25701 82 #define NCLT 0x34
electromotivated 0:f0e656f25701 83 #define FDLT 0x35
electromotivated 0:f0e656f25701 84 // Proximity sensing controls
electromotivated 0:f0e656f25701 85 #define MHDPROXR 0x36
electromotivated 0:f0e656f25701 86 #define NHDPROXR 0x37
electromotivated 0:f0e656f25701 87 #define NCLPROXR 0x38
electromotivated 0:f0e656f25701 88 #define FDLPROXR 0x39
electromotivated 0:f0e656f25701 89 #define MHDPROXF 0x3A
electromotivated 0:f0e656f25701 90 #define NHDPROXF 0x3B
electromotivated 0:f0e656f25701 91 #define NCLPROXF 0x3C
electromotivated 0:f0e656f25701 92 #define FDLPROXF 0x3D
electromotivated 0:f0e656f25701 93 #define NHDPROXT 0x3E
electromotivated 0:f0e656f25701 94 #define NCLPROXT 0x3F
electromotivated 0:f0e656f25701 95 #define FDLPROXT 0x40
electromotivated 0:f0e656f25701 96 // Electrode Touch/Release thresholds
electromotivated 0:f0e656f25701 97 #define ELE0_T 0x41
electromotivated 0:f0e656f25701 98 #define ELE0_R 0x42
electromotivated 0:f0e656f25701 99 #define ELE1_T 0x43
electromotivated 0:f0e656f25701 100 #define ELE1_R 0x44
electromotivated 0:f0e656f25701 101 #define ELE2_T 0x45
electromotivated 0:f0e656f25701 102 #define ELE2_R 0x46
electromotivated 0:f0e656f25701 103 #define ELE3_T 0x47
electromotivated 0:f0e656f25701 104 #define ELE3_R 0x48
electromotivated 0:f0e656f25701 105 #define ELE4_T 0x49
electromotivated 0:f0e656f25701 106 #define ELE4_R 0x4A
electromotivated 0:f0e656f25701 107 #define ELE5_T 0x4B
electromotivated 0:f0e656f25701 108 #define ELE5_R 0x4C
electromotivated 0:f0e656f25701 109 #define ELE6_T 0x4D
electromotivated 0:f0e656f25701 110 #define ELE6_R 0x4E
electromotivated 0:f0e656f25701 111 #define ELE7_T 0x4F
electromotivated 0:f0e656f25701 112 #define ELE7_R 0x50
electromotivated 0:f0e656f25701 113 #define ELE8_T 0x51
electromotivated 0:f0e656f25701 114 #define ELE8_R 0x52
electromotivated 0:f0e656f25701 115 #define ELE9_T 0x53
electromotivated 0:f0e656f25701 116 #define ELE9_R 0x54
electromotivated 0:f0e656f25701 117 #define ELE10_T 0x55
electromotivated 0:f0e656f25701 118 #define ELE10_R 0x56
electromotivated 0:f0e656f25701 119 #define ELE11_T 0x57
electromotivated 0:f0e656f25701 120 #define ELE11_R 0x58
electromotivated 0:f0e656f25701 121 // Proximity Touch/Release thresholds
electromotivated 0:f0e656f25701 122 #define EPROXTTH 0x59
electromotivated 0:f0e656f25701 123 #define EPROXRTH 0x5A
electromotivated 0:f0e656f25701 124 // Debounce configuration
electromotivated 0:f0e656f25701 125 #define DEB_CFG 0x5B
electromotivated 0:f0e656f25701 126 // AFE- Analogue Front End configuration
electromotivated 0:f0e656f25701 127 #define AFE_CFG 0x5C
electromotivated 0:f0e656f25701 128 // Filter configuration
electromotivated 0:f0e656f25701 129 #define FIL_CFG 0x5D
electromotivated 0:f0e656f25701 130 // Electrode configuration - transistions to "active mode"
electromotivated 0:f0e656f25701 131 #define ELE_CFG 0x5E
electromotivated 0:f0e656f25701 132
electromotivated 0:f0e656f25701 133 #define GPIO_CTRL0 0x73
electromotivated 0:f0e656f25701 134 #define GPIO_CTRL1 0x74
electromotivated 0:f0e656f25701 135 #define GPIO_DATA 0x75
electromotivated 0:f0e656f25701 136 #define GPIO_DIR 0x76
electromotivated 0:f0e656f25701 137 #define GPIO_EN 0x77
electromotivated 0:f0e656f25701 138 #define GPIO_SET 0x78
electromotivated 0:f0e656f25701 139 #define GPIO_CLEAR 0x79
electromotivated 0:f0e656f25701 140 #define GPIO_TOGGLE 0x7A
electromotivated 0:f0e656f25701 141 // Auto configration registers
electromotivated 0:f0e656f25701 142 #define AUTO_CFG_0 0x7B
electromotivated 0:f0e656f25701 143 #define AUTO_CFG_U 0x7D
electromotivated 0:f0e656f25701 144 #define AUTO_CFG_L 0x7E
electromotivated 0:f0e656f25701 145 #define AUTO_CFG_T 0x7F
electromotivated 0:f0e656f25701 146
electromotivated 0:f0e656f25701 147 // Threshold defaults
electromotivated 0:f0e656f25701 148 // Electrode touch threshold
electromotivated 0:f0e656f25701 149 #define E_THR_T 0x0F
electromotivated 0:f0e656f25701 150 // Electrode release threshold
electromotivated 0:f0e656f25701 151 #define E_THR_R 0x0A
electromotivated 0:f0e656f25701 152 // Prox touch threshold
electromotivated 0:f0e656f25701 153 #define PROX_THR_T 0x02
electromotivated 0:f0e656f25701 154 // Prox release threshold
electromotivated 0:f0e656f25701 155 #define PROX_THR_R 0x02
electromotivated 0:f0e656f25701 156
electromotivated 0:f0e656f25701 157 #endif