Martin Sturm / Mbed 2 deprecated Lab3

Dependencies:   mbed

MPR121/mpr121.h@0:c546b51ecf0b, 2011-10-11 (annotated)

Committer:
XkLi
Date:
Tue Oct 11 01:24:18 2011 +0000
Revision:
0:c546b51ecf0b
v1.0

Who changed what in which revision?

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