Payman Shabbaki / Mbed 2 deprecated 4180Project

4180 Final Project

Dependencies:   4DGL-uLCD-SE mbed Servo

mpr121.h@27:2bd737c0a8af, 2016-05-01 (annotated)

Committer:
ecarrick
Date:
Sun May 01 19:54:20 2016 +0000
Revision:
27:2bd737c0a8af
Parent:
7:52b51f507ee5 
some small fixes and adding comments

Who changed what in which revision?

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